community.fortios.faz_device – Add or remove device
Note
This plugin is part of the community.fortios collection (version 1.0.0).
To install it use: ansible-galaxy collection install community.fortios.
To use it in a playbook, specify: community.fortios.faz_device.
Synopsis
- Add or remove a device or list of devices to FortiAnalyzer Device Manager. ADOM Capable.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| adom string / required | Default: "root" | The ADOM the configuration should belong to. |
| device_ip string | The IP of the device being added to FortiAnalyzer. | |
| device_password string | The password of the device being added to FortiAnalyzer. | |
| device_serial string | The serial number of the device being added to FortiAnalyzer. | |
| device_unique_name string | The desired "friendly" name of the device being added to FortiAnalyzer. | |
| device_username string | The username of the device being added to FortiAnalyzer. | |
| faz_quota string | Specifies the quota for the device in FAZ | |
| mgmt_mode string / required |
| Management Mode of the device you are adding. |
| mode string |
| Add or delete devices. Or promote unregistered devices that are in the FortiAnalyzer "waiting pool" |
| os_minor_vers string / required | Minor OS rev of the device. | |
| os_type string / required |
| The os type of the device being added (default 0). |
| os_ver string / required |
| Major OS rev of the device |
| platform_str string | Required for determine the platform for VM platforms. ie FortiGate-VM64 |
Examples
- name: DISCOVER AND ADD DEVICE A PHYSICAL FORTIGATE
community.fortios.faz_device:
adom: "root"
device_username: "admin"
device_password: "admin"
device_ip: "10.10.24.201"
device_unique_name: "FGT1"
device_serial: "FGVM000000117994"
state: "present"
mgmt_mode: "faz"
os_type: "fos"
os_ver: "5.0"
minor_rev: 6
- name: DISCOVER AND ADD DEVICE A VIRTUAL FORTIGATE
community.fortios.faz_device:
adom: "root"
device_username: "admin"
device_password: "admin"
device_ip: "10.10.24.202"
device_unique_name: "FGT2"
mgmt_mode: "faz"
os_type: "fos"
os_ver: "5.0"
minor_rev: 6
state: "present"
platform_str: "FortiGate-VM64"
- name: DELETE DEVICE FGT01
community.fortios.faz_device:
adom: "root"
device_unique_name: "ansible-fgt01"
mode: "delete"
- name: DELETE DEVICE FGT02
community.fortios.faz_device:
adom: "root"
device_unique_name: "ansible-fgt02"
mode: "delete"
- name: PROMOTE FGT01 IN FAZ BY IP
community.fortios.faz_device:
adom: "root"
device_password: "fortinet"
device_ip: "10.7.220.151"
device_username: "ansible"
mgmt_mode: "faz"
mode: "promote"
- name: PROMOTE FGT02 IN FAZ
community.fortios.faz_device:
adom: "root"
device_password: "fortinet"
device_unique_name: "ansible-fgt02"
device_username: "ansible"
mgmt_mode: "faz"
mode: "promote"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| api_result string | always | full API response, includes status code and message |
Authors
- Luke Weighall (@lweighall)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/fortios/faz_device_module.html