Config Archive
The following are the Config Archive REST APIs:
Status
The following table details the API Response code, status and, the HTTPS methods.
|
|
|
200 |
OK |
GET |
202 |
Accepted |
POST PUT DELETE |
400 |
Bad Request |
GET POST PUT DELETE |
401 |
Unauthorized |
GET POST PUT DELETE |
403 |
Forbidden |
GET POST PUT DELETE |
404 |
Not Found |
GET POST PUT DELETE |
405 |
Method Not Allowed |
GET POST PUT DELETE |
500 |
Internal Server Error |
GET POST PUT DELETE |
Resource Name
/config/archive/devices
Description
Get Config Archive devices
URL
https://dcnm-ip/fm/fmrest/config/archive/devices
Parameter
|
|
|
filterStr |
archivedOnly:true |
Filter string |
Return Value
Format: JSON
Type: Object
|
|
|
List<BackupDeviceDO> |
O |
List of BackupDeviceDO |
Get Archived Configurations for device
Resource Name
/config/archive/devices
Description
Get Archived configuration Archive devices
URL
https://dcnm-ip/fm/fmrest/config/archive/devices
Parameter
|
|
|
filterStr |
archivedOnly:true |
Filter string |
parentID |
int |
Database ID of the device |
Return Value
Format: JSON
Type: Object
|
|
|
List<BackupDeviceDO> |
O |
List of BackupDeviceDO |
Resource Name
/config/archive/compare
Description
Compares two Archived Configurations and returns the differences.
URL
https://dcnm-ip/fm/fmrest/config/archive/compare
Parameter
|
|
|
sourceDevice |
S |
Source Device IP Address |
sourceConf |
S |
Source Configuration to Compare |
targetDevice |
S |
Target Device IP Address |
targetConf |
S |
Target Configuration to Compare |
showAll |
B |
Show diff only or all (true/false) |
Return Value
Format: JSON
Type: Object
|
|
|
Map<String, Report> |
O |
Map of group configuration Items |
Resource Name
/config/archive/copy
Description
Get list of archived configurations for a device
URL
https://dcnm-ip/fm/fmrest/config/archive/restore
Parameter
|
|
|
sourceDevice |
S |
Source Device IP Address |
sourceConf |
S |
Source Configuration to Compare |
targetDevices |
S |
Target Device IP Address |
Modified |
B |
Copy a modified configuration |
Return Value
Format: JSON
Type: Object
|
|
|
List<String> |
O |
Copy Command device response |
Resource Name
/config/archive/
Description
Delete the configuration.
URL
https://dcnm-ip/fm/fmrest/config/archive
Parameter
|
|
|
parentID(path parameter) |
S |
Source Device database ID |
configuration(path parameter) |
S |
Source Configuration to delete |
Return Value
Format: JSON
Type: Object
Resource Name
/config/archive/jobs
URL
https://https://dcnm-ip/fm/fmrest/config/archive/jobs
Return Value
Format: JSON
Type: Object
|
|
|
Map<String, Map<String, ArchiveJobDO >> |
O |
Map of ArchiveJobDO |
Get Devices for a Archive Job
Resource Name
/config/archive/job/{jobID}
Description
Get devices part of the archive job.
URL
https://https://dcnm-ip/fm/fmrest/config/archive/job/switch/groupID
Return Value
Format: JSON
Type: Object
|
|
|
Map<String, Map<String, SwitchNameDO>> |
O |
Map of switch group and SwitchNameDo. |
Resource Name
/config/archive/jobs
Description
Delete the job
URL
https://https://dcnm-ip/fm/fmrest/config/archive/jobs/{jobName}
Parameter
|
|
|
jobName |
path |
Path parameter |
Return Value
Format: JSON
Type: Object
|
|
|
ConfigDeliveryTaskDeviceDO [] |
A |
Array of device objects |
Get Device in Particular Group
Resource Name
/config/archive/job/group
Description
Get eligible devices for a group.
URL
https://https://dcnm-ip/fm/fmrest/config/archive/job/group/{groupID}
Return Value
Format: JSON
Type: Object
|
|
|
Map<String, Map<String, SwitchNameDO>> |
O |
Map of switch group and SwitchNameDo. |
Get Job Execution History
Resource Name
/config/archive/
Description
Get job execution history.
URL
https://https://dcnm-ip/fm/fmrest/config/archive/jobs/execution
Return Value
Format: JSON
Type: Object
|
|
|
Map<String, Map<String, BackupStatusDO>> |
O |
Map of BackupStatusDO. |