sushma_alethea.test.icx_rate_limit (1.0.0) — module

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 rate limit input, output, arp and BUM.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: set rate-limit input
  icx_rate_limit:
    rate_limit_input:
      interace: 1/1/2
      avergae_rate: 500

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: set rate-limit output
  icx_rate_limit:
    rate_limit_output:
      interace: 1/1/2
      value: 500

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: set rate-limit arp
  icx_rate_limit:
    rate_limit_arp:
      number: 100

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: set rate-limit BUM
  icx_rate_limit:
    rate_limit_bum:
      minutes: 3

Inputs

    
aggregate:
    description: List of Interfaces definitions.
    elements: dict
    suboptions:
      broadcast_limit:
        description: Configures the maximum number of broadcast packets allowed per second.
          Enables Syslog logging of broadcast packets.
        suboptions:
          kbps:
            description: Enables byte-based limiting. The value can be 1 to Max Port Speed.
              Set to 0 to disable byte-based limiting.
            required: true
            type: int
          log:
            description: True enables Syslog logging when the broadcast limit exceeds
              kpbs. False will disable logging.
            type: bool
          port:
            description: port(stack/slot/port) on which to set broadcast limit.
            required: true
            type: str
        type: dict
      multicast_limit:
        description: Configures the maximum number of multicast packets allowed per second.
          Enables Syslog logging of multicast packets.
        suboptions:
          kbps:
            description: Specifies the maximum number of multicast packets per second.
              The value can be 1 to Max Port Speed. Set to 0 to disable limiting..
            required: true
            type: int
          log:
            description: True enables Syslog logging when the multicast limit exceeds
              kpbs. False will disable logging.
            type: bool
          port:
            description: port(stack/slot/port) on which to set multicast limit.
            required: true
            type: str
        type: dict
      rate_limit_arp:
        description: Limits the number of ARP packets the Ruckus device accepts during
          each second.
        suboptions:
          number:
            description: Specifies the number of ARP packets and can be from 0 through
              100. If you specify 0, the device will not accept any ARP packets.
            required: true
            type: int
          state:
            choices:
            - present
            - absent
            default: present
            description: Specifies whether to enable or disable arp rate limiting.
            type: str
        type: dict
      rate_limit_bum:
        description: Configures the global level BUM suppression logging interval. The
          default logging interval 5 minutes
        suboptions:
          minutes:
            description: Specifies the interval, in whole minutes, between Syslog notifications.
              The value can be any integer from 1 to 10.
            required: true
            type: int
          state:
            choices:
            - present
            - absent
            default: present
            description: Specifies whether to configure or return to the default value.
            type: str
        type: dict
      rate_limit_input:
        description: Configures a port-based rate-limiting policy.
        suboptions:
          average_rate:
            description: Specifies the maximum number of kilobits per second (kbps).
            required: true
            type: int
          burst_size:
            description: Specifies the burst size in kilobits.
            type: int
          lag:
            description: lag id, if port is part of lag.
            type: str
          port:
            description: port(stack/slot/port) on which to set the rate-limiting policy.
            type: str
          state:
            choices:
            - present
            - absent
            default: present
            description: Specifies whether to configure or remove rate limiting.
            type: str
        type: dict
      rate_limit_output:
        description: Configures the maximum rate at which outbound traffic is sent on
          a port priority queue or on a LAG port.
        suboptions:
          lag:
            description: lag id, if port is part of lag.
            type: str
          port:
            description: port(stack/slot/port) on which to set the rate-limiting policy.
            type: str
          priority_queue:
            description: Specifies a rate-shaping priority. The value can range from 0
              to 7.
            type: int
          state:
            choices:
            - present
            - absent
            default: present
            description: Specifies whether to configure or remove output rate shaping.
            type: str
          value:
            description: Specifies the rate-shaping limit.
            required: true
            type: int
        type: dict
      unknown_unicast_limit:
        description: Configures the maximum number of unknown unicast packets allowed
          per second. Enables Syslog logging of unknown unicast packets.
        suboptions:
          kbps:
            description: Specifies the maximum number of unknown unicast packets per second.
              The value can be 1 to Max Port Speed. Set to 0 to disable limiting.
            required: true
            type: int
          log:
            description: Enables Syslog logging when the unknown unicast limit exceeds
              kpbs. False will disable logging.
            type: bool
          port:
            description: port(stack/slot/port) on which to set broadcast limit.
            required: true
            type: str
        type: dict
    type: list

