Esx.Settings.Clusters.Configuration.Plugins.Response
Represents the output structure for operations defined in spec Esx.Settings.Clusters.Configuration.Plugins.Operation.
This schema was added in vSphere API 8.0.3.0.
Note: this schema is restricted for VMware internal use only.
{
"operation": "string",
"validation_errors": [
{
"type": "string",
"identifier": "string",
"errors": [
{
"path": "string",
"display_path": [
"string"
],
"messages": [
"Vapi.Std.LocalizableMessage Object"
]
}
]
}
],
"eligibility_details": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
]
},
"extract_response": {
"config": "string"
},
"compliance_result": {
"validation_errors": [
{
"path": "string",
"display_path": [
"string"
],
"messages": [
"Vapi.Std.LocalizableMessage Object"
]
}
],
"host_compliance": {
"host_compliance": {
"status": "string",
"config_compliance": {
"config_compliance": "string"
},
"errors": [
{
"path": "string",
"display_path": [
"string"
],
"messages": [
"Vapi.Std.LocalizableMessage Object"
]
}
],
"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
}
}
]
}
}
},
"cluster_solutions_result": {
"cluster_solutions_result": {
"config_compliance": {
"config_compliance": "string"
},
"display_name": "Vapi.Std.LocalizableMessage Object",
"status": "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
}
}
]
},
"host_compliance_info": {
"host_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
}
}
]
}
},
"errors": [
{
"path": "string",
"display_path": [
"string"
],
"messages": [
"Vapi.Std.LocalizableMessage Object"
]
}
],
"summary": "Vapi.Std.LocalizableMessage Object"
}
}
},
"impact_result": {
"validation_errors": [
{
"path": "string",
"display_path": [
"string"
],
"messages": [
"Vapi.Std.LocalizableMessage Object"
]
}
],
"host_impact": {
"host_impact": {
"impact": "string",
"info": [
"Vapi.Std.LocalizableMessage Object"
],
"status": "string",
"config_compliance": {
"config_compliance": "string"
},
"errors": [
{
"path": "string",
"display_path": [
"string"
],
"messages": [
"Vapi.Std.LocalizableMessage Object"
]
}
],
"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
}
}
]
}
}
},
"cluster_solutions_result": {
"cluster_solutions_result": {
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
]
},
"drift_reviews": [
{
"property_paths": [
"string"
],
"drift_review_policy": {
"type": "string",
"name": "string",
"possible_values": [
"string"
],
"value_string": "string",
"value_long": 0,
"value_boolean": false
},
"notification": {
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
}
],
"display_name": "Vapi.Std.LocalizableMessage Object",
"status": "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
}
}
]
},
"host_compliance_info": {
"host_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
}
}
]
}
},
"errors": [
{
"path": "string",
"display_path": [
"string"
],
"messages": [
"Vapi.Std.LocalizableMessage Object"
]
}
],
"summary": "Vapi.Std.LocalizableMessage Object"
}
}
},
"get_bootstrap_config_result": {
"bootstrap_configs": {
"bootstrap_configs": [
"string"
]
}
},
"initialize_solution_response": {
"config": "string"
},
"get_available_values_response_spec": {
"results": {
"results": {
"cluster_values": "string",
"host_values": {
"host_values": "string"
},
"status": "string",
"error": {
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
}
},
"hosts": {
"hosts": {
"name": "string",
"is_vsan_witness": false
}
}
},
"patch_host_config_response": {
"patched_host_configs": {
"patched_host_configs": "string"
},
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
]
}
}
}Plugin operation.
Possible values:
- APPLY: Plugin Apply operation is invoked.
- APPLY_SOLUTION: Plugin Apply Solution operation is invoked.
Warning: this constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
- VALIDATE: Plugin Validate operation is invoked.
- CHECK_ELIGIBILITY: Plugin check_eligibility operation is invoked.
- EXTRACT: Extract operation that gets the solution specific cluster configuration.
- CHECK_COMPLIANCE: Plugin CheckCompliance operation is invoked.
This constant was added in vSphere API 9.0.0.0.
- IMPACT: Plugin Impact operation is invoked
This constant was added in vSphere API 9.0.0.0.
- GET_BOOTSTRAP_CONFIG: Warning: this constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
- INITIALIZE_SOLUTION: Warning: this constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
- GET_AVAILABLE_VALUES: Plugin get_available_values operation is invoked.
Warning: this constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
- PATCH_HOST_CONFIG: Plugin patch_host_config operation is invoked.
Warning: this constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
For more information see: Esx.Settings.Clusters.Configuration.Plugins.Operation.
This property was added in vSphere API 8.0.3.0.
List of validation errors in the cluster configuration document. These validation errors are collected by running all validation plugins registered with the framework. These plugins are also run for operation other than Esx.Settings.Clusters.Configuration.Plugins.Operation.VALIDATE. In such scenario, if this field is set, the requested operation is not executed.
This property was added in vSphere API 8.0.3.0.
If set, there were validation errors detected in the cluster configuration document.
This property contains details of the eligbility checks done by plugins.
This property was added in vSphere API 8.0.3.0.
If set, the eligibity checks generated warning or error messages.
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of operation is Esx.Settings.Clusters.Configuration.Plugins.Operation.EXTRACT.
List of compliance result returned by the compliance plugin for each host in the inventory
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of operation is Esx.Settings.Clusters.Configuration.Plugins.Operation.CHECK_COMPLIANCE.
The field contains the results of impact plugins on the cluster provided as input in the request.
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of operation is Esx.Settings.Clusters.Configuration.Plugins.Operation.IMPACT.
The getBootstrapConfigResult field contains the requested bootstrap configurations for the solution being queried.
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.
Not set except on GET_BOOTSTRAP_CONFIG operations
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 operation is Esx.Settings.Clusters.Configuration.Plugins.Operation.INITIALIZE_SOLUTION.
The field contains the results(or response) of the Esx.Settings.Clusters.Configuration.Plugins.Operation.GET_AVAILABLE_VALUES 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 operation is Esx.Settings.Clusters.Configuration.Plugins.Operation.GET_AVAILABLE_VALUES.
The Esx.Settings.Clusters.Configuration.Plugins.Operation.PATCH_HOST_CONFIG operation response details.
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 operation is Esx.Settings.Clusters.Configuration.Plugins.Operation.PATCH_HOST_CONFIG.