fortinet.fortimanager.fmgr_hotspot20_h2qpwanmetric – Configure WAN metrics.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_hotspot20_h2qpwanmetric.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
hotspot20_h2qpwanmetric
dictionary
the top level parameters set
downlink-load
integer
Downlink load.
downlink-speed
integer
Downlink speed (in kilobits/s).
link-at-capacity
string
    Choices:
  • disable
  • enable
Link at capacity.
link-status
string
    Choices:
  • down
  • up
  • in-test
Link status.
load-measurement-duration
integer
Load measurement duration (in tenths of a second).
name
string
WAN metric name.
symmetric-wan-link
string
    Choices:
  • asymmetric
  • symmetric
WAN link symmetry.
uplink-load
integer
Uplink load.
uplink-speed
integer
Uplink speed (in kilobits/s).
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure WAN metrics.
     fmgr_hotspot20_h2qpwanmetric:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        hotspot20_h2qpwanmetric:
           downlink-load: <value of integer>
           downlink-speed: <value of integer>
           link-at-capacity: <value in [disable, enable]>
           link-status: <value in [down, up, in-test]>
           load-measurement-duration: <value of integer>
           name: <value of string>
           symmetric-wan-link: <value in [asymmetric, symmetric]>
           uplink-load: <value of integer>
           uplink-speed: <value of integer>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request
response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)