Integration Guides › BFC API Reference Guide › Create a Grid

Create a Grid

In the following example you create a new grid component in the BFC/grids folder.

POST BFC/grid
POST BFC/grids?checkExternalStorage&enableLanguagePacks&numAppIPs=10

The payload is a possibly sparse grid record. For the 1.0 release of the BFC, the following fields are required in the grid record:

• name
• xen_config/esx_config

  Note: At least one of the two must be specified and have a target count greater than 0.

• grid_controller_user
• grid_controller_password

For the 1.0 release of the BFC API, the following parameters in the grid record are honored:

• description
• id
• applogic_version

  Note: If the applogic_version is not specified, the most recent (highest numbered) CA AppLogic® version is used.

• applogic_hotfixes
• oem_kit
• external_network

  Note: If external_network is not specified, one of the available external networks is selected.

  See the table below that details legal IP and VLAN parameter combinations.

• app_ips

  Note: Used to reserve address ranges explicitly for grid application use. If not specified, then specify a count of addresses in the numAppIPs query string parameter and the system will reserve that many application IP addresses.

  See the table below that details legal IP and VLAN parameter combinations.

• controller_ip

  See the table below that details legal IP and VLAN parameter combinations.

• vmware_license_key
• default_vlan

  Note: The default VLAN determines the VLAN for the grid controller IP and if otherwise specified (through the app_ips parameter data) also determines the VLAN for the requested number of application IPs.

  See the table below that details legal IP and VLAN parameter combinations.

• account_id
• account_key
• recovery_password
• global_user_dir
• grid_controller_name
• additional_config
• external_storage

  Note: By default, accessibility of external storage is not checked as part of the create. To check accessibility as part of the create operation (and fail the create if the storage can't be accessed), specify the "checkExternalStorage" query string in the POST URI. See documentation for Check External Storage to check the accessibility of the storage independent of a create operation.

Create Grid supports two IP modes:

• Fully specified addresses, where the user passes the app_ips ranges and controller_ip address. The external_network parameter is not accepted and causes an error because it is given that addresses were specified. The default VLAN is optional.
• System-selected addresses, where only a count of addresses is requested. The user can also optionally specify which external_network to use. Specific addresses are not accepted and cause an error. For example, if the user specifies addresses through app_ips ranges or controller_ip addresses. The default VLAN is optional.

Use the following table to review permissible IP and VLAN parameter combinations when passing the parameter. The top row identifies the parameter that you are passing, the value in the column below the parameter indicates the system response. Combinations can be permitted (OK), REQUIRED, or result in an ERROR. For example, when passing the external_network parameter, numAppIPs is REQUIRED.

Table - Create Grid IP and VLAN input (parameter and query string) combination rules

* = Query String input data (see below)

Supported query string parameters in the POST URI

checkExternalStorage

If simply present or set equal to true, then the accessibility of the external storage is verified as part of the grid creation operation.

enableLanguagePacks

If simply present or set equal to true, then all language packs will be applied to the grid being created.

numAppIPs

Specifies the number of application IP addresses that should be reserved for use by applications running on the grid being created. The specific addresses will be chosen by the system. Also, either this parameter or the app_ips parameter in the grid record is required and those parameters are mutually exclusive; only one or the other may be specified.

See the previous table that details legal IP and VLAN parameter combinations.

Result

On success, HTTP code 201 and the name of the created grid are returned. On error, an HTTP error code and fault(s) are returned.

Description

Creates a new grid component in the BFC.

Note: This action does not create the AppLogic grid. The first call to the start operation for the grid creates the grid.

Examples

The following example assumes you are using the query string ?numAppIPs=10 on the POST URI and a sparse grid record with the following values:

• name = 'bfcapigrid'
• description = 'a grid created via the bfc api',
• xen_config = min:1, target:2, max:3, selection_criteria:null,
• grid_controller_user = 'cadev@cadev.com',
• grid_controller_password = 'F00b@r',
• applogic_version = '3.0.8'
• external_network = 222.222.222.131/16

JSON Payload:

{"grid": {"grid_controller_user": "cadev@cadev.com", "name": "bfcapigrid", 
"xen_config":{"grid_server_configuration":{"min":2,"target":2,"max":2,"selection_criteria":null}}, 
"applogic_version": "3.0.8", 
"external_network": "222.222.222.131/16", "grid_controller_password": "F00b@r", 
"description": "a grid created via the bfc api"}} 

Response:

201

Header location:

BFC/grids/bfcapigrid

Note: The PUT and DELETE actions are not supported.