fortinet.fortimanager.fmgr_switchcontroller_qos_ipdscpmap_map – Maps between IP-DSCP value to COS queue.

Note

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

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

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

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
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
ip-dscp-map
string / required
the parameter (ip-dscp-map) in requested url
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
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
switchcontroller_qos_ipdscpmap_map
dictionary
the top level parameters set
cos-queue
integer
COS queue number.
diffserv
list / elements=string
    Choices:
  • CS0
  • CS1
  • AF11
  • AF12
  • AF13
  • CS2
  • AF21
  • AF22
  • AF23
  • CS3
  • AF31
  • AF32
  • AF33
  • CS4
  • AF41
  • AF42
  • AF43
  • CS5
  • EF
  • CS6
  • CS7
no description
ip-precedence
list / elements=string
    Choices:
  • network-control
  • internetwork-control
  • critic-ecp
  • flashoverride
  • flash
  • immediate
  • priority
  • routine
no description
name
string
Dscp mapping entry name.
value
string
Raw values of DSCP (0 - 63).
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: Maps between IP-DSCP value to COS queue.
     fmgr_switchcontroller_qos_ipdscpmap_map:
        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>
        ip-dscp-map: <your own value>
        state: <value in [present, absent]>
        switchcontroller_qos_ipdscpmap_map:
           cos-queue: <value of integer>
           diffserv:
             - CS0
             - CS1
             - AF11
             - AF12
             - AF13
             - CS2
             - AF21
             - AF22
             - AF23
             - CS3
             - AF31
             - AF32
             - AF33
             - CS4
             - AF41
             - AF42
             - AF43
             - CS5
             - EF
             - CS6
             - CS7
           ip-precedence:
             - network-control
             - internetwork-control
             - critic-ecp
             - flashoverride
             - flash
             - immediate
             - priority
             - routine
           name: <value of string>
           value: <value of string>

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)