ansible.builtin.fortios_wireless_controller_hotspot20_h2qp_wan_metric (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 wireless_controller_hotspot20 feature and h2qp_wan_metric 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 WAN metrics.
    fortios_wireless_controller_hotspot20_h2qp_wan_metric:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      wireless_controller_hotspot20_h2qp_wan_metric:
        downlink_load: "3"
        downlink_speed: "4"
        link_at_capacity: "enable"
        link_status: "up"
        load_measurement_duration: "7"
        name: "default_name_8"
        symmetric_wan_link: "symmetric"
        uplink_load: "10"
        uplink_speed: "11"

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

wireless_controller_hotspot20_h2qp_wan_metric:
    default: null
    description:
    - Configure WAN metrics.
    suboptions:
      downlink_load:
        description:
        - Downlink load.
        type: int
      downlink_speed:
        description:
        - Downlink speed (in kilobits/s).
        type: int
      link_at_capacity:
        choices:
        - enable
        - disable
        description:
        - Link at capacity.
        type: str
      link_status:
        choices:
        - up
        - down
        - in-test
        description:
        - Link status.
        type: str
      load_measurement_duration:
        description:
        - Load measurement duration (in tenths of a second).
        type: int
      name:
        description:
        - WAN metric name.
        required: true
        type: str
      symmetric_wan_link:
        choices:
        - symmetric
        - asymmetric
        description:
        - WAN link symmetry.
        type: str
      uplink_load:
        description:
        - Uplink load.
        type: int
      uplink_speed:
        description:
        - Uplink speed (in kilobits/s).
        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