fmgr_system_npu_npqueues_profile – Configure a NP7 class profile.

New in version 2.2.0.

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.9.0

FortiManager Version Compatibility


6.2.0 6.2.1 6.2.2 6.2.3 6.2.4 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11 6.2.12
False False False False None False False False False False False False False
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12 6.4.13
False False False False False False False True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8 7.0.9
False True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3 7.2.4
True True True True True
7.4.0 7.4.1
True True

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
  • 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
  • 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...
    • 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...

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

- 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 a NP7 class profile.
      fmgr_system_npu_npqueues_profile:
        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]>
        system_npu_npqueues_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>

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 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

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)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.