wlan-lanforge-scripts/py-json/create_sta.py

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# example of how to create a LANforge station                                       -
#                                                                                   -
# two examples, first using the URL-Encoded POST
# second using JSON POST data
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
import sys
if sys.version_info[0] != 3:
    print("This script requires Python 3")
    exit()

import json
import pprint
from LANforge import LFRequest
from random import seed
from random import randint
import time


def gen_mac(parent_mac, random_octet):
    print("************ random_octet: %s **************"%(random_octet))
    my_oct = random_octet
    if (len(random_octet) == 4):
        my_oct = random_octet[2:]
    octets = parent_mac.split(":")
    octets[4] = my_oct
    return ":".join(octets)

def main():
    base_url = "http://localhost:8080"
    shelf_id = 1        # typicaly assume Shelf 1
    resource_id = 1     # typically you're using resource 1 in stand alone realm
    radio = "wiphy0"
    start_id = 200
    end_id = 202
    padding_number = 10000 # the first digit of this will be deleted
    ssid = "jedway-wpa2-x2048-4-1"
    passphrase = "jedway-wpa2-x2048-4-1"
    j_printer = pprint.PrettyPrinter(indent=2)

    lf_r = LFRequest.LFRequest(base_url+"/port/1/1/wiphy0")
    wiphy0_json = lf_r.getAsJson()
    print("# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -")
    print("# radio wiphy0                                              -")
    print("# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -")
    j_printer.pprint(wiphy0_json['interface'])
    print("# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -")
    parent_radio_mac = wiphy0_json['interface']['mac']

    # generate a few random numbers and convert them into hex:
    random_hex = []
    seed( int(round(time.time() * 1000)))
    for rn in range(0, 254):
        random_dec = randint(0, 254)
        random_hex.append(hex(random_dec))

    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    # example 1                                                 -
    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    # uses URLs /cli-form/rm_vlan, /cli-form/add_sta
    # for each of the station names, delete them if they exist
    # NOTE: the ID field of the EID is ephemeral, so best stick to
    # requesting the station name. The station name can be formatted
    # with leading zeros, sta00001 is legal and != {sta0001, sta001, sta01, or sta1}

    for i in range((padding_number+start_id), (padding_number+end_id)):
        sta_name = "sta"+str(i)[1:]
        url = base_url+"/port/%s/%s/%s" % (shelf_id, resource_id, sta_name)
        print("checking for station : "+url)
        lf_r = LFRequest.LFRequest(url)
        json_response = lf_r.getAsJson()
        if (json_response != None):
            print("I would delete station %s now"%sta_name)
            lf_r = LFRequest.LFRequest(base_url+"/cli-form/rm_vlan")
            lf_r.addPostData( {
                "shelf":1,
                "resource": resource_id,
                "port": "sta%s"%i
            })
            json_response = lf_r.formPost()
            print(json_response)

        print("Next we create station %s"%sta_name)
        lf_r = LFRequest.LFRequest(base_url+"/cli-form/add_sta")
        # flags are a decimal equivalent of a hexadecimal bitfield
        # you can submit as either 0x(hex) or (dec)
        # a helper page is available at http://localhost:8080/help/add_sta
        #
        # You can watch console output of the LANforge GUI client when you
        # get errors to this command, and you can also watch the websocket
        # output for a response to this command at ws://localhost:8081
        # Use wsdump ws://localhost:8081/
        #
        # modes are listed at http://<YOUR_LANFORGE>/LANforgeDocs-5.4.1/lfcli_ug.html
        # or at https://www.candelatech.com/lfcli_ug.html
        #
        # mac address field is a pattern for creation: entirely random mac addresses
        # do not take advantage of address mask matchin in Ath10k hardware, so we developed
        # this pattern to randomize a section of octets. XX: keep parent, *: randomize, and
        # chars [0-9a-f]: use this digit
        lf_r.addPostData( {
            "shelf":1,
            "resource": resource_id,
            "radio": radio,
            "sta_name": "sta%s"%i,
            "flags":68727874560,
            "ssid": ssid,
            "key": passphrase,
            "mac": "NA", #gen_mac(parent_radio_mac, random_hex.pop(0)), #"xx:xx:xx:*:xx",
            "mode": 0,
            "rate": "DEFAULT"
        })
        json_response = lf_r.formPost()
        print(json_response)
    print("done")

    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    # example 2                                                 -
    # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    # uses URLs /cli-json/rm_vlan, /cli-json/add_sta
    # and those accept POST in json formatted text

    for i in range((padding_number+start_id), (padding_number+end_id)):
        sta_name = "sta"+str(i)[1:]
        url = base_url+"/port/%s/%s/%s" % (shelf_id, resource_id, sta_name)
        print("checking for station : "+url)
        lf_r = LFRequest.LFRequest(url)
        json_response = lf_r.getAsJson()
        if (json_response != None):
            print("I would delete station %s now"%sta_name)
            lf_r = LFRequest.LFRequest(base_url+"/cli-json/rm_vlan")
            lf_r.addPostData( {
                "shelf":1,
                "resource": resource_id,
                "port": "sta%s"%i
            })
            json_response = lf_r.jsonPost()
            print(json_response)

        print("Next we create station %s"%sta_name)
        lf_r = LFRequest.LFRequest(base_url+"/cli-form/add_sta")

        # see notes from example 1 on flags and mac address patterns
        octet = random_hex.pop(0)[2:]
        lf_r.addPostData( {
            "shelf":1,
            "resource": resource_id,
            "radio": radio,
            "sta_name": "sta%s"%i,
            "flags":68727874560,
            "ssid": ssid,
            "key": passphrase,
            "mac": gen_mac(parent_radio_mac, octet), #"xx:xx:xx:*:xx",
            "mode": 0,
            "rate": "DEFAULT"
        })
        json_response = lf_r.jsonPost()
        print(json_response)


    print("done")

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
if __name__ == "__main__":
   main()