Introduction

This Guide documents the REST API (REpresentational State Transfer API) that exists on the Panorama Server. This interface provides a means of programmatic network discovery, configuration and status retrieval for the Tellabs Optical LAN. Data is exchanged in JSON (JavaScript Object Notation). Requests are processed by the Panorama server and sent to the OLT using the standard Panorama to OLT interface.

General Structure

The Panorama REST interface provides a means to manage the Tellabs OLAN using HTTP methods. The client sends messages to the server in requests, while the server replies with information in responses.

The REST Request

The request is composed of four items; the endpoint, method, headers, and data (or body).

The Endpoint

The endpoint (or route) is the URL requests are sent to. The path of the URL determines the resource used to handle the request. The single resource in the Panorama REST interface has the format:

https://<_SERVER_>:8081/oam/oam-bin

where <_SERVER_> is the IP Address or domain name of the Panorama server host machine.

The Method

The method is the type of HTTP request to be sent to the server. All requests implemented by the Panorama REST interface are POST messages.

The Headers

Headers are used to provide information to both the client and server. They can be used for many purposes, such as authentication and providing information about the body content. HTTP Headers are property-value pairs that are separated by a colon.

The Data

The data (sometimes called "body" or "message") contains the information to be sent to the server. The data used in the body of a Panorama REST API request is a JSON object composed of the following parameters:

Putting it Together

The code samples below illustrate a request in the Panorama REST API.

Format

Example: JSON Object Data

Example: JSON Object Data(Windows)

Example: JSON File Data

Rest Interfaces

• OLT Related REST
• PON Related REST
• ONT Related REST
• UNI Related REST
• Voice Line Related REST
• VLAN Related REST

Attribute Dictionary

This section will define all the possible attributes that can be used in requests and their values.

acFailWaitTime

Name	acFailWaitTime (Video)
Description	Defines the number of seconds to wait before interrupting RF video services when the AC power fails. For ONTs with battery backup, this helps preserve battery life and lifeline POTs service as long as possible.
Allowed Values	0 to 1800 in 30 second increments default: 30 Note: Setting this attribute to zero will disable this feature and Video will never shut off.
Access	read/write

acRestoreWaitTime

Name	acRestoreWaitTime (Video)
Description	Defines the number of seconds to wait before re-enabling RF video service after AC power is restored. This helps provide hysteresis in the event that AC power is going up and down.
Allowed Values	0 to 1800 in 30 second increments default: 30 Note: Setting this attribute to zero will disable this feature and Video will never shut off.
Access	read/write

adminState

Name	adminState
Description	The adminState or administrative state defines the desired state of an object. It can be enabled (allowed to render service) or disabled (not allowed to render service). Most objects within the system have an administrative state.
Allowed Values	enabled: 1 disabled: 2
Access	read/write

agcSetting

Name	agcSetting
Description	The agcSetting defines the measurement offset that the ONT should use when using the broadband RF signal level or total optical power level as a basis for automatic gain control (AGC). Enter in increments of 1 dB.
Allowed Values	-12 dB to +12 dB default:-4 dB
Access	read/write

alarmState

Name	alarmState
Description	Defines the current alarm status of a device, card or ONT.
Allowed Values	0 eCLEARED Currently is not in alarm 1 eACTIVEREPORTABLEINDETERMINATE Could not communicate to obtain alarm state 2 eACTIVEREPORTABLEWARNING Alarm is warning level, no service affected. 3 eACTIVEREPORTABLEMINOR Alarm is minor level, some service may be affected. 4 eACTIVEREPORTABLEMAJOR Alarm is major level, one or more services affected 5 eACTIVEREPORTABLECRITICAL Alarm is critical level, all or most services affected 6 eACTIVEPENDING In the process of changing states.
Access	readonly

alignmentErrors

Name	alignmentErrors
Description	Alignment errors are the count of the number of frames received that do not end with an even number of octets and have a bad Cyclic Redundancy Check (CRC). This could indicate a cable problem or a faulty transmitter on the network equipment connected at the other end.
Allowed Values	64 bit counter
Access	readonly

arcMode

Name	arcMode
Description	The arcMode or Alarm Report Control defines whether or not to report alarms for this ONT. This attribute is deprecated and should be left at it's default setting of false.
Allowed Values	true  - Suppress Alarm Reports false - Send alarm reports. This is the default and should not be changed from the default value.
Access	read/write

availState

Name	availState
Description	The availState or availability state will be empty whenever the object is in a normal state with no issues. If failed or up but in some way impaired the availState will give a list of reasons for the off normal state.
Allowed Values	0 eNOTSUPPORTED This object is not supported or has been asked to perform an unsupported function. 1 eINTEST A test is in progress and service may be affected. 2 eFAILED This object is failed due to a hardware or software fault. 3 ePOWEROFF AC power is off, if still in service, then on battery backup. 4 eOFFLINE If the AdminState is disabled the availState will be eOFFLINE. 5 eOFFDUTY Offduty is not used currently. Indicated scheduled to be offline. 6 eDEPENDENCY Out of service due to failure of an object that this object depends on. 7 eDEGRADED The object is still rendering service but is degraded due to errors or low power levels. 8 eNOTINSTALLED The object is offline due to hardware to support it not being installed. 9 eLOGFULL The object is impaired due to logs being full. Not used as all logs are rotated. 10 eUNAUTHACCESS Not used, indicates a failure in authorization. Auth failures are simply logged.
Access	readonly

