Settings_Depots_AffectedDesiredStateInfo

Settings_Depots_AffectedDesiredStateInfo
Settings_Depots_AffectedDesiredStateInfo

The AffectedDesiredStateInfo structure contains the fields that describe which release units in the desired state will be affected by the depot to be deleted or disabled.

JSON Example
{
    "cluster_name": "string",
    "cluster_id": "string",
    "affected_base_image": {
        "version": "string",
        "display_name": "string",
        "display_version": "string"
    },
    "affected_addon": {
        "affected_addon": {
            "display_name": "string",
            "vendor": "string",
            "versions": [
                {
                    "version": "string",
                    "display_version": "string"
                }
            ]
        }
    },
    "affected_solutions": {
        "affected_solutions": {
            "display_name": "string",
            "versions": [
                {
                    "version": "string",
                    "display_version": "string"
                }
            ]
        }
    },
    "affected_hardware_support": {
        "affected_hardware_support": {
            "display_name": "string",
            "packages": {
                "packages": {
                    "versions": [
                        {
                            "version": "string"
                        }
                    ]
                }
            }
        }
    },
    "affected_independent_components": {
        "affected_independent_components": {
            "display_name": "string",
            "versions": [
                {
                    "version": "string",
                    "display_version": "string"
                }
            ]
        }
    }
}
string
cluster_name
Required

Since now we have standalone host, we use entityName/entityId to better describe name/id of either cluster or standalone host. Name of the cluster the affected desired state belongs to.

string
cluster_id
Required

Identified of the cluster the affected desired state belongs to. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.

affected_base_image
Optional

The BaseImageVersion structure contains fields that describe a specific ESXi base image.

object
affected_addon
Optional

Affected addon of the desired state. The key is name of addon. Note: there is at most one addon affected. If unset, no addon of the desired state will be affected. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.esx.settings.add_on. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.esx.settings.add_on.

object
affected_solutions
Optional

Affected solutions of the desired state. The key is name of solution. If unset, no solution of the desired state will be affected. When clients pass a value of this structure as a parameter, the key in the field map 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 map will be an identifier for the resource type: com.vmware.esx.settings.solution.

object
affected_hardware_support
Optional

Affected hardware support of the desired state. The key is HSM name. If unset, no hadrware support of the desired state will be affected. When clients pass a value of this structure as a parameter, the key in the field map 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 map will be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager.

object
affected_independent_components
Optional

Affected independent components of the desired state. The components belongs to other base images, addons, solutions and hardware support packages are not counted. The key is name of component. If unset, no independent components of the desired state will be affected. When clients pass a value of this structure as a parameter, the key in the field map 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 map will be an identifier for the resource type: com.vmware.esx.settings.component.