IBM Power Virtual Server DR Automation® CLI version 0.0.1

Command options

--instance-id (string)

instance id of instance to provision. Required.

--api-key (string)

The new API key value that will replace the existing one. Required.

--accept-language (string)

The language requested for the return document.

Example

ibmcloud power-hadr pdr api-key update \
    --instance-id 123456d3-1122-3344-b67d-4389b44b7bf9 \
    --api-key adfadfdsafsdfdsf \
    --accept-language exampleString

Example output

{
  "description" : "Key is valid.",
  "status" : "Active"
}

Command options

--instance-id (string)

instance id of instance to provision. Required.

--time (string)

(deprecated - use from_time) A time in either ISO 8601 or unix epoch format.

--from-time (string)

A from query time in either ISO 8601 or unix epoch format.

--to-time (string)

A to query time in either ISO 8601 or unix epoch format.

--accept-language (string)

The language requested for the return document.

Example

ibmcloud power-hadr pdr event list \
    --instance-id 123456d3-1122-3344-b67d-4389b44b7bf9 \
    --time 2025-06-19T23:59:59Z \
    --from-time 2025-06-19T00:00:00Z \
    --to-time 2025-06-19T23:59:59Z \
    --accept-language exampleString

Example output

{
  "events" : [ {
    "action" : "create",
    "event_id" : "1cecfe43-43cd-4b1b-86be-30c2d3d2a25f",
    "level" : "info",
    "message" : "Service Instance '7222c899-a31a-4a0c-be03-75920d23cd16' has been created successfully.",
    "messageData" : {
      "InstanceID" : {
        "id" : "7222c899-a31a-4a0c-be03-75920d23cd16"
      }
    },
    "metadata" : { },
    "resource" : "ProvisionID",
    "time" : "2025-06-23T07:12:49.840Z",
    "timestamp" : "1750662769",
    "user" : {
      "user_id" : "admin"
    }
  }, {
    "action" : "create",
    "event_id" : "c49f0ced-2a78-48a6-929c-6b824555ddc6",
    "level" : "info",
    "message" : "Disaster recovery for Service Instance '7222c899-a31a-4a0c-be03-75920d23cd16' has been managed successfully.",
    "messageData" : {
      "InstanceID" : {
        "id" : "7222c899-a31a-4a0c-be03-75920d23cd16"
      }
    },
    "metadata" : { },
    "resource" : "managedr",
    "time" : "2025-06-23T07:14:53.871Z",
    "timestamp" : "1750662893",
    "user" : {
      "email" : "abcuser@ibm.com",
      "user_id" : "IBMid-695000ab7E"
    }
  } ]
}

Command options

--instance-id (string)

instance id of instance to provision. Required.

--event-id (string)

Event ID. Required.

--accept-language (string)

The language requested for the return document.

Example

ibmcloud power-hadr pdr event get \
    --instance-id 123456d3-1122-3344-b67d-4389b44b7bf9 \
    --event-id 00116b2a-9326-4024-839e-fb5364b76898 \
    --accept-language exampleString

Example output

{
  "action" : "create",
  "api_source" : "dr-automation-api",
  "event_id" : "1cecfe43-43cd-4b1b-86be-30c2d3d2a25f",
  "level" : "info",
  "message" : "Service Instance created successfully",
  "message_data" : {
    "InstanceID" : {
      "id" : "7222c899-a31a-4a0c-be03-75920d23cd16"
    },
    "request_id" : {
      "id" : "req-12345"
    }
  },
  "metadata" : { },
  "resource" : "ProvisionID",
  "time" : "2025-06-23T07:12:49.840Z",
  "timestamp" : "1750662769",
  "user" : {
    "user_email" : "example.user@ibm.com",
    "user_id" : "IBMid-123456"
  }
}

Command options

--instance-id (string)

instance id of instance to provision. Required.

--accept-language (string)

The language requested for the return document.

Example

ibmcloud power-hadr pdr grs-location-pairs \
    --instance-id 123456d3-1122-3344-b67d-4389b44b7bf9 \
    --accept-language exampleString

Command options

--instance-id (string)

instance id of instance to provision. Required.

--accept-language (string)

The language requested for the return document.

Example

ibmcloud power-hadr pdr locations \
    --instance-id 123456d3-1122-3344-b67d-4389b44b7bf9 \
    --accept-language exampleString

Example output

{
  "dr_locations" : [ {
    "id" : "loc-001",
    "name" : "us-south"
  }, {
    "id" : "loc-002",
    "name" : "eu-de"
  } ]
}

Command options

--instance-id (string)

instance id of instance to provision. Required.

--accept-language (string)

The language requested for the return document.

Example

ibmcloud power-hadr pdr managed-vms \
    --instance-id 123456d3-1122-3344-b67d-4389b44b7bf9 \
    --accept-language exampleString

Example output

