fortinet.fortios.fortios_user_group module – Configure user groups in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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 fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_user_group
.
New in fortinet.fortios 2.0.0
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.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure user groups. |
|
Enable/disable overriding the global number of concurrent authentication sessions for this user group. Choices:
|
|
Maximum number of concurrent authenticated connections per user (0 - 100). |
|
Authentication timeout in minutes for this user group. 0 to use the global user setting auth-timeout. |
|
Set the action for the company guest user field. Choices:
|
|
Enable/disable the guest user email address field. Choices:
|
|
Time in seconds before guest user accounts expire (1 - 31536000). |
|
Determine when the expiration countdown begins. Choices:
|
|
Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Choices:
|
|
Guest User. |
|
Comment. |
|
Set the action for the company guest user field. |
|
Email. |
|
Expire time. |
|
Guest ID. see <a href=’#notes’>Notes</a>. |
|
Mobile phone. |
|
Guest name. |
|
Guest password. |
|
Set the action for the sponsor guest user field. |
|
Guest ID. |
|
Realm attribute for MD5-digest authentication. |
|
Group ID. |
|
Group matches. |
|
Name of matching user or group on remote authentication server or SCIM. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Name of remote auth server. Source user.radius.name user.ldap.name user.tacacs+.name user.saml.name user .external-identity-provider.name. |
|
Maximum number of guest accounts that can be created for this group (0 means unlimited). |
|
Names of users, peers, LDAP severs, RADIUS servers or external idp servers to add to the user group. |
|
Group member name. Source user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.saml.name user .external-identity-provider.name user.adgrp.name user.pop3.name user.certificate.name. |
|
Enable/disable the guest user mobile phone number field. Choices:
|
|
Enable/disable addition of multiple guests. Choices:
|
|
Group name. |
|
Guest user password type. Choices:
|
|
SMS server. Source system.sms-server.name. |
|
Send SMS through FortiGuard or other external server. Choices:
|
|
Set the action for the sponsor guest user field. Choices:
|
|
Name of the RADIUS user group that this local user group represents. |
|
Guest user ID type. Choices:
|
|
Enable/disable the guest user name entry. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure user groups.
fortinet.fortios.fortios_user_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_group:
auth_concurrent_override: "enable"
auth_concurrent_value: "0"
authtimeout: "0"
company: "optional"
email: "disable"
expire: "14400"
expire_type: "immediately"
group_type: "firewall"
guest:
-
comment: "Comment."
company: "<your_own_value>"
email: "<your_own_value>"
expiration: "<your_own_value>"
id: "16"
mobile_phone: "<your_own_value>"
name: "default_name_18"
password: "<your_own_value>"
sponsor: "<your_own_value>"
user_id: "<your_own_value>"
http_digest_realm: "<your_own_value>"
id: "23"
match:
-
group_name: "<your_own_value>"
id: "26"
server_name: "<your_own_value> (source user.radius.name user.ldap.name user.tacacs+.name user.saml.name user.external-identity-provider
.name)"
max_accounts: "0"
member:
-
name: "default_name_30 (source user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.saml.name user
.external-identity-provider.name user.adgrp.name user.pop3.name user.certificate.name)"
mobile_phone: "disable"
multiple_guest_add: "disable"
name: "default_name_33"
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 |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |