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

Configure FortiSwitch QoS 802.1p in Fortinet's FortiOS and FortiGate.

| "added in version" 2.9 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

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_qos feature and dot1p_map category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5


Requirements

Usage examples

  • 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 QoS 802.1p.
    fortios_switch_controller_qos_dot1p_map:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      switch_controller_qos_dot1p_map:
        description: "<your_own_value>"
        name: "default_name_4"
        priority_0: "queue-0"
        priority_1: "queue-0"
        priority_2: "queue-0"
        priority_3: "queue-0"
        priority_4: "queue-0"
        priority_5: "queue-0"
        priority_6: "queue-0"
        priority_7: "queue-0"

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_qos_dot1p_map:
    default: null
    description:
    - Configure FortiSwitch QoS 802.1p.
    suboptions:
      description:
        description:
        - Description of the 802.1p name.
        type: str
      name:
        description:
        - Dot1p map name.
        required: true
        type: str
      priority_0:
        choices:
        - queue-0
        - queue-1
        - queue-2
        - queue-3
        - queue-4
        - queue-5
        - queue-6
        - queue-7
        description:
        - COS queue mapped to dot1p priority number.
        type: str
      priority_1:
        choices:
        - queue-0
        - queue-1
        - queue-2
        - queue-3
        - queue-4
        - queue-5
        - queue-6
        - queue-7
        description:
        - COS queue mapped to dot1p priority number.
        type: str
      priority_2:
        choices:
        - queue-0
        - queue-1
        - queue-2
        - queue-3
        - queue-4
        - queue-5
        - queue-6
        - queue-7
        description:
        - COS queue mapped to dot1p priority number.
        type: str
      priority_3:
        choices:
        - queue-0
        - queue-1
        - queue-2
        - queue-3
        - queue-4
        - queue-5
        - queue-6
        - queue-7
        description:
        - COS queue mapped to dot1p priority number.
        type: str
      priority_4:
        choices:
        - queue-0
        - queue-1
        - queue-2
        - queue-3
        - queue-4
        - queue-5
        - queue-6
        - queue-7
        description:
        - COS queue mapped to dot1p priority number.
        type: str
      priority_5:
        choices:
        - queue-0
        - queue-1
        - queue-2
        - queue-3
        - queue-4
        - queue-5
        - queue-6
        - queue-7
        description:
        - COS queue mapped to dot1p priority number.
        type: str
      priority_6:
        choices:
        - queue-0
        - queue-1
        - queue-2
        - queue-3
        - queue-4
        - queue-5
        - queue-6
        - queue-7
        description:
        - COS queue mapped to dot1p priority number.
        type: str
      priority_7:
        choices:
        - queue-0
        - queue-1
        - queue-2
        - queue-3
        - queue-4
        - queue-5
        - queue-6
        - queue-7
        description:
        - COS queue mapped to dot1p priority number.
        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