Esx.Settings.EffectiveComponentDetails

Esx.Settings.EffectiveComponentDetails
Esx.Settings.EffectiveComponentDetails

The Esx.Settings.EffectiveComponentDetails schema contains information that provide more details about the component from the depot.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "display_name": "string",
    "display_version": "string",
    "vendor": "string",
    "source": "string",
    "note": "Vapi.Std.LocalizableMessage Object",
    "overridden_components": [
        {
            "version": "string",
            "display_version": "string",
            "source": "string",
            "note": "Vapi.Std.LocalizableMessage Object"
        }
    ],
    "removable": false,
    "image_customization_action": "string",
    "image_customization_description": "Vapi.Std.LocalizableMessage Object"
}
string
display_name
Required

Display name of the component.

This property was added in vSphere API 7.0.0.0.

string
display_version
Required

Human readable version of the component.

This property was added in vSphere API 7.0.0.0.

string
vendor
Required

Vendor of the component.

This property was added in vSphere API 7.0.0.0.

string
source
Required

Final effective source of the component.

Possible values:

  • BASE_IMAGE: Base image is the source for this component
  • ADD_ON: Addon is the source for this component
  • USER: User is the source for this component
  • SOLUTION: Solution is the source for this component
  • HARDWARE_SUPPORT_PACKAGE: Hardware Support Package (HSP) is the source for this component

This constant was added in vSphere API 7.0.0.0.

  • USER_REMOVED: This component was removed by the user

This constant was added in vSphere API 8.0.3.0.

For more information see: Esx.Settings.ComponentSource.

This property was added in vSphere API 7.0.0.0.

note
Optional

Note assosicated with this component.

This property was added in vSphere API 7.0.0.0.

If missing or null, note is present for this component.

array of Esx.Settings.ComponentOverrideInfo
overridden_components
Required

List of other component versions present in base image, add-ons or solutions that this component is overriding. For example, if a component version-1 was implicitly present in the base image, but user wants it to be changed to version-2. In that case, Esx.Settings.EffectiveComponentDetails.source would be USER and there will be one entry in this list indicating base image component version-1 is being overridden.

This property was added in vSphere API 7.0.0.0.

boolean
removable
Optional

Flag to indicate if the component can be removed by specifying its name in the removed components section of the software specification.

This property was added in vSphere API 8.0.3.0.

This property is optional because it was added in a newer version than its parent node.

string
image_customization_action
Optional

Image customization status for the current component.

Possible values:

  • RETAINED: The component is retained at an older version in the desired software specification.
  • REMOVED: The component is removed by the user in the desired software specification.

For more information see: Esx.Settings.ImageCustomizationAction.

This property was added in vSphere API 8.0.3.0.

if missing or null the component is not customized.

image_customization_description
Optional

Localized text describing the imageCustomizationAction.

This property was added in vSphere API 8.0.3.0.

if missing or null the component is not customized.