VsanUpdateItem

VsanUpdateItem
VsanUpdateItem

Information about an item (firmware, VIB) to be installed/updated.

This structure may be used only with operations rendered under /vsan.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "type": "string",
    "name": "string",
    "version": "string",
    "existingVersion": "string",
    "present": false,
    "vibSpec": [
        {
            "_typeName": "string",
            "host": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "metaUrl": "string",
            "metaSha1Sum": "string",
            "vibUrl": "string",
            "vibSha1Sum": "string"
        }
    ],
    "vibType": "string",
    "firmwareSpec": {
        "_typeName": "string",
        "host": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "hbaDevice": "string",
        "fwFiles": [
            {
                "_typeName": "string",
                "fileType": "string",
                "filenameOrUrl": "string",
                "sha1sum": "string"
            }
        ],
        "allowDowngrade": false,
        "firmwareComponent": [
            {
                "_typeName": "string",
                "name": "string",
                "url": "string",
                "sha1sum": "string",
                "currentVersion": "string",
                "suggestedVersion": "string",
                "componentID": [
                    "string"
                ]
            }
        ]
    },
    "downloadInfo": [
        {
            "_typeName": "string",
            "url": "string",
            "sha1sum": "string",
            "formatType": "string",
            "itemId": "string"
        }
    ],
    "eula": "string",
    "adapter": "string",
    "key": "string",
    "impact": "string",
    "firmwareUnknown": false
}
host
Required

Host for which this information is in reference to.

string
type
Required

Type of the item.

See also VsanUpdateItemTypeEnum.

string
name
Required

Name of the item.

In case of a VIB a description that includes the unique VIB name. In case of firmware, a description of firmware and device.

string
version
Required

Version provided by this item.

Note, in case of a VIB, this may not be the VIB version, but rather the version of what the VIB contains, e.g. the version of the driver or CIM provider, which may not match exactly the version of the VIB.

string
existingVersion
Optional

Existing version on the host, if any.

boolean
present
Required

If not present, it needs to be downloaded from the Internet, or uploaded to the Update Manager.

See respective APIs.

array of VsanVibSpec
vibSpec
Optional

In case of VIB type, the spec for the VIB.

string
vibType
Optional

Type of the Vib.

See also VsanVibTypeEnum.

firmwareSpec
Optional

In case of vmhba firmware type, the spec for the firmware.

downloadInfo
Optional

Information about how to download the item.

string
eula
Optional

EULA provided by this item.

Note, in case of a VIB, this is empty, as for firmware, it is the EULA provided by the vendor.

string
adapter
Optional

The device name of adapter whose vendor tool or driver/firmware to be installed or updated by the update item

string
key
Optional

Unique key to identify the an update item.

string
impact
Optional

Impact after the update item is applied.

See also VsanUpdateItemImpactTypeEnum.

boolean
firmwareUnknown
Optional

Set to true when firmware is unknown.

When it's true, it means associated firmware mgmt tool is missing, which has to be installed first.