sushma_alethea.test.icx_qos (1.0.0) — module

Configures qos features on icx switch.

| "added in version" 1.3.0 of sushma_alethea.test"

Authors: Ruckus Wireless (@Commscope)

preview | supported by community

Install collection

Install with ansible-galaxy collection install sushma_alethea.test:==1.0.0


Add to requirements.yml

  collections:
    - name: sushma_alethea.test
      version: 1.0.0

Description

This module configures qos profiles.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Modifies the dynamic buffer-share
    community.network.icx_qos:
      internal_trunk_queue:
        level: level5-1/5
        queue: 4
        state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: update dscp-priority
    community.network.icx_qos:
      dscp_priority:
         dscp_value: 0 1 3 4
         priority: '2'
         state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: update cpu rate limit
    community.network.icx_qos:
      sflow_set_cpu_rate_limit:
        burst_size: 5000
        packet_rate: 1000
        state: present

Inputs

    
profile:
    description: Changes the minimum bandwidth percentages of the eight Weighted Round
      Robin (WRR) queues.
    suboptions:
      percentage0:
        description: Percentage of the device outbound bandwidth allocated to queue 0.
        type: int
      percentage1:
        description: Percentage of the device outbound bandwidth allocated to queue 1.
        type: int
      percentage2:
        description: Percentage of the device outbound bandwidth allocated to queue 2.
        type: int
      percentage3:
        description: Percentage of the device outbound bandwidth allocated to queue 3.
        type: int
      percentage4:
        description: Percentage of the device outbound bandwidth allocated to queue 4.
        type: int
      percentage5:
        description: Percentage of the device outbound bandwidth allocated to queue 5.
        type: int
      percentage6:
        description: Percentage of the device outbound bandwidth allocated to queue 6.
        type: int
      percentage7:
        description: Percentage of the device outbound bandwidth allocated to queue 7.
        type: int
      state:
        choices:
        - present
        - absent
        default: present
        description: Changes bandwidth percentages or restores the default bandwidth percentages.
        type: str
    type: dict

mechanism:
    description: Configures the Quality of Service (QoS) queuing method. Default is WRR
    suboptions:
      queueing_method:
        choices:
        - strict
        - weighted
        - mixed-sp-wrr
        description: Method of packet prioritization.
        type: str
      state:
        choices:
        - present
        - absent
        default: present
        description: Specifies whether queueing method should be configured or reset to
          use the WRR method of packet prioritization.
        type: str
    type: dict

queue_name:
    description: Renames the queue. The default queue names are qosp7, qosp6, qosp5, qosp4,
      qosp3, qosp2, qosp1, and qosp0.
    suboptions:
      new_name:
        description: Specifies the new name of the queue. The name can be an alphanumeric
          type, string up to 32 characters long.
        type: str
      old_name:
        description: Specifies the name of the queue before the change.
        type: str
    type: dict

dscp_priority:
    description: Changes the differentiated Services Code Point (DSCP)-to-internal-forwarding-priority
      mappings..
    suboptions:
      dscp_value:
        description: Specifies the DSCP value ranges that you are remapping. You can map
          up to eight DSCP values to the same forwarding priority in the same command.
          Values can be from 0 to 7
        elements: str
        type: list
      priority:
        description: Specifies the internal forwarding priority.
        type: str
      state:
        choices:
        - present
        - absent
        default: present
        description: Changes or restores the default value.
        type: str
    type: dict

priority_to_pg:
    description: Configures priority-to-priority-group (PG) mapping for priority flow
      control (PFC). This command is supported only on Ruckus ICX 7250, ICX 7450, and
      ICX 7750 devices. This command is not supported on the Ruckus ICX 7150 or the Ruckus
      ICX 7650.
    suboptions:
      priority0:
        choices:
        - 0
        - 1
        - 2
        description: PG for QoS internal priority 0.
        type: int
      priority1:
        choices:
        - 0
        - 1
        - 2
        description: PG for QoS internal priority 1.
        type: int
      priority2:
        choices:
        - 0
        - 1
        - 2
        description: PG for QoS internal priority 2.
        type: int
      priority3:
        choices:
        - 0
        - 1
        - 2
        description: PG for QoS internal priority 3.
        type: int
      priority4:
        choices:
        - 0
        - 1
        - 2
        description: PG for QoS internal priority 4.
        type: int
      priority5:
        choices:
        - 0
        - 1
        - 2
        description: PG for QoS internal priority 5.
        type: int
      priority6:
        choices:
        - 0
        - 1
        - 2
        - 3
        description: PG for QoS internal priority 6.
        type: int
      priority7:
        choices:
        - 0
        - 1
        - 2
        - 3
        - 4
        description: PG for QoS internal priority 7.
        type: int
      state:
        choices:
        - present
        - absent
        default: present
        description: Configures priority to PG mapping or restores the default.
        type: str
    type: dict

