REST API - software

esx settings: software spec

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

Representation:

JSON
LEGACY JSON

{
    "hardware_support" : {
        "packages" : {
            "obj-103" : {
                "pkg" : "obj-103",
                "version" : "string"
            }
        }
    },
    "components" : {
        "obj-103" : "string"
    },
    "base_image" : {
        "version" : "string"
    },
    "solutions" : {
        "obj-103" : {
            "components" : [
                {
                    "component" : "obj-103"
                },
                {
                    "component" : "obj-103"
                }
            ],
            "version" : "string"
        }
    },
    "add_on" : {
        "name" : "string",
        "version" : "string"
    }
}

{
    "hardware_support" : {
        "packages" : [
            {
                "value" : {
                    "pkg" : "obj-103",
                    "version" : "string"
                },
                "key" : "obj-103"
            }
        ]
    },
    "components" : [
        {
            "value" : "string",
            "key" : "obj-103"
        }
    ],
    "base_image" : {
        "version" : "string"
    },
    "solutions" : [
        {
            "value" : {
                "components" : [
                    {
                        "component" : "obj-103"
                    },
                    {
                        "component" : "obj-103"
                    }
                ],
                "version" : "string"
            },
            "key" : "obj-103"
        }
    ],
    "add_on" : {
        "name" : "string",
        "version" : "string"
    }
}

Attributes:

Name	Type	Description
Required
-.base_image	base_image_spec	Base image of the ESX.
-.base_image.version	string	Version of the base-image
-.add_on.name	string	Name of the add-on
-.add_on.version	string	Version of the add-on
-.hardware_support.packages	object	Map of Hardware Support Packages (HSPs) for the cluster. The key is the Hardware Support Manager (HSM) name 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_spec.
Optional
-.add_on	add_on_spec	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	object	Additional components which should be part of the software specification. If value is not given for a particular component then version for that component will be picked from the constraints. These override the components present in esx.settings.software_spec.add_on and esx.settings.software_spec.base_image. Optional. If unset, no additional components will be installed.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`.
-.components.*	string	Optional.
-.solutions	object	Mapping from solution identifier to the solution specification. The key is the solution name and the value is the specification detailing components registered by that solution. Optional. If unset, no solutions will be part of 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`.
-.hardware_support	hardware_support_spec	Information about the Hardware Support Package (HSP) configured in the software specification. Optional. If unset or empty, no firmware compliance checking or remediation will be done.

Attributes:

Name	Type	Description
Required
base_image	base_image_spec	Base image of the ESX.
base_image.version	string	Version of the base-image
add_on.name	string	Name of the add-on
add_on.version	string	Version of the add-on
components[].key	string
hardware_support.packages	list	Map of Hardware Support Packages (HSPs) for the cluster. The key is the Hardware Support Manager (HSM) name 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_spec}
Optional
add_on	add_on_spec	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	list	Additional components which should be part of the software specification. If value is not given for a particular component then version for that component will be picked from the constraints. These override the components present in esx.settings.software_spec.add_on and esx.settings.software_spec.base_image. Optional. If unset, no additional components will be installed.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`.
components[].value	string	Optional.
solutions	list	Mapping from solution identifier to the solution specification. The key is the solution name and the value is the specification detailing components registered by that solution. Optional. If unset, no solutions will be part of 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`.
hardware_support	hardware_support_spec	Information about the Hardware Support Package (HSP) configured in the software specification. Optional. If unset or empty, no firmware compliance checking or remediation will be done.