Get CMDB Device Info
API Parameters for Enterprise Deployments
Get Short Description of All Devices
Sample XML Output
Sample Python Script
Get Short Description of All Devices in an Address Range
Sample XML Output
Sample Python Script
Get Full Information About One Device
Sample XML Output
Sample Python Script
Get a Section of Information (Applications, Interfaces, Processors, Storage) About One Device
Sample XML Output
Sample Python Script
API Parameters for Multitenant Deployments
Get Short Description of All Devices for an Organization
Sample XML Output
Sample Python Script
Get Short Description of All Devices in an Address Range for an Organization
Sample XML Output
Sample Python Code
Get Full Information About One Device Belonging to an Organization
Sample XML Output
Sample Python Code
Get a Section of Information (Applications, Interfaces, Processors, Storage) About One Device for an Organization Sample XML Output
Sample Python Code
Applies To
Enteprise and multitenant deployments.
API Parameters for Enterprise Deployments
Get Short Description of All Devices
| Methodology | REST API based: make an HTTP(S) request with an input XML (optional). An output XML is returned. |
| Input URL | https://<AccelOps_IP>/phoenix/rest/cmdbDeviceInfo/devices |
| Input Credentials | Username and password of any AccelOps account |
| Output | An XML that contains a short set of attributes for each device, including:
Host Name Access IP Creation Method Description Vendor, Model, version Contact info Location Uptime Hardware Model Serial Number Business Service Groups to which the device belongs |
Sample XML Output
Sample Python Script
| getCMDBinfo.py Script | Usage |
| python getCMDBInfo.py <AccelOpsSuperIp> super/<user>
<password> |
Get Short Description of All Devices in an Address Range
| Methodology | REST API based: make an HTTP(S) request with an input XML (optional). An output XML is returned. |
| Input URL | https://<AccelOps_IP>/phoenix/rest/cmdbDeviceInfo/devices?includeIps=<includeIpSet>&excludeIps
> |
| Input
Credentials |
Username and password of any AccelOps account |
| Output | An XML that contains short description of devices with access IPs in the specified address range |
If you want all devices in the range 192.168.20.1-192.168.20.100, then issue the API https://<AccelOps_IP>/pho enix/rest/cmdbDeviceInfo/devices?includeIps=192.168.20.1-192.168.20.100
If you want all devices in the range 192.168.20.1-192.168.20.100, but want to exclude 192.168.20.20,
192.168.20.25, then issue the API https://<AccelOps_IP>/phoenix/rest/cmdbDeviceInfo/devices?include
Ips=192.168.20.1-192.168.20.100&excludeIps=192.168.20.20,192.168.20.25
If you want all devices in the range 192.168.20.1-192.168.20.100, but want to exclude 192.168.20.20-192.168.20
.25, then issue the API https://<AccelOps_IP>/phoenix/rest/cmdbDeviceInfo/devices?includeIps=192.16
8.20.1-192.168.20.100&excludeIps=192.168.20.20-192.168.20.25
Sample XML Output
Query: https://<AccelOps_IP>/phoenix/rest/cmdbDeviceInfo/devices?includeIps=192.168.20.1-192.168.20.40
Output: AllDeviceInRangeShortDescription.xml
Sample Python Script
Get Full Information About One Device
| Methodology | REST API based: make an HTTP(S) request with an input XML (optional). An output XML is returned. |
| Input URL | https://<AccelOps_IP>/phoenix/rest/cmdbDeviceInfo/device?ip=<deviceIp>&loadDepend=true |
| Input Credentials | Username and password of any AccelOps account |
| Output | An XML that contains full information AccelOps has discovered about a device |
Sample XML Output
Query: https://<AccelOps_IP>/phoenix/rest/cmdbDeviceInfo/device?ip=192.168.1.12&loadDepend=true
Output: oneWindowsServerFullInfo.xml
Sample Python Script
| getCMDBinfo.py Script | |
| p g < s < |
U
Get a Section of Information (Applications, Interfaces, Processors, Storage) About One Device
| Methodology | REST API based: make an HTTP(S) request with an input XML (optional). An output XML is returned. |
| Input URL | https:// |
| Input
Credentials |
Username and password of any AccelOps account |
| Output | An XML that contains the specified section discovered for the device |
Query: https://<AccelOps_IP>/phoenix/rest/cmdbDeviceInfo/device?ip=192.168.1.12&fields=interfaces&loadDepend
=true
Output: oneWindowsServerInterfaces.xml
Sample Python Script