Skip to content

Latest commit

 

History

History
237 lines (150 loc) · 4.51 KB

API.md

File metadata and controls

237 lines (150 loc) · 4.51 KB

Table of Contents

ufiber_client3.olt

ONUProfile Objects

class ONUProfile()

set_configuration

def set_configuration()

Adds profile to OLT config. Can be used to set configuration for an existing profile

add

def add()

Adds profile to OLT config. Can be used to set configuration for an existing profile

save

def save()

Adds profile to OLT config. Can be used to set configuration for an existing profile.

delete

def delete()

Removes profile to OLT config

ONU Objects

class ONU()

ONU Defintion with configuration

set_configuration

def set_configuration()

Use OLT Client to set ONU configuration

add

def add()

Adds an onu. Can be used to set configuration for an existing ONU

save

def save()

Adds an onu. Can be used to set configuration for an existing ONU

delete

def delete()

Use OLT Client to delete ONU configuration

status

def status()

Use OLT Client to retrieve ONU status

OLTClient Objects

class OLTClient()

Client interface to Ubiquiti UFiber OLT. Host can be a hostname or a IP address

login

def login()

Login using credentials. Returns True/False

get_configuration

def get_configuration()

Returns OLT general configuration. GPON configuration != here.

set_configuration

def set_configuration(data)

Sets configuration using data dict

delete_configuration

def delete_configuration(data)

Deletes configuration using data dict

get_bulk_onu_status

def get_bulk_onu_status()

Returns list and status of provisioned ONUs

get_onu_status

def get_onu_status(serial_number)

Returns status of provisioned ONU

get_onu

def get_onu(serial_number)

Returns status of provisioned ONU

get_onu_profiles

def get_onu_profiles()

Quickly return onu profiles from configuration

get_onu_profile

def get_onu_profile(profile_id)

Get ONU profile by id