Skip to content

Latest commit

 

History

History
279 lines (256 loc) · 16.2 KB

cisco.sastre.show_alarms_module.rst

File metadata and controls

279 lines (256 loc) · 16.2 KB
source:show_alarms.py
orphan:

show_alarms -- Display vManage alarms.

Synopsis

  • This show alarms module connects to SD-WAN vManage using HTTP REST to retrieve and display vManage alarms.This module contains multiple arguments with connection and filter details to retrieve data. The retrieved data will be displayed to console in table format or can be exported as csv/json files. When multiple filters are defined, the result is an AND of all filters.

Parameters

Parameter Choices/Defaults Comments
address
string / required
vManage IP address or can also be defined via VMANAGE_IP environment variable
days
integer
Default:
0
Retrieve records since <days> ago (default is now)
detail
boolean
    Choices:
  • no ←
  • yes
Detailed output (i.e. more columns)
exclude
string
Exclude table rows matching the regular expression
hours
integer
Default:
1
Retrieve records since <hours> ago (default is now)
include
string
Include table rows matching the regular expression, exclude all other rows
max
integer
Default:
100
Maximum number of records to retrieve (default is now)
password
string / required
password or can also be defined via VMANAGE_PASSWORD environment variable.
port
integer
Default:
8443
vManage port number or can also be defined via VMANAGE_PORT environment variable
save_csv
string
Export results as CSV files under the specified directory
save_json
string
Export results as JSON-formatted file
simple
boolean
    Choices:
  • no ←
  • yes
Simple output (i.e. less columns)
tenant
string
tenant name, when using provider accounts in multi-tenant deployments.
timeout
integer
Default:
300
vManage REST API timeout in seconds
user
string / required
username or can also be defined via VMANAGE_USER environment variable.

Notes

Note

  • Tested against 20.10

Examples

- name: Show alarms data
  cisco.sastre.show_alarms:
    include: ".*"
    max: 1
    days: 1
    hours: 1
    detail: true
    save_csv: show_alarms_csv
    save_json: show_alarms_json
    address: 198.18.1.10
    port: 8443
    user: admin
    password: admin
- name: Show alarms data
  cisco.sastre.show_alarms:
    address: 198.18.1.10
    port: 8443
    user: admin
    password: admin