Repository files navigation

This Ansible Network collection provides a set of platform dependent configurationmanagement modules specifically designed for the AOS-Switch Ansible Collectionnetwork device.

• Python 2.7 or 3.5+
• Ansible 2.9.0 or later
  • Ansible 2.10+ requiresansible.netcommon collection to be installed
• For AOS-Switch firmware version 16.08 and above is supported
• Enable REST on your AOS-Switch device with the following commands:

  switch(config)# web-management sslswitch(config)# rest-interface

• If you use RADIUS or TACACS for switch managment add also this command

  switch(config)# aaa authentication rest login radius localswitch(config)# aaa authentication rest enable radius local

• Install all Ansible requirements, with the following command:

  ansible-galaxy install -r requirements.yml

Through Galaxy:

ansible-galaxy collection install arubanetworks.aos_switch

The variables that should be defined in your inventory for your AOS-Switch host are:

• ansible_host: IP address of switch inA.B.C.D format. For IPv6 hosts use a string and enclose in square brackets E.G.'[2001::1]'
• ansible_user: Username for switch inplaintext format
• ansible_password: Password for switch inplaintext format
• ansible_connection: Set to local to use REST API modules, and to network_cli to use SSH/CLI modulesSee below for info on using both REST API modules and SSH/CLI modules on a host
• ansible_network_os: Must always be set toarubanetworks.aos_switch.arubaoss

all:hosts:aosswitch_1:ansible_host:10.0.0.1ansible_user:adminansible_password:passwordansible_connection:local# REST API connection methodansible_network_os:arubanetworks.aos_switch.arubaoss# Do not change

In order to use the AOS-Switch collection you need to modify your environment in order for Ansible to recognize the Network OS:

Example of setting environment variable in the command :$ ANSIBLE_NETWORK_GROUP_MODULES=arubaoss ansible-playbook sample_playbook.yml -i inventory.yml

You can also check which ansible.cfg is used by increasing the verbosity (add -v to command above) and accordingly set the value of NETWORK_GROUP_MODULES to "arubaoss" in the [defaults] section.

[defaults]NETWORK_GROUP_MODULES=arubaoss

If collection installed throughGalaxyaddarubanetworks.aos_switch to your list of collections:

---    -hosts:allcollections:         -arubanetworks.aos_switchtasks:         -name:Create VLAN 300arubaoss_vlan:vlan_id:300name:"vlan300"config:"create"command:config_vlan

• To use the SSH/CLI modulesarubaoss_config andarubaoss_command, SSH access mustbe enabled on your AOS-Switch device. It is enabled by default.
  • If necessary, re-enable SSH access on the device with the following command:

  switch(config)# ip ssh

• The control machine'sknown_hosts file must contain the target device's public key.
  • Alternatively, host key checking by the control machine may be disabled, although this is not recommended.
  • To disable host key checking modify the ansible.cfg file (default /etc/ansible/ansible.cfg) to include:host_key_checking = false

To use both REST API and SSH/CLI modules on the same host,you must create separate plays suchthat each play uses either only REST API modules or only SSH/CLI modules.A play cannot mix and match REST API and SSH/CLI module calls.In each play,ansible_connection must possess the appropriate valueaccording to the modules used.If the play uses REST API modules, the value should belocal.If the play uses SSH/CLI modules, the value should benetwork_cli.

A recommended approach to successfully using both types of modules for a hostis as follows:

1. Set the host variables such that Ansible will connect to the host using REST API.
2. In the playbook, in each play wherein the SSH/CLImodules are used, set theansible_connection tonetwork_cli.

The inventory should look something like this:

all:hosts:switch1:ansible_host:10.0.0.1ansible_user:adminansible_password:passwordansible_connection:local# REST API connection methodansible_network_os:arubanetworks.aos_switch.arubaoss# Do not change

and the playbook like this (note how the second play, which uses the SSH/CLI modulearubaoss_command,sets theansible_connection value accordingly):

-hosts:allcollections:    -arubanetworks.aos_switchtasks:    -name:Create VLAN 300arubaoss_vlan:vlan_id:300name:"vlan300"config:"create"command:config_vlan-hosts:allcollections:    -arubanetworks.aos_switchvars:ansible_connection:network_clitasks:    -name:Execute show run on the switcharubaoss_command:commands:['show run']

At Aruba Networks we're dedicated to ensuring the quality of our products, if you find anyissues at all please open an issue on ourGithub and we'll be sure to respond promptly!

For more contribution opportunities follow our guidelines outlined in ourCONTRIBUTING.md

Apache-2.0

• Tiffany Chiapuzio-Wong (@tchiapuziowong)
• Sunil Veeramachaneni (@sunil.veeramachaneni)
• Castro, Jorge Arturo (@jorge.castro93)