Racks REST API

Use this REST API to manage racks.

Important: This REST API is supported for use only with IBM® Cloud Pak System W4600. It is not supported for use with IBM Cloud Pak System Software in a bring-your-own-hardware (BYOH) environment.

Get all racks

Returns a list of racks. You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

URI /admin/resources/racks
Method GET
Returns 200 Returns a list of all racks.
404 The rack list was not found.
500 The Platform System Manager encountered an internal error while processing the request.
Response body
[
   {
      "iscsi_iqn_secondary": "iqn.1994-05.com.ibm.pureapp:70afeb1d66c5",
      "vendor_informations": [
         "/admin/resources/vendor_informations/437fc97b-4101-4526-af58-7b700ca4220a"
      ],
      "created_time_raw": 1465935928069,
      "workload_certificate_updated_time": 1470431556718,
      "domains": null,
      "type": "rack",
      "updated_time": "Fri 05 Aug 2016 23:03:02.312 UTC",
      "secondary_sys_mgmt_node_kickstart_status": "complete",
      "domain_locks": [
      ],
      "multisystem_operation_description_text": null,
      "domain_generation_number": 1,
      "subdomain_mirror_target": null,
      "high_temperature_protection_enabled": "true",
      "target_result": "done",
      "networks": [
      ],
      "allowed_pvu": 0,
      "workload_version": "5.2.2.0",
      "label_text": "Cloud Pak System 8558/Rack37",
      "storage_controllers": [
         "/admin/resources/storage_controllers/d4dceccc-c9a4-4e97-92ce-72a2adb0341a"
      ],
      "label_key": "pure0581(\"8558/Rack37\")",
      "subdomains_target": null,
      "clusters": "/admin/resources/clusters/8776d09e-d525-429f-b94f-0c40e7acbfb6",
      "updated_time_raw": 1470438182312,
      "multisystem_operation_description_key": null,
      "subdomain_state": "pending",
      "domain_lock_manager": "T",
      "compute_node_chassis": [
         "/admin/resources/compute_node_chassis/4617b83c-e961-4813-9cf3-44415f7c8211"
      ],
      "events": [
      ],
      "state": "available",
      "multisystem_operation": null,
      "version": "2.2.2.0",
      "id": "/admin/resources/racks/be3a36db-c14e-489a-a0ec-2dc7b0e43c38",
      "switches": [
         "/admin/resources/switches/9ac233c4-d2b6-48ed-9bc4-6e9776def292",
         "/admin/resources/switches/01c1a4c0-b8d5-4e16-b391-6858601ca350",
         "/admin/resources/switches/fc26e7e1-0668-4432-a282-40260aa05751",
         "/admin/resources/switches/441c417c-4801-4acc-a55f-3c2f42b89545"
      ],
      "workload_certificate": "MIIDLzCCAhegAwIBAgIGBdWg0wmvMA0GCSqGSIb3DQEBBQUAME0xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xEjAQBgNVBAsTCVB1cmVTY2FsZTEcMBoGA1UEAxMTSUJNV29ya2xvYWREZXBsb3llcjAeFw0xNjA2MTQyMDUyNDBaFw00NjA2MTUyMDUyNDBaME0xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xEjAQBgNVBAsTCVB1cmVTY2FsZTEcMBoGA1UEAxMTSUJNV29ya2xvYWREZXBsb3llcjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAIOvxmiinBrZe11cRhV6HSBNDJ5PKiKWaBb0c/XobrhSyjd3O32LuXxuGc8MNzcHfHk0YL1X3FY6L20iVq8xBuq+1ezouuZPR1AezA7XEFh86H2p2z9PkF1Vv8E+WSzfka+L5khajpCoyq6opCdPGFAI/0qWmY9ZnrcvDcX9CchsJOYthp74LliBjTxD78ZCc7+xEg5AV48tVlwHl6pH38c/yAbquNXlLbdAZcKQ2uI5I2VQn3RNJzj7d/BOXaG9P05PtdbJRFf9WWbjMCDzrX4rOXdz5/e+kEvG53pkOwSBkU0kt2IvS/Necd/MC+hgDtCzzICco6DRRodGeC+EAS8CAwEAAaMVMBMwEQYDVR0OBAoECE+5i5aEq6MqMA0GCSqGSIb3DQEBBQUAA4IBAQAInEdAmuGl6PTyT4c540bytAoG+CuxDMyouTuS91tJA+HG4yErim+XbIMwQTBUpVPV0N7IstC9HviJFFASWgqaGGkgUrJVdzXR68I3ZP0Pfo694xdOB53tiL/dM3yiZ15GJ8ggBxpcHZFK4WQ53BQQzFc0Pcs67CxzASUyyOkMbtu2Ifw0NhU4CHy4Ef5t/9kjGjdJ0nhy74m9sLQW6CsjsKzBtL+1BUisRlqXo46KIk3lrwFZWk1RceFj8woKH1tbH1Qe1Nwbnm7g1ytJ01QNn/NIF/bsyY6TtaBpRrF/pehOICB1O2sYpqJjkDgvcBmFoU7/1h3+CoMv8Fq4hI9L",
      "label_user": "Cloud Pak System 8558/Rack37",
      "subdomains": null,
      "locations": [
         "/admin/resources/locations/1143dc4f-ba2f-4925-b760-02808ca3355b"
      ],
      "name": "8558/Rack37",
      "system_version": "2.2.2.0",
      "primary_sys_mgmt_node_kickstart_status": "complete",
      "iscsi_iqn_primary": "iqn.1994-05.com.ibm.pureapp:f03ac3ae686",
      "location_name": "Rack37",
      "target_state": "available",
      "isas_rn": 1,
      "rack_stats": [
         "/admin/resources/rack_stats/fd7d6b1a-e6f3-401e-90df-8f621850225d"
      ],
      "subdomain_mirror": null,
      "created_time": "Tue 14 Jun 2016 20:25:28.069 UTC",
      "pvu_enforcement_mode": "W",
      "subdomain_last_state_change_reason_key": null
   }
]
allowed_pvu
The maximum number of PVUs for all compute nodes in the cloud groups.
clusters
The clusters that the rack belongs to.
created_time
The time at which the object is created.
id
The unique ID of the object in the system.
label_key
The key that is used to retrieve the label for the rack.
label_text
The default translated message text.
label_user
User modified message text.
name
The name of the rack.
primary_sys_mgmt_node_kickstart_status
The kickstart status of the primary management node.
pvu_enforcement_mode
The system behavior when compute nodes are added to a cloud group and they exceed the maximum number of PVUs available. Valid values are:
  • W (warn) - the default value.
  • I (ignore)
  • E (enforce)
