Previous Topic: Retrieve GridsNext Topic: Grid Update


Grid Operations

Start the grid

POST  BFC/grids/<grid name>/operations/start
Arguments

Payload is empty.

Result

202 on success or HTTP error code on error (for example, if the grid is busy).

Description

Use this operation to start a grid that is stopped. You can use this operation after you create the grid using the BFC Grid Create API, or after you stopped a grid using the WebUI or BFC API.

When you create a grid using the BFC Web GUI, the CA AppLogic® grid is created and started in one step. If this is the first call to start a grid that has never been started, it can be very expensive and may take up to several hours to complete. During this process, CA AppLogic® grid nodes are imaged, catalogs are copied into place, volumes are configured, and so on.

After the grid is created, you can use the start operation to restart a stopped grid. To status the grid start, monitor the state field of the grid record returned from a GET to the grid URL. The start is completed when the state is resource_running_state.

Note: The GET, PUT, and DELETE actions are not supported for grid operations.

Stop the grid

POST  BFC/grids/<grid name>/operations/stop
Arguments

Payload is empty.

Result

202 on success or HTTP error code on error (for example, if the grid is busy).

Description

This operation stops the CA AppLogic® grid. To status the grid stop, monitor the state field of the grid record returned from a GET to the grid URL. The grid is stopped when the state is resource_ready_state.

Note: The GET, PUT, and DELETE actions are not supported for grid operations.

Reboot the grid

POST  BFC/grids/<grid_name>/operations/reboot
Arguments

Payload is empty.

Result

202 on success or HTTP error code on error (for example, if the grid is busy).

Description

This operation reboots the running CA AppLogic® grid. To status the grid stop, monitor the state field of the grid record returned from a GET to the grid URL. The grid is rebooted when the state returns to resource_running_state.

Note: The GET, PUT, and DELETE actions are not supported for grid operations.

Apply Hotfixes or Language Packs

POST  BFC/grids/<grid name>/operations/applyHotfixes 
Arguments

Payload is a list of strings that are the names of the hotfixes and/or language packs that should be applied or re-applied to the grid. The hotfix names should be of the form: hf1248. The language pack names are of the form lp1248-English.

Result

202 on success or HTTP error code on error (for example, if the grid is busy).

Description

This operation applies the specified hotfixes and/or language packs to a running CA AppLogic® grid. To status the operation, monitor the state field of the grid record returned from a GET to the grid URL. The specified hotfixes and/or language packs have been applied to the grid when the state returns to resource_running_state.

Note: The GET, PUT, and DELETE actions are not supported for grid operations.

Remove Nodes

POST BFC/grids/<grid name>/operations/removeNodes 
Arguments

Payload is a list of MAC and/or IP addresses specifying the nodes to be removed from the grid. Each MAC or IP address should correspond to the backbone interface of a grid server.

Note: Before you remove a node with this method, you must first disable the node in the CA AppLogic® grid controller.

Result

202 on success or HTTP error code on error (for example, if the grid is busy).

Description

This operation removes the specified nodes from the running CA AppLogic® grid. To status the operation, monitor the state field of the grid record returned from a GET to the grid URL. The specified nodes have been removed from the grid when the state returns to resource_running_state.

Note: The GET, PUT, and DELETE actions are not supported for grid operations.

Clear Failure

POST  BFC/grids/<grid_name>/operations/clearFailure
Arguments

Payload is empty.

Result

202 on success or HTTP error code on error (for example, if the grid is busy).

Description

This operation removes an error status on a grid prompting it to attempt (retry) to reach its desired state. To status the operation monitor the state field of the grid record returned from a GET to the grid URL. The grid will no longer be in one of the resource failed states (i.e. will return to the resource_running_state) on success.

Note: The GET, PUT, and DELETE actions are not supported for grid operations.

Check External Storage

POST  BFC/admin/grids/operations/checkExternalStorage
Arguments:

Payload is a external_storage_nfs record identifying the NFS server and export path of the desired storage. At present, NFS is the only supported external storage type.

Result:

200 on success (the storage is accessible) or HTTP error code (with driver_fault payload) on error.

Description:

This operation checks the accessibility of the given NFS storage. A client may wish to confirm this before proceeding with creation of a grid that intends to use the storage.

Note: The GET, PUT, and DELETE actions are not supported for this operation.