SetRecoverySettings

Updates the virtual machines’ Recovery Settings. This method updates the specified virtual machine's Recovery Settings with values contained in the supplied Recovery Settings object. This class modifies the recovery settings available to the external API, VmIpCustomization. The VmIpCustomization API allows user to configure the IP address and corresponding DNS, WINS of the virtual machine, after the migration is complete. You can disable IP customization by setting VmIpCustomization to nullptr or by not setting IpCustomizationSpecMapping within VmIpCustomization.

Synopsis

void setRecoverySettings(vim.VirtualMachine vm, RecoverySettings settings)

vm is the Virtual Machine which Recovery Settings are to be updated.

settings is the Recovery Settings to update the VM.

RecoverySettings – the VM recovery settings for presentation in the user interface, including:
  • changeVersion – change version control.
  • status – recovery status.
  • recoveryPriority – the recovery priority for this VM.
  • skipGuestShutdown –configure the shutdown behavior for this workload during real failover to not attempt a guest shutdown, even if VMware Tools are enabled.
  • powerOffTimeoutSeconds – configure the timeout for guest shutdown operations for this VM.
  • finalPowerState – final power state for this VM after recovery.
  • localFaultToleranceState – configure FT override setting for this VM when it will be failed back.
  • remoteFaultToleranceState – configure an FT override setting for this VM after recovery.
  • powerOnTimeoutSeconds – configure the timeout for VMware Tools to respond with a heartbeat.
  • powerOnDelaySeconds – configure the fixed time delay after power‐on operations for this workload.
  • prePowerOnCallouts – before power‐on Callouts (commands or prompts).
  • VmIpCustomization – allows user to configure the IP address and corresponding DNS, WINS of the virtual machine, after the migration is complete.
VmIpCustomization contains the following data required for performing IP customization for a virtual machine, when recovering it to a given SRM site:
  • IpAddressInfo - IP address definitions.
  • IpV4AddressInfo - IPv4 address definitions.
  • IpV6AddressInfo - Ipv6 address definitions.
  • IpV4AddressSpec - IPv4 address specification. Contains either static or DHCP configuration.
  • @optional IpV4AddressInfo staticAddressInfo - If this optional field is set, then this spec denotes a static IPv4 address configuration. Otherwise, an unset field denotes a DHCPv4 configuration.
  • IpV6AddressSpec - IPv6 address specification. Contains either static or DHCP configuration.
  • @optional IpV6AddressInfo staticAddressInfo - If this optional field is set, then this spec denotes a static IPv6 address configuration. Otherwise, an unset field denotes a DHCPv6 configuration.
  • enum NetBiosMode - Used to configure NetBIOS on Windows systems. The values correspond directly to Microsoft constants for NetBIOS mode.
  • NicCustomizationSpec - Contains IP customization info for a specific network adapter.
  • WindowsNicCustomizationSpec - Contains Windows specific IP customization info for a specific network adapter for a virtual machine.

Faults

  • postPowerOnCallouts – after power‐on Callouts.
  • RuntimeFault
  • DependencyConflict
  • InvalidArgument
  • RecoveryPlanLocked
  • RecoveryPlanNotFound
  • VersionConflict
  • VmNotFoundInRecoveryPlan

See Faults in Site Recovery Manager for more details.