Notifications about devices
Since Product Version: 3.7
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/sse/DevicesResponse Parameters
Attribute | Description |
---|---|
adminStatus DeviceAdminStatusEnum |
Represents the current admin status of the device.
|
collectionDetail String |
A detailed status of inventory collection. |
collectionStatus InventoryCollectionStatusEnum |
Last inventory collection status.
|
collectionTime Date |
Time of inventory collection. |
creationTime Date |
The timestamp when the instance of the device was created. |
deviceId Long |
An internal id to recognize the device, which is the id of the associated management network element associated with this device. |
deviceName String |
The name of the device. |
deviceType String |
The type of the device. |
ipAddress String |
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. |
location String |
The system location of the device. |
managementStatus LifecycleStateEnum |
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.
|
The device chassis details. |
|
productFamily String |
The product family of this device. |
reachability ReachabilityStateEnum |
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.
|
softwareType String |
A string that identifies the specific type of software that is installed. For example, Cisco IOS or Linux. |
softwareVersion String |
The specific version of the software (see attribute softwareType) that is installed. The value is formatted as a text field. |
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://localhost/webacs/api/v4/sse/Devices
<?xml version="1.0" ?>
<streamResponse count="1" responseType="listEvents" requestUrl="https://localhost/webacs/api/v4/sse/Devices" rootUrl="https://localhost/webacs/api/v4/sse">
<streamEvent dtoType="devicesDTO" id="Devices" action="CREATED">
<devicesDTO displayName="String value" id="15" uuid="String value">
<collectionDetail>String value</collectionDetail>
<collectionTime>1986-07-24T00:00:00+08:00</collectionTime>
<creationTime>1986-07-24T00:00:00+08:00</creationTime>
<deviceId>15</deviceId>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<ipAddress>String value</ipAddress>
<location>String value</location>
<managementStatus>UNKNOWN</managementStatus>
<productFamily>String value</productFamily>
<reachability>UNKNOWN</reachability>
<softwareType>String value</softwareType>
<softwareVersion>String value</softwareVersion>
<adminStatus>UNMANAGED</adminStatus>
<collectionStatus>COMPLETED</collectionStatus>
<manufacturerPartNrs>
<manufacturerPartNr>
<name>String value</name>
<partNumber>String value</partNumber>
<serialNumber>String value</serialNumber>
</manufacturerPartNr>
<manufacturerPartNr>
<name>Another string value</name>
<partNumber>Another string value</partNumber>
<serialNumber>Another string value</serialNumber>
</manufacturerPartNr>
</manufacturerPartNrs>
</devicesDTO>
</streamEvent>
</streamResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/sse/Devices.json
{
"streamResponse" : {
"@count" : 1,
"@requestUrl" : "https://localhost/webacs/api/v4/sse/Devices",
"@responseType" : "listEvents",
"@rootUrl" : "https://localhost/webacs/api/v4/sse",
"streamEvent" : [ {
"@action" : "CREATED",
"@dtoType" : "devicesDTO",
"@id" : "Devices",
"devicesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"adminStatus" : "UNMANAGED",
"collectionDetail" : "String value",
"collectionStatus" : "COMPLETED",
"collectionTime" : "1986-07-23T16:00:00.000Z",
"creationTime" : "1986-07-23T16:00:00.000Z",
"deviceId" : 15,
"deviceName" : "String value",
"deviceType" : "String value",
"ipAddress" : "String value",
"location" : "String value",
"managementStatus" : "UNKNOWN",
"manufacturerPartNrs" : {
"manufacturerPartNr" : [ {
"name" : "String value",
"partNumber" : "String value",
"serialNumber" : "String value"
}, {
"name" : "Another string value",
"partNumber" : "Another string value",
"serialNumber" : "Another string value"
} ]
},
"productFamily" : "String value",
"reachability" : "UNKNOWN",
"softwareType" : "String value",
"softwareVersion" : "String value"
}
} ]
}
}