esx settings hosts software drafts: get
Returns the information about given software draft. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
GET https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| host | string | Identifier of the host. |
| draft | string | Identifier of the working copy of the document. |
Response:
HTTP Status Code: 200
Response Body Structure:
{
"metadata" : {
"owner" : "string",
"creation_time" : "2015-01-01T22:13:05.651Z",
"status" : "VALID"
},
"software" : {
"hardware_support" : {
"packages" : {
"obj-103" : {
"pkg" : "obj-103",
"version" : "string"
}
}
},
"components" : {
"obj-103" : {
"details" : {
"vendor" : "string",
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
}
},
"base_image" : {
"details" : {
"release_date" : "2015-01-01T22:13:05.651Z",
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
},
"solutions" : {
"obj-103" : {
"components" : [
{
"component" : "obj-103"
},
{
"component" : "obj-103"
}
],
"details" : {
"components" : [
{
"component" : "obj-103",
"display_version" : "string",
"vendor" : "string",
"display_name" : "string"
},
{
"component" : "obj-103",
"display_version" : "string",
"vendor" : "string",
"display_name" : "string"
}
],
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
}
},
"add_on" : {
"name" : "string",
"details" : {
"vendor" : "string",
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
}
}
}
"metadata" : {
"owner" : "string",
"creation_time" : "2015-01-01T22:13:05.651Z",
"status" : "VALID"
},
"software" : {
"hardware_support" : {
"packages" : {
"obj-103" : {
"pkg" : "obj-103",
"version" : "string"
}
}
},
"components" : {
"obj-103" : {
"details" : {
"vendor" : "string",
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
}
},
"base_image" : {
"details" : {
"release_date" : "2015-01-01T22:13:05.651Z",
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
},
"solutions" : {
"obj-103" : {
"components" : [
{
"component" : "obj-103"
},
{
"component" : "obj-103"
}
],
"details" : {
"components" : [
{
"component" : "obj-103",
"display_version" : "string",
"vendor" : "string",
"display_name" : "string"
},
{
"component" : "obj-103",
"display_version" : "string",
"vendor" : "string",
"display_name" : "string"
}
],
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
}
},
"add_on" : {
"name" : "string",
"details" : {
"vendor" : "string",
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
}
}
}
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | info | Information about the Software Draft. |
| -.metadata | metadata | Metadata about the software draft. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.metadata.owner | string | Owner of the software draft. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.metadata.status | string | Status of the software draft. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Defines possible values of status of a software draft. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: VALID: Software draft is valid. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. INVALID: Software draft is invalid. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.metadata.creation_time | date_time | Creation time of the software draft. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.software | software_info | Software specification associated with the draft. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.software.base_image | base_image_info | Base image of the ESX. |
| -.software.base_image.details | base_image_details | Details about the base-image. Optional. unset if base-image is not present in the depot. |
| -.software.base_image.details.display_name | string | Display name of the base-image. |
| -.software.base_image.details.display_version | string | Human readable version of the base-image. |
| -.software.base_image.details.release_date | date_time | Release date of the base-image. |
| -.software.base_image.version | string | Version of the base-image |
| -.software.add_on | add_on_info | OEM customization on top of given base-image. The components in this customization override the components in the base base-image. Optional. If unset, no OEM customization will be applied. |
| -.software.add_on.details | add_on_details | Details about the add-on. Optional. unset if add-on is not present in the depot. |
| -.software.add_on.details.display_name | string | Display name of the OEM add-on. |
| -.software.add_on.details.vendor | string | Vendor of the OEM add-on. |
| -.software.add_on.details.display_version | string | Human readable version of the OEM add-on. |
| -.software.add_on.name | string | Name of the add-on |
| -.software.add_on.version | string | Version of the add-on |
| -.software.components | object | Information about the components in the software specification. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.component.Object with element values of type component_info. |
| -.software.components.* | component_info | |
| -.software.components.*.version | string | Version of the component. Optional. unset if version is not specified. |
| -.software.solutions | object | Information about the solutions in the software specification. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.settings.solution.Object with element values of type solution_info. |
| -.software.hardware_support | hardware_support_info | Information about the Hardware Support Packages (HSP) configured. Optional. If unset, no Hardware Support Package (HSP) is specified for the cluster. |
| -.software.hardware_support.packages | object | Map of Hardware Support Packages (HSPs) for the cluster. The key is the Hardware Support Manager (HSM) identifier and the value is the specification detailing the HSP configured for that HSM. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager.Object with element values of type hardware_support_package_info. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | If there is unknown internal error. The accompanying error message will give more details about the failure. |
| 404 | not_found | If there is no host associated with host or no draft associated with draft in the system. |
| 503 | service_unavailable | If the service is not available. |
| 401 | unauthenticated | If the caller is not authenticated. |
| 400 | unsupported | If the host is not a standlone host, but instead part of a cluster. |