Esx Settings Repository Software copy

Esx Settings Repository Software copy

Create a draft based on an existing software specification in the repository. A new global draft is created if one doesn't exist already. The draft is populated with the details of the existing software specification. The draft will have the name and spec of the existing software specification. The user should modify these before validating and saving the draft. Validating or saving the draft will fail if the name and spec are not modified. Upon a successful commit of this draft a new software specification in the repository will be created and this draft will be deleted.

This operation was added in vSphere API 9.0.0.0.

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

  • Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
Request
URI
POST
https://{api_host}/api/esx/settings/repository/software/{softwareSpec}?action=copy
COPY
Path Parameters
string
softwareSpec
Required

Identifier of the software specification in the repository.

The parameter must be an identifier for the resource type: com.vmware.esx.settings.repository.software_spec.


Request Body

The spec to be used to create a draft based on existing software specfication in the repository.

Required
{
    "delete_existing_draft": false
}
boolean
delete_existing_draft
Optional

Deletes any existing draft by the user before creating a new draft, if deleteExistingDraft is set to TRUE.

This property was added in vSphere API 9.0.0.0.

If deleteExistingDraft is either unset of set to FALSE and there is already draft created by the user, an AlreadyExists exception is thrown.

Authentication
This operation uses the following authentication methods.
Responses
200

Identifier of the working copy of the software.

The response will be an identifier for the resource type: com.vmware.esx.settings.draft.

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

400

If there is already a draft created by this user.

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

401

If the caller is not 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 caller does not have the necessary 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 there is no software specification associated with softwareSpec in the repository.

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"

500

If there is an unknown internal error. The accompanying error message will give more details about the failure.

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.


503

If the service is not available.

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 '{}' https://{api_host}/api/esx/settings/repository/software/{softwareSpec}?action=copy