fmgd_user_group – Configure user groups.

Added in version 1.1.0.

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.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • user_group - Configure user groups. type: dict
    • auth_concurrent_override (Alias name: 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 (Alias name: 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...
    • dynamic_mapping Dynamic mapping. type: list more...
      • _scope Scope. type: list more...
        • name Name. type: str more...
        • vdom Vdom. type: str more...
      • auth_concurrent_override (Alias name: 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 (Alias name: 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 (Alias name: expire-type) Determine when the expiration countdown begins. type: str choices: [immediately, first-successful-login] more...
      • group_type (Alias name: group-type) Set the group to be for firewall authentication, fsso, rsso, or guest users. type: str choices: [firewall, fsso-service, guest, rsso] more...
      • guest Guest. type: list 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 Group. type: str more...
        • id Guest id. type: int more...
        • mobile_phone (Alias name: mobile-phone) Mobile phone. type: str more...
        • name Guest name. type: str more...
        • password Guest password. type: list more...
        • sponsor Set the action for the sponsor guest user field. type: str more...
        • user_id (Alias name: user-id) Guest id. type: str more...
      • http_digest_realm (Alias name: http-digest-realm) Realm attribute for md5-digest authentication. type: str more...
      • id Group id. type: int more...
      • ldap_memberof (Alias name: ldap-memberof) Ldap memberof. type: str more...
      • logic_type (Alias name: logic-type) Set the logic between members or matching entries. type: str choices: [or, and] more...
      • match Match. type: list more...
        • _gui_meta Gui meta. type: str more...
        • group_name (Alias name: group-name) Name of matching user or group on remote authentication server. type: str more...
        • id Id. type: int more...
        • server_name (Alias name: server-name) Name of remote auth server. type: list more...
      • max_accounts (Alias name: 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, radius servers or external idp servers to add to the user group. type: list more...
      • mobile_phone (Alias name: mobile-phone) Enable/disable the guest user mobile phone number field. type: str choices: [disable, enable] more...
      • multiple_guest_add (Alias name: 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 (Alias name: redir-url) Redir url. type: str more...
      • sms_custom_server (Alias name: sms-custom-server) Sms server. type: list more...
      • sms_server (Alias name: 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 (Alias name: sslvpn-bookmarks-group) Sslvpn bookmarks group. type: list more...
      • sslvpn_cache_cleaner (Alias name: sslvpn-cache-cleaner) Sslvpn cache cleaner. type: str choices: [disable, enable] more...
      • sslvpn_client_check (Alias name: sslvpn-client-check) Sslvpn client check. type: list choices: [forticlient, forticlient-av, forticlient-fw, 3rdAV, 3rdFW] more...
      • sslvpn_ftp (Alias name: sslvpn-ftp) Sslvpn ftp. type: str choices: [disable, enable] more...
      • sslvpn_http (Alias name: sslvpn-http) Sslvpn http. type: str choices: [disable, enable] more...
      • sslvpn_os_check (Alias name: sslvpn-os-check) Sslvpn os check. type: str choices: [disable, enable] more...
      • sslvpn_os_check_list (Alias name: sslvpn-os-check-list) Sslvpn os check list. type: dict more...
        • action Action. type: str choices: [allow, check-up-to-date, deny] more...
        • latest_patch_level (Alias name: latest-patch-level) Latest patch level. type: str more...
        • name Name. type: str more...
        • tolerance Tolerance. type: int more...
      • sslvpn_portal (Alias name: sslvpn-portal) Sslvpn portal. type: list more...
      • sslvpn_portal_heading (Alias name: sslvpn-portal-heading) Sslvpn portal heading. type: str more...
      • sslvpn_rdp (Alias name: sslvpn-rdp) Sslvpn rdp. type: str choices: [disable, enable] more...
      • sslvpn_samba (Alias name: sslvpn-samba) Sslvpn samba. type: str choices: [disable, enable] more...
      • sslvpn_split_tunneling (Alias name: sslvpn-split-tunneling) Sslvpn split tunneling. type: str choices: [disable, enable] more...
      • sslvpn_ssh (Alias name: sslvpn-ssh) Sslvpn ssh. type: str choices: [disable, enable] more...
      • sslvpn_telnet (Alias name: sslvpn-telnet) Sslvpn telnet. type: str choices: [disable, enable] more...
      • sslvpn_tunnel (Alias name: sslvpn-tunnel) Sslvpn tunnel. type: str choices: [disable, enable] more...
      • sslvpn_tunnel_endip (Alias name: sslvpn-tunnel-endip) Sslvpn tunnel endip. type: str more...
      • sslvpn_tunnel_ip_mode (Alias name: sslvpn-tunnel-ip-mode) Sslvpn tunnel ip mode. type: str choices: [range, usrgrp] more...
      • sslvpn_tunnel_startip (Alias name: sslvpn-tunnel-startip) Sslvpn tunnel startip. type: str more...
      • sslvpn_virtual_desktop (Alias name: sslvpn-virtual-desktop) Sslvpn virtual desktop. type: str choices: [disable, enable] more...
      • sslvpn_vnc (Alias name: sslvpn-vnc) Sslvpn vnc. type: str choices: [disable, enable] more...
      • sslvpn_webapp (Alias name: sslvpn-webapp) Sslvpn webapp. type: str choices: [disable, enable] more...
      • sso_attribute_value (Alias name: sso-attribute-value) Name of the radius user group that this local user group represents. type: str more...
      • user_id (Alias name: user-id) Guest user id type. type: str choices: [email, auto-generate, specify] more...
      • user_name (Alias name: user-name) Enable/disable the guest user name entry. type: str choices: [disable, enable] more...
      • negate Negate. type: str choices: [disable, enable] 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 (Alias name: expire-type) Determine when the expiration countdown begins. type: str choices: [immediately, first-successful-login] more...
    • group_type (Alias name: group-type) Set the group to be for firewall authentication, fsso, rsso, or guest users. type: str choices: [firewall, fsso-service, guest, rsso] more...
    • guest Guest. type: list 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...
      • id Guest id. type: int more...
      • mobile_phone (Alias name: mobile-phone) Mobile phone. type: str more...
      • name Guest name. type: str more...
      • password Guest password. type: list more...
      • sponsor Set the action for the sponsor guest user field. type: str more...
      • user_id (Alias name: user-id) Guest id. type: str more...
    • http_digest_realm (Alias name: http-digest-realm) Realm attribute for md5-digest authentication. type: str more...
    • id Group id. type: int more...
    • logic_type (Alias name: logic-type) Set the logic between members or matching entries. type: str choices: [or, and] more...
    • match Match. type: list more...
      • _gui_meta Gui meta. type: str more...
      • group_name (Alias name: group-name) Name of matching user or group on remote authentication server. type: str more...
      • id Id. type: int more...
      • server_name (Alias name: server-name) Name of remote auth server. type: list more...
    • max_accounts (Alias name: 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, radius servers or external idp servers to add to the user group. type: list more...
    • mobile_phone (Alias name: mobile-phone) Enable/disable the guest user mobile phone number field. type: str choices: [disable, enable] more...
    • multiple_guest_add (Alias name: 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 (Alias name: sms-custom-server) Sms server. type: list more...
    • sms_server (Alias name: 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 (Alias name: sso-attribute-value) Name of the radius user group that this local user group represents. type: str more...
    • user_id (Alias name: user-id) Guest user id type. type: str choices: [email, auto-generate, specify] more...
    • user_name (Alias name: user-name) Enable/disable the guest user name entry. type: str choices: [disable, enable] more...
    • negate Negate. 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: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure user groups.
      fortinet.fmgdevice.fmgd_user_group:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        user_group:
          id: 0 # Required variable, integer
          # auth_concurrent_override: <value in [disable, enable]>
          # auth_concurrent_value: <integer>
          # authtimeout: <integer>
          # company: <value in [optional, mandatory, disabled]>
          # dynamic_mapping:
          #   - _scope:
          #       - name: <string>
          #         vdom: <string>
          #     auth_concurrent_override: <value in [disable, enable]>
          #     auth_concurrent_value: <integer>
          #     authtimeout: <integer>
          #     company: <value in [optional, mandatory, disabled]>
          #     email: <value in [disable, enable]>
          #     expire: <integer>
          #     expire_type: <value in [immediately, first-successful-login]>
          #     group_type: <value in [firewall, fsso-service, guest, ...]>
          #     guest:
          #       - comment: <string>
          #         company: <string>
          #         email: <string>
          #         expiration: <string>
          #         group: <string>
          #         id: <integer>
          #         mobile_phone: <string>
          #         name: <string>
          #         password: <list or string>
          #         sponsor: <string>
          #         user_id: <string>
          #     http_digest_realm: <string>
          #     id: <integer>
          #     ldap_memberof: <string>
          #     logic_type: <value in [or, and]>
          #     match:
          #       - _gui_meta: <string>
          #         group_name: <string>
          #         id: <integer>
          #         server_name: <list or string>
          #     max_accounts: <integer>
          #     member: <list or string>
          #     mobile_phone: <value in [disable, enable]>
          #     multiple_guest_add: <value in [disable, enable]>
          #     password: <value in [auto-generate, specify, disable]>
          #     redir_url: <string>
          #     sms_custom_server: <list or string>
          #     sms_server: <value in [fortiguard, custom]>
          #     sponsor: <value in [optional, mandatory, disabled]>
          #     sslvpn_bookmarks_group: <list or string>
          #     sslvpn_cache_cleaner: <value in [disable, enable]>
          #     sslvpn_client_check:
          #       - "forticlient"
          #       - "forticlient-av"
          #       - "forticlient-fw"
          #       - "3rdAV"
          #       - "3rdFW"
          #     sslvpn_ftp: <value in [disable, enable]>
          #     sslvpn_http: <value in [disable, enable]>
          #     sslvpn_os_check: <value in [disable, enable]>
          #     sslvpn_os_check_list:
          #       action: <value in [allow, check-up-to-date, deny]>
          #       latest_patch_level: <string>
          #       name: <string>
          #       tolerance: <integer>
          #     sslvpn_portal: <list or string>
          #     sslvpn_portal_heading: <string>
          #     sslvpn_rdp: <value in [disable, enable]>
          #     sslvpn_samba: <value in [disable, enable]>
          #     sslvpn_split_tunneling: <value in [disable, enable]>
          #     sslvpn_ssh: <value in [disable, enable]>
          #     sslvpn_telnet: <value in [disable, enable]>
          #     sslvpn_tunnel: <value in [disable, enable]>
          #     sslvpn_tunnel_endip: <string>
          #     sslvpn_tunnel_ip_mode: <value in [range, usrgrp]>
          #     sslvpn_tunnel_startip: <string>
          #     sslvpn_virtual_desktop: <value in [disable, enable]>
          #     sslvpn_vnc: <value in [disable, enable]>
          #     sslvpn_webapp: <value in [disable, enable]>
          #     sso_attribute_value: <string>
          #     user_id: <value in [email, auto-generate, specify]>
          #     user_name: <value in [disable, enable]>
          #     negate: <value in [disable, enable]>
          # email: <value in [disable, enable]>
          # expire: <integer>
          # expire_type: <value in [immediately, first-successful-login]>
          # group_type: <value in [firewall, fsso-service, guest, ...]>
          # guest:
          #   - comment: <string>
          #     company: <string>
          #     email: <string>
          #     expiration: <string>
          #     id: <integer>
          #     mobile_phone: <string>
          #     name: <string>
          #     password: <list or string>
          #     sponsor: <string>
          #     user_id: <string>
          # http_digest_realm: <string>
          # logic_type: <value in [or, and]>
          # match:
          #   - _gui_meta: <string>
          #     group_name: <string>
          #     id: <integer>
          #     server_name: <list or string>
          # max_accounts: <integer>
          # member: <list or string>
          # mobile_phone: <value in [disable, enable]>
          # multiple_guest_add: <value in [disable, enable]>
          # name: <string>
          # password: <value in [auto-generate, specify, disable]>
          # sms_custom_server: <list or string>
          # sms_server: <value in [fortiguard, custom]>
          # sponsor: <value in [optional, mandatory, disabled]>
          # sso_attribute_value: <string>
          # user_id: <value in [email, auto-generate, specify]>
          # user_name: <value in [disable, enable]>
          # negate: <value in [disable, enable]>

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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)