getIntfBWOutageReportDetails
Retrieve bandwidth outage report details for a network interface over a specified period. Provide interface name and time range to get outage data for monitoring and analysis.
Instructions
getIntfBWOutageReportDetails
Key parameters:
interfaceName*: Name of the interface - Managed Entity name as seen in the U
period*: Period for which the interface graph is required. [Example:
startDate: From Date. This paramete is applicable only if 'custom' time
endDate: To Date. This param is applicable only if 'custom' time is o
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). | |
| apiKey | Yes | OpManager API key for authentication | |
| period | Yes | Period for which the interface graph is required. [Example: twelvehours,Today,twfourhours,Yesterday,thisweek,Last_7_Days,lastweek,thismonth,Last_30_Days,Last_Month,custom] | |
| endDate | No | To Date. This param is applicable only if 'custom' time is opted in period param value | |
| startDate | No | From Date. This paramete is applicable only if 'custom' time is opted in period param value | |
| interfaceName | Yes | Name of the interface - Managed Entity name as seen in the URL of interface snapshot page OR 'interfaceName' property value in the listInterfaces API response |