Back to Ansible Reference

$ 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):

- config_path  Optional path to the canonical SCCFM profile
                configuration file.
        default: null
        type: path

- 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]

- profile  Named SCCFM profile configured by `sccfm-cli configure'.
        default: default
        type: str

- query   Optional text filter applied to device names.
        default: null
        type: str

NAME: sccfm

EXAMPLES:
plugin: cisco.sccfm.sccfm
profile: default
limit: 100
query: "asa"
group: sccfm
group_by_device_type: true