[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]

srm-rest-api

VmRecoverySettings

Recovery settings for a VM, defined in the context of a recovery plan

Properties

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

ShutdownActionSettings

shutdown_action_settings Required

Recovery settings related to power off of a VM.

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

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

boolean

allow_vmotion_migration Optional

Whether this VM to be migrated to the recovery site using vMotion during a planned failover workflow

array of NicSettings

nic_settings Optional

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

array of Callout

post_power_on_steps Optional

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

array of Callout

pre_power_on_steps Optional

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

integer as int64

change_version Optional

Change version control. When reconfiguring an existing Protected workload this value must be set, and match the most recent value. For settings on newly added VMs, leave it unset.

array of DependentVm

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.

StartupActionSettings

startup_action_settings Optional

Recovery settings related to power-on of a VM

string

vm_tools_status Optional

Status of VM tools on the VM

Possible values are: INSTALLING , UPGRADING , INSTALLED , NOT_INSTALLED

JSON Example

Show optional properties

{
	"ip_customization_type": "AUTO",
	"priority": "P1",
	"shutdown_action_settings": {
		"timeout_seconds": 0
	},
	"startup_action": "POWER_ON"
}

{
	"allow_vmotion_migration": false,
	"change_version": 0,
	"dependent_vms": [
		{
			"id": "string",
			"inside_vapp": false,
			"name": "string",
			"priority_group": "P1",
			"protection_group_name": "string",
			"status": "OK",
			"template": false
		}
	],
	"ip_customization_type": "AUTO",
	"nic_settings": [
		{
			"device_id": 0,
			"primary_ip_settings": {
				"dns": {
					"alternate_server": "string",
					"preferred_server": "string",
					"suffixes": [
						"string"
					],
					"type": "DHCP"
				},
				"ip_v4": {
					"alternate_gateway": "string",
					"default_gateway": "string",
					"ip_address": "string",
					"subnet_mask": "255.255.255.0",
					"type": "DHCP"
				},
				"ip_v6": {
					"alternate_gateway": "string",
					"default_gateway": "string",
					"ip_address": "fdda:5cc1:23:4::1f",
					"subnet_prefix_length": 0,
					"type": "DHCP"
				},
				"wins": {
					"alternate_server": "string",
					"primary_server": "string"
				}
			},
			"secondary_ip_settings": {
				"dns": {
					"alternate_server": "string",
					"preferred_server": "string",
					"suffixes": [
						"string"
					],
					"type": "DHCP"
				},
				"ip_v4": {
					"alternate_gateway": "string",
					"default_gateway": "string",
					"ip_address": "string",
					"subnet_mask": "255.255.255.0",
					"type": "DHCP"
				},
				"ip_v6": {
					"alternate_gateway": "string",
					"default_gateway": "string",
					"ip_address": "fdda:5cc1:23:4::1f",
					"subnet_prefix_length": 0,
					"type": "DHCP"
				},
				"wins": {
					"alternate_server": "string",
					"primary_server": "string"
				}
			}
		}
	],
	"post_power_on_steps": [
		{
			"callout_type": "PROMPT",
			"content": "string",
			"id": "string",
			"name": "string",
			"step_type": "PRE_POWER_ON",
			"timeout_seconds": 0
		}
	],
	"pre_power_on_steps": [
		{
			"callout_type": "PROMPT",
			"content": "string",
			"id": "string",
			"name": "string",
			"step_type": "PRE_POWER_ON",
			"timeout_seconds": 0
		}
	],
	"priority": "P1",
	"shutdown_action_settings": {
		"skip_shutdown_guest": false,
		"timeout_seconds": 0
	},
	"startup_action": "POWER_ON",
	"startup_action_settings": {
		"delay_before_power_on_steps_and_dependent_vms_seconds": 0,
		"power_on_vmtools_timeout_seconds": 0
	},
	"vm_tools_status": "INSTALLING"
}

[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]

srm-rest-api

Property Of

VmRecoverySettingsState

VmRecoverySettings

Properties

JSON Example

Property Of

Was this page helpful?