getDeviceSummary
Retrieve a summary of a monitored network device, including status and key metrics, to quickly assess device health and performance.
Instructions
getDeviceSummary
Category: Manage and query network devices
Key parameters:
name*: Name of the device - Managed Entity name as seen in the URL
isFluidic: Set value as TRUE by default. (for internal purpose)
snapType: Type of the device snapshot. If the device is monitored only
RouterID: Router ID of the device if the snapType is set as 'FlowDevic
Input 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). | |
| name | Yes | Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response. | |
| apiKey | Yes | OpManager API key for authentication | |
| RouterID | No | Router ID of the device if the snapType is set as 'FlowDevice'. | |
| snapType | No | Type of the device snapshot. If the device is monitored only in OpManager Plus, set value as 'MonitoringDevice'. If Flow monitoring is enabled for this device, set value as 'FlowDevice' | |
| isFluidic | No | Set value as TRUE by default. (for internal purpose) |