drmofu.fortimanager.fmgr_system_npu_npqueues_profile (2.2.2) — module

Configure a NP7 class profile.

| "added in version" 2.2.0 of drmofu.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2


Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - 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: <value of integer>
            type: <value in [cos, dscp]>
            weight: <value of integer>

Inputs

    
adom:
    description: the parameter (adom) in requested url
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

system_npu_npqueues_profile:
    description: the top level parameters set
    required: false
    suboptions:
      cos0:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of CoS 0.
        type: str
      cos1:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of CoS 1.
        type: str
      cos2:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of CoS 2.
        type: str
      cos3:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of CoS 3.
        type: str
      cos4:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of CoS 4.
        type: str
      cos5:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of CoS 5.
        type: str
      cos6:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of CoS 6.
        type: str
      cos7:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of CoS 7.
        type: str
      dscp0:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 0.
        type: str
      dscp1:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 1.
        type: str
      dscp10:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 10.
        type: str
      dscp11:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 11.
        type: str
      dscp12:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 12.
        type: str
      dscp13:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 13.
        type: str
      dscp14:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 14.
        type: str
      dscp15:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 15.
        type: str
      dscp16:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 16.
        type: str
      dscp17:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 17.
        type: str
      dscp18:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 18.
        type: str
      dscp19:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 19.
        type: str
      dscp2:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 2.
        type: str
      dscp20:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 20.
        type: str
      dscp21:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 21.
        type: str
      dscp22:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 22.
        type: str
      dscp23:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 23.
        type: str
      dscp24:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 24.
        type: str
      dscp25:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 25.
        type: str
      dscp26:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 26.
        type: str
      dscp27:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 27.
        type: str
      dscp28:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 28.
        type: str
      dscp29:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 29.
        type: str
      dscp3:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 3.
        type: str
      dscp30:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 30.
        type: str
      dscp31:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 31.
        type: str
      dscp32:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 32.
        type: str
      dscp33:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 33.
        type: str
      dscp34:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 34.
        type: str
      dscp35:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 35.
        type: str
      dscp36:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 36.
        type: str
      dscp37:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 37.
        type: str
      dscp38:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 38.
        type: str
      dscp39:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 39.
        type: str
      dscp4:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 4.
        type: str
      dscp40:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 40.
        type: str
      dscp41:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 41.
        type: str
      dscp42:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 42.
        type: str
      dscp43:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 43.
        type: str
      dscp44:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 44.
        type: str
      dscp45:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 45.
        type: str
      dscp46:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 46.
        type: str
      dscp47:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 47.
        type: str
      dscp48:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 48.
        type: str
      dscp49:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 49.
        type: str
      dscp5:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 5.
        type: str
      dscp50:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 50.
        type: str
      dscp51:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 51.
        type: str
      dscp52:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 52.
        type: str
      dscp53:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 53.
        type: str
      dscp54:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 54.
        type: str
      dscp55:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 55.
        type: str
      dscp56:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 56.
        type: str
      dscp57:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 57.
        type: str
      dscp58:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 58.
        type: str
      dscp59:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 59.
        type: str
      dscp6:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 6.
        type: str
      dscp60:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 60.
        type: str
      dscp61:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 61.
        type: str
      dscp62:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 62.
        type: str
      dscp63:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 63.
        type: str
      dscp7:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 7.
        type: str
      dscp8:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 8.
        type: str
      dscp9:
        choices:
        - queue0
        - queue1
        - queue2
        - queue3
        - queue4
        - queue5
        - queue6
        - queue7
        description: Queue number of DSCP 9.
        type: str
      id:
        description: Profile ID.
        type: int
      type:
        choices:
        - cos
        - dscp
        description: Profile type.
        type: str
      weight:
        description: Class weight.
        type: int
    type: dict

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list