fortiswitch_system_accprofile – Configure system administrative access group in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify system feature and accprofile 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_system_accprofile 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
  • system_accprofile - Configure system administrative access group. type: dict
    • admingrp - Administrative access permission. type: str choices: none, read, read-write
    • alias_commands - Alias commands (or groups of commands) that can be used by this profile. type: list
      • command_name - Alias command or group name. type: str
    • exec_alias_grp - Permission to execute alias commands. type: str choices: none, read, read-write
    • loggrp - Logging access permission. type: str choices: none, read, read-write, w, r, rw
    • mntgrp - Critical system maintenance access permission. type: str choices: none, read, read-write
    • name - Profile name. type: str required: true
    • netgrp - Network access permission. type: str choices: none, read, read-write
    • pktmongrp - Packet and flow capture functionality. type: str choices: none, read, read-write
    • routegrp - Routing access permission. type: str choices: none, read, read-write
    • swcoregrp - Switch core access permission. type: str choices: none, read, read-write
    • swmonguardgrp - Switch monitor and guard feature permission. type: str choices: none, read, read-write
    • sysgrp - System access permission. type: str choices: none, read, read-write
    • utilgrp - Utilities access permission. type: str choices: none, read, read-write

Examples

- name: Configure system administrative access group.
  fortinet.fortiswitch.fortiswitch_system_accprofile:
      state: "present"
      system_accprofile:
          admingrp: "none"
          alias_commands:
              -
                  command_name: "<your_own_value> (source system.alias.command.name system.alias.group.name)"
          exec_alias_grp: "none"
          loggrp: "none"
          mntgrp: "none"
          name: "default_name_9"
          netgrp: "none"
          pktmongrp: "none"
          routegrp: "none"
          swcoregrp: "none"
          swmonguardgrp: "none"
          sysgrp: "none"
          utilgrp: "none"

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.