arubanetworks.aoscx.aoscx_vsx (4.3.2) — module

Create or Delete VSX configuration on AOS-CX.

| "added in version" 2.8.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 modules provides configuration management of VSX on AOS-CX devices. Note that if you require to remove configuration, you'll need to delete the VSX configuration, and recreate it without the attributes you wish to remove.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete VSX configuration
  aoscx_vsx:
    state: delete
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update VSX configuration for primary device, set ISL port
  aoscx_vsx:
    device_role: primary
    isl_port: 1/1/1
    state: update
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: >
    Create simple VSX configuration with lag as ISL port for secondary device
  aoscx_vsx:
    device_role: secondary
    isl_port: lag1
    keepalive_vrf: red
    state: create
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create detailed VSX configuration
  aoscx_vsx:
    config_sync_disable: false
    config_sync_features:
      - aaa
      - bgp
      - dns
      - vrrp
    device_role: primary
    isl_port: 1/1/8
    isl_timers:
      timeout: 20
      peer_detect_interval: 100
      hold_time: 3
      hello_interval: 5
    keepalive_peer_ip: 10.0.0.2
    keepalive_src_ip:  10.0.0.1
    keepalive_timers:
      hello_interval: 5
      dead_interval: 20
    keepalive_udp_port: 7678
    keepalive_vrf: default
    linkup_delay_timer: 90
    software_update_abort_request: 7
    software_update_schedule_time: 1635356306
    software_update_url: usb://boot_bank=primary
    software_update_vrf: default
    split_recovery_disable: false
    system_mac: 00:FF:11:EE:22:DD

Inputs

    
state:
    choices:
    - create
    - update
    - delete
    default: create
    description: Create or delete VSX configuration.
    required: false
    type: str

isl_port:
    description: Port to be used as inter switch link.
    required: false
    type: str

isl_timers:
    description: Timing configuration for ISL functionality.
    suboptions:
      hello_interval:
        description: ISLP hello interval in seconds.
        required: true
        type: int
      hold_time:
        description: Configures ISL port-flap hold time in seconds.
        required: true
        type: int
      peer_detect_interval:
        description: 'Configures the amount of time in seconds that the device waits for
          ISL interface to link up after a reboot. If the ISL link does not come up within
          this time window, the device declares itself as split from its peer.

          '
        required: true
        type: int
      timeout:
        description: Seconds to wait for hellos from peer.
        required: true
        type: int
    type: dict

system_mac:
    description: 'System MAC address to be used by L2 control plane protocols like STP
      and LACP as their Bridge Identifier. A pair of VSX switches must have the same system
      MAC. If system_mac is not configured, L2 control plane protocols will use the VSX
      Primary device MAC address as their Bridge Identifier. MAC address must be in xx:xx:xx:xx:xx:xx
      format.

      '
    required: false
    type: str

device_role:
    choices:
    - primary
    - secondary
    default: primary
    description: 'Specifies whether the device will act as primary or secondary for vsx
      operation requires a switch to be primary and another to be secondary.

      '
    required: false
    type: str

keepalive_vrf:
    description: 'VRF to be used for keepalive routing. If not configured, keepalive functionality
      is disabled.

      '
    required: false
    type: str

keepalive_src_ip:
    description: 'IPv4 address of the device. If not configured, keepalive functionality
      is disabled. MUST be together with keepalive_peer_ip.

      '
    required: false
    type: str

keepalive_timers:
    description: Timing configuration for keepalive functionality.
    required: false
    suboptions:
      dead_interval:
        description: 'Configures the amount of time in seconds to wait for keepalive packets
          from a peer.

          '
        required: true
        type: int
      hello_interval:
        description: Keepalive hello interval in seconds.
        required: true
        type: int
    type: dict

keepalive_peer_ip:
    description: 'IPv4 address of the peer device. If not configured, keepalive functionality
      is disabled. MUST be together with keepalive_src_ip.

      '
    required: false
    type: str

keepalive_udp_port:
    description: UDP port number of peer device.
    required: false
    type: int

linkup_delay_timer:
    description: 'Number of seconds that multi-chassis LAGs should be held down after
      the ISL is considered to be fully established and VSX switches are synchronized.

      '
    required: false
    type: int

config_sync_disable:
    description: 'Specifies whether VSX configuration synchronization is enabled or not.

      '
    required: false
    type: bool

software_update_url:
    description: 'URL for downloading software from a connected storage device or a remote
      host. TFTP and USB are the only download methods supported.

      '
    required: false
    type: str

software_update_vrf:
    description: 'VRF that is used for downloading the image. If the VRF is not specified
      then the default VRF is used.

      '
    required: false
    type: str

config_sync_features:
    choices:
    - aaa
    - acl-log-timer
    - arp-security
    - bfd-global
    - bgp
    - control-plane-acls
    - copp-policy
    - dhcp-server
    - dns
    - dhcp-relay
    - dhcp-snooping
    - hardware-high-capacity-tcam
    - evpn
    - icmp-tcp
    - gbp
    - lldp
    - loop-protect-global
    - keychain
    - mac-lockout
    - mclag-interfaces
    - mgmd-global
    - macsec
    - neighbor
    - ospf
    - qos-global
    - nd-snooping
    - route-map
    - sflow-global
    - snmp
    - ssh
    - static-routes
    - stp-global
    - rip
    - time
    - vsx-global
    - udp-forwarder
    - vrrp
    description: 'Feature configurations to be globally synchronized between VSX peers.

      '
    elements: str
    required: false
    type: list

split_recovery_disable:
    description: Disables split brain recovery.
    required: false
    type: bool

software_update_abort_request:
    description: 'Number of times a software update process was requested to be aborted.
      The abort operation takes effect only when the update operation is in progress.

      '
    required: false
    type: int

software_update_schedule_time:
    description: 'Time (in seconds from epoch) when the update should be performed. When
      the software update parameters (URL, VRF, schedule_time[optional] are added/updated,
      the new image is downloaded to alternate bank of both, primary and secondary. Post
      download, the secondary is rebooted and then followed by the primary.

      '
    required: false
    type: int