[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

VmCriteriaRule

A criteria rule that contains specific attributes that a VM can match with.


Properties

string
attributeType Required

The attribute type of a VM used for VM matching. Below are supported types:

  • VM_TAG - Match the VM based on the tags associated with that VM.
  • VM_NAME - Match the VM based on the name of the VM. Only CONTAINS and STARTS_WITH operators are supported for this type.


string
attributeValue Required

The attribute value that is used to determine if a VM’s attribute value matches the rule. Example: if the attribute type is VM_NAME, user should set this value to the name of the VM to match with.


string
operator Required

The operator to perform to determine whether the rule’s attribute value matches a VM’s attribute value. Example: if the attribute type is VM_NAME, user can set this operator to determine whether a VM’s name must be an exact match or starts with that name. Below are supported types:

  • EQUALS - Match occurs if the VM's attribute value is exactly the same as the rule's attribute value.
  • CONTAINS - Match occurs if the VM's attribute value is contains the rule's attribute value.
  • STARTS_WITH - Match occurs if the VM's attribute value starts with the rule's attribute value.
  • ENDS_WITH - Match occurs if the VM's attribute value ends with the rule's attribute value.

JSON Example

{
	"attributeType": "string",
	"attributeValue": "string",
	"operator": "string"
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
    attributeType:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    attributeValue:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    operator:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 36.0
Property Of

VmCriteria

Feedback

Was this page helpful?