Vcenter Compute Policies create

Vcenter Compute Policies create

Creates a new compute policy.

This operation was added in vSphere API 7.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires ComputePolicy.Manage.
Request
URI
POST
https://{api_host}/api/vcenter/compute/policies
COPY
Request Body

Specification for the new policy to be created. The new policy will be an instance of the capability that has the creation type (see Vcenter Compute Policies Capabilities Info.create_spec_type) equal to the type of the specified value (see spec).

The parameter must contain all the properties defined in Vcenter Compute Policies CreateSpec.

Vcenter Compute Policies CreateSpec of type(s) application/json
Required
{
    "capability": "string",
    "name": "string",
    "description": "string"
}
string
capability
Required

Identifier of the capability this policy is based on.

This property was added in vSphere API 7.0.3.0.

if missing or null, then the name of capability schema will be used to distinguish the policy type.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.compute.policies.Capability.

string
name
Required

Name of the policy. The name needs to be unique within this vCenter server.

This property was added in vSphere API 7.0.3.0.

string
description
Required

Description of the policy.

This property was added in vSphere API 7.0.3.0.

Authentication
This operation uses the following authentication methods.
Responses
201

The identifier of the newly created policy. Use this identifier to get or destroy the policy.

The response will be an identifier for the resource type: com.vmware.vcenter.compute.Policy.

Returns string of type(s) application/json
Operation doesn't return any data structure

400

Vapi Std Errors AlreadyExists if a policy with the same name is already present on this vCenter server.

Vapi Std Errors InvalidArgument if a parameter passed in the spec is invalid.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0
"Vapi Std Errors Unauthorized Object"

500

if more than 100 policies are created.

Returns Vapi Std Errors UnableToAllocateResource of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors UnableToAllocateResource0
"Vapi Std Errors UnableToAllocateResource Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"capability:"string","description:"string","name:"string"}' https://{api_host}/api/vcenter/compute/policies