An operation to export a list of devices. It accepts three parameters: ipAddress, groupId or groupPath. If no parameters are specified, no devices will be exported.
NBI filtering can be applied to the parameters. Use the GroupSpecification service to obtain groupId or groupPath information.
Examples
- ipAddress="192.168.1.1" -- export one device by ip
- ipAddress=in("192.168.1.1","192.168.1.2") -- export multiple devices by ips
- ipAddress=startsWith("192.168.1") --export devices by ip range. Other filtering could be endsWith, contains
- groupPath=startsWith("Device Type/Wireless Controller")' --export devices by the group Device Type/Wireless Controller and its child groups
- groupPath="Device Type/Wireless Controller/Cisco 5500 Series Wireless LAN Controllers"&ipAddress=startsWith("171")' --export devices by a group and ip range in that group
- groupId=in(81160,81161) -- export devices by groupIds
Since Product Version: 2.2
Resource URL
/webacs/api/v1/op/devices/exportDevicesRequest Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
ipAddress optional |
query |
The ip addreses of the devices to be exported |
String |
groupId optional |
query |
The ids of the groups of the devices to be exported. A group logically organizes devices. A group could be a device type, a site or a user defined group |
String |
groupPath optional |
query |
The name of a group |
Response Parameters
Type | Attribute Name | Description |
---|---|---|
devices |
|
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/devices/exportDevices
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <devicesExportResult> <devices> <device> <cliEnablePassword>String value</cliEnablePassword> <cliPassword>String value</cliPassword> <cliRetries>String value</cliRetries> <cliTimeout>String value</cliTimeout> <cliUsername>String value</cliUsername> <credentialProfileName>String value</credentialProfileName> <httpConfigPassword>String value</httpConfigPassword> <httpConfigUsername>String value</httpConfigUsername> <httpMonitorPassword>String value</httpMonitorPassword> <httpMonitorUsername>String value</httpMonitorUsername> <httpPort>String value</httpPort> <httpServer>String value</httpServer> <ipAddress>String value</ipAddress> <networkMask>String value</networkMask> <protocol>String value</protocol> <snmpCommunity>String value</snmpCommunity> <snmpReadCommunity>String value</snmpReadCommunity> <snmpRetries>String value</snmpRetries> <snmpTimeout>String value</snmpTimeout> <snmpVersion>String value</snmpVersion> <snmpWriteCommunity>String value</snmpWriteCommunity> <snmpv3AuthPassword>String value</snmpv3AuthPassword> <snmpv3AuthType>String value</snmpv3AuthType> <snmpv3PrivacyPassword>String value</snmpv3PrivacyPassword> <snmpv3PrivacyType>String value</snmpv3PrivacyType> <snmpv3UserName>String value</snmpv3UserName> <udfs> <udf> <name>String value</name> <value>String value</value> </udf> </udfs> </device> </devices> </devicesExportResult> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v1/op/devices/exportDevices.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/devices\/exportDevices", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "devicesExportResult" : { "devices" : { "device" : { "cliEnablePassword" : "String value", "cliPassword" : "String value", "cliRetries" : "String value", "cliTimeout" : "String value", "cliUsername" : "String value", "credentialProfileName" : "String value", "httpConfigPassword" : "String value", "httpConfigUsername" : "String value", "httpMonitorPassword" : "String value", "httpMonitorUsername" : "String value", "httpPort" : "String value", "httpServer" : "String value", "ipAddress" : "String value", "networkMask" : "String value", "protocol" : "String value", "snmpCommunity" : "String value", "snmpReadCommunity" : "String value", "snmpRetries" : "String value", "snmpTimeout" : "String value", "snmpVersion" : "String value", "snmpWriteCommunity" : "String value", "snmpv3AuthPassword" : "String value", "snmpv3AuthType" : "String value", "snmpv3PrivacyPassword" : "String value", "snmpv3PrivacyType" : "String value", "snmpv3UserName" : "String value", "udfs" : { "udf" : { "name" : "String value", "value" : "String value" } } } } } } }