fmgr_system_npu_npqueues – Configure queue assignment on NP7.
Added in version 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.nameNew 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.
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 v6.x and v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.4.7 -> v6.4.14, v7.0.1 -> latest
Parameters
- 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
- 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
- adom - The parameter in requested url type: str required: true
- system_npu_npqueues - Configure queue assignment on NP7. type: dict
- ethernet_type (Alias name: ethernet-type) type: list more...
- ip_protocol (Alias name: ip-protocol) type: list more...
- ip_service (Alias name: ip-service) type: list more...
- profile type: list
more...
- cos0 Queue number of cos 0. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- cos1 Queue number of cos 1. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- cos2 Queue number of cos 2. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- cos3 Queue number of cos 3. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- cos4 Queue number of cos 4. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- cos5 Queue number of cos 5. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- cos6 Queue number of cos 6. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- cos7 Queue number of cos 7. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp0 Queue number of dscp 0. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp1 Queue number of dscp 1. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp10 Queue number of dscp 10. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp11 Queue number of dscp 11. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp12 Queue number of dscp 12. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp13 Queue number of dscp 13. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp14 Queue number of dscp 14. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp15 Queue number of dscp 15. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp16 Queue number of dscp 16. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp17 Queue number of dscp 17. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp18 Queue number of dscp 18. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp19 Queue number of dscp 19. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp2 Queue number of dscp 2. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp20 Queue number of dscp 20. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp21 Queue number of dscp 21. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp22 Queue number of dscp 22. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp23 Queue number of dscp 23. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp24 Queue number of dscp 24. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp25 Queue number of dscp 25. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp26 Queue number of dscp 26. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp27 Queue number of dscp 27. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp28 Queue number of dscp 28. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp29 Queue number of dscp 29. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp3 Queue number of dscp 3. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp30 Queue number of dscp 30. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp31 Queue number of dscp 31. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp32 Queue number of dscp 32. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp33 Queue number of dscp 33. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp34 Queue number of dscp 34. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp35 Queue number of dscp 35. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp36 Queue number of dscp 36. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp37 Queue number of dscp 37. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp38 Queue number of dscp 38. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp39 Queue number of dscp 39. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp4 Queue number of dscp 4. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp40 Queue number of dscp 40. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp41 Queue number of dscp 41. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp42 Queue number of dscp 42. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp43 Queue number of dscp 43. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp44 Queue number of dscp 44. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp45 Queue number of dscp 45. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp46 Queue number of dscp 46. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp47 Queue number of dscp 47. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp48 Queue number of dscp 48. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp49 Queue number of dscp 49. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp5 Queue number of dscp 5. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp50 Queue number of dscp 50. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp51 Queue number of dscp 51. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp52 Queue number of dscp 52. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp53 Queue number of dscp 53. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp54 Queue number of dscp 54. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp55 Queue number of dscp 55. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp56 Queue number of dscp 56. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp57 Queue number of dscp 57. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp58 Queue number of dscp 58. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp59 Queue number of dscp 59. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp6 Queue number of dscp 6. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp60 Queue number of dscp 60. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp61 Queue number of dscp 61. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp62 Queue number of dscp 62. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp63 Queue number of dscp 63. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp7 Queue number of dscp 7. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp8 Queue number of dscp 8. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- dscp9 Queue number of dscp 9. type: str choices: [queue0, queue1, queue2, queue3, queue4, queue5, queue6, queue7] more...
- id Profile id. type: int more...
- type Profile type. type: str choices: [cos, dscp] more...
- weight Class weight. type: int more...
- scheduler type: list more...
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
- 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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- 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.