Esx Settings Clusters Software Drafts importSoftwareSpec

Imports the desired software specification as a new draft. If a desired document is missing, then this operation will create an empty draft except when the source type is of either Esx Settings Clusters Software Drafts SourceType.LATEST_RECOMMENDATION or Esx Settings Clusters Software Drafts SourceType.CURRENT_SERIES_RECOMMENDATION, then Vapi Std Errors NotFound error is reported. In addition, the exisiting draft will be overwritten when the source type is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION.

Warning: Using HTTP is not secure. Please use HTTPS URLs instead.

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 VcIntegrity.lifecycleSoftwareSpecification.Write.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Request

URI

POST

https://{api_host}/api/esx/settings/clusters/{cluster}/software/drafts?action=import-software-spec

COPY

Path Parameters

string

cluster

Required

Identifier of the cluster.

The parameter must be an identifier for the resource type: ClusterComputeResource.

Request Body

Specification to import desired software specification.

Esx Settings Clusters Software Drafts ImportSpec of type(s) application/json

Required

Show optional properties

{
    "source_type": "string"
}

{
    "source_type": "string",
    "location": "string",
    "file_id": "string",
    "software_spec": "string"
}

string

source_type

Required

Type of the source to import the desired software specification

For more information see: Esx Settings Clusters Software Drafts SourceType.

This property was added in vSphere API 7.0.0.0.

string As uri As uri

location

Optional

Location of the software specification file to be imported.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of source_type is Esx Settings Clusters Software Drafts SourceType.PULL.

string

file_id

Optional

File identifier returned by the file upload endpoint after file is uploaded.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of source_type is Esx Settings Clusters Software Drafts SourceType.PUSH.

string

software_spec

Optional

The JSON string representing the desired software specification.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of source_type is Esx Settings Clusters Software Drafts SourceType.JSON_STRING.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

200

Identifier of the software draft.

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

404

If there is no cluster associated with cluster in the system or if the source type of import specification is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION, and a recommendation does not exist for the cluster. It was either never generated or deleted due to changes in cluster state such as a new desired image spec being committed.

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 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 '{"source_type:"string"}' https://{api_host}/api/esx/settings/clusters/{cluster}/software/drafts?action=import-software-spec

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Esx Settings Operations

GET

Esx Settings Clusters Software Drafts list