:source: fmgr_system_npu_npqueues_profile.py
:orphan:
.. _fmgr_system_npu_npqueues_profile:
fmgr_system_npu_npqueues_profile -- Configure a NP7 class profile.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.2.0
.. warning::
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name``
- New argument name starting in 3.0.0: ``var_name``
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. 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: v6.4.7 -> v6.4.15, v7.0.1 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: 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: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: 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: integer required: false default: 300
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- system_npu_npqueues_profile - Configure a NP7 class profile. type: dict
- cos0 Queue number of cos 0. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- cos1 Queue number of cos 1. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- cos2 Queue number of cos 2. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- cos3 Queue number of cos 3. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- cos4 Queue number of cos 4. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- cos5 Queue number of cos 5. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- cos6 Queue number of cos 6. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- cos7 Queue number of cos 7. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp0 Queue number of dscp 0. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp1 Queue number of dscp 1. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp10 Queue number of dscp 10. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp11 Queue number of dscp 11. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp12 Queue number of dscp 12. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp13 Queue number of dscp 13. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp14 Queue number of dscp 14. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp15 Queue number of dscp 15. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp16 Queue number of dscp 16. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp17 Queue number of dscp 17. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp18 Queue number of dscp 18. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp19 Queue number of dscp 19. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp2 Queue number of dscp 2. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp20 Queue number of dscp 20. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp21 Queue number of dscp 21. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp22 Queue number of dscp 22. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp23 Queue number of dscp 23. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp24 Queue number of dscp 24. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp25 Queue number of dscp 25. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp26 Queue number of dscp 26. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp27 Queue number of dscp 27. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp28 Queue number of dscp 28. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp29 Queue number of dscp 29. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp3 Queue number of dscp 3. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp30 Queue number of dscp 30. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp31 Queue number of dscp 31. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp32 Queue number of dscp 32. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp33 Queue number of dscp 33. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp34 Queue number of dscp 34. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp35 Queue number of dscp 35. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp36 Queue number of dscp 36. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp37 Queue number of dscp 37. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp38 Queue number of dscp 38. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp39 Queue number of dscp 39. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp4 Queue number of dscp 4. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp40 Queue number of dscp 40. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp41 Queue number of dscp 41. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp42 Queue number of dscp 42. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp43 Queue number of dscp 43. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp44 Queue number of dscp 44. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp45 Queue number of dscp 45. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp46 Queue number of dscp 46. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp47 Queue number of dscp 47. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp48 Queue number of dscp 48. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp49 Queue number of dscp 49. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp5 Queue number of dscp 5. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp50 Queue number of dscp 50. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp51 Queue number of dscp 51. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp52 Queue number of dscp 52. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp53 Queue number of dscp 53. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp54 Queue number of dscp 54. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp55 Queue number of dscp 55. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp56 Queue number of dscp 56. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp57 Queue number of dscp 57. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp58 Queue number of dscp 58. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp59 Queue number of dscp 59. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp6 Queue number of dscp 6. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp60 Queue number of dscp 60. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp61 Queue number of dscp 61. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp62 Queue number of dscp 62. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp63 Queue number of dscp 63. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp7 Queue number of dscp 7. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp8 Queue number of dscp 8. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- dscp9 Queue number of dscp 9. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- id Profile id. type: int
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- type Profile type. type: str choices: [cos, dscp]
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> latest
- weight Class weight. type: int
more...
Supported Version Ranges: v6.4.7 -> v6.4.15, v7.0.1 -> 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
tasks:
- name: Configure a NP7 class profile.
fortinet.fortimanager.fmgr_system_npu_npqueues_profile:
# workspace_locking_adom:
adom:
state: present #
system_npu_npqueues_profile:
id: 0 # Required variable, integer
# 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:
# type:
# weight:
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: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 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 version type: 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)