Oracle Cloud Infrastructure Documentation

Customizing the Steps in a Disaster Recovery Plan

Customizing the plan steps is the most convenient way to change a Private Cloud Appliance disaster recovery (DR) plan with default configuration. The administrator can enable or disable steps, configure steps to run in check-only mode, insert steps, and remove steps.

Note

Custom steps and custom commands are not available in appliance software version 3.0.2-b1261765.

Changing the Properties of a DR Plan Step

You can enable or disable an existing DR plan step, and decide whether it should be performed in check-only mode.

Using the Service CLI

  1. Look up the ID of the DR plan step you want to change (show DrPlan). If you don't have the DR plan ID, look it up using the commands drGetConfigs and drListPlan.

  2. Change the DR plan step with the edit DrPlanStep command. These are the properties you can change in order to affect how a DR plan is executed:

    • enabled=[True|False] – determines whether this step is performed or not

    • checkOnly=[True|False] – determines whether this step is performed in check-only mode

    • command=[string] – (NOT available) specifies a custom command to be run as part of this step

      For standard DR plan operations, the command parameter must be set to None.

    PCA-ADMIN> edit DrPlanStep id=6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::precheck checkOnly=False
JobId: d281141c-c388-490e-b038-239598488bc6
Data: DrPlanStep id: 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::precheck. Successfully started job for DR Plan Step update for config_id 6e797d8b-7245-4d49-8e68-bf67f2d53041

  3. Use the job ID to check the status of the operation you started.

    PCA-ADMIN> show Job id=d281141c-c388-490e-b038-239598488bc6
Data:
  Id = d281141c-c388-490e-b038-239598488bc6
  Type = Job
  Associated Work Request Id = 8f40d0a3-b2ac-4742-bed8-70beb26d669d
  Done = true
  Name = MODIFY_TYPE
  Progress Message = DrPlanStep id: 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::precheck. Successfully updated plan step [precheck] in DR Plan [sw1] for config [6e797d8b-7245-4d49-8e68-bf67f2d53041]
  Transcript = Created job MODIFY_TYPE
  Username = admin
  WorkItemIds 1 = id:92a94a5e-4773-4ba8-ac4b-990496c5c2f9  type:WorkItem  name:

  4. To display the status and updated details of a DR plan step, use the show DrPlanStep command.

    PCA-ADMIN> show DrPlanStep id=6e797d8b-7245-4d49-8e68-bf67f2d53041::fo1::precheck
Data:
  Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::fo1::precheck
  Type = DrPlanStep
  Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::fo1::precheck
  Step Name = PRECHECK
  Config Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041
  Plan Name = fo1
  Enabled = true
  Last Status = norun
  Command = None
  Check Only = false
Using the Service Web UI

  1. Under Disaster Recovery Service, open the DR Configurations page. In the table, click the configuration for which you want to modify a DR plan. The DR Configuration detail page appears.

  2. In the Resources section, click Plans. Click the name of the plan for which you want to edit the steps. The DR Plan detail page appears. The Resources section displays all steps in the plan.

  3. In the Actions column, open the quick menu (3 dots) for the step you want to change, and click Edit.

  4. In the Update DR Plan Step window, edit the properties as needed:

    • Step Name: Do not change the selected step.

    • Enabled: Select Yes or No to determine whether this step is performed or not during plan execution.

    • Insert Type: Do not change. This field is used only for adding a new step.

    • Insert Location: Do not change. This field is used only for adding a new step.

    • Command: (NOT available.) Specify a custom command to be run as part of this step.

      For standard DR plan operations, this field must remain empty. Custom commands only apply to custom DR plan steps.

    • Check Only: Select Yes or No to determine whether this step is performed or not in check-only mode.

  5. Click Update DR Plan Step to apply your changes.

Inserting a DR Plan Step

Extra steps can be added to a DR plan.

Using the Service CLI

  1. Gather the information that you need to run the command:

    • DR configuration ID (drGetConfigs)

    • DR plan name (drListPlan)

    • name of the step before or after which the new step must be inserted (show DrPlan)

  2. Add a step to the DR plan with the create DrPlanStep command.

    Note the mandatory and optional parameters. If the insertType and insertLocation parameters are not provided, the new step is added as the final step of the DR plan.

    Syntax (entered on a single line):

    create DrPlanStep
