Skip to content

Latest commit

 

History

History
278 lines (255 loc) · 15.4 KB

cisco.sastre.show_devices_module.rst

File metadata and controls

278 lines (255 loc) · 15.4 KB
source:show_devices.py
orphan:

show_devices -- Show Device List

Synopsis

  • This show devices module connects to SD-WAN vManage using HTTP REST to retrieve different data.This module contains multiple arguments with connection and filter details to retrieve devices,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
exclude
string
Exclude table rows matching the regular expression
include
string
Include table rows matching the regular expression, exclude all other rows
not_regex
string
Regular expression matching device name, type or model NOT to display.
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
reachable
boolean
    Choices:
  • no ←
  • yes
Display only reachable devices
regex
string
Regular expression matching device name, type or model to display
save_csv
string
Export results as CSV files under the specified directory
save_json
string
Export results as JSON-formatted file
site
string
Select devices with site ID.
system_ip
string
Select device with system IP.
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 devices data
  cisco.sastre.show_devices:
    regex: ".*"
    include: ".*"
    reachable: true
    site: "100"
    system_ip: 10.1.0.2
    save_csv: show_devices_csv
    save_json: show_devices_json
    address: 198.18.1.10
    port: 8443
    user: admin
    password: admin
- name: Show devices data
  cisco.sastre.show_devices:
    not_regex: ".*"
    reachable: true
    site: "100"
    system_ip: 10.1.0.2
    save_csv: show_devices_csv
    save_json: show_devices_json
    address: 198.18.1.10
    port: 8443
    user: admin
    password: admin