Summary
Auto remediate with additional options.
Description
Patch device configuration automatically from compliance report.
Route
No Northbound API Available
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
complianceReportId |
string |
yes |
- |
removeDisallowedConfig |
boolean |
yes |
- |
options |
object |
no |
Additional options to specify which items to remediate. |
Copied to Clipboard
{
"complianceReportId": "5c35355dbebaa82eaf8113f0",
"removeDisallowedConfig": false,
"options": {
"severity": "['warning']",
"type": "['required']"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"complianceReportId": {
"title": "complianceReportId",
"$ref": "common#/definitions/mongoObjectId"
},
"removeDisallowedConfig": {
"title": "removeDisallowedConfig",
"type": "boolean"
},
"options": {
"title": "options",
"type": "object",
"properties": {
"severity": {
"type": "array",
"examples": [
"['warning']"
]
},
"type": {
"type": "array",
"examples": [
"['required']"
]
}
}
}
},
"required": [
"complianceReportId",
"removeDisallowedConfig"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
remediationResult |
object |
- |
Copied to Clipboard
{
"response": [
{
"result": false,
"parents": [
"id"
],
"new": "ex",
"old": "aliquip id magna"
},
{
"result": true,
"parents": [
"ad",
"commodo ipsum eu cupidatat aliqua",
"id consectetur eiusmod",
"reprehenderit"
],
"new": "culpa nostrud adipisicing",
"old": "elit aliqua"
},
{
"result": true,
"parents": [
"pariatur proident",
"elit aute culpa dolore",
"labore",
"do incididunt reprehenderit dolor quis",
"anim"
],
"new": "est",
"old": "exercitation consequat aute"
},
{
"result": false,
"parents": [
"do deserunt sit nostrud velit",
"magna commodo et laboris labore",
"cillum veniam"
],
"new": "laboris magna anim",
"old": "consectetur"
}
]
}
Copied to Clipboard
{
"title": "remediationResult",
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"type": "object",
"properties": {
"result": {
"type": "boolean"
},
"parents": {
"type": "array",
"items": {
"type": "string"
}
},
"new": {
"type": "string"
},
"old": {
"type": "string"
}
}
}
}
}
}