cisco.sastre.inventory_module.rst

source:	inventory.py
orphan:

inventory -- Inventory device List

• Synopsis
• Parameters
• Notes
• Examples

Synopsis

• This inventory module connects to SD-WAN vManage using HTTP REST to retrieve inventory device list.This module returns list of SD-WAN devices from vManage with multiple filter options. When multiple filters are defined, the result is an AND of all filters. When no filter is defined all devices are returned.

Parameters

Parameter	Choices/Defaults	Comments
address string / required		vManage IP address or can also be defined via VMANAGE_IP environment variable
device_type string		Match on device type to include. Supported values are 'vmanage', 'vsmart', 'vbond', 'vedge', 'cedge'
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
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: Get inventory devices
  cisco.sastre.inventory:
    regex: ".*"
    reachable: true
    site: "100"
    system_ip: 10.1.0.2
    device_type: 'vmanage'
    address: 198.18.1.10
    port: 8443
    user: admin
    password: admin
- name: Get inventory devices
  cisco.sastre.inventory:
    not_regex: ".*"
    reachable: true
    site: "100"
    system_ip: 10.1.0.2
    address: 198.18.1.10
    port: 8443
    user: admin
    password: admin