bridgeProfileName

Name	bridgeProfileName
Description	This structure has been deprecated and should always be set to its default value of blank.
Allowed Values	""
Access	readonly

buildDate

Name	buildDate
Description	Defines the date on which the software was built.
Allowed Values	date: of the form YYMMDD example: 180228 Feb 28th 2018
Access	readonly

buildId

Name	buildId
Description	Defines the exact build ID and is unique for every build of the system.
Allowed Values	buildid: XXXXXX example: 180104
Access	readonly

carrierSenseErrors

Name	carrierSenseErrors
Description	The count of packets where the packet was attempted to be received but no carrier signal was detected on the port.
Allowed Values	64 bit counter
Access	readonly

cfi

Name	cfi (voice)
Description	Defines the value of the canonical format indicator in the VLAN ID.
Allowed Values	Do not change from its default value of 1.
Access	read/write

cleiCode

Name	cleiCode
Description	CLEI codes or Common Language Equipment Identifiers are used in Telecom service provider systems to uniquely identify a board type and specific revision of that board to Telco management systems. It is not used in Enterprise and will not be populated unless in a Telco environment/software release.
Allowed Values	cleiCode: <string expressing clei code>
Access	readonly

cpeThreshold

Name	cpeThreshold
Description	The cpeThreshold defines the number of consecutive drift corrections of an ONT can occur before raising an alarm. The cpeThreshold should not be modified from it's default value of 3.
Allowed Values	default: 3
Access	read/write(not recommended)

cpState

Name	cpState
Description	The cpState variable defines status of a circuit pack.
Allowed Values	0 Unknown Card state is unknown due to communications failure. 1 Slave Card is in inactive standby mode and being controlled by the active card. 2 Master Card is active and is controlling the standby card. 3 Not Ready Card is initializing and cannot render service currently. 4 Normal Card is not redundant and is in the normal state.
Access	read/write(not recommended)

configLock

Name	configLock
Description	When an ONT is configured, it state is configLock set to false. Whenever the ONT is successfully ranged the ONT will be "locked" to that ONT ID and will be bound there until deleted. Any ONT that is in the configuration lock set to true has been communicated with successfully at least once in the past.
Allowed Values	true : The ONT has been communicated to and the ONT id assigned and is locked to this id. false: The ONT has not been communicated with and has not yet been ranged. This is the default on creation.
Access	read/write

currentIPAddr

Name	currentIPAddr
Description	Defines the current IP address of an ONT that is equipped for voice services. This IP is used for SIP and RTP voice transport. ONTs that do not support voice have no IP address.
Allowed Values	currentIPAddr: xx.xx.xx.xx example: 10.20.70.129
Access	readonly

currentdnsprimary

Name	currentdnsprimary
Description	Defines the current dns primary server's IP address of an ONT that is equipped for voice services. This IP is used for name resolution in SIP and RTP voice transport. ONTs that do not support voice have no primary dns IP address.
Allowed Values	currentIPAddr: xx.xx.xx.xx example: 10.20.70.129
Access	readonly

currentdnssecondary

Name	currentdnssecondary
Description	Defines the current secondary dns server's IP address of an ONT that is equipped for voice services. This IP is used for name resolution in SIP and RTP voice transport when the primary is not available. ONTs that do not support voice have no primary dns IP address.
Allowed Values	currentIPAddr: xx.xx.xx.xx example: 10.20.70.129
Access	readonly

currentmask

Name	currentmask
Description	Defines the current IP mask of an ONT that is equipped for voice services. This IP is used for SIP and RTP voice transport. ONTs that do not support voice have no IP mask.
Allowed Values	currentmask: xxx.xxx.xxx.xxx example: 255.255.255.0
Access	readonly

currentgateway

Name	currentgateway
Description	Defines the current gateway IP address of an ONT that is equipped for voice services. This IP is used for SIP and RTP voice transport. ONTs that do not support voice have no IP gateway address.
Allowed Values	currentIPAddr: xx.xx.xx.xx example: 10.20.70.1
Access	readonly

dataSheddingInterval

Name	dataSheddingInterval
Description	The dataSheddingInterval defines how long after an ONT transitions to battery power that it should start shedding data services such as ethernet and PoE ports.
Allowed Values	900 This attribute is not fully supported and should not be modified from its default value of 900 seconds or 15 minutes.
Access	read/write

deferredTransmission

