fortinet.fortimanager.fmgr_user_group_dynamicmapping module – Configure user groups.

Note

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

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_dynamicmapping.

New in fortinet.fortimanager 2.1.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.
group string / required	The parameter (group) in requested url.
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_dynamicmapping dictionary	The top level parameters set.
_scope list / elements=dictionary	Scope.
name string	Name.
vdom string	Vdom.
auth-concurrent-override string	Deprecated, please rename it to auth_concurrent_override. Enable/disable overriding the global number of concurrent authen… Choices: "disable" "enable"
auth-concurrent-value integer	Deprecated, please rename it to auth_concurrent_value. 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 string	Deprecated, please rename it to expire_type. Determine when the expiration countdown begins. Choices: "immediately" "first-successful-login"
group-type string	Deprecated, please rename it to group_type. 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 string	Deprecated, please rename it to mobile_phone. Mobile phone.
name string	Guest name.
password any	(list) Guest password.
sponsor string	Set the action for the sponsor guest user field.
user-id string	Deprecated, please rename it to user_id. Guest ID.
http-digest-realm string	Deprecated, please rename it to http_digest_realm. Realm attribute for MD5-digest authentication.
id integer / required	Group ID.
ldap-memberof string	Deprecated, please rename it to ldap_memberof. Ldap memberof.
logic-type string	Deprecated, please rename it to logic_type. Logic type. Choices: "or" "and"
match list / elements=dictionary	Match.
_gui_meta string	Gui meta.
group-name string	Deprecated, please rename it to group_name. Name of matching user or group on remote authentication server.
id integer	ID.
server-name string	Deprecated, please rename it to server_name. Name of remote auth server.
max-accounts integer	Deprecated, please rename it to max_accounts. 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 string	Deprecated, please rename it to mobile_phone. Enable/disable the guest user mobile phone number field. Choices: "disable" "enable"
multiple-guest-add string	Deprecated, please rename it to multiple_guest_add. Enable/disable addition of multiple guests. Choices: "disable" "enable"
password string	Guest user password type. Choices: "auto-generate" "specify" "disable"
redir-url string	Deprecated, please rename it to redir_url. Redir url.
sms-custom-server string	Deprecated, please rename it to sms_custom_server. SMS server.
sms-server string	Deprecated, please rename it to sms_server. 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 any	(list or str) Deprecated, please rename it to sslvpn_bookmarks_group. Sslvpn bookmarks group.
sslvpn-cache-cleaner string	Deprecated, please rename it to sslvpn_cache_cleaner. Sslvpn cache cleaner. Choices: "disable" "enable"
sslvpn-client-check list / elements=string	Deprecated, please rename it to sslvpn_client_check. Sslvpn client check. Choices: "forticlient" "forticlient-av" "forticlient-fw" "3rdAV" "3rdFW"
sslvpn-ftp string	Deprecated, please rename it to sslvpn_ftp. Sslvpn ftp. Choices: "disable" "enable"
sslvpn-http string	Deprecated, please rename it to sslvpn_http. Sslvpn http. Choices: "disable" "enable"
sslvpn-os-check string	Deprecated, please rename it to sslvpn_os_check. Sslvpn os check. Choices: "disable" "enable"
sslvpn-os-check-list dictionary	Deprecated, please rename it to sslvpn_os_check_list. Sslvpn os check list.
action string	Action. Choices: "allow" "check-up-to-date" "deny"
latest-patch-level string	Deprecated, please rename it to latest_patch_level. Latest patch level.
name string	Name.
tolerance integer	Tolerance.
sslvpn-portal any	(list or str) Deprecated, please rename it to sslvpn_portal. Sslvpn portal.
sslvpn-portal-heading string	Deprecated, please rename it to sslvpn_portal_heading. Sslvpn portal heading.
sslvpn-rdp string	Deprecated, please rename it to sslvpn_rdp. Sslvpn rdp. Choices: "disable" "enable"
sslvpn-samba string	Deprecated, please rename it to sslvpn_samba. Sslvpn samba. Choices: "disable" "enable"
sslvpn-split-tunneling string	Deprecated, please rename it to sslvpn_split_tunneling. Sslvpn split tunneling. Choices: "disable" "enable"
sslvpn-ssh string	Deprecated, please rename it to sslvpn_ssh. Sslvpn ssh. Choices: "disable" "enable"
sslvpn-telnet string	Deprecated, please rename it to sslvpn_telnet. Sslvpn telnet. Choices: "disable" "enable"
sslvpn-tunnel string	Deprecated, please rename it to sslvpn_tunnel. Sslvpn tunnel. Choices: "disable" "enable"
sslvpn-tunnel-endip string	Deprecated, please rename it to sslvpn_tunnel_endip. Sslvpn tunnel endip.
sslvpn-tunnel-ip-mode string	Deprecated, please rename it to sslvpn_tunnel_ip_mode. Sslvpn tunnel ip mode. Choices: "range" "usrgrp"
sslvpn-tunnel-startip string	Deprecated, please rename it to sslvpn_tunnel_startip. Sslvpn tunnel startip.
sslvpn-virtual-desktop string	Deprecated, please rename it to sslvpn_virtual_desktop. Sslvpn virtual desktop. Choices: "disable" "enable"
sslvpn-vnc string	Deprecated, please rename it to sslvpn_vnc. Sslvpn vnc. Choices: "disable" "enable"
sslvpn-webapp string	Deprecated, please rename it to sslvpn_webapp. Sslvpn webapp. Choices: "disable" "enable"
sso-attribute-value string	Deprecated, please rename it to sso_attribute_value. Name of the RADIUS user group that this local user group represents.
user-id string	Deprecated, please rename it to user_id. Guest user ID type. Choices: "email" "auto-generate" "specify"
user-name string	Deprecated, please rename it to user_name. 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 (generated based on argument schema)
  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_dynamicmapping:
        # 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>
        group: <your own value>
        state: present # <value in [present, absent]>
        user_group_dynamicmapping:
          _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, directory-service, fsso-service, ...]>
          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: <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: <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]>

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)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)