fortinet.fortimanager.fmgr_user_group module – Configure user groups.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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 fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_group
.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Enable/disable overriding the global number of concurrent authentication sessions for this user group. Choices:
|
|
Maximum number of concurrent authenticated connections per user |
|
Authentication timeout in minutes for this user group. |
|
Set the action for the company guest user field. Choices:
|
|
Dynamic mapping. |
|
Scope. |
|
Name. |
|
Vdom. |
|
Enable/disable overriding the global number of concurrent authentication sessions for this user group. Choices:
|
|
Maximum number of concurrent authenticated connections per user |
|
Authentication timeout in minutes for this user group. |
|
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 |
|
Determine when the expiration countdown begins. Choices:
|
|
Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Choices:
|
|
Guest. |
|
Comment. |
|
Set the action for the company guest user field. |
|
Email. |
|
Expire time. |
|
Group. |
|
Guest ID. |
|
Mobile phone. |
|
Guest name. |
|
(list) Guest password. |
|
Set the action for the sponsor guest user field. |
|
Guest ID. |
|
Realm attribute for MD5-digest authentication. |
|
Group ID. |
|
Ldap memberof. |
|
Logic type. Choices:
|
|
Match. |
|
Gui meta. |
|
Name of matching user or group on remote authentication server. |
|
ID. |
|
Name of remote auth server. |
|
Maximum number of guest accounts that can be created for this group |
|
(list or str) Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. |
|
Enable/disable the guest user mobile phone number field. Choices:
|
|
Enable/disable addition of multiple guests. Choices:
|
|
Guest user password type. Choices:
|
|
Redir url. |
|
SMS server. |
|
Send SMS through FortiGuard or other external server. Choices:
|
|
Set the action for the sponsor guest user field. Choices:
|
|
(list or str) Sslvpn bookmarks group. |
|
Sslvpn cache cleaner. Choices:
|
|
Sslvpn client check. Choices:
|
|
Sslvpn ftp. Choices:
|
|
Sslvpn http. Choices:
|
|
Sslvpn os check. Choices:
|
|
Sslvpn os check list. |
|
Action. Choices:
|
|
Latest patch level. |
|
Name. |
|
Tolerance. |
|
(list or str) Sslvpn portal. |
|
Sslvpn portal heading. |
|
Sslvpn rdp. Choices:
|
|
Sslvpn samba. Choices:
|
|
Sslvpn split tunneling. Choices:
|
|
Sslvpn ssh. Choices:
|
|
Sslvpn telnet. Choices:
|
|
Sslvpn tunnel. Choices:
|
|
Sslvpn tunnel endip. |
|
Sslvpn tunnel ip mode. Choices:
|
|
Sslvpn tunnel startip. |
|
Sslvpn virtual desktop. Choices:
|
|
Sslvpn vnc. Choices:
|
|
Sslvpn webapp. 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:
|
|
Enable/disable the guest user email address field. Choices:
|
|
Time in seconds before guest user accounts expire. |
|
Determine when the expiration countdown begins. Choices:
|
|
Set the group to be for firewall authentication, FSSO, RSSO, or guest users. Choices:
|
|
Guest. |
|
Comment. |
|
Set the action for the company guest user field. |
|
Email. |
|
Expire time. |
|
Guest name. |
|
Guest ID. |
|
Mobile phone. |
|
Guest name. |
|
(list) Guest password. |
|
Set the action for the sponsor guest user field. |
|
Guest ID. |
|
Realm attribute for MD5-digest authentication. |
|
Group ID. |
|
Match. |
|
Gui meta. |
|
Name of matching group on remote authentication server. |
|
ID. |
|
Name of remote auth server. |
|
Maximum number of guest accounts that can be created for this group |
|
Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. |
|
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. |
|
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:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure user groups.
fortinet.fortimanager.fmgr_user_group:
bypass_validation: false
adom: FortiCarrier
state: present
user_group:
id: 1
name: ansible-test-group
password: specify # <value in [auto-generate, specify, disable]>
user-id: email # <value in [email, auto-generate, specify]>
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the user groups
fortinet.fortimanager.fmgr_fact:
facts:
selector: "user_group"
params:
adom: "ansible"
group: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |