This API has a deprecated equivalent from v7.0U1.
Export Customization Specs
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. if you do not have all of the privileges described as follows: - Operation execution requires VirtualMachine.Provisioning.ReadCustSpecs.
Request
URLURL
https://{api_host}/api/vcenter/guest/customization-specs/{name}?action=export
Path Parameters
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.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
GuestCustomizationSpecsExportRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"format": "JSON"
}
format
Required
The CustomizationSpecs.Format enumerated type specifies the formats the customization specification can be exported to.
JSON : JSON format.
XML : XML format.
Possible values are: JSON , XML
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
string
of type application/json
The string representation of the customization specification in the specified format.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$GuestCustomizationSpecsExportRequestBody = Initialize-GuestCustomizationSpecsExportRequestBody -Format "JSON"
Invoke-ExportNameCustomizationSpecs -Name "MyName" -GuestCustomizationSpecsExportRequestBody $GuestCustomizationSpecsExportRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"format":"JSON"}' https://{api_host}/api/vcenter/guest/customization-specs/{name}?action=export
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/guest/customization-specs/{name}?action=export
x-vmw-doc-operation: export
Availability
Added in 7.0U2
