arubanetworks.aos_switch.arubaoss_loop_protect (1.7.0) — module

implements loop-protect rest api

| "added in version" 2.6.0 of arubanetworks.aos_switch"

Authors: Ashish Pant (@hpe)

preview | supported by community

Install collection

Install with ansible-galaxy collection install arubanetworks.aos_switch:==1.7.0


Add to requirements.yml

  collections:
    - name: arubanetworks.aos_switch
      version: 1.7.0

Description

This configures loop protect on device over vlan or port

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
     - name: update loop
       arubaoss_loop_protect:
         command: update
         trap: True
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
     - name: enable loop-prtoect on port
       arubaoss_loop_protect:
         command: update_port
         interface: 1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
     - name: disable loop-prtoect on port
       arubaoss_loop_protect:
         command: update_port
         interface: 1
         loop_protected: False
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
     - name: change loop-protect mode to vlan
       arubaoss_loop_protect:
         command: update
         mode: LPM_VLAN
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
     - name: enable loop-prtoect on vlan
       arubaoss_loop_protect:
         command: update_vlan
         vlan: 10

Inputs

    
host:
    description: 'Specifies the DNS host name or address for connecting to the remote
      device over the specified transport. The value of host is used as the destination
      address for the transport.

      '
    type: str

mode:
    choices:
    - LPM_PORT
    - LPM_VLAN
    default: LPM_PORT
    description:
    - Configures vlan or port mode
    required: false

port:
    description: 'Specifies the port to use when building the connection to the remote
      device.

      '
    type: int

vlan:
    description:
    - Vlan id on which loop protect is to be configured
    required: false

command:
    choices:
    - update
    - update_port
    - update_vlan
    description:
    - Type of action to be taken.
    required: true

timeout:
    description: 'Specifies the timeout in seconds for communicating with the network
      device for either connecting or sending commands. If the timeout is exceeded before
      the operation is completed, the module will error.

      '
    type: int

use_ssl:
    description: 'Configures use SSL (HTTPS) for access to the remote device.

      '
    type: bool

password:
    description: 'Specifies the password to use to authenticate the connection to the
      remote device. This value is used to authenticate the SSH session. If the value
      is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD
      will be used instead.

      '
    type: str

provider:
    description: A dict object containing connection details.
    suboptions:
      api_version:
        default: None
        description: 'Configures (force) API version (vX.Y) for acces to the remote device.

          '
        type: str
      host:
        description: 'Specifies the DNS host name or address for connecting to the remote
          device over the specified transport. The value of host is used as the destination
          address for the transport.

          '
        type: str
      password:
        description: 'Specifies the password to use to authenticate the connection to
          the remote device. This value is used to authenticate the SSH session. If the
          value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD
          will be used instead.

          '
        type: str
      port:
        description: 'Specifies the port to use when building the connection to the remote
          device.

          '
        type: int
      ssh_keyfile:
        description: 'Specifies the SSH key to use to authenticate the connection to the
          remote device. This value is the path to the key used to authenticate the SSH
          session. If the value is not specified in the task, the value of environment
          variable ANSIBLE_NET_SSH_KEYFILE will be used instead.

          '
        type: path
      timeout:
        description: 'Specifies the timeout in seconds for communicating with the network
          device for either connecting or sending commands. If the timeout is exceeded
          before the operation is completed, the module will error.

          '
        type: int
      transport:
        default: aossapi
        description: 'Configures the transport (aossapi or network_cli) mode.

          '
        type: str
      use_proxy:
        default: false
        description: 'Configures use (Local) Proxy for access to the remote device.

          '
        type: bool
      use_ssl:
        description: 'Configures use SSL (HTTPS) for access to the remote device.

          '
        type: bool
      username:
        description: 'Configures the username to use to authenticate the connection to
          the remote device. This value is used to authenticate the SSH session. If the
          value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME
          will be used instead.

          '
        type: str
      validate_certs:
        default: false
        description: 'Configures validation of certification for access to the remote
          device.

          '
        type: bool
    type: dict

username:
    description: 'Configures the username to use to authenticate the connection to the
      remote device. This value is used to authenticate the SSH session. If the value
      is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME
      will be used instead.

      '
    type: str

interface:
    description:
    - Interface id on which loop protect to be configured
    required: false

api_version:
    default: None
    description: 'Configures (force) API version (vX.Y) for acces to the remote device.

      '
    type: str

ssh_keyfile:
    description: 'Specifies the SSH key to use to authenticate the connection to the remote
      device. This value is the path to the key used to authenticate the SSH session.
      If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE
      will be used instead.

      '
    type: path

validate_certs:
    default: false
    description: 'Configures validation of certification for access to the remote device.

      '
    type: bool

receiver_action:
    choices:
    - LPRA_SEND_DISABLE
    - LPRA_NO_DISABLE
    - LPRA_SEND_RECV_DISABLE
    default: LPRA_SEND_DISABLE
    description:
    - Set the action to take when a loop is detected. is_loop_protection_enabled must
      be true to update the receiver_action.
    required: false

trasmit_interval:
    description:
    - Set the number of seconds between loop detect packet transmissions.
    required: false

port_disable_timer:
    description:
    - Set the number of seconds before disabled ports are automatically re-enabled
    required: false