ansible.builtin.fortios_switch_controller_stp_settings (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 stp_settings 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 FortiSwitch spanning tree protocol (STP).
    fortios_switch_controller_stp_settings:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      switch_controller_stp_settings:
        forward_time: "3"
        hello_time: "4"
        max_age: "5"
        max_hops: "6"
        name: "default_name_7"
        pending_timer: "8"
        revision: "9"
        status: "enable"

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

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_stp_settings:
    default: null
    description:
    - Configure FortiSwitch spanning tree protocol (STP).
    suboptions:
      forward_time:
        description:
        - Period of time a port is in listening and learning state (4 - 30 sec).
        type: int
      hello_time:
        description:
        - Period of time between successive STP frame Bridge Protocol Data Units (BPDUs)
          sent on a port (1 - 10 sec).
        type: int
      max_age:
        description:
        - Maximum time before a bridge port saves its configuration BPDU information (6
          - 40 sec).
        type: int
      max_hops:
        description:
        - Maximum number of hops between the root bridge and the furthest bridge (1- 40).
        type: int
      name:
        description:
        - Name of global STP settings configuration.
        type: str
      pending_timer:
        description:
        - Pending time (1 - 15 sec).
        type: int
      revision:
        description:
        - STP revision number (0 - 65535).
        type: int
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable STP.
        type: str
    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