Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET devices/exportDevices

Private Resource

This resource is not part of the public API and may be changed or removed without notice. The use of this resource is not supported by Cisco. Use it at your own risk.

Export devices. It accepts three parameters: ipAddress, groupId or groupPath. If no paramters are specified, none will be returned. The NBI filterings can be applied to the parameters. Please refer to the NBI filtering page for details. Use the GroupSpecification service to otbain groupId or groupPath information. Examples: 1) ?ipAddress=192.168.1.1 -- export one device by ip 2) ipAddress=in("192.168.1.1","192.168.1.2") -- export multiple devices by ips 3) ipAddress=startsWith("192.168.1") --export devices by ip range. Other filterings could be endsWith, contains 4) groupPath=startsWith("Device Type/Wireless Controller") --export devices of the group Device Type/Wireless Controller and its child groups 5) groupPath="Device Type/Wireless Controller/Cisco 5500 Series Wireless LAN Controllers"&ipAddress=startsWith("171") --export devices by a group and an ip range in that group 6) groupId=in(81160,81161) -- export devices by groupIds

Since Product Version: Unspecified

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Credential

HTTP Methods

GET

Resource URL

/webacs/api/v4/op/devices/exportDevices

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

ipAddress String

query

Optional

Management address of the device to be exported. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.

groupId String

query

Optional

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

groupPath String

query

Optional

The name of a group

Response Parameters

Attribute Description

devices Arrow image 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://10.64.80.159/webacs/api/v4/op/devices/exportDevices

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v4/op">
  <devicesExportResult>
    <devices>
      <device>
        <altitude>String value</altitude>
        <building>String value</building>
        <city>String value</city>
        <cliEnablePassword>String value</cliEnablePassword>
        <cliPassword>String value</cliPassword>
        <cliRetries>String value</cliRetries>
        <cliTimeout>String value</cliTimeout>
        <cliUsername>String value</cliUsername>
        <country>String value</country>
        <county>String value</county>
        <credentialProfileName>String value</credentialProfileName>
        <floor>String value</floor>
        <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>
        <latitude>String value</latitude>
        <longitude>String value</longitude>
        <networkMask>String value</networkMask>
        <protocol>String value</protocol>
        <region>String value</region>
        <room>String value</room>
        <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>
        <state>String value</state>
        <street>String value</street>
        <udfs>
          <udf>
            <name>String value</name>
            <value>String value</value>
          </udf>
          <udf>
            <name>Another string value</name>
            <value>Another string value</value>
          </udf>
        </udfs>
      </device>
      <device>
        <altitude>Another string value</altitude>
        <building>Another string value</building>
        <city>Another string value</city>
        <cliEnablePassword>Another string value</cliEnablePassword>
        <cliPassword>Another string value</cliPassword>
        <cliRetries>Another string value</cliRetries>
        <cliTimeout>Another string value</cliTimeout>
        <cliUsername>Another string value</cliUsername>
        <country>Another string value</country>
        <county>Another string value</county>
        <credentialProfileName>Another string value</credentialProfileName>
        <floor>Another string value</floor>
        <httpConfigPassword>Another string value</httpConfigPassword>
        <httpConfigUsername>Another string value</httpConfigUsername>
        <httpMonitorPassword>Another string value</httpMonitorPassword>
        <httpMonitorUsername>Another string value</httpMonitorUsername>
        <httpPort>Another string value</httpPort>
        <httpServer>Another string value</httpServer>
        <ipAddress>Another string value</ipAddress>
        <latitude>Another string value</latitude>
        <longitude>Another string value</longitude>
        <networkMask>Another string value</networkMask>
        <protocol>Another string value</protocol>
        <region>Another string value</region>
        <room>Another string value</room>
        <snmpCommunity>Another string value</snmpCommunity>
        <snmpPort>Another string value</snmpPort>
        <snmpReadCommunity>Another string value</snmpReadCommunity>
        <snmpRetries>Another string value</snmpRetries>
        <snmpTimeout>Another string value</snmpTimeout>
        <snmpVersion>Another string value</snmpVersion>
        <snmpWriteCommunity>Another string value</snmpWriteCommunity>
        <snmpv3AuthPassword>Another string value</snmpv3AuthPassword>
        <snmpv3AuthType>Another string value</snmpv3AuthType>
        <snmpv3PrivacyPassword>Another string value</snmpv3PrivacyPassword>
        <snmpv3PrivacyType>Another string value</snmpv3PrivacyType>
        <snmpv3UserName>Another string value</snmpv3UserName>
        <state>Another string value</state>
        <street>Another string value</street>
        <udfs>
          <udf>
            <name>String value</name>
            <value>String value</value>
          </udf>
          <udf>
            <name>Another string value</name>
            <value>Another string value</value>
          </udf>
        </udfs>
      </device>
    </devices>
  </devicesExportResult>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.80.159/webacs/api/v4/op/devices/exportDevices.json

