ComputePoliciesCapabilitiesVmEvacuationVmotionCreateSpec

The CreateSpec structure contains information used to create a new vMotion policy that applies when a host is evacuated, see 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 structure 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.


Properties

string
capability Required

Identifier of the capability this policy is based on. 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. if unset, then the name of capability structure will be used to distinguish the policy type. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.


string
description Required

Description of the policy. 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.


string
name Required

Name of the policy. The name needs to be unique within this vCenter server. 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.


string
vm_tag Required

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 structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine.

JSON Example

{
    "capability": "string",
    "description": "string",
    "name": "string",
    "vm_tag": "string"
}
Feedback

Was this page helpful?