drConfigId=<DR_configuration_id> 
planName=<DR_plan_name>
stepName=<DR_plan_new_step_name>
[optional:]
insertType=[BEFORE|AFTER]
insertLocation=<DR_plan_existing_step_name>
enabled=[True|False]
checkOnly=[True|False]
command=<execution_path>
    Note

    Custom steps and custom commands are not available in appliance software version 3.0.2-b1261765.

    • Do not use the command parameter.

    • Select a step name from this list: precheck, role_reversal_precheck, stop_primary, role_reversal, start_standby, cleanup_primary, post_config.

    Example:

    PCA-ADMIN> create DrPlanStep drConfigId=6e797d8b-7245-4d49-8e68-bf67f2d53041 planName=sw1 stepName=ROLE_REVERSAL insertType=BEFORE insertLocation=START_STANDBY
JobId: 7a162b6c-1ddc-410c-b27a-0996fb2d26df
Data: DrPlanStep id: 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::role_reversal. Successfully started job for DR Plan Step Create for config_id 6e797d8b-7245-4d49-8e68-bf67f2d53041

  3. Use the job ID to check the status of the operation you started.

    PCA-ADMIN> show Job id=7a162b6c-1ddc-410c-b27a-0996fb2d26df
Data:
  Id = 7a162b6c-1ddc-410c-b27a-0996fb2d26df
  Type = Job
  Associated Work Request Id = a4c76ef9-f91d-402e-986f-9795738fb429
  Done = true
  Name = CREATE_TYPE
  Progress Message = Successfully added step [role_reversal] in plan [sw1] for config [6e797d8b-7245-4d49-8e68-bf67f2d53041]
  Run State = Succeeded
  Transcript = Created job CREATE_TYPE
  Username = admin
  WorkItemIds 1 = id:5c376fae-f281-4f7a-984f-b996b19d367d  type:WorkItem  name:

  4. Repeat the create DrPlanStep command to add all the required steps to the DR plan.

  5. To display the status and updated details of a DR plan, use the show DrPlan command.

    PCA-ADMIN> show DrPlan id=6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1
Data:
  Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1
  Type = DrPlan
  Plan Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1
  Plan Name = sw1
  Config Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041
  Operation = switchover
  Steps 1 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::precheck
  Steps 1 - Step Name = PRECHECK
  Steps 1 - Enabled = true
  Steps 1 - Last Status = norun
  Steps 1 - Command = None
  Steps 1 - Check Only = true
  Steps 2 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::role_reversal_precheck
  Steps 2 - Step Name = ROLE_REVERSAL_PRECHECK
  Steps 2 - Enabled = true
  Steps 2 - Last Status = norun
  Steps 2 - Command = None
  Steps 2 - Check Only = true
  Steps 3 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::stop_primary
  Steps 3 - Step Name = STOP_PRIMARY
  Steps 3 - Enabled = true
  Steps 3 - Last Status = norun
  Steps 3 - Command = None
  Steps 3 - Check Only = false
  Steps 4 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::role_reversal
  Steps 4 - Step Name = ROLE_REVERSAL
  Steps 4 - Enabled = true
  Steps 4 - Last Status = norun
  Steps 4 - Command = None
  Steps 4 - Check Only = false
  Steps 5 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::start_standby
  Steps 5 - Step Name = START_STANDBY
  Steps 5 - Enabled = true
  Steps 5 - Last Status = norun
  Steps 5 - Command = None
  Steps 5 - Check Only = false
  Steps 6 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::cleanup_primary
  Steps 6 - Step Name = CLEANUP_PRIMARY
  Steps 6 - Enabled = true
  Steps 6 - Last Status = norun
  Steps 6 - Command = None
  Steps 6 - Check Only = false
  Steps 7 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::post_config
  Steps 7 - Step Name = POST_CONFIG
  Steps 7 - Enabled = true
  Steps 7 - Last Status = norun
  Steps 7 - Command = None
  Steps 7 - Check Only = false
