fortios_user_group – Configure user groups in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_user_group – Configure user groups in Fortinet’s FortiOS and FortiGate

New in version 2.9.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

## Requirements

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
password string | Default: "" | FortiOS or FortiGate password.
ssl_verify boolean | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
state string / required | Choices: present absent | Indicates whether to create or remove the object.
user_group dictionary | Default: null | Configure user groups.
| auth_concurrent_override string | Choices: enable disable | Enable/disable overriding the global number of concurrent authentication sessions for this user group.
| auth_concurrent_value integer |  | Maximum number of concurrent authenticated connections per user (0 - 100).
| authtimeout integer |  | Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout.
| company string | Choices: optional mandatory disabled | Set the action for the company guest user field.
| email string | Choices: disable enable | Enable/disable the guest user email address field.
| expire integer |  | Time in seconds before guest user accounts expire. (1 - 31536000 sec)
| expire_type string | Choices: immediately first-successful-login | Determine when the expiration countdown begins.
| group_type string | Choices: firewall fsso-service rsso guest | Set the group to be for firewall authentication, FSSO, RSSO, or guest users.
| guest list |  | Guest User.
|  | comment string |  | Comment.
|  | company string |  | Set the action for the company guest user field.
|  | email string |  | Email.
|  | expiration string |  | Expire time.
|  | mobile_phone string |  | Mobile phone.
|  | name string |  | Guest name.
|  | password string |  | Guest password.
|  | sponsor string |  | Set the action for the sponsor guest user field.
|  | user_id string |  | Guest ID.
| http_digest_realm string |  | Realm attribute for MD5-digest authentication.
| id integer |  | Group ID.
| match list |  | Group matches.
|  | group_name string |  | Name of matching group on remote authentication server.
|  | id integer / required |  | ID.
|  | server_name string |  | Name of remote auth server. Source user.radius.name user.ldap.name user.tacacs+.name.
| max_accounts integer |  | Maximum number of guest accounts that can be created for this group (0 means unlimited).
| member list |  | Names of users, peers, LDAP servers, or RADIUS servers to add to the user group.
|  | name string / required |  | Group member name. Source user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.adgrp.name user .pop3.name.
| mobile_phone string | Choices: disable enable | Enable/disable the guest user mobile phone number field.
| multiple_guest_add string | Choices: disable enable | Enable/disable addition of multiple guests.
| name string / required |  | Group name.
| password string | Choices: auto-generate specify disable | Guest user password type.
| sms_custom_server string |  | SMS server. Source system.sms-server.name.
| sms_server string | Choices: fortiguard custom | Send SMS through FortiGuard or other external server.
| sponsor string | Choices: optional mandatory disabled | Set the action for the sponsor guest user field.
| sso_attribute_value string |  | Name of the RADIUS user group that this local user group represents.
| user_id string | Choices: email auto-generate specify | Guest user ID type.
| user_name string | Choices: disable enable | Enable/disable the guest user name entry.
username string |  | FortiOS or FortiGate username.
vdom string | Default: "root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

## Notes

Note

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
       ssl_verify: "False"
      tasks:
      - name: Configure user groups.
        fortios_user_group:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          user_group:
            auth_concurrent_override: "enable"
            auth_concurrent_value: "4"
            authtimeout: "5"
            company: "optional"
            email: "disable"
            expire: "8"
            expire_type: "immediately"
            group_type: "firewall"
            guest:
             -
                comment: "Comment."
                company: "<your_own_value>"
                email: "<your_own_value>"
                expiration: "<your_own_value>"
                mobile_phone: "<your_own_value>"
                name: "default_name_17"
                password: "<your_own_value>"
                sponsor: "<your_own_value>"
                user_id: "<your_own_value>"
            http_digest_realm: "<your_own_value>"
            id:  "22"
            match:
             -
                group_name: "<your_own_value>"
                id:  "25"
                server_name: "<your_own_value> (source user.radius.name user.ldap.name user.tacacs+.name)"
            max_accounts: "27"
            member:
             -
                name: "default_name_29 (source user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.adgrp.name user.pop3.name)"
            mobile_phone: "disable"
            multiple_guest_add: "disable"
            name: "default_name_32"
            password: "auto-generate"
            sms_custom_server: "<your_own_value> (source system.sms-server.name)"
            sms_server: "fortiguard"
            sponsor: "optional"
            sso_attribute_value: "<your_own_value>"
            user_id: "email"
            user_name: "disable"

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
build string | always | Build number of the fortigate image Sample: 1547
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id
name string | always | Name of the table used to fulfill the request Sample: urlfilter
path string | always | Path of the table used to fulfill the request Sample: webfilter
revision string | always | Internal revision number Sample: 17.0.2.10658
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string | always | Indication of the operation's result Sample: success
vdom string | always | Virtual domain used Sample: root
version string | always | Version of the FortiGate Sample: v5.6.3

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.