listDevices
Retrieve a filtered list of devices from OpManager by type, category, vendor, severity, or group to monitor network infrastructure.
Instructions
listDevices
Category: Manage and query network devices
Key parameters:
isFluidic: Set value as 'true' by default.(for internal purpose)
type: Fetches the list of devices that fall under the given Device
category: Fetches the list of devices that fall under the given device
app: Fetches the list of devices that have the given App in it an
bvName: Fetches the list of devices that are under the given Busines
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app | No | Fetches the list of devices that have the given App in it and monitored in OpManager Plus [Example: MSSQL, Exchange, Domain Controller] | |
| host | Yes | OpManager host address (e.g., 'opmanager.example.com' or 'opmanager.example.com:8061'). Default port is 8061 (HTTPS). | |
| page | No | To fetch devices in batches. This should be combinedly used with 'rows' parameter. [Example: page=1, rows=200, page=2, rows=200] | |
| rows | No | To fetch devices in batches. This should be combinedly used with 'page' parameter [Example: page=1, rows=200, page=2, rows=200] | |
| type | No | Fetches the list of devices that fall under the given Device Type. [Example: type=Cisco2081] | |
| apiKey | Yes | OpManager API key for authentication | |
| bvName | No | Fetches the list of devices that are under the given Business View map name | |
| vendor | No | Fetches the list of devices that have the given vendor name. | |
| category | No | Fetches the list of devices that fall under the given device category [Example: Server, Switch, etc.] | |
| protocol | No | Filter devices by protocol [Example: all|SNMP|WMI|CLI|VIWebService|VIWMI|CLI|XenService|PrismAPI|NetAppAPI|SMI] | |
| severity | No | Filter devices by severity [Example: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)] | |
| groupName | No | Filter devices by Group name | |
| isFluidic | No | Set value as 'true' by default.(for internal purpose) | |
| sortByType | No | Defining sort type to be ascending or descending [Example, sortByType=asc Or sortByType=desc] | |
| customFields | No | To fetch custom field values for the devices, supply the required custom field names in the 'customFields' param in the API request. Example: /api/json/device/listDevices?apiKey=***************&customFields=Building,Comments,Floor | |
| sortByColumn | No | Sorting device list by columns [Example: displayName, interfaceCount, ipaddress, type, etc.] | |
| getInterfaces | No | To fetch devices with associated interfaces. Boolean value: TRUE/FALSE | |
| selectedVTypes | No | Filter devices by Virtual device type [Example: VMware-VM|VMware-Host|HyperV-VM|Xen-VM|VMware-vCenter|Xen-Host|HyperV-Host] |