Disaster recovery profiles REST API

Use this REST API to manage disaster recovery profiles.

Communication between a primary and backup Cloud Pak System environment is required for disaster recovery. This communication requires a bidirectional trust relationship. This trust relationship is created only when a disaster recovery profile is created using the console. Profiles created using any other method do not enable the required communication between the systems.

Create a new disaster recovery profile

URI /admin/resources/dr_infos
Method POST
Request body JSON  
Returns 201 Created.
400 Bad request. The input JSON was not valid.
403 Forbidden. The user is not allowed to perform the requested function.
500 Platform System Manager encountered an internal error while processing the request.

Creates a new disaster recovery profile. See Get a specific disaster recovery profile for the format of the response body and the description of the attributes.

Get all disaster recovery profiles

URI /admin/resources/dr_infos
Method GET
Request body JSON  
Returns 200 OK
500 Platform System Manager encountered an internal error while processing the request.

Gets all disaster recovery profiles. There is no request body on input. The response body is a list of disaster recovery profiles. For the content and description of the disaster recovery profiles returned, see Get a specific disaster recovery profile.

Get a specific disaster recovery profile

URI /admin/resources/dr_infos/{id}
Method GET
Request body JSON  
Returns 200 OK
404 The disaster recovery profile was not found.
500 Platform System Manager encountered an internal error while processing the request.

Gets an existing disaster recovery profile identified by {id}. There is no request body on input.

Response body

{
      "last_mgmt_data_repl_state": "successful",
      "last_sweep": null,
      "pharos_configuration": "configured",
      "query_storage": null,
      "storage_cumulative_state": "available",
      "name": "Rack34",
      "target_result": "done",
      "planned_failover": "no",
      "last_failover_time": 0,
      "state": "enabled",
      "label_key": "pure9200",
      "mgmt_data_repl_transaction_id": 842,
      "v7000s_consolidated": "true",
      "label_text": "Disaster Recovery Information",
      "events": [
      ],
      "id": "/admin/resources/dr_infos/428e90b3-399f-4114-8b81-1ad0e72aa5f5",
      "remote_wwpns": "[\n   \"50:05:07:68:02:10:E3:A4\",\n   \"50:05:07:68:02:20:E3:A4\",\n   \"50:05:07:68:02:30:E3:A4\",\n   \"50:05:07:68:02:40:E3:A4\",\n   \"50:05:07:68:02:10:E3:A5\",\n   \"50:05:07:68:02:20:E3:A5\",\n   \"50:05:07:68:02:30:E3:A5\",\n   \"50:05:07:68:02:40:E3:A5\"\n]",
      "is_remote_in_maint_mode": "F",
      "iwd_disk_replication_state_reason": "CWZIP9218I The disk replication state for Workload Management has changed from pending to available because a volume has completed copying.",
      "target_storage_state": null,
      "remote_storage_controller_id": "00000200A26185C0",
      "iwd_disk_replication_state": "available",
      "trust_user_id": "admin_dr",
      "allow_failover": "block",
      "storage_copy_bandwidth": 1000,
      "created_time_raw": 1369250599582,
      "trust_clientid": "f29f9fa6-8ee1-4f49-8e09-19702b10f264",
      "storage_connection_state_reason": "CWZIP9221I The storage controller connection state has changed to connected.",
      "last_mgmt_data_repl_sync_id": "0a93f9b7-8a00-4939-bbce-224510ac3930",
      "remote_mgmt_net_vlan_id": "1035",
      "rackid": null,
      "storage_connection_state": "connected",
      "last_mgmt_data_repl_error_time": 1369775946992,
      "updated_time_raw": 1369944436907,
      "last_state_reason": "CWZIP9240I Disaster recovery is enabled in backup role.",
      "last_mgmt_data_heartbeat": 1369944436905,
      "mgmt_data_repl_state_update_time": 1369919749750,
      "created_time": "Wed 22 May 2013 19:23:19.582 UTC",
      "partner_dr_infos_uuid": "a215449f-efa2-4883-b222-d2c097fceee2",
      "updated_time": "Thu 30 May 2013 20:07:16.907 UTC",
      "connection_type": "fiber",
      "remote_mgmt_data_repl_state": "available",
      "version": "1.1.0.0",
      "last_mgmt_data_repl_time": 1369944266178,
      "target_state": "enabled",
      "disable": "no",
      "mgmt_data_repl_state_reason": "CWZIP9264I The management data replication state has changed to available. Continuous replication of management data is functioning properly.",
      "target_partner_ip": "rk35.purescale.raleigh.ibm.com",
      "last_mgmt_data_repl_job_id": null,
      "partner_racks_uuid": "ad30bd73-9565-47f1-ba0c-9a9f69e00ad5",
      "role": "B",
      "mgmt_data_repl_state": "available",
      "is_local_in_maint_mode": "F",
      "description": "DR Profile",
      "partner_ip": "rk35.purescale.raleigh.ibm.com",
      "isas_rn": 1
   }
