Developer Documentation
Set Clusters Software Drafts Software Base Image
Released in v7.0.0Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists. 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/{draft}/software/base-image
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource. |
| required |
|
string | Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft. |
Request Body
Request Body
Contains
SettingsBaseImageSpec
of type application/json
(required)
{
"version": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | version | string |
Version of the base-image |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : If there is some unknown internal error. The accompanying error message will give more details about the failure. | com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster or no draft associated with draft in the system. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
