esx settings clusters software drafts internal: info
The
info structure defines the information about software draft.Representation:
{
"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"
}
}
}
{
"metadata" : {
"owner" : "string",
"creation_time" : "2015-01-01T22:13:05.651Z",
"status" : "VALID"
},
"software" : {
"hardware_support" : {
"packages" : [
{
"value" : {
"pkg" : "obj-103",
"version" : "string"
},
"key" : "obj-103"
}
]
},
"components" : [
{
"value" : {
"details" : {
"vendor" : "string",
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
},
"key" : "obj-103"
}
],
"base_image" : {
"details" : {
"release_date" : "2015-01-01T22:13:05.651Z",
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
},
"solutions" : [
{
"value" : {
"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"
},
"key" : "obj-103"
}
],
"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" : [
{
"value" : {
"pkg" : "obj-103",
"version" : "string"
},
"key" : "obj-103"
}
]
},
"components" : [
{
"value" : {
"details" : {
"vendor" : "string",
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
},
"key" : "obj-103"
}
],
"base_image" : {
"details" : {
"release_date" : "2015-01-01T22:13:05.651Z",
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
},
"solutions" : [
{
"value" : {
"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"
},
"key" : "obj-103"
}
],
"add_on" : {
"name" : "string",
"details" : {
"vendor" : "string",
"display_version" : "string",
"display_name" : "string"
},
"version" : "string"
}
}
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| -.metadata | metadata | Metadata about the software draft. |
| -.metadata.owner | string | Owner of the software draft. |
| -.metadata.status | string | Status of the software draft. The status_type structure defines possible values of status of a software draft. Value is one of:VALID: Software draft is valid. INVALID: Software draft is invalid. |
| -.metadata.creation_time | date_time | Creation time of the software draft. |
| -.software | software_info | Software specification associated with the draft. |
| -.software.base_image | base_image_info | Base image of the ESX. |
| -.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.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.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.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. |
| Optional | ||
| -.software.base_image.details | base_image_details | Details about the base-image. Optional. unset if base-image is not present in the depot. |
| -.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.components.*.version | string | Version of the component. Optional. unset if version is not specified. |
| -.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. |
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| metadata | metadata | Metadata about the software draft. |
| metadata.owner | string | Owner of the software draft. |
| metadata.status | string | Status of the software draft. The status_type structure defines possible values of status of a software draft. Value is one of:VALID: Software draft is valid. INVALID: Software draft is invalid. |
| metadata.creation_time | date_time | Creation time of the software draft. |
| software | software_info | Software specification associated with the draft. |
| software.base_image | base_image_info | Base image of the ESX. |
| 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.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 | list | 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.List of {"key": string, "value": component_info} |
| software.components[].key | string | |
| software.components[].value | component_info | |
| software.solutions | list | 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.List of {"key": string, "value": solution_info} |
| software.hardware_support.packages | list | 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.List of {"key": string, "value": hardware_support_package_info} |
| Optional | ||
| software.base_image.details | base_image_details | Details about the base-image. Optional. unset if base-image is not present in the depot. |
| 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.components[].value.version | string | Version of the component. Optional. unset if version is not specified. |
| 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. |