Compute Running Configuration Diff. Currently supported only for router devices.
Since Product Version: 3.1
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v1/op/configArchiveService/configDiff/{device}Request Parameters
Attribute | Source | Description |
---|---|---|
device String |
path |
RequiredThe device name or the management address of the device. The management address is the address used to add the device to the managed inventory, either an IP address or hostname. |
timeStamp Long |
query |
Optionaltimestamp in UTC milliseconds. When provided, API computes any diff from provided timeStamp till latest. |
diffType String |
query |
OptionalConfig Archive Diff Type (Processed/Unprocessed). Unprocessed is raw diff. |
Response Parameters
Attribute | Description |
---|---|
configChanged boolean |
flag indicating if config has changed for a given device from given timeStamp, |
Config diff payload |
|
deviceIp String |
The management address of the device. The management address is the address used to add the device to the managed inventory, either an IP address or hostname. |
deviceName String |
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://localhost/webacs/api/v1/op/configArchiveService/configDiff/routerName
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/configArchiveService/configDiff/routerName" rootUrl="https://localhost/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>
<items>
<items>
<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>
</items>
</items>
<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>
<items>
<items>
<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>
</items>
</items>
<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://localhost/webacs/api/v1/op/configArchiveService/configDiff/routerName.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/configArchiveService\/configDiff\/routerName",
"@rootUrl" : "https : \/\/localhost\/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",
"items" : {
"items" : {
"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"
}
},
"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",
"items" : {
"items" : {
"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"
}
},
"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"
}
}
}