com.vmware.vcenter.compute.policies.capabilities.vm.evacuation package

Submodules

com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.best_effort_restart_client module

class com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.best_effort_restart_client.CreateSpec(vm_tag=None, capability='com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.best_effort_restart', name=None, description=None)

Bases: VapiStruct

The CreateSpec class contains information used to create a new policy that applies to virtual machines when their host is entering maintenance mode and that will cause these virtual machines to enter a powered-off state; after which these virtual machines will be powered-on as soon as possible, see com.vmware.vcenter.compute_client.Policies.create(). All virtual machines that are running on a host that is entering maintenance-mode and that have the tag indicated by CreateSpec.vm_tag will go through a guest shut-down. If guest shut-down is unavailable or doesn’t complete in time, then the VM is powered-off. Virtual machines that are in a powered-off state because of this policy will be attempted to be powered-on every few minutes. The host on which the VM will be powered-on can be different than the host where the VM was initially running. This class was added in vSphere API 8.0.3.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. All virtual machines that have the tag indicated by CreateSpec.vm_tag will go through a guest shut-down if their host is entering maintenance-mode. If guest shut-down is unavailable or doesn’t complete in time, then the VM is powered-off. Virtual machines that are in a powered-off state because of this policy will be attempted to be powered-on every few minutes. The host on which the VM will be powered-on can be different than the host where the VM was initially running. This attribute was added in vSphere API 8.0.3.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine.
capability (str) – Identifier of the capability this policy is based on. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.
name (str) – Name of the policy. The name needs to be unique within this vCenter server.
description (str) – Description of the policy.

property capability: Return the discriminator value

class com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.best_effort_restart_client.Info(vm_tag=None, name=None, description=None, capability='com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.best_effort_restart')

Bases: VapiStruct

The Info class contains information about a policy that applies to virtual machines when their host is entering maintenance mode and that will cause these virtual machines to enter a powered-off state; after which these virtual machines will be powered-on as soon as possible, see com.vmware.vcenter.compute_client.Policies.create(). All virtual machines that are running on a host that is entering maintenance-mode and that have the tag indicated by Info.vm_tag will go through a guest shut-down. If guest shut-down is unavailable or doesn’t complete in time, then the VM is powered-off. Virtual machines that are in a powered-off state because of this policy will be attempted to be powered-on every few minutes. The host on which the VM will be powered-on can be different than the host where the VM was initially running. This class was added in vSphere API 8.0.3.0.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. All virtual machines that have the tag indicated by Info.vm_tag will go through a guest shut-down if their host is entering maintenance-mode. If guest shut-down is unavailable or doesn’t complete in time, then the VM is powered-off. Virtual machines that are in a powered-off state because of this policy will be attempted to be powered-on every few minutes. The host on which the VM will be powered-on can be different than the host where the VM was initially running. This attribute was added in vSphere API 8.0.3.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine.
name (str) – Name of the policy.
description (str) – Description of the policy.
capability (str) – Identifier of the capability this policy is based on. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.

property capability: Return the discriminator value

class com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.best_effort_restart_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client module

class com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.CreateSpec(vm_tag=None, capability='com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion', name=None, description=None)

Bases: VapiStruct

The CreateSpec class contains information used to create a new vMotion policy that applies when a host is evacuated, see com.vmware.vcenter.compute_client.Policies.create(), in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. All virtual machines that share the tag indicated by CreateSpec.vm_tag will be vMotioned from a host whenever the host is evacuated by vCenter. If vCenter cannot migrate a virtual machine, then it will remain running on its current host. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. Virtual machines with this tag will be vMotioned from a host if vCenter requires to evacuate the host. If vMotion is not feasible, then the virtual machine will remain running on its current host. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine.
capability (str) – Identifier of the capability this policy is based on. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.
name (str) – Name of the policy. The name needs to be unique within this vCenter server.
description (str) – Description of the policy.

property capability: Return the discriminator value

class com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.Info(vm_tag=None, name=None, description=None, capability='com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion')

Bases: VapiStruct

The Info class contains information about a vMotion policy that applies when a host is evacuated, see com.vmware.vcenter.compute_client.Policies.get(), in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. All virtual machines that share the tag indicated by Info.vm_tag will be vMotioned from a host whenever the host is evacuated by vCenter. If vCenter cannot migrate a virtual machine, then it will remain running on its current host. Warning: This class is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

vm_tag (str) – Identifier of a tag that can be associated with a virtual machine. Virtual machines with this tag will be vMotioned from a host if vCenter requires to evacuate the host. If vMotion is not feasible, then the virtual machine will remain running on its current host. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine.
name (str) – Name of the policy.
description (str) – Description of the policy.
capability (str) – Identifier of the capability this policy is based on. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.

property capability: Return the discriminator value

class com.vmware.vcenter.compute.policies.capabilities.vm.evacuation.vmotion_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance