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.
Filtering operators can be applied to the parameters. Use the GET data/GroupSpecification resource 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
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- API Health Service (6)
- Access Point Operations (3)
- Alarms Management Service (5)
- CLI Template Configuration (12)
- Clients (7)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (6)
- Device Operations (5)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (6)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Plug and Play (9)
- Report Service (4)
- Software Updates (2)
- Statistics (90)
- System Settings (25)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- v1
- v2
- v3
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Credential |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v1/op/devices/exportDevicesRequest Parameters
Attribute | Source | Description |
---|---|---|
ipAddress String |
query |
OptionalThe ip addreses of the devices to be exported |
groupId String |
query |
OptionalThe 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 |
groupPath String |
query |
OptionalThe name of a group |
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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/devices/exportDevices?ipAddress=192.168.1.1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/devices/exportDevices?ipAddress=192.168.1.1" rootUrl="https://localhost/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>
<snmpPort>String value</snmpPort>
<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://localhost/webacs/api/v1/op/devices/exportDevices.json?ipAddress=192.168.1.1
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/devices\/exportDevices?ipAddress=192.168.1.1",
"@rootUrl" : "https : \/\/localhost\/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",
"snmpPort" : "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"
}
}
}
}
}
}
}
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Credential |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v2/op/devices/exportDevices UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
ipAddress String |
query |
OptionalThe ip addreses of the devices to be exported |
groupId String |
query |
OptionalThe 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 |
groupPath String |
query |
OptionalThe name of a group |
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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/v2/op/devices/exportDevices?ipAddress=192.168.1.1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/devices/exportDevices?ipAddress=192.168.1.1" rootUrl="https://localhost/webacs/api/v2/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>
<snmpPort>String value</snmpPort>
<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://localhost/webacs/api/v2/op/devices/exportDevices.json?ipAddress=192.168.1.1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/devices/exportDevices?ipAddress=192.168.1.1",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/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",
"snmpPort" : "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"
} ]
}
} ]
}
} ]
}
}
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Credential |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v3/op/devices/exportDevices UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
ipAddress String |
query |
OptionalThe ip addreses of the devices to be exported |
groupId String |
query |
OptionalThe 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 |
groupPath String |
query |
OptionalThe name of a group |
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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/v3/op/devices/exportDevices?ipAddress=192.168.1.1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/devices/exportDevices?ipAddress=192.168.1.1" rootUrl="https://localhost/webacs/api/v3/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>
<snmpPort>String value</snmpPort>
<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>
<udf>
<name>String value</name>
<value>String value</value>
</udf>
</udfs>
</device>
</devices>
</devicesExportResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/devices/exportDevices.json?ipAddress=192.168.1.1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/devices/exportDevices?ipAddress=192.168.1.1",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/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",
"snmpPort" : "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"
}, {
"name" : "String value",
"value" : "String value"
} ]
}
} ]
}
} ]
}
}