Summary
Run Compliance Reports.
Description
Kick off one or more compliance checks for devices in a specified Golden Config tree.
Route
POST /configuration_manager/compliance_reports/config
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| deviceName |
string |
yes |
- |
| configuration |
string |
yes |
- |
Copied to Clipboard
{
"deviceName": "Cisco-Device.1",
"configuration": "interface Loopback1\n ip address 10.0.0.1\nntp server 105.62.30.158"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"deviceName": {
"title": "deviceName",
"type": "string",
"examples": [
"Cisco-Device.1"
]
},
"configuration": {
"title": "configuration",
"type": "string",
"examples": [
"interface Loopback1\n ip address 10.0.0.1\nntp server 105.62.30.158"
]
}
},
"required": [
"deviceName",
"configuration"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| runComplianceBatchResult |
object |
- |
Copied to Clipboard
{
"status": 202,
"message": "compliance batch ${batchId} started",
"batchId": "5c35355dbebaa82eaf8113f0"
}
Copied to Clipboard
{
"title": "runComplianceBatchResult",
"type": "object",
"properties": {
"status": {
"type": "integer",
"const": 202
},
"message": {
"type": "string",
"examples": [
"compliance batch ${batchId} started"
]
},
"batchId": {
"$ref": "common#/definitions/mongoObjectId"
}
}
}
