PlannedFailoverSpec#

class PlannedFailoverSpec(should_ignore_warnings=False, should_live_migrate_v_ms=False, name=None, failover_directions=None, *args, **kwargs)#

Bases: BaseRecoveryPlanActionSpec

The planned failover recovery plan action is used to perform a planned failover on the recovery plan.

Parameters:
  • should_ignore_warnings – (should_ignore_warnings) Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing shouldIgnoreWarnings as true. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan. (Default False)

  • should_live_migrate_v_ms – (should_live_migrate_v_ms) Indicates whether to perform a live migration of virtual machines (VMs) during a PLANNED_FAILOVER operation. When not specified or specified as false, the migration is performed for all virtual machines (VMs) in offline mode. When specified as true, the migration is performed for all virtual machines (VMs) in a running state. (Default False)

property should_ignore_warnings#

Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing shouldIgnoreWarnings as true. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan.

Type:

bool

property should_live_migrate_v_ms#

Indicates whether to perform a live migration of virtual machines (VMs) during a PLANNED_FAILOVER operation. When not specified or specified as false, the migration is performed for all virtual machines (VMs) in offline mode. When specified as true, the migration is performed for all virtual machines (VMs) in a running state.

Type:

bool

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model