Update Plan Virtual Machine Recovery Settings

Update Plan Virtual Machine Recovery Settings

Update recovery settings for a protected virtual machine.

Request
URI
POST
https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/vms/{vm_id}/recovery-settings/actions/update
COPY
Path Parameters
string
pairing_id
Required

The ID of a pairing between this Site Recovery Manager server and remote one.

string
plan_id
Required

The ID of a recovery plan defined within current pairing.

string
vm_id
Required

The ID of a virtual machine.


Request Body

Spec describing VM recovery settings.

VmRecoverySettingsSpec of type(s) application/json
Required
{
    "ip_customization_type": "string",
    "nic_settings": [
        {
            "device_id": 0,
            "primary_ip_settings": {
                "ip_v4": {
                    "ip_address": "string",
                    "type": "string",
                    "default_gateway": "string",
                    "alternate_gateway": "string",
                    "subnet_mask": "255.255.255.0"
                },
                "ip_v6": {
                    "ip_address": "fdda:5cc1:23:4::1f",
                    "type": "string",
                    "default_gateway": "string",
                    "alternate_gateway": "string",
                    "subnet_prefix_length": 0
                },
                "dns": {
                    "type": "string",
                    "preferred_server": "string",
                    "alternate_server": "string",
                    "suffixes": [
                        {}
                    ]
                },
                "wins": {
                    "primary_server": "string",
                    "alternate_server": "string"
                }
            },
            "secondary_ip_settings": {
                "ip_v4": {
                    "ip_address": "string",
                    "type": "string",
                    "default_gateway": "string",
                    "alternate_gateway": "string",
                    "subnet_mask": "255.255.255.0"
                },
                "ip_v6": {
                    "ip_address": "fdda:5cc1:23:4::1f",
                    "type": "string",
                    "default_gateway": "string",
                    "alternate_gateway": "string",
                    "subnet_prefix_length": 0
                },
                "dns": {
                    "type": "string",
                    "preferred_server": "string",
                    "alternate_server": "string",
                    "suffixes": [
                        {}
                    ]
                },
                "wins": {
                    "primary_server": "string",
                    "alternate_server": "string"
                }
            }
        }
    ],
    "priority": "string",
    "startup_action": "string",
    "shutdown_action_settings": {
        "skip_shutdown_guest": false,
        "timeout_seconds": 0
    },
    "pre_power_on_steps": [
        {
            "name": "string",
            "content": "string",
            "callout_type": "string",
            "timeout_seconds": 0,
            "step_type": "string",
            "id": "string"
        }
    ],
    "post_power_on_steps": [
        {
            "name": "string",
            "content": "string",
            "callout_type": "string",
            "timeout_seconds": 0,
            "step_type": "string",
            "id": "string"
        }
    ],
    "startup_action_settings": {
        "power_on_vmtools_timeout_seconds": 0,
        "delay_before_power_on_steps_and_dependent_vms_seconds": 0
    },
    "dependent_vms": [
        {
            "id": "string",
            "name": "string",
            "template": false,
            "inside_vapp": false,
            "status": "string",
            "priority_group": "string",
            "protection_group_name": "string"
        }
    ]
}
string
ip_customization_type
Required

IP customization modes:

  • Auto (AUTO)
    • If the advanced setting 'recovery.useIpMapperAutomatically' is set to True - Site Recovery Manager evaluates the IP subnet mapping rules during recovery to customize the virtual machines.
    • If the advanced setting 'recovery.useIpMapperAutomatically' is set to False - Site Recovery Manager does not evaluate the IP subnet mapping rules during recovery.
  • Use IP customization rules if applicable (NETWORK_LEVEL)
    • Site Recovery Manager will evaluate the IP subnet mapping rules during recovery of the concrete VM regardless of the advanced setting value of recovery.useIpMapperAutomatically.
  • Manual IP customization (MANUAL)
    • Manually set up explicit recovery IP settings per VM.
  • No IP customization (NO_CUSTOMIZATION)
    • Do not change VM IP settings during recovery.

