Steampunk Ansible Documentation - arubanetworks.aos_switch.arubaoss_interface (1.7.0) - module - Implements Ansible module for port configuration and management.

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 implement rest api's which can be used to configure ports

Usage examples

Scanned by Steampunk Spotter

     - name: configure port description
       arubaoss_interface:
         interface: 1
         description: "test_interface"

Scanned by Steampunk Spotter

     - name: configure qos on port
       arubaoss_interface:
         interface: 5
         qos_policy: "my_qos"

Scanned by Steampunk Spotter

     - name: delete qos from port
       arubaoss_interface:
         interface: 5
         qos_policy: "my_qos"
         enable: False

Scanned by Steampunk Spotter

     - name: config acl on ports
       arubaoss_interface:
         interface: 2
         acl_id: test
         acl_type: standard
         acl_direction: in

Scanned by Steampunk Spotter

     - name: delete acl ports stats
       arubaoss_interface:
         state: delete
         interface: 2
         acl_id: test
         acl_type: standard
         acl_direction: in

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

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

'
type: int

acl_id:
description:
- Name ACL profile that needs to applied to port
required: false

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 to be configured
required: true

admin_stat:
description:
- interface admin status
required: false

qos_policy:
description:
- Name of QOS policy profile that needs to applied to port
required: false

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

'
type: str

description:
description:
- interface name/description, to remove the description of an interface pass in an
empty string ''
required: false

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

acl_direction:
description:
- Direction in which ACL will be applied.
required: false

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

'
type: bool