tagged_priority:
    description: Changes the VLAN priority of 802.1p to hardware forwarding queue mappings.
    suboptions:
      num:
        description: Specifies the VLAN priority. The value can range from 0 to 7.
        type: int
      queue:
        description: Specifies the hardware forwarding queue on which you are reassigning
          the priority. The value can range from 0 to 7.
        type: str
      state:
        choices:
        - present
        - absent
        default: present
        description: Changed VLAN priority to hardware forwarding queue or sets it to
          802.1p.
        type: str
    type: dict

scheduler_profile:
    description: Configures a user-defined Quality of Service (QoS) scheduler profile.
      Either scheduling-mechanism or profile weight must be specfied.
    suboptions:
      scheduling_mechanism:
        choices:
        - mixed-sp-wrr
        - strict
        - weighted
        description: Configures the queue assignment with the specified scheduling mechanism.
        type: str
      state:
        choices:
        - present
        - absent
        default: present
        description: Configures or removes the scheduler profile configuration.
        type: str
      user_profile_name:
        description: Specifies the name of the scheduler profile to be configured.
        type: str
      wt0:
        description: QOS-profile weight for queue 0.
        type: int
      wt1:
        description: QOS-profile weight for queue 1.
        type: int
      wt2:
        description: QOS-profile weight for queue 2.
        type: int
      wt3:
        description: QOS-profile weight for queue 3.
        type: int
      wt4:
        description: QOS-profile weight for queue 4.
        type: int
      wt5:
        description: QOS-profile weight for queue 5.
        type: int
      wt6:
        description: QOS-profile weight for queue 6.
        type: int
      wt7:
        description: QOS-profile weight for queue 7.
        type: int
    type: dict

check_running_config:
    description: Check running configuration. This can be set as environment variable.
      Module will use environment variable value(default:False), unless it is overridden,
      by specifying it as module parameter.
    type: bool

internal_trunk_queue:
    description: Modifies the dynamic buffer-share level of inter-packet-processor (inter-pp)
      HiGig links egress queues on ICX 7450 devices. This command is supported only on
      ICX 7450 devices or across stack units or for ports across master and slave packet-processor
      (pp) devices in ICX7450-48 units.
    suboptions:
      level:
        choices:
        - level1-1/64
        - level2-1/32
        - level3-1/16
        - level4-1/9
        - level5-1/5
        - level6-1/3
        - level7-1/2
        - level8-2/3
        description: Specifies the number of buffers that can be used in a sharing pool.
        type: str
      queue:
        description: Specifies the queue to apply the buffer limit to. Each port has eight
          hardware queues. The value can range from 0 to 7.
        type: int
      state:
        choices:
        - present
        - absent
        default: present
        description: Change or restore the default queue share level on the specified
          queue.
        type: str
    type: dict

egress_shape_ifg_bytes:
    description: Configures egress shaper IFG bytes. By default a value of 20 is configured.
    suboptions:
      state:
        choices:
        - present
        - absent
        default: present
        description: Specifies whether egress shape ifg bytes should be configured or
          reset to default value of 20.
        type: str
      value_in_bytes:
        description: Specifies the number of preamble and IFG bytes to be added to egress
          shaping in the range 1 through 127.
        type: int
    type: dict

