# Data Object - SrmRecoverySettings

Parameter to
  SetRecoverySettings
Returned by
  GetRecoverySettings
See also
  SrmCallout, SrmVmIpCustomization
Since
  SRM API 3.0

## Data Object Description

Contains the common information associated with protected workloads that are in a recovery plan.

Properties

Name | Type | Description
--- | --- | ---
changeVersion* | xsd:long | Change version control. When reconfiguring an existing Protected workload this value must be set and must match the most recent value. For settings on newly added VMs, leave it unset.
dependentVmIds* | xsd:string[] | Dependent VMs. 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. VM identity is available through ProtectionGroup#ProtectedVm#drVmIdentity. Since SRM API 11.0
finalPowerState | vim.VirtualMachine.PowerState | Final power state for this VM after recovery. If "poweredOn", then the VM will be left powered on and the post-power-on steps will be executed as part of the failover and test workflows. If "poweredOff", then the VM will be left powered off and the post-power-on steps will not be executed as part of the failover and test workflows. Note that the VM may still be powered on during recovery as part of the IP customization workflow. All other values are not supported.
localFaultToleranceState | xsd:boolean | Configure an FT override setting for this VM when it will be failed back. During recovery, this value will be swapped with the remote state, and become the setting for the FT state if the VM is failed back or rolled back.
postPowerOnCallouts* | SrmCallout[] | Post-power on Callouts. This list of Callouts will be converted into jobs during recovery and executed after the machine has been powered on and the heartbeat timing criteria have been met. If the VM is not configured to be powered on during recovery, the post-power on steps will not be executed.
powerOffTimeoutSeconds* | xsd:int | Configure the timeout for guest shutdown operations for this VM. After guest shutdown, wait for the specified number of seconds before forcibly powering off the VM. This delay is intended to give the application hosted by the VM time to finish gracefully shutting down. This value is in seconds. If not set, then the application default value will be used.
powerOnDelaySeconds* | xsd:int | Configure the fixed time delay after power-on operations for this workload. Once VMware Tools responds with a heartbeat, subsequent steps of the recovery of the VM will be delayed for the specified amount of time. This delay is intended to give the application hosted by the VM time to finish its startup cycle. This value is in seconds. If not set, then the application default value will be used. If set to 0 (zero), no delay will be introduced.
powerOnTimeoutSeconds* | xsd:int | Configure the maximum timeout for VMware Tools to respond with a heartbeat. Recovery will continue once a heartbeat is heard, otherwise recovery of the workload will fail. This value is in seconds. If not set, then the application default value will be used. If set to 0 (zero), recovery will not wait for VMware Tools and will proceed immediately (use powerOnDelay to add a fixed time delay).
prePowerOnCallouts* | SrmCallout[] | Pre-power on Callouts. This list of Callouts will be converted into jobs during recovery and executed after the recovered virtual machine has been configured, but before it has been powered on. If the VM is not configured to be powered on during recovery, the pre-power on steps will still be executed.
recoveryPriority | xsd:string | The recovery priority, as defined in RecoveryPriority, for this VM.
remoteFaultToleranceState | xsd:boolean | Configure an FT override setting for this VM after recovery. If this value is true, then FT will be attempted to be enabled during recovery. This setting will affect host placement, and the VM will be placed on an FT-capable host if possible.
skipGuestShutdown | xsd:boolean | Configure the shutdown behavior for this workload during real failover to not attempt a guest shutdown, even if VMware Tools is enabled. If this value is false and VMware Tools is installed, then the workload will be issued a guest shutdown during failover. If this value is true or VMware Tools is not installed, then the workload will be directly powered off.
status | xsd:string | Recovery Status, as defined in Status. This is a status condition based on the recovery settings in this plan.
vmIpCustomizationData* | SrmVmIpCustomization | IP customization information. Since SRM API 7.0
Properties inherited from
None

*Need not be set