{
  "managed_vm_list" : {
    "3f2e1a09-1234-4d56-7890-abcd1234ef56" : {
      "core" : "0.50",
      "dr_average_time" : "10",
      "dr_region" : "nyc02",
      "memory" : "4",
      "region" : "nyc01",
      "vm_name" : "example_vm",
      "workgroup_name" : "Example_Workgroup",
      "workspace_name" : "Example_Workspace"
    },
    "9b8a7c65-4321-0fed-cba9-87654321abcd" : {
      "core" : "1.00",
      "dr_average_time" : "5",
      "dr_region" : "sfo04",
      "memory" : "8",
      "region" : "sfo03",
      "vm_name" : "another_vm",
      "workgroup_name" : "Another_Workgroup",
      "workspace_name" : "Another_Workspace"
    }
  }
}

Command options

--instance-id (string)

instance id of instance to provision. Required.

--accept-language (string)

The language requested for the return document.

Example

ibmcloud power-hadr pdr summary \
    --instance-id 123456d3-1122-3344-b67d-4389b44b7bf9 \
    --accept-language exampleString

Example output

{
  "managed_vm_list" : [ {
    "id" : "vm-01-1234-5678-90ab",
    "name" : "test-aix-vm1"
  }, {
    "id" : "vm-02-2234-5678-90cd",
    "name" : "test-aix-vm2"
  } ],
  "orchestrator_details" : {
    "location_id" : "dal10",
    "mfa_enabled" : "false",
    "orch_ext_connectivity_status" : "Connected",
    "orch_standby_node_addition_status" : "Success",
    "orchestrator_cluster_message" : "Cluster operational",
    "orchestrator_config_status" : "Configured",
    "orchestrator_group_leader" : "primary0906",
    "orchestrator_location_type" : "off-premises",
    "orchestrator_name" : "primary0906",
    "orchestrator_status" : "Active",
    "orchestrator_workspace_name" : "vpcdr6-abc-power-workspace",
    "proxy_ip" : "10.0.0.5",
    "schematic_workspace_name" : "us-south.workspace.projects-service.3ae96a02",
    "schematic_workspace_status" : "Available",
    "ssh_key_name" : "mani_key",
    "standby_orchestrator_name" : "standby0906",
    "standby_orchestrator_status" : "Active",
    "standby_orchestrator_workspace_name" : "Test_workspace_frankfurt",
    "transit_gateway_name" : "dra-tg-01",
    "vpc_name" : "vpc-primary-us-south"
  },
  "service_details" : {
    "crn" : "crn:v1:staging:public:power-dr-automation:global:a/b68c234e719144b18598ae4a7b80c44c:03e32707-1234-zzsd-kkjh-4d790e863d5a09061::",
    "deployment_name" : "defect_testing6abc0906",
    "description" : "5/5: Primary orchestrator primary0906 is successfully deployed in 3m17s",
    "orchestrator_ha" : true,
    "primary_ip_address" : "10.51.0.123",
    "primary_orchestrator_dashboard_url" : "",
    "recovery_location" : "eu-de",
    "resource_group" : "default-rg",
    "standby_description" : "4/4: Standby orchestrator standby0906 is successfully deployed in 5m37s",
    "standby_ip_address" : "10.0.9.123",
    "standby_orchestrator_dashboard_url" : "",
    "standby_status" : "Active",
    "status" : "Active"
  }
}

Command options

--instance-id (string)

instance id of instance to provision. Required.

--primary-workspace-name (string)

The primary Power virtual server workspace name. Required.

--accept-language (string)

The language requested for the return document.

--standby-workspace-name (string)

The standby Power virtual server workspace name.

Example

ibmcloud power-hadr pdr machine-types \
    --instance-id 123456d3-1122-3344-b67d-4389b44b7bf9 \
    --primary-workspace-name Test-workspace-wdc06 \
    --accept-language exampleString \
    --standby-workspace-name Test-workspace-wdc07

Command options

--instance-id (string)

instance id of instance to provision. Required.

--location-id (string)

Location ID value. Required.

Example

ibmcloud power-hadr pdr powervs-workspaces \
    --instance-id 123456d3-1122-3344-b67d-4389b44b7bf9 \
    --location-id exampleString

Example output

{
  "dr_standby_workspaces" : [ {
    "details" : {
      "crn" : "crn:v1:bluemix:public:power-iaas:us-south:abc123:8aac93a4-f0cf-4b19-8d6d-9ba10883985d::"
    },
    "id" : "8aac93a4-f0cf-4b19-8d6d-9ba10883985d",
    "location" : {
      "region" : "us-south",
      "type" : "region",
      "url" : "https://us-south.power-iaas.cloud.ibm.com"
    },
    "name" : "ws-dallas-standby",
    "status" : "active"
  } ],
  "dr_workspaces" : [ {
    "details" : {
      "crn" : "crn:v1:bluemix:public:power-iaas:us-south:abc123:9a9688a8-57e1-40b5-8c7d-f07e0a1cb305::"
    },
    "id" : "9a9688a8-57e1-40b5-8c7d-f07e0a1cb305",
    "location" : {
      "region" : "us-south",
      "type" : "region",
      "url" : "https://us-south.power-iaas.cloud.ibm.com"
    },
    "name" : "ws-dallas-primary",
    "status" : "active"
  } ]
}

