Try SpotterAdd a device to the Device Manager database.
| "added in version" 1.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Add a FOS device to FMG
hosts: fortimanagers
gather_facts: false
connection: httpapi
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
fortinet.fortimanager.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
fortinet.fortimanager.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
fortinet.fortimanager.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
- name: Example playbook
hosts: fortimanagers
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.
fortinet.fortimanager.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
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
dvm_cmd_add_device:
description: The top level parameters set.
required: false
suboptions:
adom:
description: Name or ID of the ADOM where the command is to be executed on.
type: str
device:
description: No description.
suboptions:
adm_pass:
description: (list) No description.
type: raw
adm_usr:
description: Add real and promote device.
type: str
authorization template:
description: Deprecated, please rename it to authorization_template. Add model
device only.
type: str
desc:
description: Available for all operations.
type: str
device action:
description:
- Deprecated, please rename it to device_action.
- 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.
type: str
device blueprint:
description: Deprecated, please rename it to device_blueprint. Add model device
only.
type: str
faz.quota:
description: Deprecated, please rename it to faz_quota. Available for all
operations.
type: int
ip:
description: Add real device only.
type: str
meta fields:
description: (dict or str) Deprecated, please rename it to meta_fields.
type: raw
mgmt_mode:
choices:
- unreg
- fmg
- faz
- fmgfaz
description: Add real and model device.
type: str
mr:
description: Add model device only.
type: int
name:
description: Required for all operations.
type: str
os_type:
choices:
- unknown
- fos
- fsw
- foc
- fml
- faz
- fwb
- fch
- fct
- log
- fmg
- fsa
- fdd
- fac
- fpx
- fna
description: Add model device only.
type: str
os_ver:
choices:
- unknown
- '0.0'
- '1.0'
- '2.0'
- '3.0'
- '4.0'
- '5.0'
- '6.0'
- '7.0'
- '8.0'
description: Add model device only.
type: str
patch:
description: Add model device only.
type: int
platform_str:
description: Add model device only.
type: str
sn:
description: Add model device only.
type: str
type: dict
flags:
choices:
- none
- create_task
- nonblocking
- log_dev
description: No description.
elements: str
type: list
groups:
description: No description.
elements: dict
suboptions:
name:
description: No description.
type: str
vdom:
description: No description.
type: str
type: list
type: dict
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list