$ ansible-doc -t module cisco.sccfm.onboard_cdfmc_ftd
> MODULE cisco.sccfm.onboard_cdfmc_ftd (sccfm-ansible/plugins/modules/onboard_cdfmc_ftd.py)
Onboard a cdFMC-managed FTD device using the manual (non-ZTP)
registration flow.
After the device is created, the module returns a CLI key that must
be pasted into the FTD device's CLI to complete registration with
the cdFMC.
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
= fmc_access_policy_uid UUID of the FMC access policy to apply to
this device.
type: str
- grouped_labels Mapping of grouped labels to assign to the device.
default: null
type: dict
= licenses List of licenses to apply to the device.
At least one license is required.
choices: [BASE, CARRIER, THREAT, MALWARE, URLFilter]
elements: str
type: list
= name Human-readable name for the FTD device.
type: str
- performance_tier Performance tier of the FTDv.
Required when `virtual' is true.
choices: [FTDv5, FTDv10, FTDv20, FTDv30, FTDv50, FTDv100, FTDv]
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
- ungrouped_labels List of free-form labels to assign to the device.
default: null
elements: str
type: list
- virtual Indicate whether the FTD is a virtual device.
When true, `performance_tier' is required.
default: false
type: bool
AUTHOR: Cisco SCCFM Team
EXAMPLES:
# Example 1: Onboard a physical cdFMC-managed FTD
- name: Onboard FTD device
cisco.sccfm.onboard_cdfmc_ftd:
name: "My FTD"
fmc_access_policy_uid: "7131daad-e813-4b8f-8f42-be1e241e8cdb"
licenses:
- BASE
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
# Example 2: Onboard a virtual FTD with multiple licenses
- name: Onboard virtual FTD
cisco.sccfm.onboard_cdfmc_ftd:
name: "My vFTD"
fmc_access_policy_uid: "7131daad-e813-4b8f-8f42-be1e241e8cdb"
licenses:
- BASE
- CARRIER
virtual: true
performance_tier: "FTDv5"
# Example 3: Onboard with labels
- name: Onboard FTD with labels
cisco.sccfm.onboard_cdfmc_ftd:
name: "Branch FTD"
fmc_access_policy_uid: "7131daad-e813-4b8f-8f42-be1e241e8cdb"
licenses:
- BASE
ungrouped_labels:
- ra-vpn-headend
grouped_labels:
environment:
- prod
# Example 4: Using module_defaults (recommended)
- name: Onboard cdFMC-managed FTD
hosts: localhost
gather_facts: false
module_defaults:
group/cisco.sccfm.all:
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
tasks:
- name: Onboard branch FTD
cisco.sccfm.onboard_cdfmc_ftd:
name: "Branch FTD"
fmc_access_policy_uid: "7131daad-e813-4b8f-8f42-be1e241e8cdb"
licenses:
- BASE
RETURN VALUES:
- cli_key The CLI key to paste into the FTD device's CLI to register
it with the cdFMC.
Paste this value into the FTD CLI once to complete
onboarding.
Can be passed directly to a subsequent SSH task.
returned: success (changed=True)
type: str
- device The newly onboarded cdFMC-managed FTD device.
returned: success
type: dict