Steampunk Ansible Documentation - arubanetworks.aos_switch.arubaoss_ip_route (1.7.0) - module

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 implements static routing rest api and global routing configuration

Usage examples

Scanned by Steampunk Spotter

     - name: add route vlan
       arubaoss_ip_route:
         ip_route_mode: IRM_VLAN
         ip_version: IAV_IP_V4
         destination: 1.1.1.0
         mask: 255.255.255.0
         destination_vlan: 20
         name: "test"

Scanned by Steampunk Spotter

     - name: add route vlan
       arubaoss_ip_route:
         ip_route_mode: IRM_VLAN
         ip_version: IAV_IP_V4
         destination: 1.1.1.0
         mask: 255.255.255.0
         destination_vlan: 20
         name: "test"

Scanned by Steampunk Spotter


     - name: add route blackhole
       arubaoss_ip_route:
         ip_route_mode: IRM_BLACK_HOLE
         ip_version: IAV_IP_V4
         destination: 2.2.2.0
         mask: 255.255.255.0

Scanned by Steampunk Spotter

     - name: delete route vlan
       arubaoss_ip_route:
         ip_route_mode: IRM_VLAN
         destination_vlan: 20
         destination: 1.1.1.0
         mask: 255.255.255.0
         state: delete

Scanned by Steampunk Spotter

     - name: delete route blackhole
       arubaoss_ip_route:
         ip_route_mode: IRM_BLACK_HOLE
         destination: 2.2.2.0
         mask: 255.255.255.0
         state: delete

Scanned by Steampunk Spotter

     - name: delete route blackhole
       arubaoss_ip_route:
         ip_route_mode: IRM_BLACK_HOLE
         destination: 2.2.2.0
         mask: 255.255.255.0
         state: delete

Inputs

tag:
description:
- Tag that can be used to filter redistribution of this route via route-maps
required: false

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

mask:
description:
- Subnet for the ip route.
required: false

name:
description:
- name for ip route being configured
required: false

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

'
type: int

metric:
default: 1
description:
- ip route metric
required: false

gateway:
description:
- IP address of the gateway to forward traffic when route mode is IRM_GATEWAY
required: false

logging:
description:
- if the packets received on the route need to be logged
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

distance:
default: 1
description:
- ip route distance
required: false

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

vlan_name:
description:
- vlan id/name to which route is being applied
required: false

ip_version:
default: IAV_IPV_V4
description:
- Ip address type to be configured
required: false

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

'
type: str

destination:
description:
- IP address for the ip routed
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

ip_route_mode:
choices:
- IRM_GATEWAY
- IRM_REJECT
- IRM_VLAN
- IRM_BLACK_HOLE
- IRM_TUNNEL_ARUBA_VPN
description:
- Mode for route type
required: true

bfd_ip_address:
description:
- Enable BFD for static routes. Only for Lava and Bolt platforms.
required: false

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

'
type: bool

destination_vlan:
description:
- vlan id for IRM_VLAN mode.
required: false