$ ansible-doc -t module cisco.sccfm.onboard_cdfmc_ftd_ztp
> MODULE cisco.sccfm.onboard_cdfmc_ftd_ztp (sccfm-ansible/plugins/modules/onboard_cdfmc_ftd_ztp.py)
Onboard a cdFMC-managed FTD device via Zero-Touch Provisioning
(ZTP).
The device registers automatically when it is plugged in and
connects to the Internet.
Applies to 1xxx/2xxx/3xxx series physical FTD devices.
This module is idempotent - if a device with the same name and
serial number is already onboarded, it returns `changed=False'
without error.
If the name is already taken by a device with a different serial
number, the module fails with a clear error message.
Note: the inventory API does not support searching by serial number,
so a device onboarded under a different name with the same serial
cannot be detected at this stage. The API will return an error in
that case.
OPTIONS (= indicates it is required):
- admin_password Initial provisioning password for the FTD device.
Required if a password has not already been set on
the device.
default: null
no_log: true
type: str
- api_token API token for SCCFM.
set_via:
env:
- name: SCCFM_API_TOKEN
default: null
no_log: true
type: str
- device_group_uid UUID of the device group the device will join
after registration.
default: null
type: str
= fmc_access_policy_uid UUID of the FMC access policy to apply to
this device.
type: str
= licenses List of licenses to apply to the device. At least one is
required.
choices: [BASE, CARRIER, THREAT, MALWARE, URLFilter]
elements: str
type: list
= name Human-readable name for the FTD device.
type: str
- region SCCFM region (int, us, eu, apj, au, uae, in, or ci).
set_via:
env:
- name: SCCFM_REGION
default: null
type: str
= serial_number Serial number of the physical FTD device.
type: str
AUTHOR: Cisco SCCFM Team
EXAMPLES:
# Example 1: Onboard a physical FTD via ZTP
- name: Onboard FTD via ZTP
cisco.sccfm.onboard_cdfmc_ftd_ztp:
name: "Branch FTD"
serial_number: "FTD1234567890"
licenses:
- BASE
fmc_access_policy_uid: "7131daad-e813-4b8f-8f42-be1e241e8cdb"
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
# Example 2: Onboard with initial password and device group
- name: Onboard FTD via ZTP with password
cisco.sccfm.onboard_cdfmc_ftd_ztp:
name: "Branch FTD"
serial_number: "FTD1234567890"
licenses:
- BASE
- CARRIER
fmc_access_policy_uid: "7131daad-e813-4b8f-8f42-be1e241e8cdb"
admin_password: "{{ ftd_admin_password }}"
device_group_uid: "abcd1234-0000-0000-0000-000000000001"
# Example 3: Using module_defaults (recommended)
- name: Onboard cdFMC-managed FTD with ZTP
hosts: localhost
gather_facts: false
module_defaults:
group/cisco.sccfm.all:
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
tasks:
- name: Onboard branch FTD through ZTP
cisco.sccfm.onboard_cdfmc_ftd_ztp:
name: "Branch FTD"
serial_number: "FTD1234567890"
licenses:
- BASE
fmc_access_policy_uid: "7131daad-e813-4b8f-8f42-be1e241e8cdb"
RETURN VALUES:
- device_uid The UID of the onboarded FTD device in SCC Firewall
Manager.
`None' when the module runs in check mode or the device
already existed (`changed=False').
returned: always
type: str