fmgr_user_group – Configure user groups.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
user_group yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • user_group - no description type: dict
    • auth-concurrent-override - Enable/disable overriding the global number of concurrent authentication sessions for this user group. type: str choices: [disable, enable] more...
    • auth-concurrent-value - Maximum number of concurrent authenticated connections per user (0 - 100). type: int more...
    • authtimeout - Authentication timeout in minutes for this user group. type: int more...
    • company - Set the action for the company guest user field. type: str choices: [optional, mandatory, disabled] more...
    • email - Enable/disable the guest user email address field. type: str choices: [disable, enable] more...
    • expire - Time in seconds before guest user accounts expire. type: int more...
    • expire-type - Determine when the expiration countdown begins. type: str choices: [immediately, first-successful-login] more...
    • group-type - Set the group to be for firewall authentication, FSSO, RSSO, or guest users. type: str choices: [firewall, directory-service, fsso-service, guest, rsso] more...
    • guest - Guest. type: array more...
      • comment - Comment. type: str more...
      • company - Set the action for the company guest user field. type: str more...
      • email - Email. type: str more...
      • expiration - Expire time. type: str more...
      • mobile-phone - Mobile phone. type: str more...
      • name - Guest name. type: str more...
      • password - Guest password. type: str more...
      • sponsor - Set the action for the sponsor guest user field. type: str more...
      • user-id - Guest ID. type: str more...
      • id - Guest ID. type: int more...
    • http-digest-realm - Realm attribute for MD5-digest authentication. type: str more...
    • id - Group ID. type: int more...
    • match - Match. type: array more...
      • _gui_meta - _Gui_Meta. type: str more...
      • group-name - Name of matching group on remote authentication server. type: str more...
      • id - ID. type: int more...
      • server-name - Name of remote auth server. type: str more...
    • max-accounts - Maximum number of guest accounts that can be created for this group (0 means unlimited). type: int more...
    • member - Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. type: list more...
    • mobile-phone - Enable/disable the guest user mobile phone number field. type: str choices: [disable, enable] more...
    • multiple-guest-add - Enable/disable addition of multiple guests. type: str choices: [disable, enable] more...
    • name - Group name. type: str more...
    • password - Guest user password type. type: str choices: [auto-generate, specify, disable] more...
    • sms-custom-server - SMS server. type: str more...
    • sms-server - Send SMS through FortiGuard or other external server. type: str choices: [fortiguard, custom] more...
    • sponsor - Set the action for the sponsor guest user field. type: str choices: [optional, mandatory, disabled] more...
    • sso-attribute-value - Name of the RADIUS user group that this local user group represents. type: str more...
    • user-id - Guest user ID type. type: str choices: [email, auto-generate, specify] more...
    • user-name - Enable/disable the guest user name entry. type: str choices: [disable, enable] more...
    • dynamic_mapping - No description for the parameter type: array more...
      • _scope - No description for the parameter type: array more...
        • name - No description for the parameter type: str more...
        • vdom - No description for the parameter type: str more...
      • auth-concurrent-override - Enable/disable overriding the global number of concurrent authentication sessions for this user group. type: str choices: [disable, enable] more...
      • auth-concurrent-value - Maximum number of concurrent authenticated connections per user (0 - 100). type: int more...
      • authtimeout - Authentication timeout in minutes for this user group. type: int more...
      • company - Set the action for the company guest user field. type: str choices: [optional, mandatory, disabled] more...
      • email - Enable/disable the guest user email address field. type: str choices: [disable, enable] more...
      • expire - Time in seconds before guest user accounts expire (1 - 31536000). type: int more...
      • expire-type - Determine when the expiration countdown begins. type: str choices: [immediately, first-successful-login] more...
      • group-type - Set the group to be for firewall authentication, FSSO, RSSO, or guest users. type: str choices: [firewall, directory-service, fsso-service, guest, rsso] more...
      • guest - No description for the parameter type: array more...
        • comment - Comment. type: str more...
        • company - Set the action for the company guest user field. type: str more...
        • email - Email. type: str more...
        • expiration - Expire time. type: str more...
        • group - No description for the parameter type: str more...
        • id - Guest ID. type: int more...
        • mobile-phone - Mobile phone. type: str more...
        • name - Guest name. type: str more...
        • password - No description for the parameter type: str more...
        • sponsor - Set the action for the sponsor guest user field. type: str more...
        • user-id - Guest ID. type: str more...
      • http-digest-realm - Realm attribute for MD5-digest authentication. type: str more...
      • id - No description for the parameter type: int more...
      • ldap-memberof - No description for the parameter type: str more...
      • logic-type - No description for the parameter type: str choices: [or, and] more...
      • match - No description for the parameter type: array more...
        • _gui_meta - No description for the parameter type: str more...
        • group-name - Name of matching user or group on remote authentication server. type: str more...
        • id - ID. type: int more...
        • server-name - Name of remote auth server. type: str more...
      • max-accounts - Maximum number of guest accounts that can be created for this group (0 means unlimited). type: int more...
      • member - No description for the parameter type: str more...
      • mobile-phone - Enable/disable the guest user mobile phone number field. type: str choices: [disable, enable] more...
      • multiple-guest-add - Enable/disable addition of multiple guests. type: str choices: [disable, enable] more...
      • password - Guest user password type. type: str choices: [auto-generate, specify, disable] more...
      • redir-url - No description for the parameter type: str more...
      • sms-custom-server - SMS server. type: str more...
      • sms-server - Send SMS through FortiGuard or other external server. type: str choices: [fortiguard, custom] more...
      • sponsor - Set the action for the sponsor guest user field. type: str choices: [optional, mandatory, disabled] more...
      • sslvpn-bookmarks-group - No description for the parameter type: str more...
      • sslvpn-cache-cleaner - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-client-check - No description for the parameter type: array choices: [forticlient, forticlient-av, forticlient-fw, 3rdAV, 3rdFW] more...
      • sslvpn-ftp - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-http - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-os-check - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-os-check-list type: dict
        • action - No description for the parameter type: str choices: [allow, check-up-to-date, deny] more...
        • latest-patch-level - No description for the parameter type: str more...
        • name - No description for the parameter type: str more...
        • tolerance - No description for the parameter type: int more...
      • sslvpn-portal - No description for the parameter type: str more...
      • sslvpn-portal-heading - No description for the parameter type: str more...
      • sslvpn-rdp - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-samba - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-split-tunneling - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-ssh - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-telnet - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-tunnel - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-tunnel-endip - No description for the parameter type: str more...
      • sslvpn-tunnel-ip-mode - No description for the parameter type: str choices: [range, usrgrp] more...
      • sslvpn-tunnel-startip - No description for the parameter type: str more...
      • sslvpn-virtual-desktop - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-vnc - No description for the parameter type: str choices: [disable, enable] more...
      • sslvpn-webapp - No description for the parameter type: str choices: [disable, enable] more...
      • sso-attribute-value - Name of the RADIUS user group that this local user group represents. type: str more...
      • user-id - Guest user ID type. type: str choices: [email, auto-generate, specify] more...
      • user-name - Enable/disable the guest user name entry. type: str choices: [disable, enable] more...

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: 'your_value'

- 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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.