secondary_sys_mgmt_node_kickstart_status
The kickstart status of the secondary management node.
state
The general availability of the object. If pending, the object is created but not activated. If available, the object is active in the system.
type
The model type of the rack.
updated time
The time at which the object was last updated.

Get a specific rack

Returns a single rack that is identified by the rack ID. You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Table 1. Rack information
URI /admin/resources/racks/<id>
Method GET
Returns 200 The rack was returned.
404 The rack was not found.
500 The Platform System Manager encountered an internal error while processing the request.

Shut down a rack

Shut downs a rack that is identified by the rack ID.

Avoid trouble: Stop all virtual machines before you attempt to shut down the rack.
URI /admin/resources/racks/<id>
Method PUT
Returns 200 The request to shut down the rack was received. The ID of the job that is queued to shut down the rack is included in the response.
400® The specified ID is not valid.
500 The Platform System Manager encountered an internal error while processing the request.
Request body
{
      "target_state": "shutdown"
}
target_state
The target state for the rack.

Set the allowed PVUs

Sets the allowed PVUs for a rack that is identified by the rack ID.

Avoid trouble: Stop all virtual machines before you attempt to set the allowed PVUs.
URI /admin/resources/racks/<id>
Method PUT
Returns 200 The request to set the allowed PVUs was received. The ID of the queued job is included in the response.
400 The specified ID is not valid.
500 Platform System Manager encountered an internal error while processing the request.
Request body
{
      "allowed_pvu": 2240
}
allowed_pvu
The maximum number of PVUs for all compute nodes in the cloud groups.

Set the PVU enforcement mode

Sets the PVU enforcement mode for a rack that is identified by the rack ID.

Avoid trouble: Stop all virtual machines before you attempt to set the PVU enforcement mode.
URI /admin/resources/racks/<id>
Method PUT
Returns 200 The request to set the PVU enforcement mode was received. The ID of the queued job is included in the response.
400 The specified ID is not valid.
500 Platform System Manager encountered an internal error while processing the request.
Request body
{
      "pvu_enforcement_mode": "E"
}
pvu_enforcement_mode
The system behavior when compute nodes are added to a cloud group and they exceed the maximum number of PVUs available. Valid values are:
  • W (warn) - the default value.
  • I (ignore)
  • E (enforce)
Children: