Skip to content

Latest commit

 

History

History
451 lines (407 loc) · 20.1 KB

fortios_switch_controller_vlan.rst

File metadata and controls

451 lines (407 loc) · 20.1 KB
Raw
source:fortios_switch_controller_vlan.py
orphan:

fortios_switch_controller_vlan -- Configure VLANs for switch controller in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and vlan category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_switch_controller_vlan v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • 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
  • switch_controller_vlan - Configure VLANs for switch controller. type: dict more...
    Supported Version Ranges
    switch_controller_vlan v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • auth - Authentication. type: str choices: radius, usergroup more...
      Supported Version Ranges
      auth v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
      [radius] v6.0.0 -> latest
      [usergroup] v6.0.0 -> latest
    • color - Color of icon on the GUI. type: int more...
      Supported Version Ranges
      color v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • comments - Comment. type: str more...
      Supported Version Ranges
      comments v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • name - Switch VLAN name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • portal_message_override_group - Specify captive portal replacement message override group. type: str more...
      Supported Version Ranges
      portal_message_override_group v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • portal_message_overrides - Individual message overrides. type: dict more...
      Supported Version Ranges
      portal_message_overrides v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
      • auth_disclaimer_page - Override auth-disclaimer-page message with message from portal-message-overrides group. type: str more...
        Supported Version Ranges
        auth_disclaimer_page v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
      • auth_login_failed_page - Override auth-login-failed-page message with message from portal-message-overrides group. type: str more...
        Supported Version Ranges
        auth_login_failed_page v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
      • auth_login_page - Override auth-login-page message with message from portal-message-overrides group. type: str more...
        Supported Version Ranges
        auth_login_page v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
      • auth_reject_page - Override auth-reject-page message with message from portal-message-overrides group. type: str more...
        Supported Version Ranges
        auth_reject_page v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • radius_server - Authentication radius server. Source user.radius.name. type: str more...
      Supported Version Ranges
      radius_server v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • security - Security. type: str choices: open, captive-portal, 8021x more...
      Supported Version Ranges
      security v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
      [open] v6.0.0 -> latest
      [captive-portal] v6.0.0 -> latest
      [8021x] v6.0.0 -> latest
    • selected_usergroups - Selected user group. type: list member_path: selected_usergroups:name more...
      Supported Version Ranges
      selected_usergroups v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
      • name - User group name. Source user.group.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • usergroup - Authentication usergroup. Source user.group.name. type: str more...
      Supported Version Ranges
      usergroup v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • vdom - Virtual domain, type: str more...
      Supported Version Ranges
      vdom v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3
    • vlanid - VLAN ID. type: int more...
      Supported Version Ranges
      vlanid v6.0.0 -> v6.0.11 v6.2.3 -> v6.2.3

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure VLANs for switch controller.
  fortinet.fortios.fortios_switch_controller_vlan:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_vlan:
          auth: "radius"
          color: "16"
          comments: "<your_own_value>"
          name: "default_name_6"
          portal_message_override_group: "<your_own_value>"
          portal_message_overrides:
              auth_disclaimer_page: "<your_own_value>"
              auth_login_failed_page: "<your_own_value>"
              auth_login_page: "<your_own_value>"
              auth_reject_page: "<your_own_value>"
          radius_server: "<your_own_value> (source user.radius.name)"
          security: "open"
          selected_usergroups:
              -
                  name: "default_name_16 (source user.group.name)"
          usergroup: "<your_own_value> (source user.group.name)"
          vdom: "<your_own_value>"
          vlanid: "2047"

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 fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate 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
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

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)
  • Nicolas Thomas (@thomnico)

Hint

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