fmgr_user_group – Configure user groups.

New in version 2.0.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 v6.x and v7.x.

Requirements

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

• ansible>=2.9.0

FortiManager Version Compatibility

6.0.0
True
6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
True	True	True	True	True	True	True	True	True	True
6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
True	True	True	True	True	True	True	True	True	True	True	True
7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
True	True	True	True	True	True	True	True
7.2.0	7.2.1	7.2.2
True	True	True
7.4.0
True

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 - Enable/disable overriding the global number of concurrent authentication sessions for this user group. type: str choices: [disable, enable] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• auth-concurrent-value - Maximum number of concurrent authenticated connections per user (0 - 100). type: int more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• authtimeout - Authentication timeout in minutes for this user group. type: int more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• company - Set the action for the company guest user field. type: str choices: [optional, mandatory, disabled] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• email - Enable/disable the guest user email address field. type: str choices: [disable, enable] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• expire - Time in seconds before guest user accounts expire. type: int more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• expire-type - Determine when the expiration countdown begins. type: str choices: [immediately, first-successful-login] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

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

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• guest - Guest. type: array more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

  • comment - Comment. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • company - Set the action for the company guest user field. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • email - Email. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • expiration - Expire time. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • mobile-phone - Mobile phone. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • name - Guest name. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • password - Guest password. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sponsor - Set the action for the sponsor guest user field. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • user-id - Guest ID. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • group - Guest name. type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2
    False	False	False
    7.4.0
    False

  • id - Guest ID. type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

• http-digest-realm - Realm attribute for MD5-digest authentication. type: str more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• id - Group ID. type: int more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• match - Match. type: array more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

  • _gui_meta - _Gui_Meta. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • group-name - Name of matching group on remote authentication server. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • id - ID. type: int more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • server-name - Name of remote auth server. type: str more...

    6.0.0
    True
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    True	True	True	True	True	True	True	True	True	True
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    True	True	True	True	True	True	True	True	True	True	True	True
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

• max-accounts - Maximum number of guest accounts that can be created for this group (0 means unlimited). type: int more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• member - Names of users, peers, LDAP severs, or RADIUS servers to add to the user group. type: list more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• mobile-phone - Enable/disable the guest user mobile phone number field. type: str choices: [disable, enable] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• multiple-guest-add - Enable/disable addition of multiple guests. type: str choices: [disable, enable] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• name - Group name. type: str more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• password - Guest user password type. type: str choices: [auto-generate, specify, disable] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• sms-custom-server - SMS server. type: str more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• sms-server - Send SMS through FortiGuard or other external server. type: str choices: [fortiguard, custom] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• sponsor - Set the action for the sponsor guest user field. type: str choices: [optional, mandatory, disabled] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• sso-attribute-value - Name of the RADIUS user group that this local user group represents. type: str more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• user-id - Guest user ID type. type: str choices: [email, auto-generate, specify] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• user-name - Enable/disable the guest user name entry. type: str choices: [disable, enable] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

• dynamic_mapping - No description for the parameter type: array more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
  False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
  False	False	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2
  True	True	True
  7.4.0
  True

  • _scope - No description for the parameter type: array more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

    • name - No description for the parameter type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • vdom - No description for the parameter type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

  • auth-concurrent-override - Enable/disable overriding the global number of concurrent authentication sessions for this user group. type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • auth-concurrent-value - Maximum number of concurrent authenticated connections per user (0 - 100). type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • authtimeout - Authentication timeout in minutes for this user group. type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • company - Set the action for the company guest user field. type: str choices: [optional, mandatory, disabled] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • email - Enable/disable the guest user email address field. type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • expire - Time in seconds before guest user accounts expire (1 - 31536000). type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • expire-type - Determine when the expiration countdown begins. type: str choices: [immediately, first-successful-login] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

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

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • guest - No description for the parameter type: array more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

    • comment - Comment. type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • company - Set the action for the company guest user field. type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • email - Email. type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • expiration - Expire time. type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • group - No description for the parameter type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • id - Guest ID. type: int more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • mobile-phone - Mobile phone. type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • name - Guest name. type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • password - No description for the parameter type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • sponsor - Set the action for the sponsor guest user field. type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • user-id - Guest ID. type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

  • http-digest-realm - Realm attribute for MD5-digest authentication. type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • id - Group ID. type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • ldap-memberof - No description for the parameter type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • logic-type - No description for the parameter type: str choices: [or, and] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	False	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • match - No description for the parameter type: array more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

    • _gui_meta - No description for the parameter type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • group-name - Name of matching user or group on remote authentication server. type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • id - ID. type: int more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

    • server-name - Name of remote auth server. type: str more...

      6.0.0
      False
      6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
      False	False	False	False	False	False	False	False	False	False
      6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
      False	False	False	False	False	False	False	False	False	False	False	False
      7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
      False	False	True	True	True	True	True	True
      7.2.0	7.2.1	7.2.2
      True	True	True
      7.4.0
      True

  • max-accounts - Maximum number of guest accounts that can be created for this group (0 means unlimited). type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • member - No description for the parameter type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • mobile-phone - Enable/disable the guest user mobile phone number field. type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • multiple-guest-add - Enable/disable addition of multiple guests. type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • password - Guest user password type. type: str choices: [auto-generate, specify, disable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • redir-url - No description for the parameter type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sms-custom-server - SMS server. type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sms-server - Send SMS through FortiGuard or other external server. type: str choices: [fortiguard, custom] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sponsor - Set the action for the sponsor guest user field. type: str choices: [optional, mandatory, disabled] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-bookmarks-group - No description for the parameter type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-cache-cleaner - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-client-check - No description for the parameter type: array choices: [forticlient, forticlient-av, forticlient-fw, 3rdAV, 3rdFW] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-ftp - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-http - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-os-check - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-os-check-list type: dict
  • action - No description for the parameter type: str choices: [allow, check-up-to-date, deny] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • latest-patch-level - No description for the parameter type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • name - No description for the parameter type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • tolerance - No description for the parameter type: int more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-portal - No description for the parameter type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-portal-heading - No description for the parameter type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-rdp - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-samba - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-split-tunneling - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-ssh - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-telnet - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-tunnel - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-tunnel-endip - No description for the parameter type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-tunnel-ip-mode - No description for the parameter type: str choices: [range, usrgrp] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-tunnel-startip - No description for the parameter type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-virtual-desktop - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-vnc - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sslvpn-webapp - No description for the parameter type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • sso-attribute-value - Name of the RADIUS user group that this local user group represents. type: str more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • user-id - Guest user ID type. type: str choices: [email, auto-generate, specify] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

  • user-name - Enable/disable the guest user name entry. type: str choices: [disable, enable] more...

    6.0.0
    False
    6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10
    False	False	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7
    False	False	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2
    True	True	True
    7.4.0
    True

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:

• 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 0
• version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

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)

Hint

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