Name	deferredTransmission
Description	The count of times that a transmission was deferred due to a transmission being detected. This is an legacy counter used when collision detect is present. Full duplex point to point ethernet links should never encounter this.
Allowed Values	64 bit counter
Access	read/write

degradedThreshold

Name	degradedThreshold (Video)
Description	Provides the lower threshold to determine when the degraded Signal (RF Video Signal Degraded) alarm should be generated for an ONT. This threshold is set at the OLT level and applies to all ONTs for that OLT.
Allowed Values	Range is -5 through -12 (default is -9.5). Enter in increments of 0.5 dBm.
Access	read/write

deviceID

Name	deviceID
Description	Defines the device ID which is also used as the hostname for the ONT. Defines the unique name for the Tellabs Configuration ID or hostname associated with the ONT. This identifies the ONT when communicating with the Tellabs Configuration Server.
Allowed Values	Any valid printable text string, up to 24 ASCII characters.
Access	read/write

dnsprimary

Name	dnsprimary (voice)
Description	Defines the primary dns IP address to be used for voice services.
Allowed Values	Standard IP Nomenclature: 0.0.0.0
Access	read/write

dnssecondary

Name	dnssecondary (voice)
Description	Defines the secondary dns IP address to be used for voice services.
Allowed Values	Standard IP Nomenclature: 0.0.0.0
Access	read/write

domainName

Name	domainName(voice)
Description	Defines the domain name that was received back from DHCP when the IP address was assigned.
Allowed Values	Standard domain name Nomenclature example: tellabs.com
Access	read/write

dot1PortNumber

Name	dot1PortNumber
Description	The ifindex assigned to the port
Allowed Values	example: 395
Access	readonly

driftWindowThreshold

Name	driftWindowThreshold
Description	The driftWindowThreshold will define the the amount of drift allowed in bursts sent from the ONTs versus their assigned transmission window.
Allowed Values	It should not be modified from the default value of 3. default: 3
Access	read/write(not recommended)

fcsErrors

Name	fcsErrors
Description	The count of Ethernet frames which included a frame check sum error which indicates an error in the transmitted packet.
Allowed Values	64 bit counter
Access	readonly

enableFEC

Name	enableFEC
Description	The enableFEC attribute controls whether or not FEC or Forward Error Correction is enabled on the port. FEC will correct single-bit and some multi-bit errors in the data passing through the port. FEC is often useful for clearing up marginal optics and will add an equivalent of 3dB of margin to the signal. Enabling FEC will result in a reduction of bandwidth to approximately 8GB on 10GB links.
Allowed Values	true: FEC is enabled on the link false: FEC is disabled on the link
Access	read/write

externalPowerAvailable

Name	externalPowerAvailable
Description	The externalPowerAvailable attribute defines the power available in the attached power supply for this ONT. It will normally default to the power value of the most commonly used power supply. If remote DC power is utilized, it should be set to 100W as this is the max remote power available. The ONT usage will be subtracted from this number to give the max PoE power available to the ONT which can be found in the nominal PoE power attribute.
Allowed Values	0 to 65535 Units are Watts defaults vary by the AC power supply normally supplied with the ONT.
Access	read/write

expTypeId

Name	expTypeId
Description	The expTypeID is an enumerated type that gives the expected card type ID that should be installed in this slot or ONT id.
Allowed Values	TypeId TypeName Description 1 BLANKSLOT No provisioning 2 4xONU 4xONU, includes QOIU512, QOIU513 10 TDU TDU 11 ESU ESU 30 ONT ONT circuit pack, SFU702 53 NOT_PROV NOT PROVISIONED 54 ESU30 ESU30 55 ESU2 ESU2 59 ONT_2V1E1C onts with 2 voice, 1 ethernet, 1 coax 60 ONT_NONE ONT_NONE 65 ONT_2V4E_ETSI ETSI ONT with 2 voice,1 Eth and RF overlay includes ONT705 66 OFA 1134 optical fan assembly 67 PWR A or B power input 71 ONT_4E ONT709 with 4 GbE ports 72 ONT_24V24E ONT729 with 24 GbE ports and 24 Voice 74 ONT_24E ONT728 with 24 Data 75 ONT_24V24EGP ONT729GP with 24 Data, 24 Voice 78 ONT120 ONT120 Base 78 ONT140 ONT140 Base 80 SFUBASIC ONT140 Base 81 SFP_ONT ONT070 1x ESL 82 ESU32 ESU 1131/1134 83 ONT142R ONT142R 84 ONT742G ONT742G 85 ONT742GR ONT742GR 86 8xPON OIU8, QOIU8 87 ONT180 ONT180 8x ESL 88 ONT205 ONT205 5x XGSPON ESL 89 ONT131 ONT131 3x ESL 1x POTS 90 ONT121WX ONT121WX 2x ESL 1x POTS 91 ONT248 ONT248 48x ESL 92 ONT140CL ONT140CL 4x ESL 93 ONT202 ONT202 2x Multi-gig ESL
Access	read/write

forcedStopMode

