REST API - software

esx hosts: software info

The software_info structure contains fields that describe desired software specification for an ESX host.

Representation:

JSON
LEGACY JSON

{
    "components" : {
        "obj-103" : {
            "display_version" : "string",
            "vendor" : "string",
            "display_name" : "string",
            "version" : "string"
        }
    },
    "base_image" : {
        "release_date" : "2015-01-01T22:13:05.651Z",
        "display_version" : "string",
        "display_name" : "string",
        "version" : "obj-103"
    },
    "solutions" : {
        "obj-103" : {
            "components" : {
                "obj-103" : {
                    "display_version" : "string",
                    "vendor" : "string",
                    "display_name" : "string",
                    "version" : "string"
                }
            },
            "display_name" : "string",
            "version" : "string"
        }
    },
    "add_on" : {
        "vendor" : "string",
        "display_version" : "string",
        "name" : "obj-103",
        "display_name" : "string",
        "version" : "string"
    }
}

{
    "components" : [
        {
            "value" : {
                "display_version" : "string",
                "vendor" : "string",
                "display_name" : "string",
                "version" : "string"
            },
            "key" : "obj-103"
        }
    ],
    "base_image" : {
        "release_date" : "2015-01-01T22:13:05.651Z",
        "display_version" : "string",
        "display_name" : "string",
        "version" : "obj-103"
    },
    "solutions" : [
        {
            "value" : {
                "components" : [
                    {
                        "value" : {
                            "display_version" : "string",
                            "vendor" : "string",
                            "display_name" : "string",
                            "version" : "string"
                        },
                        "key" : "obj-103"
                    }
                ],
                "display_name" : "string",
                "version" : "string"
            },
            "key" : "obj-103"
        }
    ],
    "add_on" : {
        "vendor" : "string",
        "display_version" : "string",
        "name" : "obj-103",
        "display_name" : "string",
        "version" : "string"
    }
}

Attributes:

Name	Type	Description
Required
-.base_image	base_image_info	Base image of the ESX.
-.base_image.version	string	Version of the base-image. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.esx.hosts.base_image`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.esx.hosts.base_image`.
-.base_image.display_name	string	Display name of the base-image.
-.base_image.display_version	string	Human readable version of the base-image.
-.base_image.release_date	date_time	Release date of the base-image.
-.add_on.name	string	Name of the add-on When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.esx.hosts.add_on`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.esx.hosts.add_on`.
-.add_on.version	string	Version of the add-on
-.add_on.display_name	string	Display name of the OEM add-on.
-.add_on.vendor	string	Vendor of the OEM add-on.
-.add_on.display_version	string	Human readable version of the OEM add-on.
-.components	object	Map of components in an ESX image. The key is the component name and value is the information about specific version of the component. 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.hosts.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.hosts.component`.Object with element values of type component_info.
-.components.*.version	string	Version of the component.
-.components.*.display_name	string	Display name of the component.
-.components.*.display_version	string	Human readable version of the component.
-.components.*.vendor	string	Vendor of the component.
-.solutions	object	Map of software solutions in an ESX image. The key is the solution name and value is the specification detailing components registered by that solution. 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.hosts.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.hosts.solution`.Object with element values of type solution_info.
-.solutions.*	solution_info
-.solutions.*.version	string	Version of the solution.
-.solutions.*.display_name	string	Display name of the solution.
-.solutions.*.components	object	Components registered by the solution. 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.hosts.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.hosts.component`.Object with element values of type component_info.
-.solutions..components.	component_info
-.solutions..components..version	string	Version of the component.
-.solutions..components..display_name	string	Display name of the component.
-.solutions..components..display_version	string	Human readable version of the component.
-.solutions..components..vendor	string	Vendor of the component.
Optional
-.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.
-.components.*	component_info	Optional.

Attributes:

Name	Type	Description
Required
base_image	base_image_info	Base image of the ESX.
base_image.version	string	Version of the base-image. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.esx.hosts.base_image`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.esx.hosts.base_image`.
base_image.display_name	string	Display name of the base-image.
base_image.display_version	string	Human readable version of the base-image.
base_image.release_date	date_time	Release date of the base-image.
add_on.name	string	Name of the add-on When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.esx.hosts.add_on`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.esx.hosts.add_on`.
add_on.version	string	Version of the add-on
add_on.display_name	string	Display name of the OEM add-on.
add_on.vendor	string	Vendor of the OEM add-on.
add_on.display_version	string	Human readable version of the OEM add-on.
components	list	Map of components in an ESX image. The key is the component name and value is the information about specific version of the component. 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.hosts.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.hosts.component`.List of {"key": string, "value": component_info}
components[].key	string
components[].value.version	string	Version of the component.
components[].value.display_name	string	Display name of the component.
components[].value.display_version	string	Human readable version of the component.
components[].value.vendor	string	Vendor of the component.
solutions	list	Map of software solutions in an ESX image. The key is the solution name and value is the specification detailing components registered by that solution. 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.hosts.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.hosts.solution`.List of {"key": string, "value": solution_info}
solutions[].key	string
solutions[].value	solution_info
solutions[].value.version	string	Version of the solution.
solutions[].value.display_name	string	Display name of the solution.
solutions[].value.components	list	Components registered by the solution. 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.hosts.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.hosts.component`.List of {"key": string, "value": component_info}
solutions[].value.components[].key	string
solutions[].value.components[].value	component_info
solutions[].value.components[].value.version	string	Version of the component.
solutions[].value.components[].value.display_name	string	Display name of the component.
solutions[].value.components[].value.display_version	string	Human readable version of the component.
solutions[].value.components[].value.vendor	string	Vendor of the component.
Optional
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.
components[].value	component_info	Optional.