$ ansible-doc -t module cisco.sccfm.list_asa_boot_registry
> MODULE cisco.sccfm.list_asa_boot_registry (sccfm-ansible/plugins/modules/list_asa_boot_registry.py)
Retrieves boot registry information (system image, config register,
boot system entries) from one or more ASA devices managed by SCC
Firewall Manager.
Executes `show version' and `show run boot' on the target devices
and parses the output into structured data.
Devices can be selected by a Lucene query or by specifying a list of
UIDs.
See
https://developer.cisco.com/docs/cisco-security-cloud-control/execute-cli-command/
for API documentation.
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 devices to return when using `query'.
Ignored when using `uids'.
default: 50
type: int
- offset Pagination offset when using `query'.
Ignored when using `uids'.
default: 0
type: int
- query Lucene query to filter ASA devices.
Mutually exclusive with `uids'.
The query is automatically combined with `deviceType:ASA'.
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
- uids List of device UIDs to query.
Mutually exclusive with `query'.
default: null
elements: str
type: list
AUTHOR: Cisco SCCFM Team
EXAMPLES:
# Example 1: Get boot registry info for ASAs matching a query
- name: List boot registry on production ASAs
cisco.sccfm.list_asa_boot_registry:
query: "name:prod-* AND connectivityState:ONLINE"
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
register: boot_registry
# Example 2: Get boot registry info for specific devices by UID
- name: List boot registry on specific ASAs
cisco.sccfm.list_asa_boot_registry:
uids:
- "12345678-1234-1234-1234-123456789abc"
- "87654321-4321-4321-4321-cba987654321"
register: boot_registry
# Example 3: Using module_defaults (recommended)
- name: List boot registry
hosts: localhost
gather_facts: false
module_defaults:
group/cisco.sccfm.all:
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
tasks:
- name: List boot registry on branch ASAs
cisco.sccfm.list_asa_boot_registry:
query: "name:branch-*"
register: boot_registry
- name: Show devices with modified config
ansible.builtin.debug:
msg: "{{ boot_registry.results | selectattr('config_modified', 'equalto', true) | list }}"
RETURN VALUES:
- results List of boot registry entries for the target devices.
elements: dict
returned: success
type: list
contains:
- boot_system_entries List of boot system entries from the
running config.
elements: str
type: list
- compiled_date The date the running image was compiled.
type: str
- config_modified Whether the configuration has been
modified since last restart.
type: bool
- config_register The configuration register value (e.g.
0x1).
type: str
- device_uid The UID of the device.
type: str
- system_image_file The system image file path on the
device.
type: str