{ "metadata": { "name": "@itentialopensource/configuration-compliance-and-remediation", "version": "0.2.7-2023.1.0", "description": "This Artifact showcases how to set up a Configuration Compliance and Remediation use case to prevent device configuration drift", "license": "Apache-2.0", "repository": { "type": "gitlab", "hostname": "gitlab.com", "path": "itentialopensource/pre-built-automations" }, "keywords": [ "Itential", "IAP", "App-Artifacts", "Artifact", "Demo", "ConfigManager", "Remediaton" ], "author": "Itential Artifacts", "IAPDependencies": { "@itential/app-operations_manager": "", "@itential/app-json_forms": "1.13.0", "@itential/app-workflow_engine": "6.7.10", "@itential/app-configuration_manager": "3.28.19" }, "gitlabId": 16510420 }, "manifest": { "bundleName": "Configuration Compliance And Remediation", "fingerprint": "5e2b53d1d5f48409e1f90a5c", "createdEpoch": "1579897809793", "artifacts": [ { "id": "Config Compliance & Remediation", "name": "Config Compliance & Remediation", "type": "automation", "location": "/bundles/automations/Config Compliance & Remediation.json", "properties": { "entryPoint": false } }, { "id": "Config Compliance and Remediation - Find Tree ID", "name": "Config Compliance and Remediation - Find Tree ID", "type": "workflow", "location": "/bundles/workflows/Config Compliance and Remediation - Find Tree ID.json", "properties": { "entryPoint": false } }, { "id": "Config Compliance and Remediation - Parent", "name": "Config Compliance and Remediation - Parent", "type": "workflow", "location": "/bundles/workflows/Config Compliance and Remediation - Parent.json", "properties": { "entryPoint": false } }, { "id": "Config Compliance and Remediation - Remediate", "name": "Config Compliance and Remediation - Remediate", "type": "workflow", "location": "/bundles/workflows/Config Compliance and Remediation - Remediate.json", "properties": { "entryPoint": false } }, { "id": "Config Compliance & Remediation", "name": "Config Compliance & Remediation", "type": "json-forms", "location": "/bundles/json_forms/Config Compliance & Remediation.json", "properties": { "entryPoint": false } }, { "id": "CSR1k config", "name": "CSR1k config", "type": "golden-config", "location": "/bundles/ucm_golden_configs/CSR1k config.json", "properties": { "entryPoint": false } } ] }, "bundles": [ { "type": "automation", "data": { "_id": "61d712881d80cd01af41ddd7", "name": "Config Compliance & Remediation", "description": "This Artifact is scheduled to run a weekly compliance check of all devices in a Configuration tree ", "componentName": "Config Compliance and Remediation - Parent", "componentType": "workflows", "gbac": { "write": [], "read": [] }, "created": "2022-01-06T16:02:16.834Z", "createdBy": "kay.wolfe@itential.com", "lastUpdated": "2022-01-06T16:02:16.834Z", "lastUpdatedBy": "kay.wolfe@itential.com", "triggers": [ { "_id": "61d712891d80cd01af41ddd8", "created": "2022-01-06T16:02:17.179Z", "createdBy": "kay.wolfe@itential.com", "lastUpdated": "2022-01-06T16:02:17.179Z", "lastUpdatedBy": "kay.wolfe@itential.com", "name": "Manual Trigger (migrated from Config Compliance & Remediation)", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "61d712881d80cd01af41ddd7", "formId": "Config Compliance & Remediation", "formData": { "configurationTree": "CSR1k config", "score": 90, "mode": "Zero Touch", "enableDisallowedConfigurationRemoval": false }, "migrationVersion": 1 } ] } }, { "type": "workflow", "data": { "name": "Config Compliance and Remediation - Find Tree ID", "tasks": { "workflow_start": { "name": "workflow_start", "groups": [], "x": -0.43859649122807, "y": 0.388686131386861, "summary": "workflow_start", "description": "workflow_start" }, "workflow_end": { "name": "workflow_end", "groups": [], "x": 0.355263157894737, "y": 0.430976430976431, "summary": "workflow_end", "description": "workflow_end" }, "d261": { "name": "getGoldenConfigTrees", "summary": "Get a list of all Golden Config trees.", "description": "Get a list of all Golden Config trees.", "location": "Application", "locationType": null, "app": "ConfigurationManager", "displayName": "ConfigurationManager", "type": "automatic", "variables": { "incoming": {}, "outgoing": { "goldenConfigTrees": null }, "translations": [] }, "deprecated": false, "groups": [], "actor": "Pronghorn", "x": -0.242982456140351, "y": 0.400673400673401 }, "98a7": { "name": "query", "summary": "Query Tree id", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": false, "query": "id", "obj": "$var.43de.current_item" }, "outgoing": { "return_data": "$var.job.treeId" }, "error": "", "translations": [ { "translations": [], "type": "*", "variable": "treeId" } ], "decorators": [] }, "deprecated": false, "groups": [], "x": 0.256140350877193, "y": -0.00505050505050505, "scheduled": false }, "43de": { "name": "forEach", "summary": "Loop over every tree", "description": "Iterate over each item in an array", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "data_array": "$var.d261.goldenConfigTrees" }, "outgoing": { "current_item": null }, "error": "", "translations": [] }, "deprecated": false, "groups": [], "x": 0.209649122807018, "y": 0.429292929292929, "scheduled": false }, "22c3": { "name": "evaluation", "summary": "Run Evaluation Task", "description": "Run an evaluation", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "all_true_flag": false, "evaluation_groups": [ { "all_true_flag": false, "evaluations": [ { "query": "name", "operand_1": { "variable": "current_item", "task": "43de" }, "operator": "==", "operand_2": { "variable": "treeName", "task": "job", "editable": true } } ] } ] }, "outgoing": { "return_value": null }, "translations": [] }, "deprecated": false, "groups": [], "x": 0.202631578947368, "y": 0.144781144781145 }, "c453": { "name": "newVariable", "summary": "Create a Job Variable", "description": "Create a new Job variable by Job ID and assign it a value.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "name": "treeId", "value": "" }, "outgoing": { "value": null }, "translations": [] }, "deprecated": false, "groups": [], "x": -0.04030501089324619, "y": 0.325626204238921 }, "6d58": { "name": "newVariable", "summary": "Create a Job Variable", "description": "Create a new Job variable by Job ID and assign it a value.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "name": "treeVersions", "value": "" }, "outgoing": { "value": null }, "translations": [] }, "deprecated": false, "groups": [], "x": -0.0447368421052632, "y": 0.65993265993266 }, "acd5": { "name": "query", "summary": "Query Tree versions", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": false, "query": "versions", "obj": "$var.43de.current_item" }, "outgoing": { "return_data": "$var.job.treeVersions" }, "error": "", "translations": [ { "translations": [], "type": "*", "variable": "treeVersions" } ], "decorators": [] }, "deprecated": false, "groups": [], "x": 0.143859649122807, "y": -0.00673400673400673, "scheduled": false } }, "transitions": { "5617": {}, "6047": {}, "7575": {}, "9666": {}, "workflow_start": { "d261": { "type": "standard", "state": "success" } }, "workflow_end": {}, "8f13": {}, "f128": {}, "777e": {}, "cc1b": {}, "d261": { "c453": { "type": "standard", "state": "success" }, "6d58": { "type": "standard", "state": "success" } }, "98a7": {}, "43de": { "22c3": { "type": "standard", "state": "loop" }, "workflow_end": { "type": "standard", "state": "success" } }, "22c3": { "98a7": { "type": "standard", "state": "success" }, "acd5": { "type": "standard", "state": "success" } }, "c453": { "43de": { "type": "standard", "state": "success" } }, "6d58": { "43de": { "type": "standard", "state": "success" } }, "acd5": {}, "f3ab": {}, "fe34": {} }, "font_size": 12, "created": "2020-02-19T01:29:11.921Z", "created_by": { "provenance": "Local AAA", "username": "admin@pronghorn", "firstname": "admin", "inactive": true, "email": "" }, "createdVersion": "4.5.3-2019.2.9.0", "last_updated": "2022-07-05T15:25:06.970Z", "last_updated_by": { "provenance": "Itential-Okta", "username": "robert.terpin@itential.com", "firstname": "Robert", "inactive": false }, "lastUpdatedVersion": "5.44.57", "type": "automation", "description": null, "inputSchema": { "type": "object", "properties": { "treeName": { "type": [ "array", "boolean", "null", "number", "object", "string" ] } }, "required": [ "treeName" ] }, "outputSchema": { "type": "object", "properties": { "treeName": { "type": [ "array", "boolean", "null", "number", "object", "string" ] }, "_id": { "type": "string", "pattern": "^[0-9a-f]{24}$" }, "initiator": { "type": "string" }, "treeId": { "title": "return_data", "type": [ "string", "number", "object", "integer", "array", "boolean", "null" ], "examples": [ "value" ] }, "treeVersions": { "title": "return_data", "type": [ "string", "number", "object", "integer", "array", "boolean", "null" ], "examples": [ "value" ] } } }, "canvasVersion": 1, "tags": [], "groups": [], "migrationVersion": 1 } }, { "type": "workflow", "data": { "name": "Config Compliance and Remediation - Parent", "tasks": { "3649": { "name": "query", "summary": "Query scorePass", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": false, "query": "scorePass", "obj": "$var.406b.job_details" }, "outgoing": { "return_data": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": 0.5181159420289855, "y": 0.2482394366197183, "scheduled": false }, "5463": { "name": "ViewData", "summary": "View Data", "description": "View data in a pretty format", "location": "Application", "app": "WorkFlowEngine", "displayName": "Tools", "type": "manual", "variables": { "incoming": { "header": "Remediation Results", "message": "", "body": "$var.7bbe.output", "variables": {}, "btn_success": "Finish", "btn_failure": "" }, "outgoing": {}, "error": "", "decorators": [] }, "view": "/workflow_engine/task/ViewData", "deprecated": false, "matched": [ { "key": "name", "highlightString": "ViewData" } ], "groups": [], "x": 0.7833333333333333, "y": 0.08274647887323944, "scheduled": false }, "5636": { "name": "query", "summary": "Query Tree Id", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": false, "query": "treeId", "obj": "$var.a61d.job_details" }, "outgoing": { "return_data": "$var.job.treeId" }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": -0.0236842105263158, "y": 0.489908256880734, "scheduled": false }, "9666": { "name": "query", "summary": "Query Compliance Reports Array", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": true, "query": "reports", "obj": "$var.ff62.runComplianceBatchResult" }, "outgoing": { "return_data": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": 0.20434782608695654, "y": 0.3485915492957746, "scheduled": false }, "workflow_start": { "name": "workflow_start", "groups": [], "x": -0.4072463768115942, "y": 0.34330985915492956, "summary": "workflow_start", "description": "workflow_start" }, "workflow_end": { "name": "workflow_end", "groups": [], "x": 0.9050724637681159, "y": 0.34330985915492956, "summary": "workflow_end", "description": "workflow_end" }, "b18f": { "name": "query", "summary": "Query Name", "description": "query name from incoming vars", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": false, "query": "configurationTree", "obj": "$var.job.formData" }, "outgoing": { "return_data": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": -0.322463768115942, "y": 0.352112676056338, "scheduled": false }, "ff62": { "name": "runComplianceForTree", "summary": "Run Compliance Reports (Tree)", "description": "Begin a compliance report run for a Golden Config tree.", "location": "Application", "locationType": null, "app": "ConfigurationManager", "displayName": "ConfigurationManager", "type": "automatic", "variables": { "incoming": { "treeId": "$var.job.treeId", "version": "$var.job.treeVersions", "variables": "", "grading": "" }, "outgoing": { "runComplianceBatchResult": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "runComplianceForTree" } ], "groups": [], "actor": "Pronghorn", "x": 0.09710144927536232, "y": 0.3362676056338028, "scheduled": false }, "fe34": { "name": "merge", "summary": "Merge Data", "description": "Merge data into a single object", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "data_to_merge": [ { "key": "scorePass", "value": { "task": "3649", "variable": "return_data" } }, { "key": "scoreFail", "value": { "task": "92c9", "variable": "return_data" } } ] }, "outgoing": { "merged_object": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "merge" }, { "key": "summary", "highlightString": "Merge Data" }, { "key": "description", "highlightString": "Merge data into a single object" } ], "groups": [], "x": 0.591304347826087, "y": 0.32922535211267606 }, "7bbe": { "name": "makeData", "summary": "Make Data", "description": "Make Data", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "Tools", "type": "automatic", "variables": { "incoming": { "input": "The following devices were remediated successfully:


The following devices were not remediated:


", "outputType": "string", "variables": "$var.fe34.merged_object" }, "outgoing": { "output": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "makeData" }, { "key": "summary", "highlightString": "Make Data" }, { "key": "description", "highlightString": "Make Data" } ], "groups": [], "actor": "Pronghorn", "x": 0.6695652173913044, "y": 0.3345070422535211, "scheduled": false }, "2dfc": { "name": "evaluation", "summary": "Run Evaluation Task", "description": "Run an evaluation", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "all_true_flag": false, "evaluation_groups": [ { "all_true_flag": false, "evaluations": [ { "query": "mode", "operand_1": { "variable": "formData", "task": "job" }, "operator": "==", "operand_2": { "variable": "Zero Touch", "task": "static" } } ] } ] }, "outgoing": { "return_value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "evaluation" }, { "key": "summary", "highlightString": "Run Evaluation Task" }, { "key": "description", "highlightString": "Run an evaluation" } ], "groups": [], "x": 0.7927536231884058, "y": 0.323943661971831 }, "a61d": { "name": "childJob", "summary": "Run Tree ID Flow", "description": "Run a child Job inside a Workflow", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "task": "", "workflow": "Config Compliance and Remediation - Find Tree ID", "variables": { "treeName": { "variable": "", "task": "b18f", "value": "return_data" } }, "data_array": "", "transformation": "", "loopType": "" }, "outgoing": { "job_details": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "childJob" }, { "key": "summary", "highlightString": "Run Child Job" }, { "key": "description", "highlightString": "Run a child Job inside a Workflow" } ], "groups": [], "actor": "job", "x": -0.17681159420289855, "y": 0.3485915492957746 }, "f2d0": { "name": "query", "summary": "Query Tree Version", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": false, "query": "treeVersions[0]", "obj": "$var.a61d.job_details" }, "outgoing": { "return_data": "$var.job.treeVersions" }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": -0.0298245614035088, "y": 0.238532110091743, "scheduled": false }, "92c9": { "name": "query", "summary": "Query scoreFail", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": false, "query": "scoreFail", "obj": "$var.406b.job_details" }, "outgoing": { "return_data": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": 0.5217391304347826, "y": 0.4454225352112676, "scheduled": false }, "406b": { "name": "childJob", "summary": "Run Remediation Flow", "description": "Run a child Job inside a Workflow", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "task": "", "workflow": "Config Compliance and Remediation - Remediate", "variables": { "treeId": { "variable": "", "task": "5636", "value": "return_data" }, "treeVersion": { "variable": "", "task": "f2d0", "value": "return_data" }, "complianceReportsArray": { "variable": "", "task": "9666", "value": "return_data" }, "formData": { "variable": "", "task": "job", "value": "formData" } }, "data_array": "", "transformation": "", "loopType": "" }, "outgoing": { "job_details": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "childJob" }, { "key": "summary", "highlightString": "Run Child Job" }, { "key": "description", "highlightString": "Run a child Job inside a Workflow" } ], "groups": [], "actor": "job", "x": 0.3746376811594203, "y": 0.3503521126760563 } }, "transitions": { "3649": { "fe34": { "type": "standard", "state": "success" } }, "5463": { "workflow_end": { "type": "standard", "state": "success" } }, "5617": {}, "5636": { "ff62": { "type": "standard", "state": "success" } }, "6047": {}, "9666": { "406b": { "type": "standard", "state": "success" } }, "workflow_start": { "b18f": { "type": "standard", "state": "success" } }, "workflow_end": {}, "b18f": { "a61d": { "type": "standard", "state": "success" } }, "f128": {}, "777e": {}, "ff62": { "9666": { "type": "standard", "state": "success" } }, "cc1b": {}, "d261": {}, "83d7": {}, "fe34": { "7bbe": { "type": "standard", "state": "success" } }, "7bbe": { "2dfc": { "type": "standard", "state": "success" } }, "2dfc": { "5463": { "type": "standard", "state": "failure" }, "workflow_end": { "type": "standard", "state": "success" } }, "a143": {}, "a61d": { "5636": { "type": "standard", "state": "success" }, "f2d0": { "type": "standard", "state": "success" } }, "f2d0": { "ff62": { "type": "standard", "state": "success" } }, "92c9": { "fe34": { "type": "standard", "state": "success" } }, "406b": { "3649": { "type": "standard", "state": "success" }, "92c9": { "type": "standard", "state": "success" } } }, "font_size": 12, "created": "2020-02-17T19:36:47.065Z", "created_by": { "provenance": "Local AAA", "username": "admin@pronghorn", "firstname": "admin", "inactive": true, "email": "" }, "createdVersion": "4.5.3-2019.2.9.0", "last_updated": "2022-01-06T18:29:23.929Z", "last_updated_by": { "provenance": "Itential-Okta", "username": "kay.wolfe@itential.com", "firstname": "Kay", "inactive": false, "email": "" }, "lastUpdatedVersion": "5.44.8-2021.2.0", "type": "automation", "description": null, "canvasVersion": 1, "inputSchema": { "type": "object", "properties": { "formData": { "type": "object", "examples": [ { "name": "value" } ] } }, "required": [ "formData" ] }, "outputSchema": { "type": "object", "properties": { "formData": { "type": "object", "examples": [ { "name": "value" } ] }, "_id": { "type": "string", "pattern": "^[0-9a-f]{24}$" }, "initiator": { "type": "string" }, "treeId": { "type": [ "string", "number", "object", "integer", "array", "boolean", "null" ], "examples": [ "value" ] }, "treeVersions": { "type": [ "string", "number", "object", "integer", "array", "boolean", "null" ], "examples": [ "value" ] } } }, "tags": [], "groups": [], "migrationVersion": 1 } }, { "type": "workflow", "data": { "name": "Config Compliance and Remediation - Remediate", "tasks": { "229": { "name": "runComplianceForDevice", "summary": "Run Compliance Report", "description": "Begin a compliance report run for a device.", "location": "Application", "locationType": null, "app": "ConfigurationManager", "displayName": "ConfigurationManager", "type": "automatic", "variables": { "incoming": { "treeId": "$var.job.treeId", "version": "$var.job.treeVersion", "deviceName": "$var.7bf2.return_data", "variables": "", "grading": "" }, "outgoing": { "runComplianceBatchResult": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "summary", "highlightString": "Run Compliance Report" }, { "key": "description", "highlightString": "Begin a compliance report run for a device." } ], "groups": [], "actor": "Pronghorn", "x": 0.9967320261437909, "y": 0.926056338028169, "scheduled": false }, "1116": { "name": "forEach", "summary": "For Each Compliance Report", "description": "Iterate over each item in an array", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "data_array": "$var.job.complianceReportsArray" }, "outgoing": { "current_item": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "forEach" } ], "groups": [], "x": 0.513157894736842, "y": 0.357664233576642, "scheduled": false }, "5617": { "name": "push", "summary": "Push Item to Array", "description": "Push item to a job variable array", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "job_variable": "scoreFail", "item_to_push": "$var.7bf2.return_data" }, "outgoing": { "job_variable_value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "push" }, { "key": "summary", "highlightString": "Push Item to Array" }, { "key": "description", "highlightString": "Push item to a job variable array" } ], "groups": [], "x": 1.144880174291939, "y": 1.2112676056338028 }, "6871": { "name": "makeData", "summary": "Make Data", "description": "Make Data", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "Tools", "type": "automatic", "variables": { "incoming": { "input": "The device was not remediated!
The old score was
The new score is
The Threshold score was

The following is the remediation report:


", "outputType": "string", "variables": "$var.5cbf.merged_object" }, "outgoing": { "output": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "makeData" }, { "key": "summary", "highlightString": "Make Data" }, { "key": "description", "highlightString": "Make Data" } ], "groups": [], "actor": "Pronghorn", "x": 0.967543859649123, "y": 1.22385321100917, "scheduled": false }, "7575": { "name": "evaluation", "summary": "Run Evaluation Task", "description": "Run an evaluation", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "all_true_flag": false, "evaluation_groups": [ { "all_true_flag": false, "evaluations": [ { "query": "score", "operand_1": { "variable": "formData", "task": "job" }, "operator": "<", "operand_2": { "variable": "score1", "task": "job" } } ] } ] }, "outgoing": { "return_value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "evaluation" }, { "key": "summary", "highlightString": "Run Evaluation Task" }, { "key": "description", "highlightString": "Run an evaluation" } ], "groups": [], "x": 0.533333333333333, "y": 0.967153284671533 }, "8579": { "name": "evaluation", "summary": "Run Evaluation Task", "description": "Run an evaluation", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "all_true_flag": false, "evaluation_groups": [ { "all_true_flag": false, "evaluations": [ { "query": "mode", "operand_1": { "variable": "formData", "task": "job" }, "operator": "==", "operand_2": { "variable": "Zero Touch", "task": "static" } } ] } ] }, "outgoing": { "return_value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "evaluation" }, { "key": "summary", "highlightString": "Run Evaluation Task" }, { "key": "description", "highlightString": "Run an evaluation" } ], "groups": [], "x": 0.808771929824561, "y": 0.622018348623853 }, "9380": { "name": "query", "summary": "Query Config Check Score 1", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": true, "query": "score", "obj": "$var.1116.current_item" }, "outgoing": { "return_data": "$var.job.score1" }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": 0.6045751633986928, "y": 0.6109154929577465, "scheduled": false }, "workflow_start": { "name": "workflow_start", "groups": [], "x": 0.0894736842105263, "y": 0.387205387205387, "summary": "workflow_start", "description": "workflow_start" }, "workflow_end": { "name": "workflow_end", "groups": [], "x": 0.67280701754386, "y": 0.335016835016835, "summary": "workflow_end", "description": "workflow_end" }, "e475": { "name": "runAutoRemediation", "summary": "Push Configuration", "description": "Patch device configuration automatically from compliance report", "location": "Application", "locationType": null, "app": "ConfigurationManager", "displayName": "ConfigurationManager", "type": "automatic", "variables": { "incoming": { "complianceReportId": "$var.8f13.return_data", "removeDisallowedConfig": "$var.a143.return_data" }, "outgoing": { "remediationResult": null }, "error": "$var.job.pushConfigError" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "runAutoRemediation" } ], "groups": [], "actor": "Pronghorn", "x": 0.702631578947368, "y": 0.930275229357798, "scheduled": false }, "8f13": { "name": "query", "summary": "Query ReportID", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": true, "query": "reportId", "obj": "$var.1116.current_item" }, "outgoing": { "return_data": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": 0.516666666666667, "y": 0.607664233576642, "scheduled": false }, "7bf2": { "name": "query", "summary": "Query DeviceInReport", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": true, "query": "device", "obj": "$var.1116.current_item" }, "outgoing": { "return_data": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": 0.418421052631579, "y": 0.614963503649635, "scheduled": false }, "ee9d": { "name": "query", "summary": "Query Config Check Score 2", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": true, "query": "score", "obj": "$var.229.runComplianceBatchResult" }, "outgoing": { "return_data": "$var.job.score2" }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": 1.1644880174291938, "y": 0.9242957746478874, "scheduled": false }, "e996": { "name": "ViewData", "summary": "Remediation Run", "description": "View data in a pretty format", "location": "Application", "app": "WorkFlowEngine", "displayName": "Tools", "type": "manual", "variables": { "incoming": { "header": "Successful Device Remediation run", "message": "$var.7bf2.return_data", "body": "$var.e279.output", "variables": {}, "btn_success": "Go to Next Device", "btn_failure": "" }, "outgoing": {}, "error": "", "decorators": [] }, "view": "/workflow_engine/task/ViewData", "deprecated": false, "matched": [ { "key": "name", "highlightString": "ViewData" } ], "groups": [], "x": 0.954385964912281, "y": 1.52293577981651, "scheduled": false }, "2d43": { "name": "evaluation", "summary": "Run Evaluation Task", "description": "Run an evaluation", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "all_true_flag": false, "evaluation_groups": [ { "all_true_flag": false, "evaluations": [ { "query": "score", "operand_1": { "variable": "formData", "task": "job" }, "operator": "<", "operand_2": { "variable": "score2", "task": "job" } } ] } ] }, "outgoing": { "return_value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "evaluation" }, { "key": "summary", "highlightString": "Run Evaluation Task" }, { "key": "description", "highlightString": "Run an evaluation" } ], "groups": [], "x": 1.3140350877193, "y": 1.2256880733945 }, "dc8": { "name": "newVariable", "summary": "Create a Job Variable", "description": "Create a new Job variable by Job ID and assign it a value.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "name": "scoreFail", "value": [] }, "outgoing": { "value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "newVariable" } ], "groups": [], "x": 0.225438596491228, "y": 0.381386861313869 }, "f3ab": { "name": "newVariable", "summary": "Create a Job Variable", "description": "Create a new Job variable by Job ID and assign it a value.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "name": "scorePass", "value": [] }, "outgoing": { "value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "newVariable" } ], "groups": [], "x": 0.357017543859649, "y": 0.375420875420875 }, "83d7": { "name": "push", "summary": "Push Item to Array", "description": "Push item to a job variable array", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "job_variable": "scorePass", "item_to_push": "$var.7bf2.return_data" }, "outgoing": { "job_variable_value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "push" }, { "key": "summary", "highlightString": "Push Item to Array" }, { "key": "description", "highlightString": "Push item to a job variable array" } ], "groups": [], "x": 0.358771929824561, "y": 0.961678832116788 }, "f923": { "name": "push", "summary": "Push Item to Array", "description": "Push item to a job variable array", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "job_variable": "scorePass", "item_to_push": "$var.7bf2.return_data" }, "outgoing": { "job_variable_value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "push" }, { "key": "summary", "highlightString": "Push Item to Array" }, { "key": "description", "highlightString": "Push item to a job variable array" } ], "groups": [], "x": 1.44298245614035, "y": 1.2348623853211 }, "d344": { "name": "evaluation", "summary": "Run Evaluation Task", "description": "Run an evaluation", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "all_true_flag": false, "evaluation_groups": [ { "all_true_flag": false, "evaluations": [ { "query": "mode", "operand_1": { "variable": "formData", "task": "job" }, "operator": "==", "operand_2": { "variable": "Zero Touch", "task": "static" } } ] } ] }, "outgoing": { "return_value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "evaluation" }, { "key": "summary", "highlightString": "Run Evaluation Task" }, { "key": "description", "highlightString": "Run an evaluation" } ], "groups": [], "x": 1.3219298245614, "y": 1.52477064220183 }, "a143": { "name": "query", "summary": "Query enableDisallowedConfigRemoval", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": false, "query": "enableDisallowedConfigurationRemoval", "obj": "$var.job.formData" }, "outgoing": { "return_data": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": 0.4651416122004357, "y": 0.7764084507042254, "scheduled": false }, "8ef9": { "name": "backUpDevice", "summary": "Backup device configuration", "description": "Backup device configuration in mongo", "location": "Application", "locationType": null, "app": "ConfigurationManager", "displayName": "ConfigurationManager", "type": "automatic", "variables": { "incoming": { "name": "$var.7bf2.return_data", "options": {} }, "outgoing": { "status": null }, "error": "", "decorators": [] }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "backUpDevice" }, { "key": "summary", "highlightString": "Backup device configuration" }, { "key": "description", "highlightString": "Backup device configuration in mongo" } ], "groups": [], "actor": "Pronghorn", "x": 0.546491228070175, "y": 1.24036697247706, "scheduled": false }, "5cbf": { "name": "merge", "summary": "Merge Data", "description": "Merge data into a single object", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "data_to_merge": [ { "key": "oldScore", "value": { "task": "9380", "variable": "return_data" } }, { "key": "newScore", "value": { "task": "ee9d", "variable": "return_data" } }, { "key": "pushResult", "value": { "task": "e475", "variable": "remediationResult" } }, { "key": "thresholdScore", "value": { "task": "de1a", "variable": "return_data" } } ] }, "outgoing": { "merged_object": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "merge" }, { "key": "summary", "highlightString": "Merge Data" }, { "key": "description", "highlightString": "Merge data into a single object" } ], "groups": [], "x": 1.3115468409586057, "y": 0.9313380281690141 }, "e279": { "name": "makeData", "summary": "Push Results and scores", "description": "Push Results and scores", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "Tools", "type": "automatic", "variables": { "incoming": { "input": "The device was remediated successfully!
The old score was The new score is
The Threshold score was

The following is the remediation report:


", "outputType": "string", "variables": "$var.5cbf.merged_object" }, "outgoing": { "output": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "makeData" }, { "key": "summary", "highlightString": "Make Data" }, { "key": "description", "highlightString": "Make Data" } ], "groups": [], "actor": "Pronghorn", "x": 1.14473684210526, "y": 1.51192660550459, "scheduled": false }, "3d1b": { "name": "push", "summary": "Push Item to Array", "description": "Push item to a job variable array", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "job_variable": "scoreFail", "item_to_push": "$var.7bf2.return_data" }, "outgoing": { "job_variable_value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "push" }, { "key": "summary", "highlightString": "Push Item to Array" }, { "key": "description", "highlightString": "Push item to a job variable array" } ], "groups": [], "x": 0.700877192982456, "y": 0.631192660550459 }, "a861": { "name": "ViewData", "summary": "Remediation Run", "description": "View data in a pretty format", "location": "Application", "app": "WorkFlowEngine", "displayName": "Tools", "type": "manual", "variables": { "incoming": { "header": "Unsuccessful Device Remediation run", "message": "$var.7bf2.return_data", "body": "$var.c3fa.return_data", "variables": {}, "btn_success": "Go to Next Device", "btn_failure": "" }, "outgoing": {}, "error": "", "decorators": [] }, "view": "/workflow_engine/task/ViewData", "deprecated": false, "matched": [ { "key": "name", "highlightString": "ViewData" } ], "groups": [], "x": 1.18245614035088, "y": 0.622018348623853, "scheduled": false }, "d14b": { "name": "evaluation", "summary": "Run Evaluation Task", "description": "Run an evaluation", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "all_true_flag": false, "evaluation_groups": [ { "all_true_flag": false, "evaluations": [ { "query": "message", "operand_1": { "variable": "remediationResult", "task": "e475" }, "operator": "!contains", "operand_2": { "variable": "success", "task": "static" } } ] } ] }, "outgoing": { "return_value": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "evaluation" }, { "key": "summary", "highlightString": "Run Evaluation Task" }, { "key": "description", "highlightString": "Run an evaluation" } ], "groups": [], "x": 0.814035087719298, "y": 0.928440366972477 }, "3f9c": { "name": "merge", "summary": "Merge All Unsuccessful data", "description": "Merge data into a single object", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "data_to_merge": [ { "key": "", "value": { "task": "6871", "variable": "output" } }, { "key": "", "value": { "task": "job", "variable": "pushConfigError" } }, { "key": "", "value": { "task": "e475", "variable": "remediationResult" } } ] }, "outgoing": { "merged_object": null } }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "merge" }, { "key": "summary", "highlightString": "Merge Data" }, { "key": "description", "highlightString": "Merge data into a single object" } ], "groups": [], "x": 0.957017543859649, "y": 0.620183486238532 }, "de1a": { "name": "query", "summary": "Query threshold score", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": false, "query": "score", "obj": "$var.job.formData" }, "outgoing": { "return_data": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": 0.5827886710239651, "y": 0.7623239436619719, "scheduled": false }, "c3fa": { "name": "query", "summary": "Query the merged unsuccessful result", "description": "Query data using a dot/bracket notation string and a matching key/value pair.", "location": "Application", "locationType": null, "app": "WorkFlowEngine", "displayName": "WorkFlowEngine", "type": "operation", "variables": { "incoming": { "pass_on_null": true, "query": "[0]", "obj": "$var.3f9c.merged_object" }, "outgoing": { "return_data": null }, "error": "" }, "deprecated": false, "matched": [ { "key": "name", "highlightString": "query" }, { "key": "summary", "highlightString": "Query Data Using 'json-query' Format" }, { "key": "description", "highlightString": "Query data using a dot/bracket notation string and a matching key/value pair." } ], "groups": [], "x": 1.0359649122807, "y": 0.61651376146789, "scheduled": false } }, "transitions": { "229": { "ee9d": { "type": "standard", "state": "success" } }, "1116": { "8f13": { "type": "standard", "state": "loop" }, "workflow_end": { "type": "standard", "state": "success" } }, "5617": { "6871": { "type": "standard", "state": "success" } }, "6047": {}, "6871": { "3f9c": { "type": "standard", "state": "success" } }, "7575": { "e475": { "type": "standard", "state": "failure" }, "83d7": { "type": "standard", "state": "success" }, "8ef9": { "type": "standard", "state": "failure" } }, "8579": { "3f9c": { "type": "standard", "state": "failure" } }, "9380": { "de1a": { "type": "standard", "state": "success" } }, "workflow_start": { "dc8": { "type": "standard", "state": "success" } }, "workflow_end": {}, "e475": { "3d1b": { "type": "standard", "state": "error" }, "d14b": { "type": "standard", "state": "success" } }, "8f13": { "9380": { "type": "standard", "state": "success" }, "7bf2": { "type": "standard", "state": "success" } }, "7bf2": { "a143": { "type": "standard", "state": "success" } }, "f128": {}, "ee9d": { "5cbf": { "type": "standard", "state": "success" } }, "777e": {}, "e996": {}, "cc1b": {}, "2d43": { "5617": { "type": "standard", "state": "failure" }, "f923": { "type": "standard", "state": "success" }, "d344": { "type": "standard", "state": "success" } }, "d261": {}, "dc8": { "f3ab": { "type": "standard", "state": "success" } }, "f3ab": { "1116": { "type": "standard", "state": "success" } }, "83d7": {}, "f923": {}, "d344": { "e279": { "type": "standard", "state": "failure" } }, "a143": { "7575": { "type": "standard", "state": "success" } }, "8ef9": {}, "5cbf": { "2d43": { "type": "standard", "state": "success" } }, "e279": { "e996": { "type": "standard", "state": "success" } }, "3d1b": { "8579": { "type": "standard", "state": "success" } }, "93d": {}, "c6d9": {}, "ee5f": {}, "a861": {}, "d14b": { "229": { "type": "standard", "state": "success" }, "8579": { "type": "standard", "state": "failure" } }, "3f9c": { "c3fa": { "type": "standard", "state": "success" } }, "de1a": { "7575": { "type": "standard", "state": "success" } }, "c3fa": { "a861": { "type": "standard", "state": "success" } }, "5daa": {}, "d0d1": {} }, "font_size": 12, "created": "2020-02-17T19:36:47.065Z", "created_by": { "provenance": "Local AAA", "username": "admin@pronghorn", "firstname": "admin", "inactive": true, "email": "" }, "createdVersion": "4.5.3-2019.2.9.0", "last_updated": "2022-01-06T18:27:09.748Z", "last_updated_by": { "provenance": "Itential-Okta", "username": "kay.wolfe@itential.com", "firstname": "Kay", "inactive": false, "email": "" }, "lastUpdatedVersion": "5.44.8-2021.2.0", "type": "automation", "description": null, "canvasVersion": 1, "inputSchema": { "type": "object", "properties": { "treeId": { "type": [ "array", "boolean", "null", "number", "object", "string" ] }, "treeVersion": { "type": [ "array", "boolean", "null", "number", "object", "string" ] }, "complianceReportsArray": { "type": "array" }, "formData": { "type": "object", "examples": [ { "name": "value" } ] } }, "required": [ "treeId", "treeVersion", "complianceReportsArray", "formData" ] }, "outputSchema": { "type": "object", "properties": { "treeId": { "type": [ "array", "boolean", "null", "number", "object", "string" ] }, "treeVersion": { "type": [ "array", "boolean", "null", "number", "object", "string" ] }, "complianceReportsArray": { "type": "array" }, "formData": { "type": "object", "examples": [ { "name": "value" } ] }, "_id": { "type": "string", "pattern": "^[0-9a-f]{24}$" }, "initiator": { "type": "string" }, "scoreFail": { "type": [ "array", "boolean", "null", "number", "object", "string" ] }, "score1": { "type": [ "string", "number", "object", "integer", "array", "boolean", "null" ], "examples": [ "value" ] }, "pushConfigError": { "type": [ "array", "boolean", "null", "number", "object", "string" ] }, "score2": { "type": [ "string", "number", "object", "integer", "array", "boolean", "null" ], "examples": [ "value" ] }, "scorePass": { "type": [ "array", "boolean", "null", "number", "object", "string" ] } } }, "tags": [], "groups": [], "migrationVersion": 1 } }, { "type": "json-forms", "data": { "id": "5e553a3729e427093c4fbc05", "created": "2020-01-24T18:55:34.587Z", "createdBy": "admin@pronghorn", "lastUpdated": "2021-11-19T14:10:24.244Z", "lastUpdatedBy": "admin@pronghorn", "name": "Config Compliance & Remediation", "description": null, "struct": { "type": "array", "items": [ { "nodeId": "56b5529c-29f2-46c0-aeb2-84ad5c48a238", "type": "string", "title": "Configuration Tree", "description": "", "placeholder": "", "required": true, "enum": [], "binding": true, "rel": "collection", "targetPointer": "/enum", "method": "GET", "base": "/configuration_manager", "href": "/configs", "sourcePointer": "/", "sourceKeyPointer": "/name" }, { "nodeId": "2fd91b47-d4e7-4c85-9852-032de5f730d4", "type": "number", "widget": "updown", "title": "Score", "description": "Enter a score between 0-100", "placeholder": "0-100", "required": true }, { "nodeId": "79ddeb8b-76ec-4e47-bb84-c61146af8e15", "type": "string", "title": "Mode", "description": "", "placeholder": "", "required": true, "enum": [ { "id": "9e1a0a12-c667-4795-9d71-b7ea8e108ed4", "value": "Zero Touch" }, { "id": "06a3472e-efd2-4b93-a5b8-ebe623c1a90d", "value": "Verbose" } ], "binding": false, "rel": "collection", "targetPointer": "/enum" }, { "nodeId": "f12c5b7a-70aa-4a8f-bba9-3fd7e95e5ddf", "type": "boolean", "title": "Enable disallowed configuration removal", "description": "", "default": true } ] }, "schema": { "title": "Config Compliance & Remediation", "description": "", "type": "object", "required": [ "configurationTree", "score", "mode" ], "properties": { "configurationTree": { "type": "string", "title": "Configuration Tree", "description": "", "enum": [] }, "score": { "type": "number", "title": "Score", "description": "Enter a score between 0-100" }, "mode": { "type": "string", "title": "Mode", "description": "", "enum": [ "Zero Touch", "Verbose" ] }, "enableDisallowedConfigurationRemoval": { "type": "boolean", "title": "Enable disallowed configuration removal", "description": "", "default": true } } }, "uiSchema": { "score": { "ui:placeholder": "0-100", "ui:widget": "updown" } }, "bindingSchema": { "properties": { "configurationTree": { "binding:method": "GET", "binding:link": { "$ref": "/links", "rel": "collection" }, "binding:target": { "propertyPointer": "/enum" }, "binding:hyperSchema": { "type": "object", "base": "/configuration_manager", "links": [ { "rel": "collection", "href": "/configs", "targetMediaType": "application/json", "targetSchema": { "$ref": "#" } } ] }, "binding:source": { "propertyPointer": "/", "keyPointer": "/name" } } } }, "validationSchema": {}, "version": "2020.1" } }, { "type": "golden-config", "data": { "status": "success", "data": [ { "_id": "5e2b445a3475aa09250fd445", "name": "CSR1k config", "treeId": "5e2b445a3475aa09250fd444", "version": "initial", "deviceType": "cisco-ios", "root": { "name": "base", "attributes": { "devices": [], "remediationWorkflow": null, "configId": "5e2b445a3475aa09250fd443", "export": { "_id": "5e2b445a3475aa09250fd443", "deviceType": "cisco-ios", "lines": [ { "evalMode": "required", "severity": "warning", "id": "5e2b44d851e2be5c", "words": [ { "type": "literal", "value": "version" }, { "type": "literal", "value": "12.2" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8c9fd71b6", "words": [ { "type": "literal", "value": "service" }, { "type": "literal", "value": "pad" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8835ccf6a", "words": [ { "type": "literal", "value": "service" }, { "type": "literal", "value": "tcp-keepalives-in" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d801257388", "words": [ { "type": "literal", "value": "service" }, { "type": "literal", "value": "tcp-keepalives-out" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8b8617a82", "words": [ { "type": "literal", "value": "service" }, { "type": "literal", "value": "timestamps" }, { "type": "literal", "value": "debug" }, { "type": "literal", "value": "datetime" }, { "type": "literal", "value": "msec" }, { "type": "literal", "value": "localtime" }, { "type": "literal", "value": "show-timezone" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d870facd15", "words": [ { "type": "literal", "value": "service" }, { "type": "literal", "value": "timestamps" }, { "type": "literal", "value": "log" }, { "type": "literal", "value": "datetime" }, { "type": "literal", "value": "msec" }, { "type": "literal", "value": "localtime" }, { "type": "literal", "value": "show-timezone" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8c483137d", "words": [ { "type": "literal", "value": "service" }, { "type": "literal", "value": "password-encryption" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d888a9a383", "words": [ { "type": "literal", "value": "hostname" }, { "type": "literal", "value": "lab2-b-009" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8bed9f2b7", "words": [ { "type": "literal", "value": "logging" }, { "type": "literal", "value": "console" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d83477d6f5", "words": [ { "type": "literal", "value": "enable" }, { "type": "literal", "value": "secret" }, { "type": "literal", "value": "5" }, { "type": "literal", "value": "$1$W5X0$YwqXhRgUjzAvFSB6WdTEr0" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8791d1259", "words": [ { "type": "literal", "value": "aaa" }, { "type": "literal", "value": "new-model" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d80c9b7077", "words": [ { "type": "literal", "value": "aaa" }, { "type": "literal", "value": "authentication" }, { "type": "literal", "value": "login" }, { "type": "literal", "value": "default" }, { "type": "literal", "value": "group" }, { "type": "literal", "value": "radius" }, { "type": "literal", "value": "enable" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d85b6cde90", "words": [ { "type": "literal", "value": "aaa" }, { "type": "literal", "value": "accounting" }, { "type": "literal", "value": "exec" }, { "type": "literal", "value": "default" }, { "type": "literal", "value": "start-stop" }, { "type": "literal", "value": "group" }, { "type": "literal", "value": "tacacs+" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8a9900187", "words": [ { "type": "literal", "value": "aaa" }, { "type": "literal", "value": "accounting" }, { "type": "literal", "value": "commands" }, { "type": "literal", "value": "1" }, { "type": "literal", "value": "default" }, { "type": "literal", "value": "stop-only" }, { "type": "literal", "value": "group" }, { "type": "literal", "value": "tacacs+" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d807a6510f", "words": [ { "type": "literal", "value": "aaa" }, { "type": "literal", "value": "accounting" }, { "type": "literal", "value": "commands" }, { "type": "literal", "value": "15" }, { "type": "literal", "value": "default" }, { "type": "literal", "value": "stop-only" }, { "type": "literal", "value": "group" }, { "type": "literal", "value": "tacacs+" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d871869c58", "words": [ { "type": "literal", "value": "aaa" }, { "type": "literal", "value": "session-id" }, { "type": "literal", "value": "common" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d85fdf195a", "words": [ { "type": "literal", "value": "clock" }, { "type": "literal", "value": "timezone" }, { "type": "literal", "value": "EST" }, { "type": "literal", "value": "10" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d83bdc186f", "words": [ { "type": "literal", "value": "clock" }, { "type": "literal", "value": "summer-time" }, { "type": "literal", "value": "ESDT" }, { "type": "literal", "value": "recurring" }, { "type": "literal", "value": "1" }, { "type": "literal", "value": "Sun" }, { "type": "literal", "value": "Oct" }, { "type": "literal", "value": "2:00" }, { "type": "literal", "value": "1" }, { "type": "literal", "value": "Sun" }, { "type": "literal", "value": "Apr" }, { "type": "literal", "value": "3:00" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8c80dcdf8", "words": [ { "type": "literal", "value": "system" }, { "type": "literal", "value": "mtu" }, { "type": "literal", "value": "routing" }, { "type": "literal", "value": "1998" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d82c1bb7c2", "words": [ { "type": "literal", "value": "authentication" }, { "type": "literal", "value": "mac-move" }, { "type": "literal", "value": "permit" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d844461aa6", "words": [ { "type": "literal", "value": "udld" }, { "type": "literal", "value": "message" }, { "type": "literal", "value": "time" }, { "type": "literal", "value": "7" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d824f445ac", "words": [ { "type": "literal", "value": "ip" }, { "type": "literal", "value": "subnet-zero" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d84e436146", "words": [ { "type": "literal", "value": "ip" }, { "type": "literal", "value": "gratuitous-arps" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d89a95ae23", "words": [ { "type": "literal", "value": "ip" }, { "type": "literal", "value": "domain" }, { "type": "literal", "value": "name" }, { "type": "literal", "value": "itential.com" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d81cff613a", "words": [ { "type": "literal", "value": "ip" }, { "type": "literal", "value": "name-server" }, { "type": "literal", "value": "1.1.1.1" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d855d1a6e6", "words": [ { "type": "literal", "value": "ip" }, { "type": "literal", "value": "igmp" }, { "type": "literal", "value": "snooping" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d897d168ed", "words": [ { "type": "literal", "value": "spanning-tree" }, { "type": "literal", "value": "mode" }, { "type": "literal", "value": "pvst" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d818bbde39", "words": [ { "type": "literal", "value": "spanning-tree" }, { "type": "literal", "value": "etherchannel" }, { "type": "literal", "value": "guard" }, { "type": "literal", "value": "misconfig" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8d193e6f3", "words": [ { "type": "literal", "value": "spanning-tree" }, { "type": "literal", "value": "extend" }, { "type": "literal", "value": "system-id" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8f3dbcebe", "words": [ { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "internal" }, { "type": "literal", "value": "allocation" }, { "type": "literal", "value": "policy" }, { "type": "literal", "value": "ascending" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8842187bc", "words": [ { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "dot1q" }, { "type": "literal", "value": "tag" }, { "type": "literal", "value": "native" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d8348726d7", "words": [ { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "3" } ], "lines": [ { "evalMode": "required", "severity": "warning", "id": "5e2b44d87e925009", "words": [ { "type": "literal", "value": "name" }, { "type": "literal", "value": "PortParking" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d86d91f2ca", "words": [ { "type": "literal", "value": "state" }, { "type": "literal", "value": "suspend" } ], "lines": [] } ] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d862f8b946", "words": [ { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "996" } ], "lines": [ { "evalMode": "required", "severity": "warning", "id": "5e2b44d89b4d2e09", "words": [ { "type": "literal", "value": "name" }, { "type": "literal", "value": "Management996" } ], "lines": [] } ] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44d81b82acfd", "words": [ { "type": "literal", "value": "ip" }, { "type": "literal", "value": "finger" } ], "lines": [] } ], "created": "2020-01-24T19:24:10.572Z", "createdBy": "5dc057f8056099373694eaac", "lastUpdated": "2020-01-24T19:26:17.582Z", "lastUpdatedBy": "5dc057f8056099373694eaac" } }, "children": [ { "name": "Day1 - US", "attributes": { "devices": [], "remediationWorkflow": null, "configId": "5e2b44a43475aa09250fd446", "export": { "_id": "5e2b44a43475aa09250fd446", "deviceType": "cisco-ios", "lines": [ { "evalMode": "required", "severity": "warning", "id": "5e2b44b5aae5bcbd", "words": [ { "type": "literal", "value": "spanning-tree" }, { "type": "literal", "value": "mode" }, { "type": "literal", "value": "pvst" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b536595c26", "words": [ { "type": "literal", "value": "spanning-tree" }, { "type": "literal", "value": "etherchannel" }, { "type": "literal", "value": "guard" }, { "type": "literal", "value": "misconfig" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b572a1caf1", "words": [ { "type": "literal", "value": "spanning-tree" }, { "type": "literal", "value": "extend" }, { "type": "literal", "value": "system-id" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b530e4c859", "words": [ { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "internal" }, { "type": "literal", "value": "allocation" }, { "type": "literal", "value": "policy" }, { "type": "literal", "value": "ascending" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5ce6a696c", "words": [ { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "dot1q" }, { "type": "literal", "value": "tag" }, { "type": "literal", "value": "native" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5e2447757", "words": [ { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "3" } ], "lines": [ { "evalMode": "required", "severity": "warning", "id": "5e2b44b57fea44cc", "words": [ { "type": "literal", "value": "name" }, { "type": "literal", "value": "PortParking" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b59b902756", "words": [ { "type": "literal", "value": "state" }, { "type": "literal", "value": "suspend" } ], "lines": [] } ] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5be4c61da", "words": [ { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "996" } ], "lines": [ { "evalMode": "required", "severity": "warning", "id": "5e2b44b550dbc885", "words": [ { "type": "literal", "value": "name" }, { "type": "literal", "value": "Management996" } ], "lines": [] } ] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b561f82da1", "words": [ { "type": "literal", "value": "ip" }, { "type": "literal", "value": "finger" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5025d6867", "words": [ { "type": "literal", "value": "interface" }, { "type": "literal", "value": "GigabitEthernet0/1" } ], "lines": [ { "evalMode": "required", "severity": "warning", "id": "5e2b44b518d2dabe", "words": [ { "type": "literal", "value": "description" }, { "type": "literal", "value": "***" }, { "type": "literal", "value": "PARKED" }, { "type": "literal", "value": "PORT" }, { "type": "literal", "value": "***" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b566ab3815", "words": [ { "type": "literal", "value": "switchport" }, { "type": "literal", "value": "access" }, { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "3" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5ebcc4698", "words": [ { "type": "literal", "value": "shutdown" } ], "lines": [] } ] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5584bc6b6", "words": [ { "type": "literal", "value": "interface" }, { "type": "literal", "value": "GigabitEthernet0/2" } ], "lines": [ { "evalMode": "required", "severity": "warning", "id": "5e2b44b53b3e87fc", "words": [ { "type": "literal", "value": "description" }, { "type": "literal", "value": "***" }, { "type": "literal", "value": "PARKED" }, { "type": "literal", "value": "PORT" }, { "type": "literal", "value": "***" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b54d83d165", "words": [ { "type": "literal", "value": "switchport" }, { "type": "literal", "value": "access" }, { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "3" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5f20d048d", "words": [ { "type": "literal", "value": "shutdown" } ], "lines": [] } ] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b552d636b2", "words": [ { "type": "literal", "value": "interface" }, { "type": "literal", "value": "GigabitEthernet0/3" } ], "lines": [ { "evalMode": "required", "severity": "warning", "id": "5e2b44b57cae1f0f", "words": [ { "type": "literal", "value": "description" }, { "type": "literal", "value": "To" }, { "type": "literal", "value": "TLAB-S-020" }, { "type": "literal", "value": "GigabitEthernet" }, { "type": "literal", "value": "0/1" }, { "type": "literal", "value": "[J" }, { "type": "literal", "value": "LAB2" }, { "type": "literal", "value": "TLAB" }, { "type": "literal", "value": "K102]" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5514f4ac9", "words": [ { "type": "literal", "value": "port-type" }, { "type": "literal", "value": "nni" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b57d589e9a", "words": [ { "type": "literal", "value": "switchport" }, { "type": "literal", "value": "trunk" }, { "type": "literal", "value": "allowed" }, { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "1,996" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5afbe700d", "words": [ { "type": "literal", "value": "switchport" }, { "type": "literal", "value": "mode" }, { "type": "literal", "value": "trunk" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5e76c514a", "words": [ { "type": "literal", "value": "switchport" }, { "type": "literal", "value": "backup" }, { "type": "literal", "value": "interface" }, { "type": "literal", "value": "Gi0/4" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5b799394f", "words": [ { "type": "literal", "value": "udld" }, { "type": "literal", "value": "port" }, { "type": "literal", "value": "aggressive" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5cb9c8ac5", "words": [ { "type": "literal", "value": "storm-control" }, { "type": "literal", "value": "broadcast" }, { "type": "literal", "value": "level" }, { "type": "literal", "value": "5.00" } ], "lines": [] } ] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b50302b664", "words": [ { "type": "literal", "value": "interface" }, { "type": "literal", "value": "GigabitEthernet0/4" } ], "lines": [ { "evalMode": "required", "severity": "warning", "id": "5e2b44b5ef668f94", "words": [ { "type": "literal", "value": "description" }, { "type": "literal", "value": "RESERVED" }, { "type": "literal", "value": "FOR" }, { "type": "literal", "value": "FLEXLINK" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5c30cec94", "words": [ { "type": "literal", "value": "port-type" }, { "type": "literal", "value": "nni" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b592a50125", "words": [ { "type": "literal", "value": "switchport" }, { "type": "literal", "value": "trunk" }, { "type": "literal", "value": "allowed" }, { "type": "literal", "value": "vlan" }, { "type": "literal", "value": "1,996" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5419f92e3", "words": [ { "type": "literal", "value": "switchport" }, { "type": "literal", "value": "mode" }, { "type": "literal", "value": "trunk" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b5ce8e92b0", "words": [ { "type": "literal", "value": "shutdown" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b57a4403fb", "words": [ { "type": "literal", "value": "udld" }, { "type": "literal", "value": "port" }, { "type": "literal", "value": "aggressive" } ], "lines": [] }, { "evalMode": "required", "severity": "warning", "id": "5e2b44b53f606925", "words": [ { "type": "literal", "value": "storm-control" }, { "type": "literal", "value": "broadcast" }, { "type": "literal", "value": "level" }, { "type": "literal", "value": "5.00" } ], "lines": [] } ] } ], "created": "2020-01-24T19:25:24.187Z", "createdBy": "5dc057f8056099373694eaac", "lastUpdated": "2020-01-24T19:25:56.262Z", "lastUpdatedBy": "5dc057f8056099373694eaac" } }, "children": [ { "name": "Day2 - US West", "attributes": { "devices": [], "remediationWorkflow": null, "configId": "5e2b45133475aa09250fd447" }, "children": [] }, { "name": "Day2 - US East", "attributes": { "devices": [], "remediationWorkflow": null, "configId": "5e2b453d3475aa09250fd448" }, "children": [] } ] }, { "name": "Day1 - EMEA", "attributes": { "devices": [], "remediationWorkflow": null, "configId": "5e2b45783475aa09250fd449", "export": { "_id": "5e2b45783475aa09250fd449", "deviceType": "cisco-ios", "lines": [], "created": "2020-01-24T19:28:56.503Z", "createdBy": "5dc057f8056099373694eaac", "lastUpdated": "2020-01-24T19:28:56.503Z", "lastUpdatedBy": "5dc057f8056099373694eaac" } }, "children": [ { "name": "Day2 - Europe", "attributes": { "devices": [], "remediationWorkflow": null, "configId": "5e2b458a3475aa09250fd44a", "export": { "_id": "5e2b458a3475aa09250fd44a", "deviceType": "cisco-ios", "lines": [], "created": "2020-01-24T19:29:14.965Z", "createdBy": "5dc057f8056099373694eaac", "lastUpdated": "2020-01-24T19:29:14.965Z", "lastUpdatedBy": "5dc057f8056099373694eaac" } }, "children": [] } ] } ] }, "created": "2020-01-24T19:24:10.572Z", "createdBy": "5dc057f8056099373694eaac", "lastUpdated": "2020-01-24T19:29:27.215Z", "lastUpdatedBy": "5dc057f8056099373694eaac" } ] } } ], "readme": "\n# Configuration Compliance and Remediation\n\n## Table of Contents\n* [Overview](#overview)\n* [Features](#features)\n* [Components](#components)\n\t* [Workflows](#workflows)\n\t* [Operations Manager Job](#operations-manager-job)\n* [Requirements](#requirements)\n* [Known Limitations](#known-limitations)\n* [How to Install](#how-to-install)\n* [How to Run](#how-to-run)\n* [Job Variables](#job-variables)\n* [Test Environment](#test-environment)\n\n## Overview\nThe Configuration Compliance and Remediation pre-built allows network engineers to run scheduled compliance reports to check the compliance of devices against a specified Golden Configuration. If the compliance score has fallen under a customizable value for any given device, the pre-built will automatically take a backup of this device and try to automatically remediate the configuration back to the specified state. A report of all changes is shown to a network engineer.\n\n## Components\nThis pre-built is comprised of a set of modular components intended to modularize and simplify the remediation process to suit your device and environment. \n\n### Workflows\n#### 1) Parent flow\n
\n \"parent\n
\n\nThis workflow backs up the device config and attempts the remediation. If [verbose mode](#zero-touch-and-verbose-mode) is enabled, the remediation results will be shown for every successful device remediated along with a report at the end showing the list of all the devices that were successfully & unsuccessfully remediated.\n\n#### 2) Remediation flow\n
\n \"remediation\n
\nThis workflow returns 2 arrays - one with a set of devices in the tree which were successfully remediated and one with a set of devices in the tree for which either the remediation failed, or the compliance score failed to increase more than the threshold value set by the user. \n\n### Operations Manager Job\n
\n \"automation\"\n
\n\nThis pre-built can be scheduled to run in regular intervals by using operations manager. The screenshot above shows how the operations manager automation for this pre-built looks. Users can schedule periodical remediations on their configuration trees by setting the `Run At` and `Repeats` parameters in the `Schedule` card. The input data required for starting the workflows can be permanently set to a value by setting the values in the form on the right hand side (Please check [How to Run](#how-to-run) for instructions on filling the form).\n\n## Features\n* Schedules the weekly creation of a compliance report of all devices grouped under a Configuration Tree\n* Devices that have fallen under a customizable compliance score are auto remediated to bring them back into compliance\n* Includes example Configuration Trees for different device types\n* Modular Design\n* Zero touch option executes automation end to end without any manual tasks (no reports)\n* User customizable disallowed configuration removal\n* User customizable threshold compliance score for remediation approval\n\n## Requirements\nIn order to use the device connection health check pre-built, users will have to satisfy one of the following pre-requisites:\n* Itential Automation Platform `^2022.1`\n\n## Known Limitations\nAt the time of this writing, the pre-built is limited to the device types your chosen southbound system supports\n\n## How to Install\nPlease ensure that you are running a supported version of the Itential Automation Platform (IAP) as listed above in the [requirements](#requirements) section in order to install the Configuration Compliance and Remediation pre-built. \nSimply search for `config-compliance-and-remediation` within app-admin_essentials > pre-builts > browse and click the install\n\n## How to Run\n### Operations Manager\nAs a starting point, this pre-built assumes that the devices that you are trying to remediate are already configured and up and running.\nThe remediation process can be started through Operations Manager. First, select the target configuration tree from the drop-down list of available trees. Next, supply the minimum compliance score (between 0-100) for the remediation result to be considered acceptable. Finally, check/uncheck the check box to enable/disable disallowed configuration removal during the remediation process\n
\n \"Form\n
\n\n### Zero Touch and Verbose Mode\n
\n \"Modes\"\n
\nThis pre-built supports options for limiting or expanding the necessary amount of manual interaction while running:\n\n* `Zero Touch`: Enable zero touch to perform the entire remediation process without any interaction necessary. Please note that you should still monitor remediation process, and that any errors encountered will still need your attention in order to handle.\n* `Verbose Mode`: Enable verbose mode in order to view the remediation reports throughout the remediation process.\n\nWhen you are ready to initiate the upgrade process, press the `RUN` button to begin.\n\n## Job Variables\nShould you decide to run the pre-built without using operations manager, the following job variables are required to start the pre-built.\n\n### Workflow : Config Compliance & Remediation - Parent\nThe workflow takes in one variable called `formData` which is of type object. `formData` is expected to contain the following variables:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Job VariableTypeDescription
configurationTreestringName of the tree
scoreintegerThreshold for the compliance score - must be between 0-100
typestringThe mode you want to use (one of 'Zero Touch' or 'Verbose')
enableDisallowedConfigurationRemovalbooleanEnable/Disable disallowed configuration removal during the remediation process - Enabled by default
\n\n## Test Environment\n* IAP version 2019.3.1\n" }