Get Clusters Software Compliance
Released in v7.0.0 DescriptionReturns the compliance state for the cluster if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/compliance
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
SettingsClusterCompliance
of type application/json
Cluster compliance result.
{
"commit": "string",
"compliant_hosts": [
"string"
],
"host_info": {
"key": {
"name": "string"
}
},
"hosts": {
"key": {
"add_on": {
"current": {
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"name": "string",
"version": "string"
},
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"status": "enum",
"target": {
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"name": "string",
"version": "string"
}
},
"base_image": {
"current": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string"
},
"version": "string"
},
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"status": "enum",
"target": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string"
},
"version": "string"
}
},
"commit": "string",
"components": {
"key": {
"current": {
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"version": "string"
},
"current_source": "enum",
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"status": "enum",
"target": {
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"version": "string"
},
"target_source": "enum"
}
},
"hardware_support": {
"key": {
"current": {
"pkg": "string",
"version": "string"
},
"hardware_modules": {
"key": {
"current": {
"version": "string"
},
"details": {
"component_class": "enum",
"description": "string"
},
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"status": "enum",
"target": {
"version": "string"
}
}
},
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"status": "enum",
"target": {
"pkg": "string",
"version": "string"
}
}
},
"impact": "enum",
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"scan_time": "string",
"solutions": {
"key": {
"current": {
"components": [
{
"component": "string"
}
],
"details": {
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
],
"display_name": "string",
"display_version": "string"
},
"version": "string"
},
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"status": "enum",
"target": {
"components": [
{
"component": "string"
}
],
"details": {
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
],
"display_name": "string",
"display_version": "string"
},
"version": "string"
}
}
},
"status": "enum"
}
},
"impact": "enum",
"incompatible_hosts": [
"string"
],
"non_compliant_hosts": [
"string"
],
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"scan_time": "string",
"status": "enum",
"unavailable_hosts": [
"string"
]
}| Property Name | Type | Description |
|---|---|---|
| compliant_hosts | array of string |
Identifiers of compliant hosts. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem. |
| host_info | map of SettingsHostInfo |
Auxillary information about the hosts. This gives some additional information about the hosts referenced in this result. 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: HostSystem. 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: HostSystem. |
| hosts | map of SettingsHostCompliance |
Mapping from host identifier to the compliance information for the host. 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: HostSystem. 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: HostSystem. |
| impact | SettingsComplianceImpact Enum |
Overall impact. |
| incompatible_hosts | array of string |
Identifiers of incompatible hosts. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem. |
| non_compliant_hosts | array of string |
Identifiers of non-compliant hosts. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem. |
| notifications | SettingsNotifications |
Notifications returned by the scan operation. |
| scan_time | string |
Scan completion time. |
| status | SettingsComplianceStatus Enum |
Overall compliance state of the host. |
| unavailable_hosts | array of string |
Identifiers of unavailable hosts. There will not be compliance details for these hosts in ClusterCompliance.hosts. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem. |
| commit | string |
Identifier of the commit on which the scan is run to generate this result. unset if operation is performed on a draft. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.commit. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/compliance
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure. | com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system or if the compliance information is unavailable. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
