$ ansible-doc -t module cisco.sccfm.get_access_group
> MODULE cisco.sccfm.get_access_group (sccfm-ansible/plugins/modules/get_access_group.py)
Retrieve the full details of an ASA access group by UID.
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
- region SCCFM region (int, us, eu, apj, au, uae, in, or ci).
set_via:
env:
- name: SCCFM_REGION
default: null
type: str
= uid Unique identifier (UID) of the access group to retrieve.
type: str
AUTHOR: Cisco SCCFM Team
EXAMPLES:
# Get access group details by UID
- name: Get access group
cisco.sccfm.get_access_group:
uid: "c6fa254e-db7a-447e-a58f-95df1e09c2af"
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
register: result
- name: Show access group name
ansible.builtin.debug:
msg: "Access group: {{ result.access_group.name }}"
# Using module_defaults (recommended)
- name: Get access group with shared auth
hosts: localhost
gather_facts: false
module_defaults:
group/cisco.sccfm.all:
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
tasks:
- name: Get access group
cisco.sccfm.get_access_group:
uid: "c6fa254e-db7a-447e-a58f-95df1e09c2af"
RETURN VALUES:
- access_group Full details of the access group.
returned: success
type: dict
contains:
- entity_uid UID of the device or manager.
type: str
- is_shared Whether the access group is shared.
type: bool
- name Access group name.
type: str
- uid Unique identifier.
type: str