allow_failover
The indicator, on the backup system, of whether a planned failover is allowed.
connection_type
The type of connection used to replicate data between two racks. Valid values are fiber or IP.
created_time
The time at which the object is created.
description
The description of the disaster recovery profile.
disable
The indicator of whether the current state transition should disable the disaster recovery profile.
id
The unique ID of the object in the system.
is_local_in_maint_mode
The indicator of whether maintenance is being applied to this system. This is a read-only field.
is_remote_in_maint_mode
The indicator of whether maintenance is being applied to the partner system. This is a read-only field.
iwd_disk_replication_state
The storage replication state for workload management disks. This is a read-only field.
iwd_disk_replication_state_reason
The reason for the last change in the storage replication state for workload management disks. This is a read-only field.
label_key
The key for retrieving the label for the disaster recovery profile.
last_failover_time
The time when the last disaster recovery failover occurred. This is a read-only field.
last_mgmt_data_heartbeat
The time when a disaster recovery heartbeat was last sent from the primary system to the backup system. This is a read-only field.
last_mgmt_data_repl_error_time
The last time an error occurred replicating a resource to the backup system. This is a read-only field.
last_mgmt_data_repl_job_id
The ID of the last job that performed fixup for a resource that was replicated to the backup system. This is a read-only field.
last_mgmt_data_repl_state
The state (successful, pending, or failed) of the last resource that was replicated to the backup system. This is a read-only field.
last_mgmt_data_repl_sync_id
The unique ID of the last management data resource that the primary system attempted to replicate to the backup system. This is a read-only field.
last_mgmt_data_repl_time
The time when a management data resource was last successfully replicated to the backup system. This is a read-only field.
last_state_reason
The reason for the last disaster recovery profile state change. This is a read-only field.
last_sweep
The indicator of whether a last replication of management data is needed before a failover and the indicator of whether that replication has completed. This is a read-only field.
mgmt_data_repl_state
The state of the management data replication. This is a read-only field.
mgmt_data_repl_state_reason
The reason for the last management data replication state change. This is a read-only field.
mgmt_data_repl_state_update_time
The time when the last_mgmt_data_repl_state value was last updated. This is a read-only field.
mgmt_data_repl_transaction_id
The management data replication transaction ID. This is a read-only field.
name
The name of the disaster recovery profile.
partner_dr_infos_uuid
The unique ID of the corresponding disaster recovery profile on the partner system. This is a read-only field.
partner_ip
The peer management location of the disaster recovery profile.
partner_racks_uuid
The unique ID of the rack on the partner system. This is a read-only field.
pharos_configuration
The state of the configuration of the local SAN switch using the storage controller WWPNs of the partner system. This is a read-only field.
planned_failover
The indicator, on the backup system, of whether a failover is planned or unplanned.
query_storage
The indicator of whether the disk replication status should be updated.
rackid
This field is not used. This is a read-only field.
remote_mgmt_data_repl_state
The management data replication state of the partner system. This is a read-only field.
remote_storage_controller_id
The storage controller ID of the partner system.
remote_wwpns
The storage controller WWPNs of the partner system.
role
The disaster recovery role of this system.
state
The state of the disaster recovery profile.
storage_connection_state
The state of the connection between the storage controller on this system and the storage controller on the partner system. This is a read-only field.
storage_connection_state_reason
The reason for the last change in the state of the connection between the storage controller on this system and the storage controller on the partner system. This is a read-only field.
storage_copy_bandwidth
The maximum bandwidth, in MBps, to be used by the storage controller copy process.
storage_cumulative_state
The state of the copy process between the storage controller on this system and the storage controller on the partner system. This is a read-only field.
target_partner_ip
The target peer management location of the disaster recovery profile, used to update the peer management location.
target_result
The target result of the disaster recovery profile.
target_state
The target state of the disaster recovery profile.
target_storage_state
The target storage replication state.
trust_clientid
The client ID for use with the trust relationship.
trust_user_id
The user ID to be used to establish the trust relationship from this system to the partner system.
updated_time
The time at which the object was last updated.
v7000s_consolidated
The indicator of whether the local storage controllers are consolidated.

Update a specific disaster recovery profile

URI /admin/resources/dr_infos/{id}
Method PUT
Request body JSON  
Returns 202 Accepted.
400 Bad request. The input JSON was not valid.
403 Forbidden. The user is not allowed to perform the requested function.
500 Platform System Manager encountered an internal error while processing the request.

Updates an existing disaster recovery profile. See Get a specific disaster recovery profile for the format of the response body and the description of the attributes.

Delete a specific disaster recovery profile

URI /admin/resources/dr_infos/{id}
Method DELETE
Request body JSON  
  202 Accepted.
403 Forbidden. The user is not allowed to perform the requested function.
404 The disaster recovery profile was not found.
500 Platform System Manager encountered an internal error while processing the request.

Deletes an existing disaster recovery profile. There is no request body or response body.