fortinet.fortimanager.fmgr_user_group module – Configure user groups.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

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

access_token

string

The token to access FortiManager without using username and password.

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.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

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.

Choices:

  • "present"

  • "absent"

user_group

dictionary

The top level parameters set.

auth_concurrent_override

aliases: auth-concurrent-override

string

Enable/disable overriding the global number of concurrent authentication sessions for this user group.

Choices:

  • "disable"

  • "enable"

auth_concurrent_value

aliases: auth-concurrent-value

integer

Maximum number of concurrent authenticated connections per user

authtimeout

integer

Authentication timeout in minutes for this user group.

company

string

Set the action for the company guest user field.

Choices:

  • "optional"

  • "mandatory"

  • "disabled"

dynamic_mapping

list / elements=dictionary

Dynamic mapping.

_scope

list / elements=dictionary

Scope.

name

string

Name.

vdom

string

Vdom.

auth_concurrent_override

aliases: auth-concurrent-override

string

Enable/disable overriding the global number of concurrent authentication sessions for this user group.

Choices:

  • "disable"

  • "enable"

auth_concurrent_value

aliases: auth-concurrent-value

integer

Maximum number of concurrent authenticated connections per user

authtimeout

integer

Authentication timeout in minutes for this user group.

company

string

Set the action for the company guest user field.

Choices:

  • "optional"

  • "mandatory"

  • "disabled"

email

string

Enable/disable the guest user email address field.

Choices:

  • "disable"

  • "enable"

expire

integer

Time in seconds before guest user accounts expire

expire_type

aliases: expire-type

string

Determine when the expiration countdown begins.

Choices:

  • "immediately"

  • "first-successful-login"

group_type

aliases: group-type

string

Set the group to be for firewall authentication, FSSO, RSSO, or guest users.

Choices:

  • "firewall"

  • "directory-service"

  • "fsso-service"

  • "guest"

  • "rsso"

guest

list / elements=dictionary

Guest.

comment

string

Comment.

company

string

Set the action for the company guest user field.

email

string

Email.

expiration

string

Expire time.

group

string

Group.

id

integer

Guest ID.

mobile_phone

aliases: mobile-phone

string

Mobile phone.

name

string

Guest name.

password

any

(list) Guest password.

sponsor

string

Set the action for the sponsor guest user field.

user_id

aliases: user-id

string

Guest ID.

http_digest_realm

aliases: http-digest-realm

string

Realm attribute for MD5-digest authentication.

id

integer

Group ID.

ldap_memberof

aliases: ldap-memberof

string

Ldap memberof.

logic_type

aliases: logic-type

string

Logic type.

Choices:

  • "or"

  • "and"

match

list / elements=dictionary

Match.

_gui_meta

string

Gui meta.

group_name

aliases: group-name

string

Name of matching user or group on remote authentication server.

id

integer

ID.

server_name

aliases: server-name

string

Name of remote auth server.

max_accounts

aliases: max-accounts

integer

Maximum number of guest accounts that can be created for this group

member

any

(list or str) Names of users, peers, LDAP severs, or RADIUS servers to add to the user group.

mobile_phone

aliases: mobile-phone

string

Enable/disable the guest user mobile phone number field.

Choices:

  • "disable"

  • "enable"

multiple_guest_add

aliases: multiple-guest-add

string

Enable/disable addition of multiple guests.

Choices:

  • "disable"

  • "enable"

password

string

Guest user password type.

Choices:

  • "auto-generate"

  • "specify"

  • "disable"

redir_url

aliases: redir-url

string

Redir url.

sms_custom_server

aliases: sms-custom-server

string

SMS server.

sms_server

aliases: sms-server

string

Send SMS through FortiGuard or other external server.

Choices:

  • "fortiguard"

  • "custom"

sponsor

string

Set the action for the sponsor guest user field.

Choices:

  • "optional"

  • "mandatory"

  • "disabled"

sslvpn_bookmarks_group

aliases: sslvpn-bookmarks-group

any

(list or str) Sslvpn bookmarks group.

sslvpn_cache_cleaner

aliases: sslvpn-cache-cleaner

string

Sslvpn cache cleaner.

Choices:

  • "disable"

  • "enable"

sslvpn_client_check

aliases: sslvpn-client-check

list / elements=string

Sslvpn client check.

Choices:

  • "forticlient"

  • "forticlient-av"

  • "forticlient-fw"

  • "3rdAV"

  • "3rdFW"

sslvpn_ftp

aliases: sslvpn-ftp

string

Sslvpn ftp.

Choices:

  • "disable"

  • "enable"

sslvpn_http

aliases: sslvpn-http

string

Sslvpn http.

Choices:

  • "disable"

  • "enable"

sslvpn_os_check

aliases: sslvpn-os-check

string

Sslvpn os check.

Choices:

  • "disable"

  • "enable"

sslvpn_os_check_list

aliases: sslvpn-os-check-list

dictionary

Sslvpn os check list.

action

string

Action.

Choices:

  • "allow"

  • "check-up-to-date"

  • "deny"

latest_patch_level

aliases: latest-patch-level

