arubanetworks.aoscx.aoscx_interface (4.3.2) — module

Module for configuring Interfaces in AOS-CX switches.

| "added in version" 4.0.0 of arubanetworks.aoscx"

Authors: Aruba Networks (@ArubaNetworks)

preview | supported by certified

Install collection

Install with ansible-galaxy collection install arubanetworks.aoscx:==4.3.2


Add to requirements.yml

  collections:
    - name: arubanetworks.aoscx
      version: 4.3.2

Description

This module provides the functionality for configuring Interfaces on AOS-CX devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: >
    Configure Interface 1/1/2 - full duplex, speed of 1000 Mbps and no
    auto-negotiation.
  aoscx_interface:
    name: 1/1/2
    configure_speed: true
    autoneg: off
    duplex: full
    speeds:
      - 1000
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: >
    Configure Interface 1/1/2 - half duplex, speed 10 Mbps and no
    auto-negotiation.
  aoscx_interface:
    name: 1/1/2
    configure_speed: true
    autoneg: off
    duplex: half
    speeds:
      - 10
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: >
    Configure Interface 1/1/2 - advertise only 100 Mbps and 1000 Mbps speeds
    and duplex auto-negotiation.
  aoscx_interface:
    name: 1/1/2
    configure_speed: true
    autoneg: on
    speeds:
      - 100
      - 1000
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure Interface 1/1/2 - speeds and duplex auto-negotiation.
  aoscx_interface:
    name: 1/1/2
    configure_speed: true
    autoneg: on
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Administratively disable interface 1/1/2
  aoscx_interface:
    name: 1/1/2
    enabled: false
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set a QoS trust mode for interface 1/1/2
  aoscx_interface:
    name: 1/1/2
    qos_trust_mode: cos
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set interface 1/1/3 to use global trust mode
  aoscx_interface:
    name: 1/1/3
    qos_trust_mode: global
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure Interface 1/1/3 to use the global QoS trust mode
  aoscx_interface:
    name: 1/1/13
    qos_trust_mode: global
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set a Queue Profile for interface 1/1/2
  aoscx_interface:
    name: 1/1/2
    queue_profile: STRICT-PROFILE
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set interface 1/1/3 to use global Queue Profile
  aoscx_interface:
    name: 1/1/3
    use_global_queue_profile: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure Schedule Profile on an interface
  aoscx_interface:
    name: 1/1/17
    qos: STRICT
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove a Schedule Profile from an interface
  aoscx_interface:
    name: 1/1/17
    no_qos: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set the QoS rate to the 1/1/17 Interface
  aoscx_interface:
    name: 1/1/17
    qos_rate:
      broadcast: 200pps
      unknown_unicast: 100kbps
      multicast: 200pps
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure Interface 1/1/2 - enable vsx-sync features
  aoscx_interface:
    name: 1/1/2
    vsx_sync:
      - acl
      - irdp
      - qos
      - rate_limits
      - vlan
      - vsx_virtual
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set the MTU rate to the 1/1/1 Interface
  aoscx_interface:
    name: 1/1/17
    mtu: 1300

Inputs

    
mtu:
    description: Configure MTU value of the interface
    required: false
    type: int

qos:
    description: 'Name of existing QoS schedule profile to apply to interface. This option
      is mutually exclusive with the no_qos option.

      '
    required: false
    type: str

name:
    description: 'Interface name, should be in the format chassis/slot/port, e.g. 1/2/3,
      1/2/32.

      '
    required: true
    type: str

state:
    choices:
    - create
    - update
    - delete
    default: create
    description: Create, Update or Delete the Interface.
    required: false
    type: str

duplex:
    choices:
    - full
    - half
    description: 'Configure the interface for full duplex or half duplex. If `autoneg`is
      `on` this must be omitted.

      '
    required: false
    type: str

no_qos:
    default: false
    description: 'Flag to remove the existing QoS schedule profile of the interface. use
      true to remove it. This option is mutually exclusive with the qos option.

      '
    required: false
    type: bool

speeds:
    description: 'Configure the speeds of the interface in megabits per second. If `duplex`
      is defined only one speed may be specified.

      '
    elements: int
    required: false
    type: list

autoneg:
    description: 'Configure the auto-negotiation state of the interface. If `off` both
      `speeds`, and `duplex` are required.

      '
    required: false
    type: bool

enabled:
    description: 'Administrative state of the interface. Use true to administratively
      enable it.

      '
    required: false
    type: bool

qos_rate:
    description: 'The rate limit value configured for broadcast/multicast/unknown unicast
      traffic.

      '
    required: false
    suboptions:
      broadcast:
        description: 'Ingress broadcast rate-limit bandwidth value. The unit type is specified
          by the end of the string, i.e.: 200pps or 100kpbs.

          '
        required: false
        type: str
      multicast:
        description: 'Ingress multicast rate-limit bandwidth value. The unit type is specified
          by the end of the string. i.e.: 200pps or 100kpbs.

          '
        required: false
        type: str
      unknown_unicast:
        description: 'Ingress unknown unicast rate-limit bandwidth value. The unit type
          is specified by the end of the string, i.e.: 200pps or 100kbps.

          '
        required: false
        type: str
    type: dict

vsx_sync:
    choices:
    - acl
    - irdp
    - qos
    - rate_limits
    - vlan
    - vsx_virtual
    - virtual_gw_l3_src_mac_enable
    - policy
    - threshold_profile
    - macsec_policy
    - mka_policy
    - portfilter
    - client_ip_track_configuration
    - mgmd_acl
    - mgmd_enable
    - mgmd_robustness
    - mgmd_querier_max_response_time
    - mgmd_mld_version
    - mgmd_querier_interval
    - mgmd_last_member_query_interval
    - mgmd_querier_enable
    - mgmd_mld_static_groups
    - mgmd_igmp_static_groups
    - mgmd_igmp_version
    description: 'Controls which attributes should be synchronized between VSX peers.

      '
    elements: str
    required: false
    type: list

description:
    description: Description of the interface.
    required: false
    type: str

queue_profile:
    description: Name of queue profile to apply to interface.
    required: false
    type: str

qos_trust_mode:
    choices:
    - cos
    - dscp
    - none
    - global
    description: 'Specifies the interface QoS Trust Mode. ''global'' configures the interface
      to use the global configuration.

      '
    required: false
    type: str

configure_speed:
    default: false
    description: 'Option to configure speed/duplex in the interface. It `true`, `autoneg`
      is required.

      '
    required: false
    type: bool

use_global_queue_profile:
    default: false
    description: 'Option to use the switch''s global Queue Profile. This option is mutually
      exclusive with the queue_profile option.

      '
    required: false
    type: bool