ansible.builtin.fortios_switch_controller_global (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

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

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"
  tasks:
  - name: Configure FortiSwitch global settings.
    fortios_switch_controller_global:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      switch_controller_global:
        allow-multiple-interfaces: "enable"
        default-virtual-switch-vlan: "<your_own_value> (source system.interface.name)"
        disable-discovery:
         -
            name: "default_name_6"
        https-image-push: "enable"
        log-mac-limit-violations: "enable"
        mac-aging-interval: "9"
        mac-retention-period: "10"
        mac-violation-timer: "11"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

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.

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

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

username:
    description:
    - FortiOS or FortiGate username.
    required: true

switch_controller_global:
    default: null
    description:
    - Configure FortiSwitch global settings.
    suboptions:
      allow-multiple-interfaces:
        choices:
        - enable
        - disable
        description:
        - Enable/disable multiple FortiLink interfaces for redundant connections between
          a managed FortiSwitch and FortiGate.
      default-virtual-switch-vlan:
        description:
        - Default VLAN for ports when added to the virtual-switch. Source system.interface.name.
      disable-discovery:
        description:
        - Prevent this FortiSwitch from discovering.
        suboptions:
          name:
            description:
            - Managed device ID.
            required: true
      https-image-push:
        choices:
        - enable
        - disable
        description:
        - Enable/disable image push to FortiSwitch using HTTPS.
      log-mac-limit-violations:
        choices:
        - enable
        - disable
        description:
        - Enable/disable logs for Learning Limit Violations.
      mac-aging-interval:
        description:
        - Time after which an inactive MAC is aged out (10 - 1000000 sec, default = 300,
          0 = disable).
      mac-retention-period:
        description:
        - Time in hours after which an inactive MAC is removed from client DB.
      mac-violation-timer:
        description:
        - Set timeout for Learning Limit Violations (0 = disabled).

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