community.network.fmgr_device – Add or remove device from FortiManager.
community.network.fmgr_device – Add or remove device from FortiManager.
Note
This plugin is part of the community.network collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.fmgr_device
.
Synopsis
- Add or remove a device or list of devices from FortiManager Device Manager using JSON RPC API.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
adom string / required |
Default: "root" |
The ADOM the configuration should belong to. |
blind_add string |
|
When adding a device, module will check if it exists, and skip if it does. If enabled, this option will stop the module from checking if it already exists, and blindly add the device. |
device_ip string |
The IP of the device being added to FortiManager. Supports both IPv4 and IPv6. | |
device_password string |
The password of the device being added to FortiManager. | |
device_serial string |
The serial number of the device being added to FortiManager. | |
device_unique_name string |
The desired "friendly" name of the device being added to FortiManager. | |
device_username string |
The username of the device being added to FortiManager. | |
mode string |
|
The desired mode of the specified object. |
Notes
Examples
- name: DISCOVER AND ADD DEVICE FGT1
community.network.fmgr_device:
adom: "root"
device_username: "admin"
device_password: "admin"
device_ip: "10.10.24.201"
device_unique_name: "FGT1"
device_serial: "FGVM000000117994"
mode: "add"
blind_add: "enable"
- name: DISCOVER AND ADD DEVICE FGT2
community.network.fmgr_device:
adom: "root"
device_username: "admin"
device_password: "admin"
device_ip: "10.10.24.202"
device_unique_name: "FGT2"
device_serial: "FGVM000000117992"
mode: "delete"
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)
- Andrew Welsh (@Ghilli3)
- Jim Huber (@p4r4n0y1ng)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/fmgr_device_module.html