Name	forcedStopMode
Description	This attribute allows the ONT to be eSTOP'ed or command it to be silent on the PON until re-enabled. This can happen when the system detects the ONT either drifting, or transmitting outside it's window, or departing and arriving too many times in close succession. If this occurs, the OLT will put the ONT in eSTOP mode. A user can also force this behavior by disabling the ONT which will set the eSTOP mode to on. Changing the AdminState to enabled will turn it back on.
Allowed Values	true The ONT is configured to be in the eSTOP mode. false The ONT is configured for normal operation.
Access	read/write

gatewayIPAddress

Name	gatewayIPAddress
Description	Defines the gateway IP address when in voice gateway mode.
Allowed Values	Standard IP Nomenclature: 0.0.0.0
Access	read/write

hostName

Name	hostName(voice)
Description	Defines the host name that was assigned the ONT during configuration for those ONTs that support hostnames. The host name is configured via the Device ID field in the TConfig section. This is only relevant on certain voice ONTs. Data only ONTs have no hostname.
Allowed Values	Standard host name Nomenclature example: room112-ont729
Access	readonly

inPauseFrames

Name	inPauseFrames
Description	Count of the number of pause frames received from the peer on the other side of the ethernet link.
Allowed Values	64 bit counter
Access	readonly

installedType

Name	installedType
Description	Defines the actual card type of the device that is installed in a slot or ONT type of an ONT at a given ONT ID.
Allowed Values	The installed type is an enum with the following defintion. example: room112-ont729
Access	readonly

ipAddress

Name	ipAddress (voice gateway)
Description	This attribute allows assignment of a static IP address to the ONT when in voice gateway mode. DHCP is ALWAYs used for softswitch mode.
Allowed Values	Standard IP address nomenclature applies: 0.0.0.0
Access	read/write

ipAssignmentMode

Name	ipAssignmentMode
Description	Defines whether the IP should be assigned via DHCP or static IP
Allowed Values	0 DHCPv4 1 Static IP 2 DHCPv6 3 Dual Stack
Access	read/write

ledHoldTime

Name	ledHoldTime
Description	The ledHoldTime defines the time that an ONT should keep the leds on the ONT faceplate lit after a change in state on the ONT. For hospitality and offices, it is often desirable to have the LEDS of an ONT turn off after some time to keep from disturbing workers or guests near the ONT. (Having something blinking on the wall of a hotel room can make it hard to sleep). After the timer times out, the ONT will turn off all LEDs except for power. They will come back on if there is a change in port state or alarm state and begin the timer again.
Allowed Values	0 to 65535 seconds 0 will set the ONT to always keep the alarm indicators lit.
Access	read/write

lldpProfileName

Name	lldpProfileName
Description	The name of the LLDP profile to be assigned to the port. The LLDP profile must have been defined prior to use.
Allowed Values	"lldpProfileName":"LLDP-Inventory"
Access	read/write

locationName

Name	locationName
Description	The userlabel field on an ONT is known as locationName within the model.
Allowed Values	string: Any valid printable string.
Access	read/write

maxUpstreamBandwidth

Name	maxUpstreamBandwidth
Description	The peak bandwidth that will be given to that class of service(CoS) TCONT.
Allowed Values	0 to the upStreamLineRate
Access	ACCESS HERE

manufactureDate

Name	manufactureDate
Description	The date that the card, ONT or assembly was built.
Allowed Values	MM/YYYY example: 12/2012
Access	readonly

minUpstreamBandwidth

Name	minUpstreamBandwidth
Description	The minimum guaranteed bandwidth that will be given to that class of service(CoS) TCONT.
Allowed Values	0 to the upstreamLineRate
Access	readonly

mtuSize

Name	mtuSize
Description	The maximum transmission unit or maximum size in bytes of the payload portion of an ethernet frame going over the port.
Allowed Values	0 to 9000 bytes
Access	readonly

nacProfileName

Name	nacProfileName
Description	The name of a nac or Network Access Control profile to be applied to the port. The profile must have been created prior to assignment.
Allowed Values	"nacProfileName":"VLAN2995-UT"
Access	read/write

opState

Name	opState
Description	The operational state of the object or entity. The operational state can be up or down.
Allowed Values	up      0 down 1
Access	readonly

opLineSpeed

Name	opLineSpeed
Description	The Ethernet port speed that resulted from negotiation.
Allowed Values	10 (10BT) 100 (100BT) 1000 (1GBT) 2500 (2.5GBT) 5000 (5GBT) 1000 (10GBT)
Access	readonly

outPauseFrames

Name	outPauseFrames
Description	Count of the number of pause frames transmitted of the ethernet link.
Allowed Values	64 bit counter
Access	readonly

overloadThreshold

Name	overloadThreshold (Video)
Description	Provides the upper threshold to determine when the overloadSignal (RF Video Overload) alarm should be generated for an ONT. This threshold is set at the OLT level and applies to all ONTs for that OLT.
Allowed Values	Range is 0 through 5 (default is 2.5). Enter in increments of 0.5 dBm.
Access	read/write

