community.fortios.fmgr_device module – Add or remove device from FortiManager.
Note
This module is part of the community.fortios collection (version 1.0.0).
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 community.fortios
.
To use it in a playbook, specify: community.fortios.fmgr_device
.
Synopsis
Add or remove a device or list of devices from FortiManager Device Manager using JSON RPC API.
Parameters
Parameter |
Comments |
---|---|
The ADOM the configuration should belong to. Default: |
|
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. Choices:
|
|
The IP of the device being added to FortiManager. Supports both IPv4 and IPv6. |
|
The password of the device being added to FortiManager. |
|
The serial number of the device being added to FortiManager. |
|
The desired “friendly” name of the device being added to FortiManager. |
|
The username of the device being added to FortiManager. |
|
The desired mode of the specified object. Choices:
|
Notes
Note
Full Documentation at https://ftnt-ansible-docs.readthedocs.io/en/latest/.
Examples
- name: DISCOVER AND ADD DEVICE FGT1
community.fortios.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.fortios.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 |
Description |
---|---|
full API response, includes status code and message Returned: always |