[{"label":"Latest (v37.1)","version":"latest"},{"version":"v37.0"},{"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

VdcComputePolicy2

vDC compute policy that contains vDC specific configuration for workloads. (Version 2.0.0)

Properties

string

policyType Required

The discriminator type is used to differentiate among various sub policy types.

string

name Required

Display name.

string

description Optional

string

id Optional

UUID for vDC compute policy. This is immutable.

boolean

isAutoGenerated Optional

It is a read-only field. It indicates whether the policy is auto-generated.

boolean

isSizingOnly Optional

This field cannot be updated and is a read-only field in the client after creation. It defines whether the policy is SIZING_ONLY or if it also contains affinity information.

array of string

compatibleVdcTypes Optional

A list of read-only compatible vDC types for this policy.

EntityReference

pvdcComputePolicy Optional

This field cannot be updated and is a read-only field in the client after creation.

string

pvdcId Optional

URN for Provider vDC.

JSON Example

Show optional properties

{
    "name": "myPolicy",
    "policyType": "VdcKubernetesPolicy"
}

{
    "description": "This is an example payload to create a policy of type VdcKubernetesPolicy.\nFollow /1.0.0/vdcComputePolicies example to know payload to create a VdcVmPolicy type\nof compute policy. Note that policyType field will have to be added to the payload taken\nfrom /1.0.0/vdcComputePolicies example, if you are using /2.0.0/vdcComputePolicies.\n",
    "kubernetesConfig": {
        "namespaceResourceSpec": {
            "cpuLimit": 1000,
            "cpuReservationGuarantee": 1,
            "memoryLimit": 1024,
            "memoryReservationGuarantee": 1
        },
        "storageClasses": [
            {
                "limit": 20480,
                "storageClass": "gold"
            },
            {
                "limit": 10240,
                "storageClass": "silver"
            }
        ],
        "virtualMachineClasses": [
            "best-effort-xsmall",
            "best-effort-small"
        ]
    },
    "name": "myPolicy",
    "policyType": "VdcKubernetesPolicy",
    "pvdcComputePolicy": {
        "id": "urn:vcloud:pvdcComputePolicy:494f4a50-09ce-4ba7-913b-3fde593bc7ef",
        "name": "nameOfPvdcPolicy"
    },
    "vdc": {
        "id": "urn:vcloud:vdc:f8dfe02d-47e5-4e3c-ba71-f0d67810d0ef",
        "name": "vdc1"
    }
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:

x-vcloud-cross-references:
    - cross-reference:
        alias: publishableToVdc
        description: |
            A filter to look up compute policies that are available to publish to the VDC.
            Supported filters:
              publishableToVdc==urn:vcloud:vdc:${UUID}
        x-vcloud-added-in: "36.0"
    - cross-reference:
        alias: pvdc
        description: |
            A filter to look up vDC compute policies that refer to a global placement policy
            (PvdcComputePolicy) belonging to the given PVDC.
            Supported filters:
              pvdc==urn:vcloud:providervdc:${UUID}
        x-vcloud-added-in: "35.2"
    - cross-reference:
        alias: vgpuProfileName
        description: |
            A filter to return the vDC compute policies that refer to the given vgpuProfileName.
        referenced-property: name
        referenced-type: ./compute-policy/vgpu-profiles.yaml#/definitions/VgpuProfile
        x-vcloud-added-in: "36.2"
x-vcloud-property-annotations:
    pvdcComputePolicy:
        x-vcloud-added-in: "35.0"
        x-vcloud-restricted: |
            Restricted field, requires 'View Alternate Admin version of Compute Policies for an Organization vDC' right to access this field.

vmware-cloud-director

Availability

Added in 35.0

Property Of

InlineVdcComputePolicies21

Parameter To

Create VDC Compute Policy
Update VDC Compute Policy
Update VDC Max Compute Policy

Returned By

Create VDC Compute Policy
Get VDC Compute Policy
Update VDC Compute Policy
Get VDC Max Compute Policy
Update VDC Max Compute Policy

VdcComputePolicy2

Properties

JSON Example

Vendor Extensions

Availability

Property Of

Parameter To

Returned By

Was this page helpful?