Using the Service Web UI

  1. Under Disaster Recovery Service, open the DR Configurations page. In the table, click the configuration for which you want to modify a DR plan. The DR Configuration detail page appears.

  2. In the Resources section, click Plans. Click the name of the plan to which you want to add one or more steps. The DR Plan detail page appears. The Resources section displays all steps in the plan.

  3. In the Resources section of the DR Plan detail page, on the right hand side of the Steps box, click Add Step.

  4. In the Add DR Plan Step window, enter the following information in the respective fields:

    • Step Name: Select a standard step from the list.

    • Enabled: Select Yes or No to determine whether this step is performed or not during plan execution.

    • Insert Type: Select Before or After the insert location.

    • Insert Location: Select the existing step before or after which you want the new step to be inserted.

    • Command: (NOT available.) Specify a custom command to be run as part of this step.

      For standard DR plan operations, this field must remain empty.

    • Check Only: Select Yes or No to determine whether this step is performed or not in check-only mode.

  5. Click Add DR Plan Step to insert this new step in the selected location.

  6. Repeat until all the required DR plan steps have been added.

Deleting a DR Plan Step

Steps can be removed from a DR plan.

Using the Service CLI

  1. Look up the ID of the DR plan step you want to delete (show DrPlan). If you don't have the DR plan ID, look it up using the commands drGetConfigs and drListPlan.

  2. Delete the DR plan step with the delete DrPlanStep command.

    PCA-ADMIN> delete DrPlanStep id=6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::precheck
JobId: c75a4c71-0525-40b7-9618-c2a4e8fcb051
Data: DrPlanStep id: 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::precheck. Successfully started job for DR Plan Step delete for config_id 6e797d8b-7245-4d49-8e68-bf67f2d53041

  3. Use the job ID to check the status of the operation you started.

    PCA-ADMIN> show Job id=c75a4c71-0525-40b7-9618-c2a4e8fcb051
Data:
  Id = c75a4c71-0525-40b7-9618-c2a4e8fcb051
  Type = Job
  Associated Work Request Id = d7bd3873-e5a0-4437-b6c2-8ca0cce83953
  Done = true
  Name = DELETE_TYPE
  Progress Message = DrPlanStep id: 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::precheck. Successfully deleted step [precheck] in plan [sw1] for config [6e797d8b-7245-4d49-8e68-bf67f2d53041]
  Run State = Succeeded
  Transcript = Created job DELETE_TYPE
  Username = admin
  WorkItemIds 1 = id:b462883b-6e6e-49b6-b455-1ceb54a5e2e3  type:WorkItem  name:

  4. Repeat the delete DrPlanStep command to remove all the required steps from the DR plan.

  5. To display the status and updated details of a DR plan, use the show DrPlan command.

    PCA-ADMIN> show DrPlan id=6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1
Data:
  Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1
  Type = DrPlan
  Plan Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1
  Plan Name = sw1
  Config Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041
  Operation = switchover
  Steps 1 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::stop_primary
  Steps 1 - Step Name = STOP_PRIMARY
  Steps 1 - Enabled = true
  Steps 1 - Last Status = norun
  Steps 1 - Command = None
  Steps 1 - Check Only = false
  Steps 2 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::role_reversal
  Steps 2 - Step Name = ROLE_REVERSAL
  Steps 2 - Enabled = true
  Steps 2 - Last Status = norun
  Steps 2 - Command = None
  Steps 2 - Check Only = false
  Steps 3 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::start_standby
  Steps 3 - Step Name = START_STANDBY
  Steps 3 - Enabled = true
  Steps 3 - Last Status = norun
  Steps 3 - Command = None
  Steps 3 - Check Only = false
  Steps 4 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::cleanup_primary
  Steps 4 - Step Name = CLEANUP_PRIMARY
  Steps 4 - Enabled = true
  Steps 4 - Last Status = norun
  Steps 4 - Command = None
  Steps 4 - Check Only = false
  Steps 5 - Step Id = 6e797d8b-7245-4d49-8e68-bf67f2d53041::sw1::post_config
  Steps 5 - Step Name = POST_CONFIG
  Steps 5 - Enabled = true
  Steps 5 - Last Status = norun
  Steps 5 - Command = None
  Steps 5 - Check Only = false
Using the Service Web UI

  1. Under Disaster Recovery Service, open the DR Configurations page. In the table, click the configuration for which you want to modify a DR plan. The DR Configuration detail page appears.

  2. In the Resources section, click Plans. Click the name of the plan for which you want to edit the steps. The DR Plan detail page appears. The Resources section displays all steps in the plan.

  3. In the Actions column, open the quick menu (3 dots) for the step you want to remove, and click Delete.

    When prompted, click Confirm.

  4. Repeat until all obsolete DR plan steps have been removed.