{
  "mgmtResponse" : {
    "@requestUrl" : "../../../../../pages/common/login.jsp.html",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.80.159/webacs/api/v4/op",
    "devicesExportResult" : [ {
      "devices" : {
        "device" : [ {
          "altitude" : "String value",
          "building" : "String value",
          "city" : "String value",
          "cliEnablePassword" : "String value",
          "cliPassword" : "String value",
          "cliRetries" : "String value",
          "cliTimeout" : "String value",
          "cliUsername" : "String value",
          "country" : "String value",
          "county" : "String value",
          "credentialProfileName" : "String value",
          "floor" : "String value",
          "httpConfigPassword" : "String value",
          "httpConfigUsername" : "String value",
          "httpMonitorPassword" : "String value",
          "httpMonitorUsername" : "String value",
          "httpPort" : "String value",
          "httpServer" : "String value",
          "ipAddress" : "String value",
          "latitude" : "String value",
          "longitude" : "String value",
          "networkMask" : "String value",
          "protocol" : "String value",
          "region" : "String value",
          "room" : "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",
          "state" : "String value",
          "street" : "String value",
          "udfs" : {
            "udf" : [ {
              "name" : "String value",
              "value" : "String value"
            }, {
              "name" : "Another string value",
              "value" : "Another string value"
            } ]
          }
        }, {
          "altitude" : "Another string value",
          "building" : "Another string value",
          "city" : "Another string value",
          "cliEnablePassword" : "Another string value",
          "cliPassword" : "Another string value",
          "cliRetries" : "Another string value",
          "cliTimeout" : "Another string value",
          "cliUsername" : "Another string value",
          "country" : "Another string value",
          "county" : "Another string value",
          "credentialProfileName" : "Another string value",
          "floor" : "Another string value",
          "httpConfigPassword" : "Another string value",
          "httpConfigUsername" : "Another string value",
          "httpMonitorPassword" : "Another string value",
          "httpMonitorUsername" : "Another string value",
          "httpPort" : "Another string value",
          "httpServer" : "Another string value",
          "ipAddress" : "Another string value",
          "latitude" : "Another string value",
          "longitude" : "Another string value",
          "networkMask" : "Another string value",
          "protocol" : "Another string value",
          "region" : "Another string value",
          "room" : "Another string value",
          "snmpCommunity" : "Another string value",
          "snmpPort" : "Another string value",
          "snmpReadCommunity" : "Another string value",
          "snmpRetries" : "Another string value",
          "snmpTimeout" : "Another string value",
          "snmpVersion" : "Another string value",
          "snmpWriteCommunity" : "Another string value",
          "snmpv3AuthPassword" : "Another string value",
          "snmpv3AuthType" : "Another string value",
          "snmpv3PrivacyPassword" : "Another string value",
          "snmpv3PrivacyType" : "Another string value",
          "snmpv3UserName" : "Another string value",
          "state" : "Another string value",
          "street" : "Another string value",
          "udfs" : {
            "udf" : [ {
              "name" : "String value",
              "value" : "String value"
            }, {
              "name" : "Another string value",
              "value" : "Another string value"
            } ]
          }
        } ]
      }
    } ]
  }
}