$ ansible-doc -t module cisco.sccfm.deploy_cdfmc_ftd
> MODULE cisco.sccfm.deploy_cdfmc_ftd (sccfm-ansible/plugins/modules/deploy_cdfmc_ftd.py)
Deploy pending configuration changes to one or more cdFMC-managed
FTD devices via SCC Firewall Manager.
Supports deploying to a single device or up to 50 devices in
parallel.
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
- deployment_notes Notes for the deployment.
default: null
type: str
- description Human-readable description for the deployment.
default: null
type: str
- ignore_warnings Ignore warnings from pre-validation and proceed
with deployment.
default: false
type: bool
- 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 select cdFMC-managed FTD devices.
Mutually exclusive with `uids'.
The query is automatically combined with
`deviceType:CDFMC_MANAGED_FTD'.
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
- timeout Maximum number of seconds to wait for completion when
`wait=true'.
default: 3600
type: int
- uids List of device UIDs to deploy.
Mutually exclusive with `query'.
default: null
elements: str
type: list
- wait Wait for the deployment transaction to complete before
returning.
default: false
type: bool
AUTHOR: Cisco SCCFM Team
EXAMPLES:
# Example 1: Deploy changes to specific FTD devices
- name: Deploy FTD changes
cisco.sccfm.deploy_cdfmc_ftd:
uids:
- "12345678-1234-1234-1234-123456789abc"
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
# Example 2: Deploy with notes
- name: Deploy FTD changes with deployment notes
cisco.sccfm.deploy_cdfmc_ftd:
uids:
- "uid-1"
- "uid-2"
deployment_notes: "Ticket-123: firewall policy update"
description: "Deploy updated access rules"
# Example 3: Deploy using a query
- name: Deploy to all branch FTD devices
cisco.sccfm.deploy_cdfmc_ftd:
query: "name:branch-*"
ignore_warnings: true
wait: true
# Example 4: Using module_defaults (recommended)
- name: Deploy cdFMC-managed FTD changes
hosts: localhost
gather_facts: false
module_defaults:
group/cisco.sccfm.all:
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
tasks:
- name: Deploy branch FTD changes
cisco.sccfm.deploy_cdfmc_ftd:
query: "name:branch-*"
deployment_notes: "Ticket-123: firewall policy update"
wait: true
RETURN VALUES:
- device_count Number of devices included in the deployment.
returned: always
type: int
- transaction The transaction object tracking the async deployment.
returned: success (changed=True)
type: dict