:source: fmgd_system_npu_npqueues.py
:orphan:
.. _fmgd_system_npu_npqueues:
fmgd_system_npu_npqueues -- Configure queue assignment on NP7LITE.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.1.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
Parameters
----------
.. raw:: html
access_token -The token to access FortiManager without using username and password. type: strrequired: false
bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: boolrequired: false default: False
forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: strrequired: false
proposed_method - The overridden method for the underlying Json RPC request. type: strrequired: false choices: set, update, add
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: listrequired: false
rc_failed - The rc codes list with which the conditions to fail will be overriden. type: listrequired: false
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: strrequired: false choices: global, custom adom including root
workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integerrequired: falsedefault: 300
device - The parameter in requested url type: strrequired: true
system_npu_npqueues - Configure queue assignment on NP7LITE. type: dict
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure queue assignment on NP7LITE.
fortinet.fmgdevice.fmgd_system_npu_npqueues:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
system_npu_npqueues:
# custom_etype_lookup:
# ethernet_type:
# - name:
# queue:
# type:
# weight:
# ip_protocol:
# - name:
# protocol:
# queue:
# weight:
# ip_service:
# - dport:
# name:
# protocol:
# queue:
# sport:
# weight:
# profile:
# - cos0:
# cos1:
# cos2:
# cos3:
# cos4:
# cos5:
# cos6:
# cos7:
# dscp0:
# dscp1:
# dscp10:
# dscp11:
# dscp12:
# dscp13:
# dscp14:
# dscp15:
# dscp16:
# dscp17:
# dscp18:
# dscp19:
# dscp2:
# dscp20:
# dscp21:
# dscp22:
# dscp23:
# dscp24:
# dscp25:
# dscp26:
# dscp27:
# dscp28:
# dscp29:
# dscp3:
# dscp30:
# dscp31:
# dscp32:
# dscp33:
# dscp34:
# dscp35:
# dscp36:
# dscp37:
# dscp38:
# dscp39:
# dscp4:
# dscp40:
# dscp41:
# dscp42:
# dscp43:
# dscp44:
# dscp45:
# dscp46:
# dscp47:
# dscp48:
# dscp49:
# dscp5:
# dscp50:
# dscp51:
# dscp52:
# dscp53:
# dscp54:
# dscp55:
# dscp56:
# dscp57:
# dscp58:
# dscp59:
# dscp6:
# dscp60:
# dscp61:
# dscp62:
# dscp63:
# dscp7:
# dscp8:
# dscp9:
# id:
# type:
# weight:
# scheduler:
# - mode:
# name:
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
meta - The result of the request.returned: alwaystype: dict
request_url - The full url requested. returned: alwaystype: strsample: /sys/login/user
response_code - The status of api request. returned: alwaystype: intsample: 0
response_data - The data body of the api response. returned: optionaltype: list or dict
response_message - The descriptive message of the api response. returned: alwaystype: strsample: OK
system_information - The information of the target system. returned: alwaystype: dict
rc - The status the request. returned: alwaystype: intsample: 0
version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager versiontype: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)