paeProfileName

Name	paeProfileName
Description	The name of a pae or Port Authentication Entity profile to be applied to the port. This profile is used for configuring 802.1x or MAB on the port. The profile must have been created prior to assignment.
Allowed Values	"paeProfileName":<profile name> example: "paeProfileName":"radius-auth-profile"
Access	read/write

passwordAutoLearn

Name	passwordAutoLearn
Description	The passwordAutoLearn attribute controls define whether or not the ONT password is the serial number of that ONT. The OLT uses the ONT serial number as the password by default. Should not be changed from the default value.
Allowed Values	true(default): ONT serial number is learned from the PON and used as password. false: Registration ID is used as the PON Password. This is not currently supported.
Access	read/write

phyHoldTime

Name	phyHoldTime
Description	The phyHoldTime defines the time that a port should keep the Ethernet PHY active after the PON uplink has been lost. In many installations, after the PON link goes down, it is desirable to shut off the port to prevent any security violations from occurring while out of contact with the OLT. In some installations like APs and other devices, it may be desirable to keep the port up at all times. Also, bringing the port down during a PON outage forces re-authentication once the PON comes back up.
Allowed Values	0 to 65535 seconds 0 will set the port to never expire and port will stay up during PON outages.
Access	read/write

physAddress

Name	physAddress
Description	The physical location of the port in the system. It is almost identical to the AID of the port.
Allowed Values	1-<slot>-<pon>-<ont id>-<port id> 0 will set the port to never expire and port will stay up during PON outages.
Access	readonly

pkts64Octets

Name	pkts64Octets
Description	The count of packets that are 64 bytes or less. Per the ethernet standard, all packets less than 64 Octets are padded out to 64 octets.
Allowed Values	64 bit counter
Access	readonly

pkts65to127Octets

Name	pkts65to127Octets
Description	The count of packets that are between 65 and 127 Octets.
Allowed Values	64 bit counter
Access	readonly

pkts128to255Octets

Name	pkts128to255Octets
Description	The count of packets that are between 128 and 255 Octets.
Allowed Values	64 bit counter
Access	readonly

pkts256to511Octets

Name	pkts256to511Octets
Description	The count of packets that are between 256 and 511 Octets.
Allowed Values	64 bit counter
Access	readonly

pkts512to1023Octets

Name	pkts512to1023Octets
Description	The count of packets that are between 512 and 1023 Octets.
Allowed Values	64 bit counter
Access	readonly

pkts1024to1518Octets

Name	pkts1024to1518Octets
Description	The count of packets that are between 1024 and 1518 Octets.
Allowed Values	64 bit counter
Access	readonly

pkts1519to1920Octets

Name	pkts1519to1920Octets
Description	The count of packets that are between 1519 and 1920 Octets.
Allowed Values	64 bit counter
Access	readonly

poeAllocatedPower

Name	poeAllocatedPower
Description	The poeAllocatedPower defines the total amount of power for the whole ONT that has been reserved by PoE handshakes with attached devices. This is initially determined by hardware handshake and may optionally be updated by LLDP exchanges.
Allowed Values	0 to 65535 Watts
Access	readonly

poeConsumedPower

Name	poeConsumedPower
Description	The poeConsumedPower defines the total amount of power for the whole ONT that is currently being drawn by attached devices.
Allowed Values	0 to 65535 Watts
Access	readonly

poeInputCurrent

Name	poeInputCurrent
Description	The poeInputCurrent defines the total amount current that is being drawn on the input side of the ONT and being delivered to the device.
Allowed Values	0 to 65535 mA
Access	readonly

poeInputVoltage

Name	poeInputVoltage
Description	The poeInputVoltaget defines the voltage measured at the input of the ONT and being used for Power Over Ethernet Services.
Allowed Values	0 to xx Volts in .1 Volt increments
Access	readonly

poeHoldTime

Name	poeHoldTime
Description	The poeHoldTime defines the time that a port should keep the poe power on an Ethernet PHY active after the PON uplink has been lost. Often, for APs and other devices, it is desirable to keep them powered up even if the PON link goes down to speed recovery time and possibly keep Wifi running locally.
Allowed Values	0 to 65535 seconds 0 will set the port to never expire and port will stay powered up during PON outages.
Access	read/write

poePortDetectionStatus

Name	poePortDetectionStatus
Description	The poePortDetectionStatus defines whether or not the port has detected...
Allowed Values	ALLOWED VALUES HERE
Access	readonly

poePortMPSAbsentCounter

Name	poePortMPSAbsentCounter
Description	The poePortMPSAbsentCounter counts the number of times that power was being provided to the PD and then was no longer detected. It usually reflects the number of times the port has been disconnected. Most reboots don't increment this counter although a small number of devices have a hardware reset that does actually remove the termination briefly and causes this counter to increment.
Allowed Values	64 bit counter
Access	readonly

poeProfileName

