Import Software Spec Clusters Software Drafts
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 LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION, then 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. 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
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/drafts?action=import-software-spec
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
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
SettingsClustersSoftwareDraftsImportSpec of mimetype application/json
Required
Specification to import desired software specification.
{
"source_type": "PULL"
}
source_type
Required
The Drafts.SourceType enumerated type defines possible values of sources to import software specification.
PULL : Content is pulled from the URL location. The URL scheme of the value in {@link #pullLocation) can be http, https or file.
PUSH : Content was previously uploaded using the file upload enpoint present on vCenter appliance. This endpoint is present at https://VCENTERFQDN:9087/vum-fileupload URL.
JSON_STRING : The string representing the content of the software specfication.
LATEST_RECOMMENDATION : Content is from recommended image specification based on latest base image version. Recommendations can be generated using {@link: com.vmware.esx.settings.clusters.software.Recommendations#generate}.
CURRENT_SERIES_RECOMMENDATION : Content is from recommended image specification based on latest base image patch or update of the current series. For example, a cluster’s current desired base image is 7.0. Recommendation engine will look into any recommendable image specification with 7.0 series base images available at depot manager and try to recommend the highest version within 7.0 series if possible. Let’s say in this example, depot manager has 7.0 patch a and 7.0 update 1 base images. Recommendation engine would first validate all possible images based on 7.0 update 1. If it finds a valid one, it will store the recommended content with that series. This enum value will point to that stored recommended image content. Recommendations can be generated using {@link: com.vmware.esx.settings.clusters.software.Recommendations#generate}.
SPECIFIED_BASE_IMAGE_RECOMMENDATION : Content is from recommended image specification based on a specified base image version. Recommendations can be generated using {@link: com.vmware.esx.settings.clusters.software.Recommendations#generate}.
Possible values are: PULL , PUSH , JSON_STRING , LATEST_RECOMMENDATION , CURRENT_SERIES_RECOMMENDATION
string
file_id
Optional
File identifier returned by the file upload endpoint after file is uploaded. This field is optional and it is only relevant when the value of Drafts.ImportSpec.source-type is PUSH.
string
location
Optional
Location of the software specification file to be imported. This field is optional and it is only relevant when the value of Drafts.ImportSpec.source-type is PULL.
string
software_spec
Optional
The JSON string representing the desired software specification. This field is optional and it is only relevant when the value of Drafts.ImportSpec.source-type is JSON_STRING.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
string
of type application/json
Identifier of the software draft. The result will be an identifier for the resource type: com.vmware.esx.settings.draft.
Errors
404
com.vmware.vapi.std.errors.not_found : 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.
500
com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.
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
$SettingsClustersSoftwareDraftsImportSpec = Initialize-SettingsClustersSoftwareDraftsImportSpec -SourceType "PULL"
Invoke-ImportSoftwareSpecClusterSoftwareDrafts -Cluster "MyCluster" -SettingsClustersSoftwareDraftsImportSpec $SettingsClustersSoftwareDraftsImportSpec
PowerCLI Client SDK All Parameters Example
$SettingsClustersSoftwareDraftsImportSpec = Initialize-SettingsClustersSoftwareDraftsImportSpec -SourceType "PULL" -Location "MyLocation" -FileId "MyFileId" -SoftwareSpec "MySoftwareSpec"
Invoke-ImportSoftwareSpecClusterSoftwareDrafts -Cluster "MyCluster" -SettingsClustersSoftwareDraftsImportSpec $SettingsClustersSoftwareDraftsImportSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"file_id":"string","location":"string","software_spec":"string","source_type":"PULL"}' https://{api_host}/api/esx/settings/clusters/{cluster}/software/drafts?action=import-software-spec
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: import_software_spec
Availability
Added in 7.0.0.0