ingress_buffer_profile:
    description: Configures an ingress buffer profile. By default an ingress buffer profile
      is not configured. This command is supported only on Ruckus ICX 7250, ICX 7450,
      and ICX 7750 devices. This command is not supported on the Ruckus ICX 7150 or the
      Ruckus ICX 7650. For PFC disabled ports, the default PG XOFF limit is level7-1/2.
      For PFC enabled ports, the default PG XOFF limit is level2-1/32.
    suboptions:
      priority_group_number:
        description: Specifies the priority group (PG) number with the XOFF threshold
          level that must be configured.
        type: int
      shared_level:
        choices:
        - level1-1/64
        - level2-1/32
        - level3-1/16
        - level4-1/9
        - level5-1/5
        - level6-1/3
        - level7-1/2
        description: Specifies the per-PG buffer threshold to trigger sending of priority
          flow control (PFC).
        type: str
      state:
        choices:
        - present
        - absent
        default: present
        description: Specifies whether ingress buffer profile will be configured or removed.
          "absent" will detach the profile from any ports that are using it.
        type: str
      user_profile_name:
        description: Specifies the name of the ingress buffer profile to be configured.
        type: str
    type: dict

sflow_set_cpu_rate_limit:
    description: Sets the CPU rate limit for sFlow. A CPU rate limit for sFlow is configured
      with the default values of 100 sFlow sampled packets per second (PPS) and a burst
      size of 5000 B.
    suboptions:
      burst_size:
        description: Specifies the burst size. The value is measured in bytes and ranges
          from 1 to 99999.
        type: int
      packet_rate:
        description: Specifies the number of sFlow sampled PPS into the CPU. The value
          is measured in PPS and ranges from 1 to 1000.
        type: int
      state:
        choices:
        - present
        - absent
        default: present
        description: Sets or returns the device to the default CPU rate limit for sFlow.
        type: str
    type: dict

egress_buffer_profile_7150:
    description: Configures an egress buffer profile for the share port level. This is
      supported only on ICX 7150. The default egress buffer profile level is level4-1/9
      for 1/9 of the buffers in buffer memory.
    suboptions:
      port_share_level:
        choices:
        - level3-1/16
        - level4-1/9
        - level5-1/5
        - level6-1/3
        - level7-1/2
        - level8-2/3
        description: Specifies the number of buffers that can be used in the buffer memory.
        type: str
      state:
        choices:
        - present
        - absent
        default: present
        description: Specifies whether the egress-buffer-profile should be configured
          or removed. "absent" will detach the profile from any ports that are using it.
        type: str
      user_profile_name:
        description: Specifies the name of the egress buffer profile to be configured.
        type: str
    type: dict

egress_buffer_profile_7X50:
    description: Configures an egress buffer profile for the share queue level. This command
      is supported only on Ruckus ICX 7250, ICX 7450, and ICX 7750 devices. The default
      egress buffer profile level is level4-1/9 for 1/9 of the buffers in buffer memory.
      This is not supported on ICX 7150
    suboptions:
      queue_number:
        description: Specifies the queue to apply the buffer limit to. There are eight
          hardware queues per port.
        type: int
      queue_share_level:
        choices:
        - level1-1/64
        - level2-1/32
        - level3-1/16
        - level4-1/9
        - level5-1/5
        - level6-1/3
        - level7-1/2
        - level8-2/3
        description: Specifies the number of buffers that can be used in a sharing pool.
          Eight levels are supported.
        type: str
      state:
        choices:
        - present
        - absent
        default: present
        description: Specifies whether the egress-buffer-profile should be configured
          or removed. "absent" will detach the profile from any ports that are using it.
        type: str
      user_profile_name:
        description: Specifies the name of the egress buffer profile to be configured..
        type: str
    type: dict

monitor_queue_drop_counters:
    description: Configures the port that the Ruckus ICX 7150 device monitors for the
      incrementing of the egress queue drop counters.
    suboptions:
      port_id:
        description: Specifies the port ID to associate with the egress queue drop counters..
        type: str
      state:
        choices:
        - present
        - absent
        default: present
        description: Specifies whether queue drop counters must be associated to a port
          or reset to the internal local CPU port.
        type: str
    type: dict

attach_egress_buffer_profile:
    description: Attaches a user-configured egress buffer profile to one or more ports.
    suboptions:
      port:
        description: Port to which profile should be attached.
        type: str
      profile_name:
        description: Specifies the name of the egress buffer profile to be attached to
          the port.
        type: str
      state:
        choices:
        - present
        - absent
        default: present
        description: Attach or removes a user-configured egress buffer profile from the
          port and the port uses the default egress buffer profile.
        type: str
    type: dict

Outputs

changed:
  description: true when qos command was executed. False otherwise.
  returned: always
  type: bool