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.
Since Product Version: 1.2
Resource URL
/webacs/api/v1/data/DevicesResponse Parameters
Type | Attribute Name | Description |
---|---|---|
String |
adminStatus |
Represents the current admin status of the device. |
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 |
instanceUuid |
This is a uuid for this instance. |
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:
|
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. |
ReachabilityStateEnum |
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:
|
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
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://172.25.123.114/webacs/api/v1/data/Devices/15
<?xml version="1.0" ?> <queryResponse type="Devices" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/Devices/15" rootUrl="https://172.25.123.114/webacs/api/v1/data"> <entity dtoType="devicesDTO" type="Devices" url="https://172.25.123.114/webacs/api/v1/data/Devices/15"> <devicesDTO displayName="String value" id="15" uuid="String value"> <adminStatus>String value</adminStatus> <clearedAlarms>1</clearedAlarms> <collectionDetail>String value</collectionDetail> <collectionTime>2020-07-28T20:28:10.101Z</collectionTime> <creationTime>2020-07-28T20:28:10.101Z</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://172.25.123.114/webacs/api/v1/data/Devices/15.json
{ "queryResponse" : { "@type" : "Devices", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Devices\/15", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "devicesDTO", "@type" : "Devices", "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Devices\/15", "devicesDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "String value", "adminStatus" : "String value", "clearedAlarms" : 1, "collectionDetail" : "String value", "collectionTime" : "2020-07-28T20 : 28 : 10.101Z", "creationTime" : "2020-07-28T20 : 28 : 10.101Z", "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 } } } }