$ ansible-doc -t module cisco.sccfm.list_access_groups
> MODULE cisco.sccfm.list_access_groups (sccfm-ansible/plugins/modules/list_access_groups.py)
List ASA access groups from 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.
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:
# List all access groups
- name: List access groups
cisco.sccfm.list_access_groups:
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
register: result
- name: Display access groups
ansible.builtin.debug:
var: result.access_groups
# Using module_defaults (recommended)
- name: List access groups with shared auth
hosts: localhost
gather_facts: false
module_defaults:
group/cisco.sccfm.all:
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
tasks:
- name: List access groups
cisco.sccfm.list_access_groups:
limit: 100
RETURN VALUES:
- access_groups List of access groups returned by the API.
elements: dict
returned: success
type: list
contains:
- entity_uid UID of the device or manager.
type: str
- name Access group name.
type: str
- uid Unique identifier.
type: str
- count Total number of matching access groups.
returned: success
type: int
- limit The limit used in the request.
returned: success
type: int
- offset The offset used in the request.
returned: success
type: int