drmofu.fortimanager.fmgr_qosprofile (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

 - 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 WiFi quality of service
      fmgr_qosprofile:
         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]>
         qosprofile:
            bandwidth-admission-control: <value in [disable, enable]>
            bandwidth-capacity: <value of integer>
            burst: <value in [disable, enable]>
            call-admission-control: <value in [disable, enable]>
            call-capacity: <value of integer>
            comment: <value of string>
            downlink: <value of integer>
            downlink-sta: <value of integer>
            dscp-wmm-be: <value of integer>
            dscp-wmm-bk: <value of integer>
            dscp-wmm-mapping: <value in [disable, enable]>
            dscp-wmm-vi: <value of integer>
            dscp-wmm-vo: <value of integer>
            name: <value of string>
            uplink: <value of integer>
            uplink-sta: <value of integer>
            wmm: <value in [disable, enable]>
            wmm-uapsd: <value in [disable, enable]>
            wmm-be-dscp: <value of integer>
            wmm-bk-dscp: <value of integer>
            wmm-dscp-marking: <value in [disable, enable]>
            wmm-vi-dscp: <value of integer>
            wmm-vo-dscp: <value of integer>

Inputs

    
adom:
    description: the parameter (adom) in requested url
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

qosprofile:
    description: the top level parameters set
    required: false
    suboptions:
      bandwidth-admission-control:
        choices:
        - disable
        - enable
        description: Enable/disable WMM bandwidth admission control.
        type: str
      bandwidth-capacity:
        description: Maximum bandwidth capacity allowed
        type: int
      burst:
        choices:
        - disable
        - enable
        description: Enable/disable client rate burst.
        type: str
      call-admission-control:
        choices:
        - disable
        - enable
        description: Enable/disable WMM call admission control.
        type: str
      call-capacity:
        description: Maximum number of Voice over WLAN
        type: int
      comment:
        description: Comment.
        type: str
      downlink:
        description: Maximum downlink bandwidth for Virtual Access Points
        type: int
      downlink-sta:
        description: Maximum downlink bandwidth for clients
        type: int
      dscp-wmm-be:
        description: DSCP mapping for best effort access
        type: int
      dscp-wmm-bk:
        description: DSCP mapping for background access
        type: int
      dscp-wmm-mapping:
        choices:
        - disable
        - enable
        description: Enable/disable Differentiated Services Code Point
        type: str
      dscp-wmm-vi:
        description: DSCP mapping for video access
        type: int
      dscp-wmm-vo:
        description: DSCP mapping for voice access
        type: int
      name:
        description: WiFi QoS profile name.
        type: str
      uplink:
        description: Maximum uplink bandwidth for Virtual Access Points
        type: int
      uplink-sta:
        description: Maximum uplink bandwidth for clients
        type: int
      wmm:
        choices:
        - disable
        - enable
        description: Enable/disable WiFi multi-media
        type: str
      wmm-be-dscp:
        description: DSCP marking for best effort access
        type: int
      wmm-bk-dscp:
        description: DSCP marking for background access
        type: int
      wmm-dscp-marking:
        choices:
        - disable
        - enable
        description: Enable/disable WMM Differentiated Services Code Point
        type: str
      wmm-uapsd:
        choices:
        - disable
        - enable
        description: Enable/disable WMM Unscheduled Automatic Power Save Delivery
        type: str
      wmm-vi-dscp:
        description: DSCP marking for video access
        type: int
      wmm-vo-dscp:
        description: DSCP marking for voice access
        type: int
    type: dict

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list