Command options

--instance-id (string)

instance id of instance to provision. Required.

--location-id (string)

The location or data center identifier where the service instance is deployed. Required.

--machine-type (string)

The machine type used for deploying orchestrator. Required.

--orchestrator-location-type (string)

The cloud location where your orchestator need to be created. Required.

--orchestrator-name (string)

The username used for the orchestrator. Required.

--orchestrator-password (string)

The password that you can use to access your orchestrator. Required.

--orchestrator-workspace-id (string)

The unique identifier orchestrator workspace. Required.

--api-key (string)

The api Key of the service instance for deploying the disaster recovery service.

--client-id (string)

The Client Id created for MFA authentication API.

--client-secret (string)

The client secret created for MFA authentication API.

--guid (string)

The global unique identifier of the service instance.

--orchestrator-ha (bool)

Indicates whether the orchestrator High Availability (HA) is enabled for the service instance.

--proxy-ip (string)

Proxy IP for the Communication between Orchestrator and Service broker.

--region-id (string)

The power virtual server region where the service instance is deployed.

--resource-instance (string)

The uniquie identifier of the associated IBM Cloud resource instance.

--secret (string)

The secret name or identifier used for retrieving credentials from secrets manager.

--secret-group (string)

The secret group name in IBM Cloud Secrets Manager containing sensitive data for the service instance.

--ssh-key-name (string)

The name of the SSH key used for deploying the orchestator.

--standby-machine-type (string)

The machine type used for deploying standby virtual machines.

--standby-orchestrator-name (string)

The username for the standby orchestrator management interface.

--standby-orchestrator-workspace-id (string)

The unique identifier of the standby orchestrator workspace.

--standby-tier (string)

The storage tier used for deploying standby orchestrator.

--tenant-name (string)

The tenant name for MFA authentication API.

--tier (string)

The storage tier used for deploying primary orchestrator.

--stand-by-redeploy (string)

Flag to indicate if standby should be redeployed (must be "true" or "false").

--accept-language (string)

The language requested for the return document.

--accepts-incomplete (bool)

A value of true indicates that both the IBM Cloud platform and the requesting client support asynchronous deprovisioning.

The default value is true.

Example

Example request for non-HA Deployment

ibmcloud power-hadr dr create --instance-id instance1 --orchestrator-name non-HA-deployment --orchestrator-password abcabc --orchestrator-workspace-id "workspace1-abc-19304" --orchestrator-location-type locationType --location-id dal13 --machine-type s922

ibmcloud power-hadr dr create --instance-id instance1 --orchestrator-name HA-Deployment --orchestrator-password abcabc --orchestrator-workspace-id "workspace1-abc-19304" --orchestrator-location-type locationType --location-id dal13 --machine-type machineType --standby-orchestrator-name standby --standby-orchestrator-workspace-id workspace-abc-wewe --standby-machine-type s922 --orchestrator-ha true

Example output

{
  "dashboard_url" : "https://power-dra.test.cloud.ibm.com/power-dra-ui?instance_id=crn:v1:bluemix:public:power-dr-automation:us-south:a/fe3c2ccd058e407c81e1dba2b5c0e0d6:e3d09875-bbf8-4d8a-b52c-abefb67a53c5::",
  "id" : "crn:v1:staging:public:power-dr-automation:global:a/a123456fb04ceebfb4a9fd38c22334455:123456d3-1122-3344-b67d-4389b44b7bf9::"
}

Command options

--instance-id (string)

instance id of instance to provision. Required.

--accept-language (string)

The language requested for the return document.

Example

ibmcloud power-hadr pdr last-operation \
    --instance-id 123456d3-1122-3344-b67d-4389b44b7bf9 \
    --accept-language exampleString

Example output

{
  "crn" : "crn:v1:staging:public:power-dr-automation:global:a/2c5d7270091f495795350e9adfa8399c:86e0c9a9-80f4-4fcf-88a0-07643de01bb8::",
  "deployment_name" : "dr-deployment-instance-1",
  "last_updated_orchestrator_deployment_time" : "2025-10-30T11:25:00Z",
  "last_updated_standby_orchestrator_deployment_time" : "2025-10-30T11:40:00Z",
  "mfa_enabled" : "false",
  "orch_ext_connectivity_status" : "Connected",
  "orch_standby_node_addtion_status" : "Completed",
  "orchestrator_cluster_message" : "Cluster healthy",
  "orchestrator_config_status" : "Configured",
  "orchestrator_ha" : true,
  "plan_name" : "standard",
  "primary_description" : "2/5: Creating primary orchestrator VM.",
  "primary_ip_address" : "192.168.1.10",
  "primary_orchestrator_status" : "orchestrator-VM-creation-in-progress",
  "recovery_location" : "us-east",
  "resource_group" : "Default",
  "standby_description" : "1/4: Service instance is downloading orchestrator image for standby VM creation.",
  "standby_ip_address" : "192.168.1.11",
  "standby_status" : "downloading-orchestrator-image",
  "status" : "Running"
}