community.fortios.fmgr_device_group module – Alter FortiManager device groups.

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_group.

Synopsis

  • Add or edit device groups and assign devices to device groups FortiManager Device Manager using JSON RPC API.

Parameters

Parameter

Comments

adom

string

The ADOM the configuration should belong to.

Default: "root"

grp_desc

string

The description of the device group.

grp_members

string

A comma separated list of device names or device groups to be added as members to the device group.

If Group Members are defined, and mode=”delete”, only group members will be removed.

If you want to delete a group itself, you must omit this parameter from the task in playbook.

grp_name

string

The name of the device group.

mode

string

Sets one of three modes for managing the object.

Allows use of soft-adds instead of overwriting existing values

Choices:

  • "add" ← (default)

  • "set"

  • "delete"

  • "update"

vdom

string

The VDOM of the Fortigate you want to add, must match the device in FMGR. Usually root.

Default: "root"

Notes

Note

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

Description

api_result

string

full API response, includes status code and message

Returned: always

Authors

  • Luke Weighall (@lweighall)

  • Andrew Welsh (@Ghilli3)

  • Jim Huber (@p4r4n0y1ng)