$ ansible-doc -t inventory cisco.sccfm.sccfm
> INVENTORY cisco.sccfm.sccfm (sccfm-ansible/plugins/inventory/sccfm.py)
Uses Cisco Security Cloud Control Firewall Manager (SCCFM) to
enumerate devices using the REST APIs.
Each device becomes an inventory host with SCCFM metadata attached
as host variables.
OPTIONS (= indicates it is required):
= api_token API token for the SCCFM region.
set_via:
env:
- name: SCCFM_API_TOKEN
no_log: true
type: str
- group Group to place all discovered SCCFM devices into.
default: sccfm
type: str
- group_by_device_type Create groups based on device types (e.g.,
ASA, CDFMC_MANAGED_FTD).
default: false
type: bool
- limit Page size to use when fetching devices.
default: 100
type: int
= plugin Ensure this plugin gets loaded.
choices: [cisco.sccfm.sccfm]
- query Optional text filter applied to device names.
default: null
type: str
= region SCCFM region to target (int, us, eu, apj, au, uae, in, or
ci).
set_via:
env:
- name: SCCFM_REGION
type: str
NAME: cisco.sccfm.sccfm
PLUGIN_TYPE: inventory
EXAMPLES:
plugin: cisco.sccfm.sccfm
region: us
api_token: "{{ lookup('env', 'SCCFM_API_TOKEN') }}"
limit: 100
query: "asa"
group: sccfm
group_by_device_type: true