[{"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

Get VDC Compute Policy

Description

Get specified organization vDC compute policy

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/vdcComputePolicies/{vdcComputePolicyId}
Copy

Path Parameters

Path Parameters

string
vdcComputePolicyId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns VdcComputePolicy of type(s) application/json;version=36.3
{
	"compatibleVdcTypes": [
		"string"
	],
	"coresPerSocket": 0,
	"cpuCount": 0,
	"cpuLimit": 0,
	"cpuReservationGuarantee": 0,
	"cpuShares": 0,
	"cpuSpeed": 0,
	"description": "string",
	"extraConfigs": {
		"key": "string"
	},
	"id": "string",
	"isAutoGenerated": false,
	"isSizingOnly": false,
	"logicalVmGroupReferences": [
		{
			"id": "string",
			"name": "string"
		}
	],
	"memory": 0,
	"memoryLimit": 0,
	"memoryReservationGuarantee": 0,
	"memoryShares": 0,
	"name": "string",
	"namedVmGroups": [
		{
			"id": "string",
			"name": "string"
		}
	],
	"pvdcComputePolicy": {
		"id": "string",
		"name": "string"
	},
	"pvdcComputePolicyRef": {
		"id": "string",
		"name": "string"
	},
	"pvdcId": "string"
}
string
name Required

Display name.


array of string
compatibleVdcTypes Optional

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


integer as int32
cpuCount Optional

The maximum number of CPUs allowed for a VM. This is optional. When provided, VMs with this policy cannot have more than number of CPUs defined by this field.


integer as int64
cpuLimit Optional

The limit of CPU in MHz for the VM on which this policy is applied. -1 means unlimited. This is optional. If not provided, limit would be equal to the vCPUSpeed multiplied by numCPU.


number as double
cpuReservationGuarantee Optional

The factor of the configured CPU reserved for the VM on which this policy is applied.


integer as int32
cpuShares Optional

The number of CPU shares for the VM on which this policy is applied. This is optional. If not provided, Normal shares would be applied to the VM.


integer as int64
cpuSpeed Optional

The CPU speed in MHz of this VM. This is optional. When provided, VMs with this policy cannot have more than CPU speed defined by this field.


string
description Optional

map of string
extraConfigs Optional

Map of extra configs to be set on the VM with this policy.


string
id Optional

UUID for vDC compute policy. This is immutable.


boolean
isAutoGenerated Optional

This field cannot be updated and is a read-only field in the client. It defines if 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 EntityReference
logicalVmGroupReferences Optional

List of logical vm group references. This value is set at creation time and cannot be edited later.


integer as int64
memory Optional

The maximum memory in MB allowed for a VM. This is optional. When provided, VMs with this policy cannot have configured memory more than defined by this field.


integer as int64
memoryLimit Optional

The limit of memory in MB for the VM on which this policy is applied. -1 means unlimited. This is optional. If not provided, limit would be equal to the configured memory of the VM.


number as double
memoryReservationGuarantee Optional

The factor of the configured memory reserved for the VM on which this policy is applied.


integer as int32
memoryShares Optional

The number of memory shares for the VM on which this policy is applied. This is optional. If not provided, Normal shares would be applied to the VM.


integer as int32
coresPerSocket Optional

The cores per socket to be configured for the VM where this policy is applied.


array of EntityReference
namedVmGroups Optional

List of list of vmGroups grouped together in a meaningful manner. A group of vmGroups would consist of one functionally equal vmGroup picked from each cluster of the pvdc.


pvdcComputePolicy Optional

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


pvdcComputePolicyRef Optional

Deprecated in Api 32.0, this property will be removed in future release.


string
pvdcId Optional

URN for Provider VDC.

Errors

Errors

404

Not Found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/vdcComputePolicies/{vdcComputePolicyId}


[{"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
Feedback

Was this page helpful?