Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
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 version 2.10: of fortinet.fortimanager
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| adom string / required | the parameter (adom) in requested url | |||
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | ||
| enable_log boolean |
| Enable/Disable logging for task | ||
| proposed_method string |
| The overridden method for the underlying Json RPC request | ||
| rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | |||
| rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | |||
| state string / required |
| the directive to create, update or delete an object | ||
| user_group dictionary | the top level parameters set | |||
| auth-concurrent-override string |
| 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 |
| Set the action for the company guest user field. | ||
| email string |
| Enable/disable the guest user email address field. | ||
| expire integer | Time in seconds before guest user accounts expire. (1 - 31536000 sec) | |||
| expire-type string |
| Determine when the expiration countdown begins. | ||
| group-type string |
| Set the group to be for firewall authentication, FSSO, RSSO, or guest users. | ||
| guest list / elements=string | no description | |||
| comment string | Comment. | |||
| company string | Set the action for the company guest user field. | |||
| email string | Email. | |||
| expiration string | Expire time. | |||
| id integer | Guest ID. | |||
| mobile-phone string | Mobile phone. | |||
| name string | Guest name. | |||
| password string | no description | |||
| 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 / elements=string | no description | |||
| _gui_meta string | no description | |||
| group-name string | Name of matching group on remote authentication server. | |||
| id integer | ID. | |||
| server-name string | Name of remote auth server. | |||
| max-accounts integer | Maximum number of guest accounts that can be created for this group (0 means unlimited). | |||
| member list / elements=string | no description | |||
| mobile-phone string |
| Enable/disable the guest user mobile phone number field. | ||
| multiple-guest-add string |
| Enable/disable addition of multiple guests. | ||
| name string | Group name. | |||
| password string |
| Guest user password type. | ||
| sms-custom-server string | SMS server. | |||
| sms-server string |
| Send SMS through FortiGuard or other external server. | ||
| sponsor string |
| 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 |
| Guest user ID type. | ||
| user-name string |
| Enable/disable the guest user name entry. | ||
| workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | |||
| workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock | ||
Note
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure user groups.
fmgr_user_group:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
user_group:
auth-concurrent-override: <value in [disable, enable]>
auth-concurrent-value: <value of integer>
authtimeout: <value of integer>
company: <value in [optional, mandatory, disabled]>
email: <value in [disable, enable]>
expire: <value of integer>
expire-type: <value in [immediately, first-successful-login]>
group-type: <value in [firewall, directory-service, fsso-service, ...]>
guest:
-
comment: <value of string>
company: <value of string>
email: <value of string>
expiration: <value of string>
mobile-phone: <value of string>
name: <value of string>
password: <value of string>
sponsor: <value of string>
user-id: <value of string>
id: <value of integer>
http-digest-realm: <value of string>
id: <value of integer>
match:
-
_gui_meta: <value of string>
group-name: <value of string>
id: <value of integer>
server-name: <value of string>
max-accounts: <value of integer>
member: <value of list>
mobile-phone: <value in [disable, enable]>
multiple-guest-add: <value in [disable, enable]>
name: <value of string>
password: <value in [auto-generate, specify, disable]>
sms-custom-server: <value of string>
sms-server: <value in [fortiguard, custom]>
sponsor: <value in [optional, mandatory, disabled]>
sso-attribute-value: <value of string>
user-id: <value in [email, auto-generate, specify]>
user-name: <value in [disable, enable]>
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url string | always | The full url requested Sample: /sys/login/user |
| response_code integer | always | The status of api request |
| response_message string | always | The descriptive message of the api response Sample: OK. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_user_group_module.html