Back to Ansible Reference

$ ansible-doc -t module cisco.sccfm.register_cdfmc_ftd

> MODULE cisco.sccfm.register_cdfmc_ftd (sccfm-ansible/plugins/modules/register_cdfmc_ftd.py)

  Completes the registration of an FTD device with its cdFMC manager
  after the CLI key has been pasted on the device. Call this module
  after `cisco.sccfm.configure_manager' succeeds.
  Returns a transaction and waits for it to reach DONE status.

OPTIONS (= indicates it is required):

- api_token  The SCC Firewall Manager API token.
        set_via:
          env:
          - name: SCCFM_API_TOKEN
        default: null
        no_log: true
        type: str

= ftd_uid  The UID of the FTD device in SCC Firewall Manager to
            register.
        type: str

- region  The SCC Firewall Manager region.
        set_via:
          env:
          - name: SCCFM_REGION
        default: null
        type: str

- skip_initial_deployment  If true, the initial configuration
                            deployment to the device is skipped after
                            registration.
        default: false
        type: bool

AUTHOR: Cisco SCCFM Team

EXAMPLES:
- name: Register vFTD with cdFMC using shared authentication defaults
  hosts: localhost
  gather_facts: false
  module_defaults:
    group/cisco.sccfm.all:
      region: "{{ sccfm_region }}"
      api_token: "{{ sccfm_api_token }}"
  tasks:
    - name: Complete the FTD registration
      cisco.sccfm.register_cdfmc_ftd:
        ftd_uid: "{{ ftd_onboard_result.device.uid }}"

RETURN VALUES:

- device  The registered FTD device record from SCC Firewall Manager.
        returned: always
        type: dict