Module operations

RESTful API for IBM® Spectrum Control Base Edition uses the GET and POST commands for module operations.

You can run a module query by issuing the GET command to get a list of modules that belong to a storage system and their properties, or display the properties of a single module.

For example, GET /api/v1/modules/1 lists the properties of the module with identification number 1, as illustrated below.

OK 200
{
	"id": 1,
	"component_id": "1:Module:7",
	"status": "OK",
	"type" : "g3.0_interface",
	"requires_service": "REPLACE",
	"service_reason" : "HARDWARE_ERROR", 
	"disk_bay_count" : 12,
	"fc_port_count" : 4,
	"ethernet_port_count" : 4,
	"memory_gb" : 15 
}

You can initiate phase-in or phase-out action on a module by issuing the POST command with the following syntax:

POST /api/v1/modules/<module-id>/phasein
POST /api/v1/modules/<module-id>/phaseout

For example, POST /api/v1/modules/3/phasein starts a phase-in procedure for the module with identification number 3. The response to the request is OK, followed by the task ID, as illustrated below. The task ID can be used in a query request to monitor the task progress, see Query request and response.

OK
{
	"task id": "04fc6120-60ae-4182-baa9-687d6ae96ffe"
}