$ ansible-doc -t module cisco.sccfm.configure_manager
> MODULE cisco.sccfm.configure_manager (sccfm-ansible/plugins/modules/configure_manager.py)
SSH into an FTD VM and run the `configure manager add ...' command
produced by `onboard_cdfmc_ftd'.
This is the final onboarding step; it tells the FTD to phone home to
the cdFMC and register.
This module talks directly to the device over SSH (paramiko). It
does NOT call the SCCFM API, so it does not take `region' or
`api_token' and is not part of the `cisco.sccfm.all' action group.
Only works if the FTD is reachable on its SSH port (`ftd_port',
default 22) from the host running this module, or from the jump host
when `jump_host' is set.
The FTD sees the connection from the SSH client's source IP, so that
IP must be on the FTD ssh-access-list. When a jump host is used,
that source is the jump host's IP.
OPTIONS (= indicates it is required):
= cli_key The full `configure manager add ...' string returned by
`onboard_cdfmc_ftd'.
Must be a single line that starts with `configure manager
add'.
type: str
= ftd_host Management IP address or hostname of the FTD VM.
type: str
- ftd_password SSH password for the FTD VM.
Can also be supplied via the `SCCFM_FTD_PASSWORD'
environment variable.
set_via:
env:
- name: SCCFM_FTD_PASSWORD
default: null
type: str
- ftd_port SSH port of the FTD VM.
default: 22
type: int
= ftd_user SSH username for the FTD VM.
type: str
- jump_host Optional bastion to tunnel through, as
`[user@]host[:port]'.
When set, the FTD sees the connection from the jump
host's IP, so that IP must be on the FTD
ssh-access-list.
default: null
type: str
- jump_password Password for the jump host.
Can also be supplied via the `SCCFM_JUMP_PASSWORD'
environment variable.
Leave unset to use SSH key/agent authentication for
the jump host.
set_via:
env:
- name: SCCFM_JUMP_PASSWORD
default: null
type: str
- ssh_timeout SSH connect and read timeout in seconds.
default: 30
type: int
AUTHOR: Cisco SCCFM Team
EXAMPLES:
# Example 1: Direct SSH to the FTD
- name: Register FTD with its cdFMC manager
cisco.sccfm.configure_manager:
ftd_host: "203.0.113.10"
ftd_user: admin
ftd_password: "{{ vault_ftd_password }}"
cli_key: "{{ onboard_result.cli_key }}"
# Example 2: Through a jump host (bastion)
- name: Register FTD via a bastion
cisco.sccfm.configure_manager:
ftd_host: "203.0.113.10"
ftd_user: admin
ftd_password: "{{ vault_ftd_password }}"
jump_host: "bastion@203.0.113.5:2222"
jump_password: "{{ vault_jump_password }}"
cli_key: "{{ onboard_result.cli_key }}"
# Example 3: Jump host with SSH key/agent auth (no jump_password)
- name: Register FTD via a bastion using key auth
cisco.sccfm.configure_manager:
ftd_host: "203.0.113.10"
ftd_user: admin
ftd_password: "{{ vault_ftd_password }}"
jump_host: "bastion@203.0.113.5:2222"
cli_key: "{{ onboard_result.cli_key }}"
# Example 4: Chained after onboarding
- name: Onboard FTD
cisco.sccfm.onboard_cdfmc_ftd:
name: "Branch FTD"
fmc_access_policy_uid: "{{ fmc_access_policy_uid }}"
licenses:
- BASE
region: "{{ sccfm_region }}"
api_token: "{{ sccfm_api_token }}"
register: onboard_result
- name: Complete registration over SSH
cisco.sccfm.configure_manager:
ftd_host: "203.0.113.10"
ftd_user: admin
ftd_password: "{{ vault_ftd_password }}"
cli_key: "{{ onboard_result.cli_key }}"
RETURN VALUES:
- host The FTD host the command was run against.
returned: success
type: str
- msg Human-readable result message.
returned: always
type: str
- output The device output captured from the FTD CLI, with echoed
manager commands removed.
returned: success
type: str
- success Whether the FTD confirmed the manager configuration.
returned: success
type: bool