$ ansible-doc -t module cisco.sccfm.onboard_asa
> MODULE cisco.sccfm.onboard_asa (sccfm-ansible/plugins/modules/onboard_asa.py)
Onboard an ASA device to your SCC Firewall Manager tenant
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
- connector_name Name of the Secure Device Connector (SDC) to use
(required when connector_type is SDC).
default: null
type: str
= connector_type Connector type used to communicate with the device.
choices: [SDC, CDG]
type: str
= device_address Device address in the form host:port.
type: str
- grouped_labels Mapping of grouped labels to assign to the device.
default: null
type: dict
- ignore_certificate Whether to skip certificate validation when
onboarding.
default: false
type: bool
= name Human-readable name for the ASA device.
type: str
= password Password used to authenticate with the device.
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
- ungrouped_labels List of free-form labels to assign to the device.
default: null
elements: str
type: list
= username Username used to authenticate with the device.
type: str
AUTHOR: Cisco SCCFM Team
EXAMPLES:
# Example 1: Using module_defaults (recommended)
- name: Onboard ASA devices
hosts: all
module_defaults:
group/cisco.sccfm.all:
region: "{{ sccfm_region }}"
api_token: "{{ lookup('env', 'SCCFM_API_TOKEN') }}"
tasks:
- name: Onboard branch-asa-1
cisco.sccfm.onboard_asa:
name: branch-asa-1
device_address: 192.0.2.10:443
username: admin
password: "{{ vault_asa_password }}"
connector_type: SDC
connector_name: branch-sdc-1
ignore_certificate: true
grouped_labels:
site: ["branch-1"]
ungrouped_labels:
- asa
- branch
# Example 2: Explicit parameters
- name: Onboard branch-asa-1
cisco.sccfm.onboard_asa:
name: branch-asa-1
device_address: 192.0.2.10:443
username: admin
password: "{{ vault_asa_password }}"
connector_type: SDC
connector_name: branch-sdc-1
region: us
api_token: "{{ lookup('env', 'SCCFM_API_TOKEN') }}"
# Example 3: Using environment variables (SCCFM_REGION and SCCFM_API_TOKEN)
- name: Onboard branch-asa-1
cisco.sccfm.onboard_asa:
name: branch-asa-1
device_address: 192.0.2.10:443
username: admin
password: "{{ vault_asa_password }}"
connector_type: SDC
connector_name: branch-sdc-1
RETURN VALUES:
- device The existing or newly onboarded ASA device.
returned: always
type: dict