listInterfaces
Retrieve a list of network interfaces from OpManager with filtering, sorting, and pagination options.
Instructions
listInterfaces
Category: Manage and query network devices
Key parameters:
isFluidic: Set value as 'true' by default (for internal purpose)
rows: To fetch interface list in batches. This should be combinedl
page: To fetch interface list in batches. This should be combinedl
sortByColumn: Sorting interfaces list with columns [Example: inSpeed, disp
sortByType: Defining ascending or descending sort of interfaces list [Ex
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | Yes | OpManager host address (e.g., 'opmanager.example.com' or 'opmanager.example.com:8061'). Default port is 8061 (HTTPS). | |
| page | No | To fetch interface list in batches. This should be combinedly used with 'rows' parameter [Example: page=1, rows=200, page=2, rows=200] | |
| rows | No | To fetch interface list in batches. This should be combinedly used with 'page' parameter [Example: page=1, rows=200, page=2, rows=200] | |
| type | No | Filter interface with interface type. [Example: Ethernet,Software Loopback, etc] | |
| apiKey | Yes | OpManager API key for authentication | |
| severity | No | Filter interfaces with severity. [Example: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)] | |
| intfProps | No | To fetch additional interface properties such as ifName (Interface ifName), moid (internal managed object identifier used for interface/device), physAddress | |
| isFluidic | No | Set value as 'true' by default (for internal purpose) | |
| sortByType | No | Defining ascending or descending sort of interfaces list [Example, sortByType=asc Or sortByType=desc] | |
| sortByColumn | No | Sorting interfaces list with columns [Example: inSpeed, displayName, ipaddress, outSpeed, statusNum, severity - 1 (Critical), 2 (Trouble), 3 (Attention), 4 (service down), 5 (Clear), 7 (Unmanaged)] |