Possible values are : AUTO, NETWORK_MAPPING_LEVEL, MANUAL, NO_CUSTOMIZATION,
nic_settings
Optional

Contains the IP settings for all the virtual ethernet cards on the VM

string
priority
Required

Recovery priority group. Used to translate server priority values to client priorities. The recovery priority for this VM. P1 is the highest and P5 is the lowest priority.

Possible values are : P1, P2, P3, P4, P5,
string
startup_action
Required

Startup action after recovery:

  • DO_NOT_POWER_ON - The VM will not be powered on and post-power-on steps will not be executed as partof the recovery and test workflows. Note that the VM may still get powered onduring recovery as part of the IP customization workflow.
  • POWER_ON - The VM will be powered on and post-power-on steps will be executed as part of the recovery and test workflows.

Possible values are : POWER_ON, DO_NOT_POWER_ON,
shutdown_action_settings
Required

shutdown_action_settings

array of Callout
pre_power_on_steps
Optional

Contains all per VM steps that should be executed before the VM is powered on

array of Callout
post_power_on_steps
Optional

Contains all per VM steps that should be executed after the VM is powered on

startup_action_settings
Optional

startup_action_settings

dependent_vms
Optional

This is a list of VM identities that must be powered-on before this VM can be powered on. Dependencies are only valid within VMs of the same recovery priority. If there are dependent VMs that are not in the current plan and same recovery priority, they will be ignored. This list may contain VMs that are not contained by any protection group in the plan. But it will only contain valid VMs.

Authentication
This operation uses the following authentication methods.
Responses
202

Task to monitor the operation progress.

Returns TaskDrResponseEntity of type(s) application/json
This response body class contains all of the following: Task
{
    "id": "string",
    "description": "string",
    "description_id": "string",
    "entity": "string",
    "entity_name": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "progress": 0,
    "queued_time": 0,
    "start_time": 0,
    "complete_time": 0,
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
_meta
Optional

_meta


400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


Recovery Operations
POST
Cancel Recovery Plan
POST
Create Plan
POST
Create Recovery Plan Folder
POST
Create Recovery Steps Callout
DELETE
Delete Recovery Plan
DELETE
Delete Recovery Plan Folder
DELETE
Delete Recovery Step
POST
Dismiss Recovery Steps Recovery Plan Prompt
POST
Edit Recovery Steps Callout
GET
Get All Plan History Records
GET
Get All Recovery Plans
GET
Get Plan History Record
GET
Get Plan History Records
GET
Get Plan Related Protection Groups
GET
Get Plan Related Test Networks
GET
Get Plan Virtual Machine
GET
Get Plan Virtual Machine Dependent Vms
GET
Get Plan Virtual Machine Ip Customization
GET
Get Plan Virtual Machine Recovery Priority
GET
Get Plan Virtual Machine Recovery Settings
GET
Get Plan Virtual Machines
GET
Get Plan Virtual Machine Summarized Recovery Settings
GET
Get Recovery Plan
GET
Get Recovery Plan Folder
GET
Get Recovery Plan Folder Children
GET
Get Recovery Plan Folders
GET
Get Recovery Plan Issues
GET
Get Recovery Step
GET
Get Recovery Steps
GET
Get Recovery Steps Callout Details
GET
Get Recovery Steps User Prompt
GET
Get Recovery Steps User Prompts
POST
Move Recovery Plan Folder
POST
Plan Virtual Machine Check Dependent Vms
POST
Reconfigure Recovery Plan
POST
Rename Recovery Plan Folder
POST
Run Cleanup Test Recovery
POST
Run Recovery
POST
Run Reprotect
POST
Run Test Recovery
POST
Update Plan Virtual Machine Dependent Vms
POST
Update Plan Virtual Machine Ip Customization
PUT
Update Plan Virtual Machine Recovery Priority
POST
Update Plan Virtual Machine Recovery Settings