$ ansible-doc -t module cisco.sccfm.list_managers
> MODULE cisco.sccfm.list_managers (sccfm-ansible/plugins/modules/list_managers.py)
List on-premises and cloud-delivered FMC managers in your SCC
Firewall Manager tenant.
Supports pagination via `limit' and `offset'.
Supports Lucene query filtering via `query'.
OPTIONS (= indicates it is required):
- api_token API token for SCCFM.
set_via:
env:
- name: SCCFM_API_TOKEN
default: null
no_log: true
type: str
- limit Maximum number of results to return.
default: 50
type: int
- offset Pagination offset (number of results to skip).
default: 0
type: int
- query Optional Lucene query string to filter results (e.g.
`name:myFMC*').
default: null
type: str
- region SCCFM region (int, us, eu, apj, au, uae, in, or ci).
set_via:
env:
- name: SCCFM_REGION
default: null
type: str
AUTHOR: Cisco SCCFM Team
EXAMPLES:
# Example 1: List all managers
- name: List all managers
cisco.sccfm.list_managers:
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
register: result
- name: Show managers
ansible.builtin.debug:
var: result.managers
# Example 2: Find a specific manager by name
- name: Find cdFMC manager
cisco.sccfm.list_managers:
query: "name:mycdFMC"
register: result
- name: Get domain UID
ansible.builtin.set_fact:
domain_uid: "{{ result.managers[0].fmc_domain_uid }}"
# Example 3: Using module_defaults (recommended)
- name: List managers
hosts: localhost
gather_facts: false
module_defaults:
group/cisco.sccfm.all:
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
tasks:
- name: List all managers
cisco.sccfm.list_managers:
limit: 50
RETURN VALUES:
- count Total number of matching managers.
returned: success
type: int
- limit The limit used in the request.
returned: success
type: int
- managers List of managers returned by the API.
elements: dict
returned: success
type: list
contains:
- connectivity_state Connectivity state of the manager.
type: str
- device_type Type of the manager (e.g. CDFMC, ONPREM_FMC).
type: str
- fmc_domain_uid The FMC domain UID. Pass this to
list_cdfmc_access_policies.
type: str
- name Name of the manager.
type: str
- software_version Software version of the manager.
type: str
- uid Unique identifier of the manager.
type: str
- offset The offset used in the request.
returned: success
type: int