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, reachability, management status and also provides groups where device is located
Since Product Version: 3.10
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- CLI Template Configuration (12)
- Clients (7)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (10)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (6)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Generation Operations (1)
- Report Service (4)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- System Settings (26)
- 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
- v4
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
This resource was introduced in API version 4.
This resource was introduced in API version 4.
This resource was introduced in API version 4.
Resource Information
Rate Limiting? |
Yes |
Sorting? |
Yes |
Paging? |
Yes |
Filtering? |
Yes |
Group Filtering? |
Yes |
Aggregation? |
Yes |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/data/DevicesWithGroupsTo filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Response 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. |
|||||||||||
Present the list of groups the device is a member of. |
||||||||||||
|
||||||||||||
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/data/DevicesWithGroups/15
<?xml version="1.0" ?>
<queryResponse type="DevicesWithGroups" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/DevicesWithGroups/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="devicesWithGroupsDTO" type="DevicesWithGroups" url="https://localhost/webacs/api/v4/data/DevicesWithGroups/15">
<devicesWithGroupsDTO 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>
<groups>
<group>
<description>String value</description>
<fullName>String value</fullName>
<id>2</id>
<name>String value</name>
</group>
<group>
<description>Another string value</description>
<fullName>Another string value</fullName>
<id>12</id>
<name>Another string value</name>
</group>
</groups>
<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>
</devicesWithGroupsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/DevicesWithGroups/15.json
{
"queryResponse" : {
"@type" : "DevicesWithGroups",
"@requestUrl" : "https://localhost/webacs/api/v4/data/DevicesWithGroups/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "devicesWithGroupsDTO",
"@type" : "DevicesWithGroups",
"@url" : "https://localhost/webacs/api/v4/data/DevicesWithGroups/15",
"devicesWithGroupsDTO" : {
"@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",
"groups" : {
"group" : [ {
"description" : "String value",
"fullName" : "String value",
"id" : 2,
"name" : "String value"
}, {
"description" : "Another string value",
"fullName" : "Another string value",
"id" : 12,
"name" : "Another 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"
}
} ]
}
}