community.fortios.fmgr_device_group – Alter FortiManager device groups.¶
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.fmgr_device_group
.
Synopsis¶
Add or edit device groups and assign devices to device groups FortiManager Device Manager using JSON RPC API.
Parameters¶
Notes¶
Note
Full Documentation at https://ftnt-ansible-docs.readthedocs.io/en/latest/.
Examples¶
- name: CREATE DEVICE GROUP
community.fortios.fmgr_device_group:
grp_name: "TestGroup"
grp_desc: "CreatedbyAnsible"
adom: "ansible"
mode: "add"
- name: CREATE DEVICE GROUP 2
community.fortios.fmgr_device_group:
grp_name: "AnsibleGroup"
grp_desc: "CreatedbyAnsible"
adom: "ansible"
mode: "add"
- name: ADD DEVICES TO DEVICE GROUP
community.fortios.fmgr_device_group:
mode: "add"
grp_name: "TestGroup"
grp_members: "FGT1,FGT2"
adom: "ansible"
vdom: "root"
- name: REMOVE DEVICES TO DEVICE GROUP
community.fortios.fmgr_device_group:
mode: "delete"
grp_name: "TestGroup"
grp_members: "FGT1,FGT2"
adom: "ansible"
- name: DELETE DEVICE GROUP
community.fortios.fmgr_device_group:
grp_name: "AnsibleGroup"
grp_desc: "CreatedbyAnsible"
mode: "delete"
adom: "ansible"
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)