fortinet.fortimanager.fmgr_system_npu_npqueues module – Configure queue assignment on NP7.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_npu_npqueues
.
New in fortinet.fortimanager 2.2.0
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 |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The top level parameters set. |
|
Ethernet type. |
|
Ethernet Type Name. |
|
Queue Number. |
|
Ethernet Type. |
|
Class Weight. |
|
Ip protocol. |
|
IP Protocol Name. |
|
IP Protocol. |
|
Queue Number. |
|
Class Weight. |
|
Ip service. |
|
Destination port. |
|
IP service name. |
|
IP protocol. |
|
Queue number. |
|
Source port. |
|
Class weight. |
|
Profile. |
|
Queue number of CoS 0. Choices:
|
|
Queue number of CoS 1. Choices:
|
|
Queue number of CoS 2. Choices:
|
|
Queue number of CoS 3. Choices:
|
|
Queue number of CoS 4. Choices:
|
|
Queue number of CoS 5. Choices:
|
|
Queue number of CoS 6. Choices:
|
|
Queue number of CoS 7. Choices:
|
|
Queue number of DSCP 0. Choices:
|
|
Queue number of DSCP 1. Choices:
|
|
Queue number of DSCP 10. Choices:
|
|
Queue number of DSCP 11. Choices:
|
|
Queue number of DSCP 12. Choices:
|
|
Queue number of DSCP 13. Choices:
|
|
Queue number of DSCP 14. Choices:
|
|
Queue number of DSCP 15. Choices:
|
|
Queue number of DSCP 16. Choices:
|
|
Queue number of DSCP 17. Choices:
|
|
Queue number of DSCP 18. Choices:
|
|
Queue number of DSCP 19. Choices:
|
|
Queue number of DSCP 2. Choices:
|
|
Queue number of DSCP 20. Choices:
|
|
Queue number of DSCP 21. Choices:
|
|
Queue number of DSCP 22. Choices:
|
|
Queue number of DSCP 23. Choices:
|
|
Queue number of DSCP 24. Choices:
|
|
Queue number of DSCP 25. Choices:
|
|
Queue number of DSCP 26. Choices:
|
|
Queue number of DSCP 27. Choices:
|
|
Queue number of DSCP 28. Choices:
|
|
Queue number of DSCP 29. Choices:
|
|
Queue number of DSCP 3. Choices:
|
|
Queue number of DSCP 30. Choices:
|
|
Queue number of DSCP 31. Choices:
|
|
Queue number of DSCP 32. Choices:
|
|
Queue number of DSCP 33. Choices:
|
|
Queue number of DSCP 34. Choices:
|
|
Queue number of DSCP 35. Choices:
|
|
Queue number of DSCP 36. Choices:
|
|
Queue number of DSCP 37. Choices:
|
|
Queue number of DSCP 38. Choices:
|
|
Queue number of DSCP 39. Choices:
|
|
Queue number of DSCP 4. Choices:
|
|
Queue number of DSCP 40. Choices:
|
|
Queue number of DSCP 41. Choices:
|
|
Queue number of DSCP 42. Choices:
|
|
Queue number of DSCP 43. Choices:
|
|
Queue number of DSCP 44. Choices:
|
|
Queue number of DSCP 45. Choices:
|
|
Queue number of DSCP 46. Choices:
|
|
Queue number of DSCP 47. Choices:
|
|
Queue number of DSCP 48. Choices:
|
|
Queue number of DSCP 49. Choices:
|
|
Queue number of DSCP 5. Choices:
|
|
Queue number of DSCP 50. Choices:
|
|
Queue number of DSCP 51. Choices:
|
|
Queue number of DSCP 52. Choices:
|
|
Queue number of DSCP 53. Choices:
|
|
Queue number of DSCP 54. Choices:
|
|
Queue number of DSCP 55. Choices:
|
|
Queue number of DSCP 56. Choices:
|
|
Queue number of DSCP 57. Choices:
|
|
Queue number of DSCP 58. Choices:
|
|
Queue number of DSCP 59. Choices:
|
|
Queue number of DSCP 6. Choices:
|
|
Queue number of DSCP 60. Choices:
|
|
Queue number of DSCP 61. Choices:
|
|
Queue number of DSCP 62. Choices:
|
|
Queue number of DSCP 63. Choices:
|
|
Queue number of DSCP 7. Choices:
|
|
Queue number of DSCP 8. Choices:
|
|
Queue number of DSCP 9. Choices:
|
|
Profile ID. |
|
Profile type. Choices:
|
|
Class weight. |
|
Scheduler. |
|
Scheduler mode. Choices:
|
|
Scheduler name. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure queue assignment on NP7.
fortinet.fortimanager.fmgr_system_npu_npqueues:
# 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>
system_npu_npqueues:
ethernet_type:
-
name: <string>
queue: <integer>
type: <integer>
weight: <integer>
ip_protocol:
-
name: <string>
protocol: <integer>
queue: <integer>
weight: <integer>
ip_service:
-
dport: <integer>
name: <string>
protocol: <integer>
queue: <integer>
sport: <integer>
weight: <integer>
profile:
-
cos0: <value in [queue0, queue1, queue2, ...]>
cos1: <value in [queue0, queue1, queue2, ...]>
cos2: <value in [queue0, queue1, queue2, ...]>
cos3: <value in [queue0, queue1, queue2, ...]>
cos4: <value in [queue0, queue1, queue2, ...]>
cos5: <value in [queue0, queue1, queue2, ...]>
cos6: <value in [queue0, queue1, queue2, ...]>
cos7: <value in [queue0, queue1, queue2, ...]>
dscp0: <value in [queue0, queue1, queue2, ...]>
dscp1: <value in [queue0, queue1, queue2, ...]>
dscp10: <value in [queue0, queue1, queue2, ...]>
dscp11: <value in [queue0, queue1, queue2, ...]>
dscp12: <value in [queue0, queue1, queue2, ...]>
dscp13: <value in [queue0, queue1, queue2, ...]>
dscp14: <value in [queue0, queue1, queue2, ...]>
dscp15: <value in [queue0, queue1, queue2, ...]>
dscp16: <value in [queue0, queue1, queue2, ...]>
dscp17: <value in [queue0, queue1, queue2, ...]>
dscp18: <value in [queue0, queue1, queue2, ...]>
dscp19: <value in [queue0, queue1, queue2, ...]>
dscp2: <value in [queue0, queue1, queue2, ...]>
dscp20: <value in [queue0, queue1, queue2, ...]>
dscp21: <value in [queue0, queue1, queue2, ...]>
dscp22: <value in [queue0, queue1, queue2, ...]>
dscp23: <value in [queue0, queue1, queue2, ...]>
dscp24: <value in [queue0, queue1, queue2, ...]>
dscp25: <value in [queue0, queue1, queue2, ...]>
dscp26: <value in [queue0, queue1, queue2, ...]>
dscp27: <value in [queue0, queue1, queue2, ...]>
dscp28: <value in [queue0, queue1, queue2, ...]>
dscp29: <value in [queue0, queue1, queue2, ...]>
dscp3: <value in [queue0, queue1, queue2, ...]>
dscp30: <value in [queue0, queue1, queue2, ...]>
dscp31: <value in [queue0, queue1, queue2, ...]>
dscp32: <value in [queue0, queue1, queue2, ...]>
dscp33: <value in [queue0, queue1, queue2, ...]>
dscp34: <value in [queue0, queue1, queue2, ...]>
dscp35: <value in [queue0, queue1, queue2, ...]>
dscp36: <value in [queue0, queue1, queue2, ...]>
dscp37: <value in [queue0, queue1, queue2, ...]>
dscp38: <value in [queue0, queue1, queue2, ...]>
dscp39: <value in [queue0, queue1, queue2, ...]>
dscp4: <value in [queue0, queue1, queue2, ...]>
dscp40: <value in [queue0, queue1, queue2, ...]>
dscp41: <value in [queue0, queue1, queue2, ...]>
dscp42: <value in [queue0, queue1, queue2, ...]>
dscp43: <value in [queue0, queue1, queue2, ...]>
dscp44: <value in [queue0, queue1, queue2, ...]>
dscp45: <value in [queue0, queue1, queue2, ...]>
dscp46: <value in [queue0, queue1, queue2, ...]>
dscp47: <value in [queue0, queue1, queue2, ...]>
dscp48: <value in [queue0, queue1, queue2, ...]>
dscp49: <value in [queue0, queue1, queue2, ...]>
dscp5: <value in [queue0, queue1, queue2, ...]>
dscp50: <value in [queue0, queue1, queue2, ...]>
dscp51: <value in [queue0, queue1, queue2, ...]>
dscp52: <value in [queue0, queue1, queue2, ...]>
dscp53: <value in [queue0, queue1, queue2, ...]>
dscp54: <value in [queue0, queue1, queue2, ...]>
dscp55: <value in [queue0, queue1, queue2, ...]>
dscp56: <value in [queue0, queue1, queue2, ...]>
dscp57: <value in [queue0, queue1, queue2, ...]>
dscp58: <value in [queue0, queue1, queue2, ...]>
dscp59: <value in [queue0, queue1, queue2, ...]>
dscp6: <value in [queue0, queue1, queue2, ...]>
dscp60: <value in [queue0, queue1, queue2, ...]>
dscp61: <value in [queue0, queue1, queue2, ...]>
dscp62: <value in [queue0, queue1, queue2, ...]>
dscp63: <value in [queue0, queue1, queue2, ...]>
dscp7: <value in [queue0, queue1, queue2, ...]>
dscp8: <value in [queue0, queue1, queue2, ...]>
dscp9: <value in [queue0, queue1, queue2, ...]>
id: <integer>
type: <value in [cos, dscp]>
weight: <integer>
scheduler:
-
mode: <value in [none, priority, round-robin]>
name: <string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |