appliance configuration compliance: get
Returns the compliance state for the appliance. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
GET https://{server}/api/appliance/configuration/compliance/{profile}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| profile | string | Identifier of the appliance. |
Response:
HTTP Status Code: 200
Response Body Structure:
{
"result" : {
"diff_results" : {
"<string>" : {
"path" : "string",
"description" : "string",
"diff_values" : {
"modified_value" : "string",
"current_value" : "string"
},
"category" : "string"
}
}
},
"components" : {
"obj-103" : {
"diff_results" : {
"<string>" : {
"path" : "string",
"description" : "string",
"diff_values" : {
"modified_value" : "string",
"current_value" : "string"
},
"category" : "string"
}
}
}
},
"non_compliant_components" : [
"obj-103",
"obj-103"
],
"commit" : "obj-103",
"component_info" : {
"obj-103" : {
"component" : "obj-103",
"info" : "string"
}
},
"scan_time" : "2015-01-01T22:13:05.651Z",
"unavailable_components" : [
"obj-103",
"obj-103"
],
"notifications" : {
"warnings" : [
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"errors" : [
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"info" : [
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
]
},
"compliant_components" : [
"obj-103",
"obj-103"
],
"status" : "COMPLIANT"
}
"result" : {
"diff_results" : {
"<string>" : {
"path" : "string",
"description" : "string",
"diff_values" : {
"modified_value" : "string",
"current_value" : "string"
},
"category" : "string"
}
}
},
"components" : {
"obj-103" : {
"diff_results" : {
"<string>" : {
"path" : "string",
"description" : "string",
"diff_values" : {
"modified_value" : "string",
"current_value" : "string"
},
"category" : "string"
}
}
}
},
"non_compliant_components" : [
"obj-103",
"obj-103"
],
"commit" : "obj-103",
"component_info" : {
"obj-103" : {
"component" : "obj-103",
"info" : "string"
}
},
"scan_time" : "2015-01-01T22:13:05.651Z",
"unavailable_components" : [
"obj-103",
"obj-103"
],
"notifications" : {
"warnings" : [
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"errors" : [
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
],
"info" : [
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
},
{
"notification" : "obj-103",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {
"<string>" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : {}
}
}
}
}
}
}
}
}
]
},
"compliant_components" : [
"obj-103",
"obj-103"
],
"status" : "COMPLIANT"
}
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | profile_compliance | Profile compliance result. |
| -.status | string | Overall compliance state of the appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. The compliance_status structure contains the possible different status of compliance with respect to target version. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:COMPLIANT: Target version is same as current version. 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. NON_COMPLIANT: Target version is greater than current version. 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. UNAVAILABLE: Drift check failed due to unknown error or check hasn't happened yet and results are not available. 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. |
| -.result | compliance_result | Overall compliance result of the profile. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.result.diff_results | object | Mapping from property value differences between current desired and working profile. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Object with element values of type diff_result. |
| -.result.diff_results.* | diff_result | |
| -.result.diff_results.*.diff_values | diff_values | Details of value difference. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.result.diff_results.*.diff_values.current_value | string | Current property value. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.result.diff_results.*.diff_values.modified_value | string | Modified property value. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.result.diff_results.*.category | string | Category of setting. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.result.diff_results.*.path | string | Path of the setting. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.result.diff_results.*.description | string | Description of the setting. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.notifications | notifications | Notifications returned by the scan operation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.notifications.info | notification[] | Info notification messages reported. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. Only set if an info was reported by the task. |
| -.notifications.info[].notification | string | The notification Identifier. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.configuration.notification. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.configuration.notification. |
| -.notifications.info[].time | date_time | The time the notification was raised. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. Only set if the time information is available. |
| -.notifications.info[].message | localizable_message | The notification message. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.notifications.info[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| -.notifications.info[].message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| -.notifications.info[].message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| -.notifications.warnings | notification[] | Warning notification messages reported. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. Only set if an warning was reported by the task. |
| -.notifications.errors | notification[] | Error notification messages reported. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. Only set if an error was reported by the task. |
| -.scan_time | date_time | Scan completion time. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.commit | string | Identifier of the commit on which the scan is run to generate this result. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.configuration.commit. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.configuration.commit. |
| -.compliant_components | string[] | Identifiers of compliant components. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.configuration.component. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.configuration.component. |
| -.non_compliant_components | string[] | Identifiers of non-compliant components. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.configuration.component. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.configuration.component. |
| -.unavailable_components | string[] | Identifiers of unavailable components. There will not be compliance details for these components in appliance.configuration.profile_compliance.components. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.configuration.component. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.configuration.component. |
| -.components | object | Mapping from component identifier to the compliance information for the profile. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.appliance.configuration.component. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.appliance.configuration.component.Object with element values of type compliance_result. |
| -.component_info | object | Auxillary information about the components. This gives some additional information about the component referenced in this result. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.appliance.configuration.component. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.appliance.configuration.component.Object with element values of type component_info. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | If there is unknown internal error. The accompanying error message will give more details about the failure. |
| 404 | not_found | If there is no profile associated with profile in the system or if the compliance information is unavailable. |
| 503 | service_unavailable | If the service is not available. |
| 401 | unauthenticated | if the caller is not authenticated. |