Getting started with ArubaOS-Switch RESTful API¶

Using cURL¶

Login¶

We are using Ubuntu system with cURL installed. First we need to log into switch to get token (cookie):

$ curl --insecure -X POST https://16.21.188.197/rest/v1/login-sessions -H "Content-Type: application/json" -H "Accept: application/json" -d '{"userName":"manager", "password":"hpe"}'
{"uri":"/rest/v1/login-sessions","cookie":"sessionId=kC9GF2IkJjez9WixspEcPyoucwQDamodCI4TkVkAOPzkcmUeXEECQCO0dQaTUcH"}

As you can see JSON output is not formmated so it is hard to read. Let’s install tool to make this prettier:

$ sudo apt-get install yajl-tools

Add silent mode switch to cURL and use parser for pretty output:

$ curl -s --insecure -X POST https://16.21.188.197/rest/v1/login-sessions -H "Content-Type: application/json" -H "Accept: application/json" -d '{"userName":"manager", "password":"hpe"}' | json_reformat
{
    "uri": "/rest/v1/login-sessions",
    "cookie": "sessionId=WSWAiijQtlbXBBAakCSBAiBZR4v9rFkb2pqEr2PI9SiiUakVNAT7aLpSg1jP7y8"
}

Store cookie in variable:

$ export cookie=sessionId=WSWAiijQtlbXBBAakCSBAiBZR4v9rFkb2pqEr2PI9SiiUakVNAT7aLpSg1jP7y8

Get system information:

$ curl -s --insecure --cookie $cookie -X GET https://16.21.188.197/rest/v1/system | json_reformat
{
    "uri": "/system",
    "name": "HP-2920-24G-PoEP",
    "location": "",
    "contact": ""
}

Use¶

Get VLAN information:

$ curl -s --insecure --cookie $cookie -X GET https://16.21.188.197/rest/v1/vlans | json_reformat
{
    "collection_result": {
        "total_elements_count": 1,
        "filtered_elements_count": 1
    },
    "vlan_element": [
        {
            "uri": "/rest/v1/vlans/1",
            "vlan_id": 1,
            "name": "DEFAULT_VLAN",
            "status": "VS_PORT_BASED",
            "type": "VT_STATIC",
            "is_voice_enabled": false,
            "is_jumbo_enabled": false,
            "is_dsnoop_enabled": false
        }
    ]
}

Get interfaces information:

$ curl -s --insecure --cookie $cookie -X GET https://16.21.188.197/rest/v1/ports | json_reformat
{
    "collection_result": {
        "total_elements_count": 24,
        "filtered_elements_count": 24
    },
    "port_element": [
        {
            "uri": "/rest/v1/ports/1",
            "id": "1",
            "name": "",
            "is_port_enabled": true,
            "config_mode": "PCM_AUTO",
            "trunk_mode": "PTT_NONE",
            "lacp_status": "LAS_DISABLED",
            "trunk_group": "",
            "is_flow_control_enabled": false,
            "is_dsnoop_port_trusted": false,
            "internal_mode": null
        },
        {
            "uri": "/rest/v1/ports/2",
            "id": "2",
            "name": "",
            "is_port_enabled": true,
            "config_mode": "PCM_AUTO",
            "trunk_mode": "PTT_NONE",
            "lacp_status": "LAS_DISABLED",
            "trunk_group": "",
            "is_flow_control_enabled": false,
            "is_dsnoop_port_trusted": false,
            "internal_mode": null
        },
        ...
        {
            "uri": "/rest/v1/ports/23",
            "id": "23",
            "name": "",
            "is_port_enabled": true,
            "config_mode": "PCM_AUTO",
            "trunk_mode": "PTT_NONE",
            "lacp_status": "LAS_DISABLED",
            "trunk_group": "",
            "is_flow_control_enabled": false,
            "is_dsnoop_port_trusted": false,
            "internal_mode": null
        },
        {
            "uri": "/rest/v1/ports/24",
            "id": "24",
            "name": "",
            "is_port_enabled": true,
            "config_mode": "PCM_AUTO",
            "trunk_mode": "PTT_NONE",
            "lacp_status": "LAS_DISABLED",
            "trunk_group": "",
            "is_flow_control_enabled": false,
            "is_dsnoop_port_trusted": false,
            "internal_mode": null
        }
    ]
}

Get one port only:

$ curl -s --insecure --cookie $cookie -X GET https://16.21.188.197/rest/v1/ports/1 | json_reformat
{
    "uri": "/rest/v1/ports/1",
    "id": "1",
    "name": "",
    "is_port_enabled": true,
    "config_mode": "PCM_AUTO",
    "trunk_mode": "PTT_NONE",
    "lacp_status": "LAS_DISABLED",
    "trunk_group": "",
    "is_flow_control_enabled": false,
    "internal_mode": null,
    "is_dsnoop_port_trusted": false
}

