Vcenter Guest CustomizationSpecs export

Returns the content of the customization specification in the specified format. Note that any passwords in the customization specification will be set to blank values during the export operation.

This operation was added in vSphere API 7.0.0.0.

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

Operation execution requires VirtualMachine.Provisioning.ReadCustSpecs.

Request

URI

POST

https://{api_host}/api/vcenter/guest/customization-specs/{name}?action=export

COPY

Path Parameters

string

name

Required

The name of the customization specification that has to be returned.

The parameter must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec.

Request Body

Request body for invoking operation: export

{
    "format": "string"
}

string

format

Required

The format in which the customization specification has to be returned.

For more information see: Vcenter Guest CustomizationSpecs Format.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

200

The string representation of the customization specification in the specified format.

Returns string of type(s) application/json

Operation doesn't return any data structure

400

If value of format is not valid.

Returns Vapi Std Errors InvalidArgument of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

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"

404

if the customization specification is not found.

Returns Vapi Std Errors NotFound of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotFound0

"Vapi Std Errors NotFound Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0

"Vapi Std Errors ServiceUnavailable Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"format:"string"}' https://{api_host}/api/vcenter/guest/customization-specs/{name}?action=export

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Vcenter Operations

GET

Vcenter Guest CustomizationSpecs list