InfraPolicy

InfraPolicy
InfraPolicy

An infra policy object that defines vm to host and other types of affinities.

JSON Example undefined undefined 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "vcComputePolicyName": "string",
    "isMandatory": false,
    "policyRule": {
        "operator": "string",
        "rules": [
            "PolicyRule Object"
        ],
        "workloadPolicyRule": {
            "guestOsRule": {
                "operator": "string",
                "value": "string"
            },
            "guestOsFamilyRule": {
                "operator": "string",
                "value": "string"
            },
            "labelSelectorRules": [
                {
                    "operator": "string",
                    "ruleKey": "string",
                    "values": [
                        "string"
                    ]
                }
            ]
        }
    },
    "compatibleRegionZones": [
        {
            "region": {
                "name": "string",
                "id": "string"
            },
            "zones": [
                {
                    "name": "string",
                    "id": "string"
                }
            ]
        }
    ],
    "creationStatus": "string",
    "creationTime": "string",
    "syncedToVCenters": false
}
string
id
Optional

The URN of the infra policy.

string
name
Required

The name of the infra policy. Must adhere to Kubernetes naming standards (RFC 1123 DNS label format) - must be no longer than 63 characters, start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens.

string
description
Optional

The description of the infra policy.

string
vcComputePolicyName
Optional

The name of the vCenter compute policy to be used.

boolean
isMandatory
Optional

Indicates if the policy is mandatory.

PolicyRule
policyRule
Optional

A compute policy rule that defines the criteria against which the policy will be evaluated for a VM. A PolicyRule can contain either a workloadPolicyRule or a list of nested PolicyRules combined with a boolean operator. The nested rules in the 'rules' field are evaluated using the boolean operation specified in the 'operator' field. The workloadPolicyRule is always AND'd together with the results of the nested rules.

array of RegionZones
compatibleRegionZones
Optional
Constraints: maxItems: 128

The list of region-zone mappings that are compatible with this infra policy.

string
creationStatus
Optional

The creation status of the infra policy. Possible values are:

  • PENDING
  • SUCCESS
  • FAILED
string As date-time As date-time
creationTime
Optional

The ISO-8601 timestamp representing when this infra policy was created.

boolean
syncedToVCenters
Optional

Indicates whether this VCFA infra policy definition is in sync across all vCenters that participate in this policy. A vCenter participates if it has a matching vCenter compute policy name defined in the VCFA infra policy.

Parameter To
Returned By