Skip to content

Latest commit

 

History

History
140 lines (102 loc) · 6.85 KB

fortiswitch_user_group.rst

File metadata and controls

140 lines (102 loc) · 6.85 KB
Raw
source:fortiswitch_user_group.py
orphan:

fortiswitch_user_group -- User group configuration in Fortinet's FortiSwitch

.. versionadded:: 1.0.0

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify user feature and group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0

Requirements

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

  • ansible>=2.14

FortiSW Version Compatibility


Supported Version Ranges
fortiswitch_user_group v7.0.0 -> latest

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • user_group - User group configuration. type: dict
    • authtimeout - Authentication timeout (0 - 480). type: int
    • group_type - Type of user group. type: str choices: firewall
    • http_digest_realm - Realm attribute for MD5-digest authentication. type: str
    • match - Set group matches. type: list
      • group_name - Name of matching group on remote authentication server. type: str
      • id - ID. type: int
      • server_name - Name of remote authentication server. type: str
    • member - Group members. type: list
      • name - Group member name. type: str
    • name - Group name. type: str required: true

Examples

- name: User group configuration.
  fortinet.fortiswitch.fortiswitch_user_group:
      state: "present"
      user_group:
          authtimeout: "3"
          group_type: "firewall"
          http_digest_realm: "<your_own_value>"
          match:
              -
                  group_name: "<your_own_value>"
                  id: "8"
                  server_name: "<your_own_value> (source user.radius.name user.ldap.name user.tacacs+.name)"
          member:
              -
                  name: "default_name_11 (source user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name)"
          name: "default_name_12"

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:

  • build - Build number of the fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)

Hint

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