Change port name:

$ curl -s --insecure --cookie $cookie -X PUT https://16.21.188.197/rest/v1/ports/1 -d '{"name":"myTest"}' | json_reformat
{
    "uri": "/rest/v1/ports/1",
    "id": "1",
    "name": "myTest",
    "is_port_enabled": true,
    "config_mode": "PCM_AUTO",
    "trunk_mode": "PTT_NONE",
    "lacp_status": "LAS_DISABLED",
    "trunk_group": "",
    "is_flow_control_enabled": false,
    "internal_mode": null,
    "is_dsnoop_port_trusted": false
}

You can check results in CLI:

HP-2920-24G-PoEP# show interfaces 1

 Status and Counters - Port Counters for port 1

  Name  : myTest
  MAC Address      : 308d99-a23e3f
  Link Status      : Down
  Totals (Since boot or last clear) :

Python¶

Login script and getting ready¶

Asuming Python is by default installed in you Ubuntu 14.04 let’s install pip and some dependencies we will need:

sudo apt-get install python-pip
sudo pip install argparse
sudo pip install requests
sudo pip install simplejson

As we know already we need to authenticate against ArubaOS-Switch to get cookie. We will create Python script to do so and store information in file on disk.

This is login.py:

import argparse
import requests
import json

# Parse inputs
parser = argparse.ArgumentParser()
parser.add_argument('--ip', type=str, help="Controller IP address")
parser.add_argument('--user', type=str, help="Username")
parser.add_argument('--password', type=str, help="Password")
args = parser.parse_args()

# Use authentication call and pass credentials
url="https://" + args.ip + "/rest/v1/login-sessions"

data = {
 "userName":args.user,
 "password":args.password
}

r = requests.post(url, data=json.dumps(data), verify=False)

# Parse token
cookie = r.json()["cookie"].split("=")[1]
print("Cookie: " + cookie)

# Prepare JSON structure with ip address and token
login = {"ip":args.ip,"cookie":cookie}

# Write JSON to file to be read by other scripts
f = open('mylogin.txt', 'w')
f.write(json.dumps(login))
f.close

Use it to get cookie and provide IP address and your credentials:

$ python login.py --ip 16.21.188.197 --user manager --password hpe
Cookie: 5qiBb0lphJynk7vfCS2Ayo6MZ0jmNaP9OzucX3m0jNRoupnR7FMsAj7YaKqQvbd

You can check that information has been stored in mylogin.txt file:

$ cat mylogin.txt
{"ip": "16.21.188.197", "cookie": "5qiBb0lphJynk7vfCS2Ayo6MZ0jmNaP9OzucX3m0jNRoupnR7FMsAj7YaKqQvbd"}

Give your interfaces nice random names¶

Have you heard about pets vs. cattle discussion? We will go against trend and give our port pets nice random names.

We will use public random word service so make sure your station has Internet access.

This is niceport.py:

import argparse
import requests
import json

# Read login information from file
f = open('mylogin.txt', 'r')
login = json.loads(f.readlines()[0])
f.close

# Get all ports
url="https://" + login["ip"]  + "/rest/v1/ports"

r = requests.get(url, verify=False, cookies=dict(sessionId=login["cookie"]))

randomword_url="http://randomword.setgetgo.com/get.php?len=8"

# Repeat for all ports in switch
for port in r.json()["port_element"]:
    # Get random word
    rword = requests.get(randomword_url)
    name = rword.text

    # Prepare port URL and JSON with new name
    porturi="https://" + login["ip"] + port["uri"]
    portdata={
        "name":name
    }

    # Change port name and print
    rport = requests.put(porturi, verify=False, cookies=dict(sessionId=login["cookie"]), data=json.dumps(portdata))
    print port["id"] + " is now " + rport.json()["name"]

Here is output of this app:

$ python niceports.py
is now alterate
is now ptilinal
is now palmated
is now spicknel
is now mangling
is now subframe
is now Sinaitic
is now uncandor
is now wreckful
is now provoker
is now ironical
is now ateuchus
is now subspace
is now launcher
is now digitize
is now screwman
is now pycnotic
is now rearrive
is now Fossoria
is now encanker
is now purparty
is now masonite
is now maphrian
is now griseous

You can check this now in CLI:

HP-2920-24G-PoEP# show interfaces custom all port name

 Status and Counters - Custom Port Status


  Port   Name
  ------ ----------
    alterate
    ptilinal
    palmated
    spicknel
    mangling
    subframe
    Sinaitic
    uncandor
    wreckful
   provoker
   ironical
   ateuchus
   subspace
   launcher
   digitize
   screwman
   pycnotic
   rearrive
   Fossoria
   encanker
   purparty
   masonite
   maphrian
   griseous