string

Latest patch level.

name

string

Name.

tolerance

integer

Tolerance.

sslvpn_portal

aliases: sslvpn-portal

any

(list or str) Sslvpn portal.

sslvpn_portal_heading

aliases: sslvpn-portal-heading

string

Sslvpn portal heading.

sslvpn_rdp

aliases: sslvpn-rdp

string

Sslvpn rdp.

Choices:

  • "disable"

  • "enable"

sslvpn_samba

aliases: sslvpn-samba

string

Sslvpn samba.

Choices:

  • "disable"

  • "enable"

sslvpn_split_tunneling

aliases: sslvpn-split-tunneling

string

Sslvpn split tunneling.

Choices:

  • "disable"

  • "enable"

sslvpn_ssh

aliases: sslvpn-ssh

string

Sslvpn ssh.

Choices:

  • "disable"

  • "enable"

sslvpn_telnet

aliases: sslvpn-telnet

string

Sslvpn telnet.

Choices:

  • "disable"

  • "enable"

sslvpn_tunnel

aliases: sslvpn-tunnel

string

Sslvpn tunnel.

Choices:

  • "disable"

  • "enable"

sslvpn_tunnel_endip

aliases: sslvpn-tunnel-endip

string

Sslvpn tunnel endip.

sslvpn_tunnel_ip_mode

aliases: sslvpn-tunnel-ip-mode

string

Sslvpn tunnel ip mode.

Choices:

  • "range"

  • "usrgrp"

sslvpn_tunnel_startip

aliases: sslvpn-tunnel-startip

string

Sslvpn tunnel startip.

sslvpn_virtual_desktop

aliases: sslvpn-virtual-desktop

string

Sslvpn virtual desktop.

Choices:

  • "disable"

  • "enable"

sslvpn_vnc

aliases: sslvpn-vnc

string

Sslvpn vnc.

Choices:

  • "disable"

  • "enable"

sslvpn_webapp

aliases: sslvpn-webapp

string

Sslvpn webapp.

Choices:

  • "disable"

  • "enable"

sso_attribute_value

aliases: sso-attribute-value

string

Name of the RADIUS user group that this local user group represents.

user_id

aliases: user-id

string

Guest user ID type.

Choices:

  • "email"

  • "auto-generate"

  • "specify"

user_name

aliases: user-name

string

Enable/disable the guest user name entry.

Choices:

  • "disable"

  • "enable"

email

string

Enable/disable the guest user email address field.

Choices:

  • "disable"

  • "enable"

expire

integer

Time in seconds before guest user accounts expire.

expire_type

aliases: expire-type

string

Determine when the expiration countdown begins.

Choices:

  • "immediately"

  • "first-successful-login"

group_type

aliases: group-type

string

Set the group to be for firewall authentication, FSSO, RSSO, or guest users.

Choices:

  • "firewall"

  • "directory-service"

  • "fsso-service"

  • "guest"

  • "rsso"

guest

list / elements=dictionary

Guest.

comment

string

Comment.

company

string

Set the action for the company guest user field.

email

string

Email.

expiration

string

Expire time.

group

string

Guest name.

id

integer

Guest ID.

mobile_phone

aliases: mobile-phone

string

Mobile phone.

name

string

Guest name.

password

any

(list) Guest password.

sponsor

string

Set the action for the sponsor guest user field.

user_id

aliases: user-id

string

Guest ID.

http_digest_realm

aliases: http-digest-realm

string

Realm attribute for MD5-digest authentication.

id

integer

Group ID.

match

list / elements=dictionary

Match.

_gui_meta

string

Gui meta.

group_name

aliases: group-name

string

Name of matching group on remote authentication server.

id

integer

ID.

server_name

aliases: server-name

string

Name of remote auth server.

max_accounts

aliases: max-accounts

integer

Maximum number of guest accounts that can be created for this group

member

list / elements=string

Names of users, peers, LDAP severs, or RADIUS servers to add to the user group.

mobile_phone

aliases: mobile-phone

string

Enable/disable the guest user mobile phone number field.

Choices:

  • "disable"

  • "enable"

multiple_guest_add

aliases: multiple-guest-add

string

Enable/disable addition of multiple guests.

Choices:

  • "disable"

  • "enable"

name

string / required

Group name.

password

string

Guest user password type.

Choices:

  • "auto-generate"

  • "specify"

  • "disable"

sms_custom_server

aliases: sms-custom-server

string

SMS server.

sms_server

aliases: sms-server

string

Send SMS through FortiGuard or other external server.

Choices:

  • "fortiguard"

  • "custom"

sponsor

string

Set the action for the sponsor guest user field.

Choices:

  • "optional"

  • "mandatory"

  • "disabled"

sso_attribute_value

aliases: sso-attribute-value

string

Name of the RADIUS user group that this local user group represents.

user_id

aliases: user-id

string

Guest user ID type.

Choices:

  • "email"

  • "auto-generate"

  • "specify"

user_name

aliases: user-name

string

Enable/disable the guest user name entry.

Choices:

  • "disable"

  • "enable"

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

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

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

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)