ansible.builtin.fortios_switch_controller_vlan (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure VLANs for switch controller.
    fortios_switch_controller_vlan:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      switch_controller_vlan:
        auth: "radius"
        color: "4"
        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: "19"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

vdom:
    default: root
    description:
    - 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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

switch_controller_vlan:
    default: null
    description:
    - Configure VLANs for switch controller.
    suboptions:
      auth:
        choices:
        - radius
        - usergroup
        description:
        - Authentication.
        type: str
      color:
        description:
        - Color of icon on the GUI.
        type: int
      comments:
        description:
        - Comment.
        type: str
      name:
        description:
        - Switch VLAN name.
        required: true
        type: str
      portal_message_override_group:
        description:
        - Specify captive portal replacement message override group.
        type: str
      portal_message_overrides:
        description:
        - Individual message overrides.
        suboptions:
          auth_disclaimer_page:
            description:
            - Override auth-disclaimer-page message with message from portal-message-overrides
              group.
            type: str
          auth_login_failed_page:
            description:
            - Override auth-login-failed-page message with message from portal-message-overrides
              group.
            type: str
          auth_login_page:
            description:
            - Override auth-login-page message with message from portal-message-overrides
              group.
            type: str
          auth_reject_page:
            description:
            - Override auth-reject-page message with message from portal-message-overrides
              group.
            type: str
        type: dict
      radius_server:
        description:
        - Authentication radius server. Source user.radius.name.
        type: str
      security:
        choices:
        - open
        - captive-portal
        - 8021x
        description:
        - Security.
        type: str
      selected_usergroups:
        description:
        - Selected user group.
        suboptions:
          name:
            description:
            - User group name. Source user.group.name.
            required: true
            type: str
        type: list
      usergroup:
        description:
        - Authentication usergroup. Source user.group.name.
        type: str
      vdom:
        description:
        - Virtual domain,
        type: str
      vlanid:
        description:
        - VLAN ID.
        type: int
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str