Name	poeProfileName
Description	The name of a poe or Power over Ethernet profile to be applied to the port. This profile is used for configuring PoE power settings on the port. The profile must have been created prior to assignment.
Allowed Values	"poeProfileName":<profile name> example: "poeProfileName":"poe-enabled"
Access	read/write

poeUsageThreshold

Name	poeUsageThreshold
Description	The poeUsageThreshold defines the percentage of the PoE nominal power (the total PoE power available) the user wants the system to alarm. This alarm indicates that the power usage is nearing the maximum allowed by the ONT.
Allowed Values	0 to 100 - Zero to 100% is allowed.
Access	read/write

ponReach

Name	ponReach
Description	The ponReach attribute defines the distance that the furthest ONT is allowed to be on the PON. The OLT supports 20km and 30km reaches currently. For 30km, 0 to 30km reach is supported.
Allowed Values	1: 20km reach. 2: 30km reach.
Access	read/write

ponProfileName

Name	ponProfileName
Description	The ponProfileName attribute defines the name of the PON profile currently assigned to the port.
Allowed Values	String containing the PON Profile Name.
Access	read/write

profileName

Name	profileName
Description	The profileName attribute defines the port profile to be applied to an ONT UNI port.
Allowed Values	String containing the UNI Port Profile Name.
Access	read/write

pwrRestoreTimerResetInterval

Name	pwrRestoreTimerResetInterval
Description	The pwrRestoreTimerResetInterval gives the interval that power must be present before the system considers the power to be up. This provides histeresis to prevent power shedding rapidly turning on and off.
Allowed Values	30    This attribute is not fully supported and should not be modified from its default value of 30 seconds.
Access	read/write

prot802_1P

Name	prot802_1P
Description	The value of the pbit to be utilized in tconfig and SIP communications for voice ONTs.
Allowed Values	pbit: 0 to 7 default: 6
Access	read/write

rangeFailWaitTime

Name	rangeFailWaitTime (Video)
Description	The rangeFailWaitTimeattribute defines the number of hours to wait before interrupting RF video services if the ONT loses communications over the PON frequencies. This prevents users from continuing to get video services after the PON goes away. Typically, PON and video are on different optical frequencies.
Allowed Values	0 to 76 hours default: 48 hours
Access	read/write

rangeFailWaitTimePots

Name	rangeFailWaitTimePots
Description	The rangeFailWaitTimePots attribute configures a timer that will turn off the POTs voltage after the PON uplink has failed and the timer expires. It is often desirable to have the POTs turn off the voltage to trigger alarm systems when the uplink fails to prevent thieves from cutting the PON uplink to prevent the alarm system from calling out.
Allowed Values	0 to 360 in 10 second increments, zero disables the feature.
Access	read/write

registrationId

Name	registrationId
Description	When not using the serial number for the password for the ONT on the PON, this holds the value of the registration ID. This attribute is not supported at this time as registration ID is not supported.
Allowed Values	N/A
Access	N/A

rstpProfileName

Name	rstpProfileName
Description	The name of a rstp or Rapid Spanning Tree profile to be applied to the port. This profile is used for configuring RSTP on the port. The profile must have been created prior to assignment.
Allowed Values	"rstpProfileName":<profile name> example: "rstpProfileName":"rstp-root-protect"
Access	read/write

rxBIPErrorCount

Name	rxBIPErrorCount
Description	The count of Bit Interleaved Parity Errors that have been detected at the receiver of the interface. This indicates that the PON is taking errors. The BIP error count is after FEC correction if enabled.
Allowed Values	64 Bit counter
Access	readonly

rxAccessViolationDiscardCount

Name	rxAccessViolationDiscardCount
Description	The count of packets discarded due to a port blocked due to an Access Violation.
Allowed Values	64 Bit counter
Access	readonly

rxBroadcastPackets

Name	rxBroadcastPackets
Description	The count of Broadcast Packets that were received.
Allowed Values	64 Bit counter
Access	readonly

rxBytesCount

Name	rxBytesCount
Description	The count of bytes that have been received over the interface.
Allowed Values	64 Bit counter
Access	readonly

rxFloodedPackets

Name	rxFloodedPackets
Description	The count of Packets that were received via flooding upstream towards the OLT.
Allowed Values	64 Bit counter
Access	readonly

rxFloodLimitDiscardCount

Name	rxFloodLimitDiscardCount
Description	The count of packets that were discarded due to the flooding limit of broadcast/multicast being exceeded.
Allowed Values	64 Bit counter
Access	readonly

rxFragments

Name	rxFragments
Description	The count of packets that were received that had been fragmented on another interface that had a smaller MTU and were broken into fragments.
Allowed Values	64 Bit counter
Access	readonly

rxInternalDiscardCount

Name	rxInternalDiscardCount
Description	The count of packets discarded due to... NEED DESCRIPTION.
Allowed Values	64 Bit counter
Access	readonly

rxJabbers

