Integration Guides › BFC API Reference Guide › Grid Update

Grid Update

You can update a grid with or without reboot.

Update a grid without reboot

PUT  BFC/grids/<grid name>

The payload is a sparse grid record that is populated with only those fields that are to be updated.

For the 1.0 release of the BFC API, the parameters in the grid parameters that can be updated are:

• description
• xen_config
• esx_config
• vmware_license_key
• oem_kit
• global_user_dir
• account_id
• account_key

In addition, the following set of parameters can be passed when not specified with the above parameters. If a reboot is required to enable these parameters, you should use the update grid method described below.

• default_vlan, controller_ip, app_ips

  See the table below for valid combinations of these parameters for update.

• additional_config (must be specified by itself)

Result

HTTP return code 202 and an empty payload on success. Returns an HTTP error code and the associated fault information on error.

Description

Updates a grid with the specified values. The underlying CA AppLogic® grid is not rebooted as part of these updates. Grid updates happen asynchronously to the update call. When a GET call to the grid resource URL reflects the new attributes of the grid, the update has been completed.

Note: For the 1.0 release of the BFC API, when issuing a PUT to this URI, it is an error to include any of the grid parameters that can be updated by the updateGridWithReboot operation (except for the separately specified default_vlan, app_ips, controller_ip, and extra_parameters).

Example grid update using a sparsely populated grid record

JSON Payload:

	{"grid":
		"description":"Updated SimpleGrid1 description",
		"oem_kit":"ACME Computer Corp", 
		"xen_config":
		  {"grid_server_configuration":{"min":3,"target":3,"max":3,
		  "selection_criteria":null}},
		"esx_config":
		 ("grid_server_configuration":{"min":1,"target":1,"max":1,
		  "selection_criteria":null}},
		"vmware_license_key":"XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"}

Update a grid with reboot

POST  BFC/grids/<grid name>/operations/updateGridWithReboot

The payload is a sparsely populated grid record that contains only those fields that are to be updated.

For the 1.0 release of the BFC API, the parameters in the grid parameters that can be updated are:

• name
• grid_controller_name
• recovery_password

In addition, the following set of parameters can be passed when not specified with the above parameters. If a reboot is not required to enable these parameters, you should use the update grid method described above.

• default_vlan, controller_ip, app_ips

  See the table below for valid combinations of these parameters for update.

• additional_config (this must be specified by itself)

Result

HTTP return code 202 and an empty payload on success. Returns an HTTP error code and the associated fault information on error.

Description

Updates a grid with the specified values and then reboots the underlying AppLogic grid to make the new values active. Grid updates happen asynchronously to the update call. When a GET call to the grid resource URL reflects the new attributes of the grid, the update has been completed.

Note: For the 1.0 release of the BFC API, when issuing a POST to this URI, it is an error to include any of the grid parameters that can be updated via a PUT to the grid resource URI.

Table - Network properties combination for grid update