REST API - export
  1. Operations
  2. esx
  3. settings
  4. clusters
  5. software

esx settings clusters software: export

Exports the desired software specification document and/or image. This API will not export the solution section of the desired software specification.

Request:

HTTP request

POST https://{server}/api/esx/settings/clusters/{cluster}/software

?action=export
{
    "export_software_spec" : true,
    "export_offline_bundle" : true,
    "export_iso_image" : true
}

Path Parameters

Name Type Description
Required
cluster string Identifier of the cluster.

Body Parameters:

Name Type Description
bold = required
- export_spec
-.export_software_spec boolean Whether to export software specification document.
-.export_iso_image boolean Whether to export ISO image.
-.export_offline_bundle boolean Whether to export offline bundle.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "SOFTWARE_SPEC" : "http://myurl.com"
}

Headers:

None

Type:

Name Type Description
bold = required
- object A map from export type to URL of the exported data for that type.Object with element values of type URI.
-.* URI

Errors:

HTTP Status Code Type Description
500 error If there is am unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no cluster associated with cluster in the system or if desired software document is not found.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.