Name	rxJabbers
Description	The count of packets that were longer than the MRU, has an invalid crc and no rx error events were detected.
Allowed Values	64 Bit counter
Access	readonly

rxMissErrorCount

Name	rxMissErrorCount
Description	The number of times that a burst from the ONT was expected but didn't occur. Only valid on QOIU7 boards.
Allowed Values	64 Bit counter
Access	readonly

rxMulticastPackets

Name	rxMulticastPackets
Description	The count of Multicast Packets that were received.
Allowed Values	64 Bit counter
Access	readonly

rxOpticalPower

Name	rxOpticalPower
Description	The received optical power reported by the ONT receiver downstream.
Allowed Values	optical power in tenths of a dB
Access	readonly

rxProtocolFilterDiscardCount

Name	rxProtocolFilterDiscardCount
Description	The count of packets that were discarded due to a specific protocol (ARP for example) depleting the buffers above the threshold limit given for that protocol.
Allowed Values	64 Bit counter
Access	readonly

rxPLOAMCount

Name	rxPLOAMCount
Description	The count of PLOAM messages that have been received over the interface. PLOAM stands for Physical Layer Operations Administration and Maintenance messages.
Allowed Values	64 Bit counter
Access	readonly

rxOversizePkts

Name	rxOversizePackets
Description	The count of packets that were received over the wire that were larger than the MTU size on the interface. This can be an error or possibly a Jumbo frame sent on an interface with a smaller MTU such as 1500.
Allowed Values	64 Bit counter
Access	readonly

rxRunts

Name	rxRunts
Description	The count of packets that were received over the wire that were less than 64 bytes. This violates that standard and typically is an errored frame or a device that does not obey the specification.
Allowed Values	64 Bit counter
Access	readonly

rxUnauthDiscardCount

Name	rxUnauthDiscardCount
Description	The count of packets that were discarded due to the port not currently being authenticated.
Allowed Values	64 Bit counter
Access	readonly

rxUnicastPackets

Name	rxUnicastPackets
Description	The count of Unicast Packets that were received.
Allowed Values	64 Bit counter
Access	readonly

rxUtilization

Name	rxUtilization
Description	The percentage utilization of the receive side of the link.
Allowed Values	0 to 100 percent
Access	readonly

rxVlanFilterDiscardCount

Name	rxVlanFilterDiscardCount
Description	The count of packets that were discarded due to the VLAN not being configured on the port.
Allowed Values	64 Bit counter
Access	readonly

serialNum

Name	serialNum
Description	The serial number of the device being retrieved.
Allowed Values	12 byte string, 4 Alpha characters, followed by an 8 digit unique numeric identifier.
Access	readonly

statsFCS

Name	statsFCS
Description	The 15 minute PM statics count of Ethernet frames which included a frame check sum error which indicates an error in the received packet.
Allowed Values	64 bit counter
Access	readonly

statsFrameTooLong

Name	statsFrameTooLong
Description	The 15 minute PM statistics count for frames that are too long. Frames that are longer than 1518 or the current MRU (maximum receive unit) will be counted when this condition is detected.
Allowed Values	64 bit counter
Access	readonly

statsSingleCollisionFrame

Name	statsSingleCollisionFrame
Description	The count of Ethernet frames which included a frame check sum error which indicates an error in the transmitted packet.
Allowed Values	64 bit counter
Access	readonly

subnetMask

Name	subnetMask
Description	Defines the subnet mask for the IP address when in Voice Gateway mode. DHCP is used in softswitch mode.
Allowed Values	Standard IP Nomenclature: 0.0.0.0
Access	read/write

supportedCardGroupType

Name	supportedCardGroupType
Description	The card or ONT type that is configured to be at a specific location.
Allowed Values	65 - ONT704 66 - ONT705 68 - ONT709 71 - ONT729 73 - ONT728 74 - ONT729GP 75 - ONT120 76 - ONT140 78 - ONT070 79 - ONT142R 80 - ONT742G 81 - ONT742GR 83 - ONT180 84 - ONT205 335 - ONT131W 336 - ONT121W 337 - ONT121WX 338 - ONT248 339 - ONT140CL 340 - ONT202 341 - ONT224
Access	readonly

symbolErrors

Name	symbolErrors
Description	A symbol error indicates that the interface has detected an undefined or invalid symbol that has been received. This is a layer 1 error, where fcs is a layer 2 error.
Allowed Values	64 bit counter
Access	readonly

systemVersion

Name	systemVersion
Description	The version given to the overall software bundle for the system. Each board and ONT has its own version, but the system version is a co-ordinated release of all software at a known and tested set of revisions.
Allowed Values	systemVersion: <feature package version>_<version> example: FP29.1_015783
Access	readonly

txBroadcastDiscardCount

Name	txBroadcastDiscardCount
Description	The count of broadcast frames that were discarded by the downstream shaper due to lack of buffer space.
Allowed Values	64 Bit counter
Access	readonly

txBroadcastPackets

