Compute Running Configuration Diff. Currently supported only for router devices.
Since Product Version: 3.1
Resource URL
/webacs/api/v1/op/configArchiveService/configDiff/{device}Request Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
device required |
path |
deviceName or deviceIp of the device |
Long |
timeStamp optional |
query |
timestamp in UTC milliseconds. When provided, API computes any diff from provided timeStamp till latest. |
String |
diffType optional |
query |
Config Archive Diff Type (Processed/Unprocessed). Unprocessed is raw diff. |
Response Parameters
Type | Attribute Name | Description |
---|---|---|
boolean |
configChanged |
flag indicating if config has changed for a given device from given timeStamp, |
configDiffs |
Config diff payload |
|
String |
deviceIp |
Device IP of the device. |
String |
deviceName |
Device Name of the device |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://172.25.123.114/webacs/api/v1/op/configArchiveService/configDiff/{device}
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/configArchiveService/configDiff/{device}" rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <configArchiveDiffInfoDTO> <configChanged>true</configChanged> <configDiffs> <configDiffs> <destinationHeader>String value</destinationHeader> <diffType>PROCESSED</diffType> <flatItems> <flatItems> <destinationHeader>String value</destinationHeader> <diffType>PROCESSED</diffType> <flatItems> <flatItems> <destinationHeader>String value</destinationHeader> <diffType>PROCESSED</diffType> <flatItems> <flatItems> <destinationHeader>String value</destinationHeader> <diffType>PROCESSED</diffType> <hasChildren>true</hasChildren> <id>String value</id> <lines> <lines> <destinationLine>String value</destinationLine> <diffType>SAME</diffType> <separatorLine>true</separatorLine> <sourceLine>String value</sourceLine> </lines> </lines> <parentId>String value</parentId> <sourceHeader>String value</sourceHeader> <title>String value</title> </flatItems> </flatItems> <hasChildren>true</hasChildren> <id>String value</id> <lines> <lines> <destinationLine>String value</destinationLine> <diffType>SAME</diffType> <separatorLine>true</separatorLine> <sourceLine>String value</sourceLine> </lines> </lines> <parentId>String value</parentId> <sourceHeader>String value</sourceHeader> <title>String value</title> </flatItems> </flatItems> <hasChildren>true</hasChildren> <id>String value</id> <lines> <lines> <destinationLine>String value</destinationLine> <diffType>SAME</diffType> <separatorLine>true</separatorLine> <sourceLine>String value</sourceLine> </lines> </lines> <parentId>String value</parentId> <sourceHeader>String value</sourceHeader> <title>String value</title> </flatItems> </flatItems> <hasChildren>true</hasChildren> <id>String value</id> <lines> <lines> <destinationLine>String value</destinationLine> <diffType>SAME</diffType> <separatorLine>true</separatorLine> <sourceLine>String value</sourceLine> </lines> </lines> <parentId>String value</parentId> <sourceHeader>String value</sourceHeader> <title>String value</title> </configDiffs> </configDiffs> <deviceIp>String value</deviceIp> <deviceName>String value</deviceName> </configArchiveDiffInfoDTO> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v1/op/configArchiveService/configDiff/{device}.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/configArchiveService\/configDiff\/{ device }", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "configArchiveDiffInfoDTO" : { "configChanged" : true, "configDiffs" : { "configDiffs" : { "destinationHeader" : "String value", "diffType" : "PROCESSED", "flatItems" : { "flatItems" : { "destinationHeader" : "String value", "diffType" : "PROCESSED", "flatItems" : { "flatItems" : { "destinationHeader" : "String value", "diffType" : "PROCESSED", "flatItems" : { "flatItems" : { "destinationHeader" : "String value", "diffType" : "PROCESSED", "hasChildren" : true, "id" : "String value", "lines" : { "lines" : { "destinationLine" : "String value", "diffType" : "SAME", "separatorLine" : true, "sourceLine" : "String value" } }, "parentId" : "String value", "sourceHeader" : "String value", "title" : "String value" } }, "hasChildren" : true, "id" : "String value", "lines" : { "lines" : { "destinationLine" : "String value", "diffType" : "SAME", "separatorLine" : true, "sourceLine" : "String value" } }, "parentId" : "String value", "sourceHeader" : "String value", "title" : "String value" } }, "hasChildren" : true, "id" : "String value", "lines" : { "lines" : { "destinationLine" : "String value", "diffType" : "SAME", "separatorLine" : true, "sourceLine" : "String value" } }, "parentId" : "String value", "sourceHeader" : "String value", "title" : "String value" } }, "hasChildren" : true, "id" : "String value", "lines" : { "lines" : { "destinationLine" : "String value", "diffType" : "SAME", "separatorLine" : true, "sourceLine" : "String value" } }, "parentId" : "String value", "sourceHeader" : "String value", "title" : "String value" } }, "deviceIp" : "String value", "deviceName" : "String value" } } }