source: fmgr_user_group.py
orphan

fmgr_user_group -- Configure user groups.

2.0.0

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

Argument name before 3.0.0: var-name, var name, var.name
New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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 v6.x and v7.x.

Requirements

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

ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> 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
adom - 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...

Supported Version Ranges: v6.0.0 -> latest
auth_concurrent_value (Alias name: auth-concurrent-value) Maximum number of concurrent authenticated connections per user (0 - 100). type: int more...

Supported Version Ranges: v6.0.0 -> latest
authtimeout Authentication timeout in minutes for this user group. type: int more...

Supported Version Ranges: v6.0.0 -> latest
company Set the action for the company guest user field. type: str choices: [optional, mandatory, disabled] more...

Supported Version Ranges: v6.0.0 -> latest
email Enable/disable the guest user email address field. type: str choices: [disable, enable] more...

Supported Version Ranges: v6.0.0 -> latest
expire Time in seconds before guest user accounts expire. type: int more...

Supported Version Ranges: v6.0.0 -> latest
expire_type (Alias name: expire-type) Determine when the expiration countdown begins. type: str choices: [immediately, first-successful-login] more...

Supported Version Ranges: v6.0.0 -> latest
group_type (Alias name: 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...

Supported Version Ranges: v6.0.0 -> latest
guest Guest. type: list more...

Supported Version Ranges: v6.0.0 -> latest
- comment Comment. type: str more...
  
  Supported Version Ranges: v6.0.0 -> latest
- company Set the action for the company guest user field. type: str more...
  
  Supported Version Ranges: v6.0.0 -> latest
- email Email. type: str more...
  
  Supported Version Ranges: v6.0.0 -> latest
- expiration Expire time. type: str more...
  
  Supported Version Ranges: v6.0.0 -> latest
- mobile_phone (Alias name: mobile-phone) Mobile phone. type: str more...
  
  Supported Version Ranges: v6.0.0 -> latest
- name Guest name. type: str more...
  
  Supported Version Ranges: v6.0.0 -> latest
- password Guest password. type: list more...
  
  Supported Version Ranges: v6.0.0 -> latest
- sponsor Set the action for the sponsor guest user field. type: str more...
  
  Supported Version Ranges: v6.0.0 -> latest
- user_id (Alias name: user-id) Guest id. type: str more...
  
  Supported Version Ranges: v6.0.0 -> latest
- group Guest name. type: str more...
  
  Supported Version Ranges: v6.2.0 -> v6.2.12
- id Guest id. type: int more...
  
  Supported Version Ranges: v6.2.3 -> latest
http_digest_realm (Alias name: http-digest-realm) Realm attribute for md5-digest authentication. type: str more...

Supported Version Ranges: v6.0.0 -> latest
id Group id. type: int more...

Supported Version Ranges: v6.0.0 -> latest
match Match. type: list more...

Supported Version Ranges: v6.0.0 -> latest
- _gui_meta _gui_meta. type: str more...
  
  Supported Version Ranges: v6.0.0 -> latest
- group_name (Alias name: group-name) Name of matching group on remote authentication server. type: str more...
  
  Supported Version Ranges: v6.0.0 -> latest
- id Id. type: int more...
  
  Supported Version Ranges: v6.0.0 -> latest
- server_name (Alias name: server-name) Name of remote auth server. type: str more...
  
  Supported Version Ranges: v6.0.0 -> latest
max_accounts (Alias name: max-accounts) Maximum number of guest accounts that can be created for this group (0 means unlimited). type: int more...

Supported Version Ranges: v6.0.0 -> latest
member Names of users, peers, ldap severs, or radius servers to add to the user group. type: list or str more...

Supported Version Ranges: v6.0.0 -> latest
mobile_phone (Alias name: mobile-phone) Enable/disable the guest user mobile phone number field. type: str choices: [disable, enable] more...

Supported Version Ranges: v6.0.0 -> latest
multiple_guest_add (Alias name: multiple-guest-add) Enable/disable addition of multiple guests. type: str choices: [disable, enable] more...

Supported Version Ranges: v6.0.0 -> latest
name Group name. type: str more...

Supported Version Ranges: v6.0.0 -> latest
password Guest user password type. type: str choices: [auto-generate, specify, disable] more...

Supported Version Ranges: v6.0.0 -> latest
sms_custom_server (Alias name: sms-custom-server) Sms server. type: str more...

Supported Version Ranges: v6.0.0 -> latest
sms_server (Alias name: sms-server) Send sms through fortiguard or other external server. type: str choices: [fortiguard, custom] more...

Supported Version Ranges: v6.0.0 -> latest
sponsor Set the action for the sponsor guest user field. type: str choices: [optional, mandatory, disabled] more...

Supported Version Ranges: v6.0.0 -> latest
sso_attribute_value (Alias name: sso-attribute-value) Name of the radius user group that this local user group represents. type: str more...

Supported Version Ranges: v6.0.0 -> latest
user_id (Alias name: user-id) Guest user id type. type: str choices: [email, auto-generate, specify] more...

Supported Version Ranges: v6.0.0 -> latest
user_name (Alias name: user-name) Enable/disable the guest user name entry. type: str choices: [disable, enable] more...

Supported Version Ranges: v6.0.0 -> latest
dynamic_mapping type: list more...

Supported Version Ranges: v7.0.2 -> latest
- _scope type: list more...
  
  Supported Version Ranges: v7.0.2 -> latest
  - name type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - vdom type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
- 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...
  
  Supported Version Ranges: v7.0.2 -> latest
- auth_concurrent_value (Alias name: auth-concurrent-value) Maximum number of concurrent authenticated connections per user (0 - 100). type: int more...
  
  Supported Version Ranges: v7.0.2 -> latest
- authtimeout Authentication timeout in minutes for this user group. type: int more...
  
  Supported Version Ranges: v7.0.2 -> latest
- company Set the action for the company guest user field. type: str choices: [optional, mandatory, disabled] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- email Enable/disable the guest user email address field. type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- expire Time in seconds before guest user accounts expire (1 - 31536000). type: int more...
  
  Supported Version Ranges: v7.0.2 -> latest
- expire_type (Alias name: expire-type) Determine when the expiration countdown begins. type: str choices: [immediately, first-successful-login] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- group_type (Alias name: 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...
  
  Supported Version Ranges: v7.0.2 -> latest
- guest type: list more...
  
  Supported Version Ranges: v7.0.2 -> latest
  - comment Comment. type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - company Set the action for the company guest user field. type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - email Email. type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - expiration Expire time. type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - group type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - id Guest id. type: int more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - mobile_phone (Alias name: mobile-phone) Mobile phone. type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - name Guest name. type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - password type: list more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - sponsor Set the action for the sponsor guest user field. type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - user_id (Alias name: user-id) Guest id. type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
- http_digest_realm (Alias name: http-digest-realm) Realm attribute for md5-digest authentication. type: str more...
  
  Supported Version Ranges: v7.0.2 -> latest
- id Group id. type: int more...
  
  Supported Version Ranges: v7.0.2 -> latest
- ldap_memberof (Alias name: ldap-memberof) type: str more...
  
  Supported Version Ranges: v7.0.2 -> latest
- logic_type (Alias name: logic-type) type: str choices: [or, and] more...
  
  Supported Version Ranges: v7.0.3 -> latest
- match type: list more...
  
  Supported Version Ranges: v7.0.2 -> latest
  - _gui_meta type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - group_name (Alias name: group-name) Name of matching user or group on remote authentication server. type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - id Id. type: int more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - server_name (Alias name: server-name) Name of remote auth server. type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
- max_accounts (Alias name: max-accounts) Maximum number of guest accounts that can be created for this group (0 means unlimited). type: int more...
  
  Supported Version Ranges: v7.0.2 -> latest
- member type: list or str more...
  
  Supported Version Ranges: v7.0.2 -> latest
- mobile_phone (Alias name: mobile-phone) Enable/disable the guest user mobile phone number field. type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- multiple_guest_add (Alias name: multiple-guest-add) Enable/disable addition of multiple guests. type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- password Guest user password type. type: str choices: [auto-generate, specify, disable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- redir_url (Alias name: redir-url) type: str more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sms_custom_server (Alias name: sms-custom-server) Sms server. type: str more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sms_server (Alias name: sms-server) Send sms through fortiguard or other external server. type: str choices: [fortiguard, custom] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sponsor Set the action for the sponsor guest user field. type: str choices: [optional, mandatory, disabled] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_bookmarks_group (Alias name: sslvpn-bookmarks-group) type: list or str more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_cache_cleaner (Alias name: sslvpn-cache-cleaner) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_client_check (Alias name: sslvpn-client-check) type: list choices: [forticlient, forticlient-av, forticlient-fw, 3rdAV, 3rdFW] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_ftp (Alias name: sslvpn-ftp) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_http (Alias name: sslvpn-http) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_os_check (Alias name: sslvpn-os-check) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_os_check_list (Alias name: sslvpn-os-check-list) type: dict
  - action type: str choices: [allow, check-up-to-date, deny] more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - latest_patch_level (Alias name: latest-patch-level) type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - name type: str more...
    
    Supported Version Ranges: v7.0.2 -> latest
  - tolerance type: int more...
    
    Supported Version Ranges: v7.0.2 -> latest
- sslvpn_portal (Alias name: sslvpn-portal) type: list or str more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_portal_heading (Alias name: sslvpn-portal-heading) type: str more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_rdp (Alias name: sslvpn-rdp) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_samba (Alias name: sslvpn-samba) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_split_tunneling (Alias name: sslvpn-split-tunneling) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_ssh (Alias name: sslvpn-ssh) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_telnet (Alias name: sslvpn-telnet) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_tunnel (Alias name: sslvpn-tunnel) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_tunnel_endip (Alias name: sslvpn-tunnel-endip) type: str more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_tunnel_ip_mode (Alias name: sslvpn-tunnel-ip-mode) type: str choices: [range, usrgrp] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_tunnel_startip (Alias name: sslvpn-tunnel-startip) type: str more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_virtual_desktop (Alias name: sslvpn-virtual-desktop) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_vnc (Alias name: sslvpn-vnc) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sslvpn_webapp (Alias name: sslvpn-webapp) type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- sso_attribute_value (Alias name: sso-attribute-value) Name of the radius user group that this local user group represents. type: str more...
  
  Supported Version Ranges: v7.0.2 -> latest
- user_id (Alias name: user-id) Guest user id type. type: str choices: [email, auto-generate, specify] more...
  
  Supported Version Ranges: v7.0.2 -> latest
- user_name (Alias name: user-name) Enable/disable the guest user name entry. type: str choices: [disable, enable] more...
  
  Supported Version Ranges: v7.0.2 -> latest

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
  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: 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)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fmgr_user_group.rst

fmgr_user_group.rst

fmgr_user_group -- Configure user groups.

Synopsis

Requirements

FortiManager Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

Files

fmgr_user_group.rst

Latest commit

History

fmgr_user_group.rst

File metadata and controls

fmgr_user_group -- Configure user groups.

Synopsis

Requirements

FortiManager Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors