ComputePoliciesCapabilitiesClusterScaleInIgnoreVmCapabilitiesCreateSpec

The CreateSpec structure contains information used to create a new policy to ignore virtual machine capabilities when scaling-in a cluster, see Policies.create. When considering scaling-in a cluster, policies that have been created with one of the listed CreateSpec.vm-capabilities are ignored for virtual machines that have the tag indicated by CreateSpec.vm-tag in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. 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.


array of string
vm_capabilities Required

When considering scaling-in a cluster, policies that have been created with one of these capabilities are ignored for virtual machines that have the tag indicated by CreateSpec.vm-tag. This set must contain at least one item. Currently, the only allowed capability identifier is com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion. In the future, other capabilities may be specified. 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 contain identifiers for the resource type: com.vmware.vcenter.compute.policies.Capability:VirtualMachine. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.compute.policies.Capability:VirtualMachine.


string
vm_tag Required

When considering scaling-in a cluster, policies that have been created with one of the listed CreateSpec.vm-capabilities are ignored for virtual machines that have this tag. 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_capabilities": [
        "string"
    ],
    "vm_tag": "string"
}
Feedback

Was this page helpful?