Esx.Settings.Clusters.Configuration.Plugins.Request
Represents the input 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",
"config": "string",
"schema": "string",
"reference_host": "string",
"hosts": [
"string"
],
"apply": {
"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
}
}
]
}
},
"apply_solutions": {
"cluster": "string",
"cluster_solutions_impact": {
"cluster_solutions_impact": {
"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"
}
}
},
"configuration_ids": [
"string"
],
"bootstrap_configs": {
"configs": {
"configs": [
{
"filter": {
"filter": "string"
}
}
]
}
},
"impact_type": "string",
"get_available_values_request_spec": {
"path_specs": {
"path_specs": {
"hosts": [
"string"
],
"input_spec": "string"
}
}
},
"specific_solutions_for_op": [
"string"
],
"patch_host_config_request": {
"host_info": {
"host_info": {
"host_config": "string",
"source_vibs": [
"string"
],
"current_vibs": [
"string"
]
}
}
}
}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.
The desired configuration of the cluster serialized in JSON format.
This property was added in vSphere API 8.0.3.0.
This property is optional and it is only relevant when the value of operation is one of Esx.Settings.Clusters.Configuration.Plugins.Operation.APPLY, Esx.Settings.Clusters.Configuration.Plugins.Operation.VALIDATE, Esx.Settings.Clusters.Configuration.Plugins.Operation.EXTRACT, Esx.Settings.Clusters.Configuration.Plugins.Operation.CHECK_COMPLIANCE, Esx.Settings.Clusters.Configuration.Plugins.Operation.IMPACT, Esx.Settings.Clusters.Configuration.Plugins.Operation.APPLY_SOLUTION, Esx.Settings.Clusters.Configuration.Plugins.Operation.INITIALIZE_SOLUTION, Esx.Settings.Clusters.Configuration.Plugins.Operation.GET_AVAILABLE_VALUES, or Esx.Settings.Clusters.Configuration.Plugins.Operation.PATCH_HOST_CONFIG.
The cluster configuration document JSON schema.
This property was added in vSphere API 8.0.3.0.
This property is optional and it is only relevant when the value of operation is one of Esx.Settings.Clusters.Configuration.Plugins.Operation.APPLY, Esx.Settings.Clusters.Configuration.Plugins.Operation.VALIDATE, Esx.Settings.Clusters.Configuration.Plugins.Operation.EXTRACT, Esx.Settings.Clusters.Configuration.Plugins.Operation.CHECK_COMPLIANCE, Esx.Settings.Clusters.Configuration.Plugins.Operation.IMPACT, Esx.Settings.Clusters.Configuration.Plugins.Operation.APPLY_SOLUTION, Esx.Settings.Clusters.Configuration.Plugins.Operation.GET_BOOTSTRAP_CONFIG, Esx.Settings.Clusters.Configuration.Plugins.Operation.INITIALIZE_SOLUTION, Esx.Settings.Clusters.Configuration.Plugins.Operation.GET_AVAILABLE_VALUES, or Esx.Settings.Clusters.Configuration.Plugins.Operation.PATCH_HOST_CONFIG.
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 because it was added in a newer version than its parent node.
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.
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 contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.
The Esx.Settings.Clusters.Configuration.Plugins.Operation.APPLY operation request details.
This property was added in vSphere API 8.0.3.0.
This property is optional and it is only relevant when the value of operation is Esx.Settings.Clusters.Configuration.Plugins.Operation.APPLY.
The Esx.Settings.Clusters.Configuration.Plugins.Operation.APPLY_SOLUTION operation request 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.APPLY_SOLUTION.
The Esx.Settings.Clusters.Configuration.Plugins.Operation.VALIDATE operation optional request IDs to filter plugins.
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.VALIDATE.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.esx.settings.configuration.component.group.key. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.esx.settings.configuration.component.group.key.
The Operation#GET_BOOSTRAPCONFIG operation request 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.GET_BOOTSTRAP_CONFIG.
The Esx.Settings.Clusters.Configuration.Plugins.Operation.IMPACT operation type. If not specified, type shall be assumed to Esx.Settings.Clusters.Configuration.Plugins.ImpactRequestType.ALL
Possible values:
- SOLUTION: Run impact on solution configurations.
- HOST: Run impact on host configurations.
- ALL: Run impact on both solution and host configurations.
For more information see: Esx.Settings.Clusters.Configuration.Plugins.ImpactRequestType.
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.IMPACT.
The Esx.Settings.Clusters.Configuration.Plugins.Operation.GET_AVAILABLE_VALUES operation request 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.GET_AVAILABLE_VALUES.
Possible values:
- VSAN: VSAN solution
For more information see: Esx.Settings.Clusters.Configuration.Plugins.Solution.
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.EXTRACT.
The Esx.Settings.Clusters.Configuration.Plugins.Operation.PATCH_HOST_CONFIG operation request 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.