Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

No content defined

GET_Devices

# GET Devices

- Jump To

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Response Formats | xml json
HTTP Methods | GET

Represents the device view with information about the managed network elements. It provides device information such as device name, device type, ip address, software type, version, and also provides the reachability and management status.

## Resource URL

/webacs/api/v1/data/Devices

Since : 1.2

## Response Parameters

Type | Attribute Name | Description
--- | --- | ---
int | clearedAlarms | The number of cleared alarms against this device.
String | collectionDetail | A detailed status of inventory collection
Date | collectionTime | Time of inventory collection
Date | creationTime | The timestamp when the instance of the device was created.
int | criticalAlarms | The number of critical alarms against this device.
Long | deviceId | An internal id to recognize the device, which is the id of the associated management network element associated with this device.
String | deviceName | The name of the device.
String | deviceType | The type of the device.
int | informationAlarms | The number of information alarms against this device.
String | ipAddress | The ip address of the device. This is the preferred management access address for the device. This is typically an address at which SNMP, telnet, and ssh agents are available.
String | location | The system location of the device.
int | majorAlarms | The number of major alarms against this device.
LifecycleStateEnum | managementStatus | Represents the current management state of the network element: managed, unmanaged, under maintenance, and so on. This state is modified by events in the network and network management system, and also by user request. Allowed values: UNKNOWN ADDED_ININITIALSTATE MANAGED_BUT_NEVERSYNCHRONIZED MANAGED_AND_SYNCHRONIZED MANAGED_BUT_OUTOFSYNC MANAGED_BUT_LOSSOFCONNECTIVITY PREPROVISIONED UNMANAGED INSERVICE_MAINTENANCE MANAGED_BUT_INCOMPLETE MANAGED_BUT_AGENTSHUTTINGDOWN MANAGED_PREPARINGFORMAINTENANCE MANAGED_BUT_DUPLICATE MANAGED_BUT_CONFLICTINGCREDENTIALS MANAGED_BUT_SYNCHRONIZING UNMANAGED_UNLICENSED
String[] | manufacturerPartNr | The manufacturer part numbers that make up the device chassis.
int | minorAlarms | The number of minor alarms against this device.
String | productFamily | The product family of this device.
CommunicationStateEnum | reachability | Indicates management availability or reachability of the managed network element. It can indicate the availability or reachability of the management agent serving as a proxy for the network element. Allowed values: UNKNOWN REACHABLE UNREACHABLE AGENT_UNREACHABLE AGENT_UNLOADED
String | softwareType | A string that identifies the specific type of software that is installed. For example, Cisco IOS or Linux.
String | softwareVersion | The specific version of the software (see attribute softwareType) that is installed. The value is formatted as a text field.
int | warningAlarms | The number of warning alarms against this device.

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 Payload

https://192.168.116.207/webacs/api/v1/data/Devices/42

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/Devices/42" responseType="getEntity">
        <entity url="/webacs/data/className/15" type="className" dtoType="devicesDTO_$$_javassist_5164">
            <devicesDTO id="15" displayName="String value">
                <clearedAlarms>1</clearedAlarms>
                <collectionDetail>String value</collectionDetail>
                <collectionTime>2013-07-02T18:07:26.175-07:00</collectionTime>
                <creationTime>2013-07-02T18:07:26.175-07:00</creationTime>
                <criticalAlarms>1</criticalAlarms>
                <deviceId>15</deviceId>
                <deviceName>String value</deviceName>
                <deviceType>String value</deviceType>
                <informationAlarms>1</informationAlarms>
                <ipAddress>String value</ipAddress>
                <location>String value</location>
                <majorAlarms>1</majorAlarms>
                <managementStatus>UNKNOWN</managementStatus>
                <manufacturerPartNrs>
                    <manufacturerPartNr>String value</manufacturerPartNr>
                </manufacturerPartNrs>
                <minorAlarms>1</minorAlarms>
                <productFamily>String value</productFamily>
                <reachability>UNKNOWN</reachability>
                <softwareType>String value</softwareType>
                <softwareVersion>String value</softwareVersion>
                <warningAlarms>1</warningAlarms>
            </devicesDTO>
        </entity>
    </queryResponse>

## Sample JSON Payload

https://192.168.116.207/webacs/api/v1/data/Devices/42.json

    {
      "queryResponse" : {
        "@rootUrl" : "\/webacs\/data",
        "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/Devices\/42",
        "@responseType" : "getEntity",
        "entity" : {
          "@url" : "\/webacs\/data\/className\/15",
          "@type" : "className",
          "@dtoType" : "devicesDTO_$$_javassist_5164",
          "devicesDTO" : {
            "@id" : "15",
            "@displayName" : "String value",
            "clearedAlarms" : 1,
            "collectionDetail" : "String value",
            "collectionTime" : "2013-07-02T18 : 07 : 26.177-07 : 00",
            "creationTime" : "2013-07-02T18 : 07 : 26.177-07 : 00",
            "criticalAlarms" : 1,
            "deviceId" : 15,
            "deviceName" : "String value",
            "deviceType" : "String value",
            "informationAlarms" : 1,
            "ipAddress" : "String value",
            "location" : "String value",
            "majorAlarms" : 1,
            "managementStatus" : "UNKNOWN",
            "manufacturerPartNrs" : {
              "manufacturerPartNr" : "String value"
            },
            "minorAlarms" : 1,
            "productFamily" : "String value",
            "reachability" : "UNKNOWN",
            "softwareType" : "String value",
            "softwareVersion" : "String value",
            "warningAlarms" : 1
          }
        }
      }
    }