Esx.Settings.Internal.Configuration.RemediateAddedHostsResult

Esx.Settings.Internal.Configuration.RemediateAddedHostsResult
Esx.Settings.Internal.Configuration.RemediateAddedHostsResult

The Esx.Settings.Internal.Configuration.RemediateAddedHostsResult schema contains properties describing result of the remediateAddedHosts.

Warning: this schema is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

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

JSON Example
{
    "info": "string",
    "commit": "string",
    "apply_task": "string"
}
string
info
Required

Aggregated info describing status of desired cluster configuration and remediation task.

Possible values:

  • NO_OP: Indicates that for no update to desired cluster configuration was necessary. As a result, no task was created to remediate the added hosts.
  • UPDATE_CONFIG_ONLY: Indicates that as a part of remediateAddedHosts operation, the desired cluster configuration was updated. But no remediation task was created.
  • UPDATE_CONFIG_AND_REMEDIATE: Indicates that as a part of remediateAddedHosts operation, the desired cluster configuration was updated as well as remediation task was created.

For more information see: Esx.Settings.Internal.Configuration.RemediateAddedHostsResult.RemediationInfo.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

string
commit
Optional

The ID of the commit created for this operation.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of info is one of Esx.Settings.Internal.Configuration.RemediateAddedHostsResult.RemediationInfo.UPDATE_CONFIG_AND_REMEDIATE or Esx.Settings.Internal.Configuration.RemediateAddedHostsResult.RemediationInfo.UPDATE_CONFIG_ONLY.

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

string
apply_task
Optional

If the cluster is not empty, this will be set to the ID of the Apply task.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of info is Esx.Settings.Internal.Configuration.RemediateAddedHostsResult.RemediationInfo.UPDATE_CONFIG_AND_REMEDIATE.

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