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

Create VDC Compute Policy

Description

Creates a new VDC compute policy. if PolicyType is VdcKubernetesPolicy, then the response is a 202 with task URL in location header. For VdcVmPolicy type, the response is 201 with created policy in response body.

Request

Request

URL

URL


post
https://{api_host}/cloudapi/2.0.0/vdcComputePolicies
Copy

Request Body

Request Body

VdcComputePolicy2 of type(s) application/json Required
{
    "name": "myPolicy",
    "policyType": "VdcKubernetesPolicy"
}
string
name Required

Display name.


string
policyType Required

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


boolean
hasSizingInfo Optional

This field cannot be updated and is a read-only field in the client after creation. It defines whether the policy has sizing details.


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.


string
description Optional

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.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns VdcComputePolicy2 of type(s) application/json;version=37.2
{
    "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"
    }
}
string
name Required

Display name.


string
policyType Required

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


boolean
hasSizingInfo Optional

This field cannot be updated and is a read-only field in the client after creation. It defines whether the policy has sizing details.


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.


string
description Optional

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.


202 Accepted

The request have been accepted and the task to monitor the request is in the Location header.

Errors

Errors

Error
400

Invalid configuration.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"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"}}' https://{api_host}/cloudapi/2.0.0/vdcComputePolicies


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

Was this page helpful?