Name	txBroadcastPackets
Description	The count of Broadcast Packets that were transmitted.
Allowed Values	64 Bit counter
Access	readonly

txFloodedPackets

Name	txFloodedPackets
Description	The count of Packets that were transmitted via flooding downstream towards the OLT.
Allowed Values	64 Bit counter
Access	readonly

txInternalDiscardCount

Name	txInternalDiscardCount
Description	DESCRIPTION NEEDED.
Allowed Values	64 Bit counter
Access	readonly

txBytesCount

Name	txBytesCount
Description	The count of bytes that have been transmitted over the interface.
Allowed Values	64 Bit counter
Access	readonly

txFcsErrorCount

Name	txFcsErrorCount
Description	The count of frame checksum errors that have occurred on the interface.
Allowed Values	64 Bit counter
Access	readonly

txFramesCount

Name	txFramesCount
Description	The count of frames (Ethernet frames) that have been transmitted over the interface.
Allowed Values	64 Bit counter
Access	readonly

txMulticastPackets

Name	txMulticastPackets
Description	The count of Multicast Packets that were transmitted.
Allowed Values	64 Bit counter
Access	readonly

txOpticalPower

Name	txOpticalPower
Description	The output power reported by the ONT laser transmitter (upstream).
Allowed Values	Optical power in tenths of a dB
Access	readonly

txShaperDiscardCount

Name	txShaperDiscardCount
Description	The count of frames that were discarded by the downstream shaper due to lack of buffer space.
Allowed Values	64 Bit counter
Access	readonly

txUnicastPackets

Name	txUnicastPackets
Description	The count of Unicast Packets that were transmitted.
Allowed Values	64 Bit counter
Access	readonly

txUtilization

Name	txUtilization
Description	The percentage utilization of the transmit side of the link.
Allowed Values	0 to 100 percent
Access	readonly

upBERFailThreshold

Name	upBERFailThreshold
Description	The upBERFailThreshold will define the upstream Bit Error Rate (BER) threshold for failing the link. Once the error rate exceeds the BER threshold the link is failed and an alarm raised. Expressed as a negative exponent of a power of 10 (e.g. 10e-4). Typically should not be modified from the default.
Allowed Values	Any negative value from -3 to -8. default: -4 (10e-4)
Access	read/write

upBERMaintThreshold

Name	upBERMaintThreshold
Description	The upBERMaintThreshold will define the upstream Bit Error Rate (BER) threshold for signaling a maintenance alarm on the link. Once the error rate exceeds the BER threshold the link is failed and an alarm raised but the link continues to operate. The idea is to set the threshold 2 orders of magnitude less than the failure threshold to signal a need for maintenance prior to the link actually failing.
Allowed Values	Any negative value from -4 to -10. Typically should not be modified from the default. default: -6 (10e-6)
Access	read/write

upStreamLineRate

Name	upStreamLineRate
Description	The upStreamLineRate will define the usable upstream bandwidth of the PON link (i.e. 1.2Gb/s, 2.2Gb/s, 9.95Gb/s).Units are in bits per second.
Allowed Values	9,953,280 bps (10Gbps),   1,224,000 bps (1.2Gbps)
Access	readonly

userlabel

Name	userlabel
Description	The userlabel is a user defined text string associated with ONTs and ONT UNI ports that is used to put any user defined identification for the port or ONT. Often it might be the cubicle number, or what is attached to the port.
Allowed Values	Up to 24 ASCII characters, mixed case is supported.
Access	read/write

username

Name	username (Voice)
Description	The username defines the SIP user name that is used when authenticating to perform the SIP configuration download between the ONT and the Tellabs Configuration Server.
Allowed Values	Up to 24 ASCII characters, mixed case is supported.
Access	read/write

userpasswd

Name	userpasswd (Voice)
Description	The userpasswd defines the SIP digest authentication password used when authenticating to perform the SIP configuration download between the ONT and the Tellabs Configuration Server.
Allowed Values	Up to 24 ASCII characters, mixed case is supported.
Access	read/write

version

Name	version
Description	Defines the version number assigned to the software.
Allowed Values	version: free format, typically of the form: <board or ONT name>.<major version>.<minor version>.<revision> example: ONT705GR.3.22.5
Access	readonly

videoOverlaySheddingInterval

Name	videoOverlaySheddingInterval
Description	The videoOverlaySheddingInterval defines how long after an ONT transitions to battery power that it should start shedding Analog video coax services to save on battery power.
Allowed Values	900 This attribute is not fully supported and should not be modified from its default value of 900 seconds or 15 minutes.
Access	read/write

vlanid

Name	vlanid (voice)
Description	Defines the vlan ID to be used with voice services.
Allowed Values	0 to 4094
Access	read/write

voicectrlPersonality

Name	voicectrlPersonality
Description	Allows configuration of voice lines in either voice gateway mode, or SIP Softswitch mode.
Allowed Values	0 Unknown/Unconfigured 2 Voice Gateway 3 Softswitch
Access	read/write