Esx.Settings.Clusters.Configuration.Plugins.ApplyRequest

Esx.Settings.Clusters.Configuration.Plugins.ApplyRequest
Esx.Settings.Clusters.Configuration.Plugins.ApplyRequest

Represents the input structure for the Esx.Settings.Clusters.Configuration.Plugins.Operation.APPLY operation.

This schema was added in vSphere API 8.0.3.0.

Note: this schema is restricted for VMware internal use only.

JSON Example
{
    "phase": "string",
    "host": "string",
    "compliance_info": {
        "sets": [
            {
                "path": "string",
                "display_path": [
                    "string"
                ],
                "current": "string",
                "target": "string",
                "type": "string",
                "reference_current": "string",
                "reference_target": "string",
                "error": {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            }
        ],
        "adds": [
            {
                "path": "string",
                "display_path": [
                    "string"
                ],
                "current": "string",
                "target": "string",
                "type": "string",
                "reference_current": "string",
                "reference_target": "string",
                "error": {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            }
        ],
        "deletes": [
            {
                "path": "string",
                "display_path": [
                    "string"
                ],
                "current": "string",
                "target": "string",
                "type": "string",
                "reference_current": "string",
                "reference_target": "string",
                "error": {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            }
        ]
    }
}
string
phase
Required

The phase of the Esx.Settings.Clusters.Configuration.Plugins.Operation.APPLY.

Possible values:

  • PRE_HOST_APPLY: This phase indicates that the Esx.Settings.Clusters.Configuration.Plugins.Operation.APPLY operation is invoked before the ESXi host is remediated.
  • POST_HOST_APPLY: This phase indicates that the Esx.Settings.Clusters.Configuration.Plugins.Operation.APPLY operation is invoked after the ESXi host is remediated.

For more information see: Esx.Settings.Clusters.Configuration.Plugins.Phase.

This property was added in vSphere API 8.0.3.0.

string
host
Required

The identifier of the host to be remediated.

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.

compliance_info
Required

The compliance information for the host host specified in this request.

This property was added in vSphere API 8.0.3.0.