rate_limit_arp:
    description: Limits the number of ARP packets the Ruckus device accepts during each
      second.
    suboptions:
      number:
        description: Specifies the number of ARP packets and can be from 0 through 100.
          If you specify 0, the device will not accept any ARP packets.
        required: true
        type: int
      state:
        choices:
        - present
        - absent
        default: present
        description: Specifies whether to enable or disable arp rate limiting.
        type: str
    type: dict

rate_limit_bum:
    description: Configures the global level BUM suppression logging interval. The default
      logging interval 5 minutes
    suboptions:
      minutes:
        description: Specifies the interval, in whole minutes, between Syslog notifications.
          The value can be any integer from 1 to 10.
        required: true
        type: int
      state:
        choices:
        - present
        - absent
        default: present
        description: Specifies whether to configure or return to the default value.
        type: str
    type: dict

broadcast_limit:
    description: Configures the maximum number of broadcast packets allowed per second.
      Enables Syslog logging of broadcast packets.
    suboptions:
      kbps:
        description: Enables byte-based limiting. The value can be 1 to Max Port Speed.
          Set to 0 to disable byte-based limiting.
        required: true
        type: int
      log:
        description: True enables Syslog logging when the broadcast limit exceeds kpbs.
          False will disable logging.
        type: bool
      port:
        description: port( stack/slot/port) on which to set broadcast limit.
        required: true
        type: str
    type: dict

multicast_limit:
    description: Configures the maximum number of multicast packets allowed per second.
      Enables Syslog logging of multicast packets.
    suboptions:
      kbps:
        description: Specifies the maximum number of multicast packets per second. The
          value can be 1 to Max Port Speed. Set to 0 to disable limiting..
        required: true
        type: int
      log:
        description: True enables Syslog logging when the multicast limit exceeds kpbs.
          False will disable logging.
        type: bool
      port:
        description: port(stack/slot/port) on which to set broadcast limit.
        required: true
        type: str
    type: dict

rate_limit_input:
    description: Configures a port-based rate-limiting policy.
    suboptions:
      average_rate:
        description: Specifies the maximum number of kilobits per second (kbps).
        required: true
        type: int
      burst_size:
        description: Specifies the burst size in kilobits.
        type: int
      lag:
        description: lag id, if port is part of lag.
        type: str
      port:
        description: port(stack/slot/port) on which to set the rate-limiting policy.
        type: str
      state:
        choices:
        - present
        - absent
        default: present
        description: Specifies whether to configure or remove rate limiting.
        type: str
    type: dict

rate_limit_output:
    description: Configures the maximum rate at which outbound traffic is sent on a port
      priority queue or on a LAG port.
    suboptions:
      lag:
        description: lag id, if port is part of lag.
        type: str
      port:
        description: port(stack/slot/port) on which to set the rate-limiting policy.
        type: str
      priority_queue:
        description: Specifies a rate-shaping priority. The value can range from 0 to
          7.
        type: int
      state:
        choices:
        - present
        - absent
        default: present
        description: Specifies whether to configure or remove output rate shaping.
        type: str
      value:
        description: Specifies the rate-shaping limit.
        required: true
        type: int
    type: dict

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

unknown_unicast_limit:
    description: Configures the maximum number of unknown unicast packets allowed per
      second. Enables Syslog logging of unknown unicast packets.
    suboptions:
      kbps:
        description: Specifies the maximum number of unknown unicast packets per second.
          The value can be 1 to Max Port Speed. Set to 0 to disable limiting.
        required: true
        type: int
      log:
        description: Enables Syslog logging when the unknown unicast limit exceeds kpbs.
          False will disable logging.
        type: bool
      port:
        description: port(stack/slot/port) on which to set broadcast limit.
        required: true
        type: str
    type: dict

Outputs

changed:
  description: true when rate-limit command was executed. False otherwise.
  returned: always
  type: bool