Export Clusters Software
Exports the desired software specification document and/or image. This API will not export the solution section of the desired software specification. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software?action=export
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
SettingsClustersSoftwareExportSpec of mimetype application/json
Required
The Software.ExportSpec structure contains information describing how a software specification or image should be exported.
(The request body parameter is missing description)
{
"export_iso_image": false,
"export_offline_bundle": false,
"export_software_spec": false
}
boolean
export_iso_image
Required
Whether to export ISO image.
boolean
export_offline_bundle
Required
Whether to export offline bundle.
boolean
export_software_spec
Required
Whether to export software specification document.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
map of
string
formatted as uri
of type application/json
A map from export type to URL of the exported data for that type.
Errors
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system or if desired software document is not found.
500
com.vmware.vapi.std.errors.error : If there is am 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
$SettingsClustersSoftwareExportSpec = Initialize-SettingsClustersSoftwareExportSpec -ExportSoftwareSpec $false -ExportIsoImage $false -ExportOfflineBundle $false
Invoke-ExportClusterSoftware -Cluster "MyCluster" -SettingsClustersSoftwareExportSpec $SettingsClustersSoftwareExportSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"export_iso_image":false,"export_offline_bundle":false,"export_software_spec":false}' https://{api_host}/api/esx/settings/clusters/{cluster}/software?action=export
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: export
Availability
Added in 7.0.0.0
