fortinet.fortimanager.fmgr_dvm_cmd_add_device – Add a device to the Device Manager database.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_dvm_cmd_add_device.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
dvm_cmd_add_device
dictionary
the top level parameters set
adom
string
Name or ID of the ADOM where the command is to be executed on.
device
dictionary
no description
adm_pass
string
no description
adm_usr
string
<i>add real and promote device</i>.
desc
string
<i>available for all operations</i>.
device action
string
Specify add device operations, or leave blank to add real device:
"add_model" - add a model device.
"promote_unreg" - promote an unregistered device to be managed by FortiManager using information from database.
faz.quota
integer
<i>available for all operations</i>.
ip
string
<i>add real device only</i>. Add device will probe with this IP using the log in credential specified.
meta fields
dictionary
no description
mgmt_mode
string
    Choices:
  • unreg
  • fmg
  • faz
  • fmgfaz
<i>add real and model device</i>.
mr
integer
<i>add model device only</i>.
name
string
<i>required for all operations</i>. Unique name for the device.
os_type
string
    Choices:
  • unknown
  • fos
  • fsw
  • foc
  • fml
  • faz
  • fwb
  • fch
  • fct
  • log
  • fmg
  • fsa
  • fdd
  • fac
  • fpx
  • fna
<i>add model device only</i>.
os_ver
string
    Choices:
  • unknown
  • 0.0
  • 1.0
  • 2.0
  • 3.0
  • 4.0
  • 5.0
  • 6.0
os version
patch
integer
<i>add model device only</i>.
platform_str
string
<i>add model device only</i>. Required for determine the platform for VM platforms.
sn
string
<i>add model device only</i>. This attribute will be used to determine the device platform, except for VM platforms, w...
flags
list / elements=string
    Choices:
  • none
  • create_task
  • nonblocking
  • log_dev
no description
groups
list / elements=string
no description
name
string
no description
vdom
string
no description
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Add a FOS device to FMG
  hosts: fortimanager01
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
    fos_user: 'admin'
    fos_pass: 'password'
    fos_ip: '192.168.190.151'
  tasks:
    - name: discover device
      fmgr_dvm_cmd_discover_device:
        bypass_validation: True
        dvm_cmd_discover_device:
            device:
                adm_pass: '{{ fos_pass }}'
                adm_usr: '{{ fos_user }}'
                ip: '{{ fos_ip }}'
      register: probed_device
    - name: add device
      fmgr_dvm_cmd_add_device:
        bypass_validation: True
        dvm_cmd_add_device:
            adom: 'root'
            flags:
              - 'create_task'
              - 'nonblocking'
            device:
                adm_usr: '{{ probed_device.meta.response_data.device.adm_usr }}'
                adm_pass: '{{ probed_device.meta.response_data.device.adm_pass }}'
                desc: 'The device is added via FortiManager Ansible'
                ip: '{{ probed_device.meta.response_data.device.ip }}'
                mgmt_mode: 'fmg'
                name: '{{ probed_device.meta.response_data.device.name }}'
                sn: '{{ probed_device.meta.response_data.device.sn }}'
      register: installing_task
    - name: poll the task
      fmgr_fact:
        facts:
            selector: 'task_task'
            params:
                task: '{{installing_task.meta.response_data.taskid}}'
      register: taskinfo
      until: taskinfo.meta.response_data.percent == 100
      retries: 30
      delay: 5
      failed_when: taskinfo.meta.response_data.state == 'error' and 'devsnexist' not in taskinfo.meta.response_data.line[0].detail

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Add a device to the Device Manager database.
     fmgr_dvm_cmd_add_device:
        bypass_validation: False
        dvm_cmd_add_device:
           adom: ansible
           device:
              adm_pass: fortinet # device password
              adm_usr: admin # device user name
              ip: 0.0.0.0 # device ip
              mgmt_mode: fmg #<value in [unreg, fmg, faz, ...]>
              name: FGT_AWS
           flags:
             - none
             - create_task
             - nonblocking
             - log_dev

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)