fortinet.fortimanager.fmgr_user_group – Configure user groups.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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

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

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:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

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

Choices:

  • present

  • absent

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.

Choices:

  • disable

  • enable

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.

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. (1 - 31536000 sec)

expire-type

string

Determine when the expiration countdown begins.

Choices:

  • immediately

  • first-successful-login

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=string

Guest.

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

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 / elements=string

Match.

_gui_meta

string

_Gui_Meta.

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

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

mobile-phone

string

Enable/disable the guest user mobile phone number field.

Choices:

  • disable

  • enable

multiple-guest-add

string

Enable/disable addition of multiple guests.

Choices:

  • disable

  • enable

name

string

Group name.

password

string

Guest user password type.

Choices:

  • auto-generate

  • specify

  • disable

sms-custom-server

string

SMS server.

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

string

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

user-id

string

Guest user ID type.

Choices:

  • email

  • auto-generate

  • specify

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

  • 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: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the user groups
     fmgr_fact:
       facts:
           selector: 'user_group'
           params:
               adom: 'ansible'
               group: ''

- hosts: fortimanager00
  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
        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]>

Return Values

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

Key

Description

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_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)