generated

type Aal5PerformanceMonitoringHistoryData ¶

type Aal5PerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Aal5PerformanceMonitoringHistoryData (class ID #18)

This ME collects PM data as a result of performing segmentation and reassembly (SAR) and
convergence sublayer (CS) level protocol monitoring. Instances of this ME are created and
deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of an IW VCC TP that represents AAL5
	functions.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the IW VCC TP. (R, setbycreate)
		(mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Sum Of Invalid Cs Field Errors
		Sum of invalid CS field errors: This attribute counts the sum of invalid CS field errors. For
		AAL type 5, this attribute is a single count of the number of CS PDUs discarded due to one of
		the following error conditions: invalid common part indicator (CPI), oversized received SDU, or
		length violation. (R) (mandatory) (4-bytes)

	Crc Violations
		CRC violations: This attribute counts CRC violations detected on incoming SAR PDUs. (R)
		(mandatory) (4-bytes)

	Reassembly Timer Expirations
		Reassembly timer expirations: This attribute counts reassembly timer expirations. (R) (mandatory
		if reassembly timer is implemented) (4-bytes)

	Buffer Overflows
		Buffer overflows: This attribute counts the number of times where there was not enough buffer
		space for a reassembled packet. (R) (mandatory) (4-bytes)

	Encap Protocol Errors
		Encap protocol errors: This attribute counts the number of times that [IETF RFC 2684]
		encapsulation protocol detected a bad header. (R) (mandatory) (4-bytes)

type Aal5Profile ¶

type Aal5Profile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Aal5Profile (class ID #16)

This ME organizes data that describe the AAL type 5 processing functions of the ONU. It is used
with the IW VCC TP ME.

This ME is created and deleted by the OLT.

Relationships
	An instance of this ME may be associated with zero or more instances of the IW VCC TP.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Max Cpcs Pdu Size
		Max CPCS PDU size: This attribute specifies the maximum CPCS PDU size to be transmitted over the
		connection in both upstream and downstream directions. (R,-W, setbycreate) (mandatory) (2-bytes)

	Aal Mode
		(R,-W, setbycreate) (mandatory) (1-byte)

	Sscs Type
		(R,-W, setbycreate) (mandatory) (1-byte)

type AniG ¶

type AniG struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

AniG (class ID #263)

This ME organizes data associated with each access network interface supported by a GPON ONU.
The ONU automatically creates one instance of this ME for each PON physical port.

Relationships
	An instance of this ME is associated with each instance of a physical PON interface.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Its value
		indicates the physical position of the PON interface. The first byte is the slot ID, defined in
		clause 9.1.5. The second byte is the port ID. (R) (mandatory) (2-bytes)

	Sr Indication
		SR indication: This Boolean attribute indicates the ONU's capability to report queue status for
		DBA. The value true means that status reporting is available for all TCONTs that are associated
		with the ANI. (R) (mandatory) (1-byte)

	Total TCont Number
		Total TCONT number: This attribute indicates the total number of T-CONTs that can be supported
		on this ANI. (R) (mandatory) (2-bytes)

	Gem Block Length
		In all other ITU-T PON systems, the unit for queue occupancy reporting is fixed in at 4-bytes by
		the respective TC layer specification.

	Piggyback Dba Reporting
		(R) (mandatory) (1-byte)

	Deprecated
		Deprecated:	This attribute should be set to 0 by the ONU and ignored by the OLT. (R) (mandatory)
		(1-byte)

	Signal Fail Threshold
		Signal fail (SF) threshold: This attribute specifies the downstream bit error rate (BER)
		threshold to detect the SF alarm. When this value is y, the BER threshold is 10-y. Valid values
		are 3..8. Upon ME instantiation, the ONU sets this attribute to 5. (R,-W) (mandatory) (1-byte)

	Signal Degrade Threshold
		Signal degrade (SD) threshold: This attribute specifies the downstream BER threshold to detect
		the SD alarm. When this value is x, the BER threshold for SD is 10-x. Valid values are 4..10.
		The SD threshold must be lower than the SF threshold; i.e., x-> y. Upon ME instantiation, the
		ONU sets this attribute to 9. (R,-W) (mandatory) (1-byte)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Optical Signal Level
		Optical signal level: This attribute reports the current measurement of the total downstream
		optical signal level. Its value is a 2s complement integer referred to 1- mW (i.e., 1-dBm), with
		0.002 dB granularity. (R) (optional) (2-bytes)

	Lower Optical Threshold
		Lower optical threshold: This attribute specifies the optical level the ONU uses to declare the
		downstream low received optical power alarm. Valid values are  -127 dBm (coded as 254) to 0 dBm
		(coded as 0) in 0.5 dB increments. The default value 0xFF selects the ONU's internal policy.
		(R,-W) (optional) (1-byte)

	Upper Optical Threshold
		Upper optical threshold: This attribute specifies the optical level the ONU uses to declare the
		downstream high received optical power alarm. Valid values are  -127 dBm (coded as 254) to 0 dBm
		(coded as 0) in 0.5 dB increments. The default value 0xFF selects the ONU's internal policy.
		(R,-W) (optional) (1-byte)

	Onu Response Time
		(R) (optional) (2-bytes)

	Transmit Optical Level
		Transmit optical level: This attribute reports the current measurement of mean optical launch
		power. Its value is a 2s complement integer referred to 1-mW (i.e., 1-dBm), with 0.002 dB
		granularity. (R) (optional) (2-bytes)

	Lower Transmit Power Threshold
		Lower transmit power threshold: This attribute specifies the minimum mean optical launch power
		that the ONU uses to declare the low transmit optical power alarm. Its value is a 2s complement
		integer referred to 1-mW (i.e., dBm), with 0.5-dB granularity. The default value -63.5 (0x81)
		selects the ONU's internal policy. (R,-W) (optional) (1-byte)

	Upper Transmit Power Threshold
		Upper transmit power threshold: This attribute specifies the maximum mean optical launch power
		that the ONU uses to declare the high transmit optical power alarm. Its value is a 2s complement
		integer referred to 1-mW (i.e., dBm), with 0.5-dB granularity. The default value -63.5 (0x81)
		selects the ONU's internal policy. (R,-W) (optional) (1-byte)

type AttributeAccess ¶

type AttributeAccess byte

AttributeAccess represents the access allowed to an Attribute. Some MEs are instantiated by the ONU autonomously. Others are instantiated on explicit request of the OLT via a create command, and a few ME types may be instantiated in either way, depending on the ONU architecture or circumstances.

Attributes of an ME that is auto-instantiated by the ONU can be read (R), write (W), or read, write (R, W). On the other hand, attributes of a ME that is instantiated by the OLT can be either (R), (W), (R, W), (R, set by create) or (R, W, set by create).

const (
	// Access allowed on a Managed Entity attribute
	Read AttributeAccess = 1 << iota
	Write
	SetByCreate
)

func (access AttributeAccess) String() string

type AttributeDefinition ¶

type AttributeDefinition struct {
	Name          string
	AttributeType AttributeType
	Index         uint
	Mask          uint16
	DefValue      interface{}
	Size          int        // Size of attribute in bytes. 0 indicates variable/unknown
	Access        mapset.Set // AttributeAccess...
	Constraint    func(interface{}) *ParamError
	Avc           bool // If true, an AVC notification can occur for the attribute
	Tca           bool // If true, a threshold crossing alert alarm notification can occur for the attribute
	Optional      bool // If true, attribute is option, else mandatory
	Deprecated    bool // If true, attribute is deprecated
}

AttributeDefinition defines a single specific Managed Entity's attributes

func ByteField(name string, attrType AttributeType, mask uint16, defVal uint8, access mapset.Set, avc bool,
	optional bool, deprecated bool, index uint) AttributeDefinition

func GetAttributeDefinitionByName(attrMap AttributeDefinitionMap, name string) (*AttributeDefinition, error)

func MultiByteField(name string, attrType AttributeType, mask uint16, size uint, defVal []byte, access mapset.Set, avc bool,
	optional bool, deprecated bool, index uint) AttributeDefinition

func TableField(name string, attrType AttributeType, mask uint16, tableInfo TableInfo, access mapset.Set,
	avc bool, optional bool, deprecated bool, index uint) AttributeDefinition

func Uint16Field(name string, attrType AttributeType, mask uint16, defVal uint16, access mapset.Set, avc bool,
	optional bool, deprecated bool, index uint) AttributeDefinition

func Uint32Field(name string, attrType AttributeType, mask uint16, defVal uint32, access mapset.Set, avc bool,
	optional bool, deprecated bool, index uint) AttributeDefinition

func Uint64Field(name string, attrType AttributeType, mask uint16, defVal uint64, access mapset.Set, avc bool,
	optional bool, deprecated bool, index uint) AttributeDefinition

func UnknownField(name string, mask uint16, size int, index uint) AttributeDefinition

func (attr *AttributeDefinition) BufferToTableAttributes(data []byte) (interface{}, error)

func (attr *AttributeDefinition) Decode(data []byte, df gopacket.DecodeFeedback, msgType byte) (interface{}, error)

func (attr AttributeDefinition) GetAccess() mapset.Set

func (attr AttributeDefinition) GetConstraints() func(interface{}) *ParamError

func (attr AttributeDefinition) GetDefault() interface{}

func (attr AttributeDefinition) GetIndex() uint

func (attr AttributeDefinition) GetName() string

func (attr AttributeDefinition) GetSize() int

func (attr AttributeDefinition) IsBitField() bool

func (attr AttributeDefinition) IsCounter() bool

func (attr AttributeDefinition) IsString() bool

func (attr AttributeDefinition) IsTableAttribute() bool

func (attr *AttributeDefinition) SerializeTo(value interface{}, b gopacket.SerializeBuffer,
	msgType byte, bytesAvailable int) (int, error)

func (attr *AttributeDefinition) String() string

type AttributeDefinitionMap ¶

type AttributeDefinitionMap map[uint]AttributeDefinition

AttributeDefinitionMap is a map of attribute definitions with the attribute index (0..15) as the key

type AttributeFailureError ¶

type AttributeFailureError struct {
	OmciError
}

AttributeFailureError is used to encode failed attributes for Get/Set Requests

For Get requests, the failed mask is used to report attributes that could not be retrieved (most likely no space available to serialize) and could not be returned to the caller. The unsupported mask reports attributes the ONU does not support.

For Set requests, the failed mask is used to report attributes that have errors (possibly constraints) and could not be set/saved. The unsupported mask reports attributes the ONU does not support.

For Create requests that have parameter errors (code 0011), use the NewParameterError() function to signal which attributes were in error

type AttributeMe ¶ added in v0.1.0

type AttributeMe struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

AttributeMe (class ID #289)

This ME describes a particular attribute type that is supported by the ONU. This ME is not
included in an MIB upload.

Relationships
	One or more attribute entities are related to each ME entity. More than one ME entity can refer
	to a given attribute entity.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. This number is
		the same as the one that appears in the attributes table in the ME. Only one instance of each
		unique attribute need be created. The ONU can assign attribute numbering as it pleases, out of
		the pool of 64K IDs; however, it is suggested that the numbering follow a rational scheme to aid
		human readability. (R) (mandatory) (2-bytes)

	Name
		Name:	This attribute contains a 25-byte mnemonic tag for the attribute. Strings shorter than
		25-bytes are padded with null characters. (R) (mandatory) (25-bytes)

	Size
		Size:	This attribute contains the size of the attribute, in bytes. The value 0 indicates that
		the attribute can have a variable/unknown size. (R) (mandatory) (2-bytes)

	Access
		(R) (mandatory) (1-byte)

	Format
		(R) (mandatory) (1-byte)

	Lower Limit
		Lower limit:	This attribute provides the lowest value for the attribute. Valid for numeric types
		(pointer, signed integer, unsigned integer) only. For attributes smaller than 4-bytes, the
		desired numeric value is expressed in 4-byte representation (for example, the 2s complement
		1-byte integer 0xFE is expressed as 0xFFFF-FFFE; the unsigned 1-byte integer 0xFE is expressed
		as 0x0000-00FE). (R) (mandatory) (4-bytes)

	Upper Limit
		Upper limit:	This attribute provides the highest value for the attribute. It has the same
		validity and format as the lower limit attribute. (R) (mandatory) (4-bytes)

	Bit Field
		Bit field:	This attribute is a mask of the supported bits in a bit field attribute, valid for
		bit field type only. A 1 in any position signifies that its code point is supported, while 0
		indicates that it is not supported. For bit fields smaller than 4-bytes, the attribute is
		aligned at the least significant end of the mask. (R) (mandatory) (4-bytes)

	Code Points Table
		Code points table: This attribute lists the code points supported by an enumerated attribute.
		(R) (mandatory) (2 * Q bytes, where Q is the number of entries in the table.)

	Support
		(R) (mandatory) (1-byte)

type AttributeType ¶ added in v0.13.0

type AttributeType uint8

Attribute types

const (
	UnknownAttributeType         AttributeType = iota // Not known
	OctetsAttributeType                               // Series of zero or more octets
	StringAttributeType                               // Readable String
	UnsignedIntegerAttributeType                      // Integer (0..max)
	TableAttributeType                                // Table (of Octets)
	SignedIntegerAttributeType                        // Signed integer, often expressed as 2's complement
	PointerAttributeType                              // Managed Entity ID or pointer to a Managed instance
	BitFieldAttributeType                             // Bitfield
	EnumerationAttributeType                          // Fixed number of values (Unsigned Integers)
	CounterAttributeType                              // Incrementing counter
)

type AttributeValueMap ¶

type AttributeValueMap map[string]interface{}

AttributeValueMap maps an attribute (by name) to its value

type AuthenticationSecurityMethod ¶

type AuthenticationSecurityMethod struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

AuthenticationSecurityMethod (class ID #148)

The authentication security method defines the user ID and password configuration to establish a
session between a client and a server. This object may be used in the role of the client or
server. An instance of this ME is created by the OLT if authenticated communication is
necessary.

Relationships
	One instance of this management entity may be associated with a network address ME. This ME may
	also be cited by other MEs that require authentication parameter management.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The value 0xFFFF
		is reserved. (R, setbycreate) (mandatory) (2-bytes)

	Validation Scheme
		(R,-W) (mandatory) (1-byte)

	Username 1
		Username 1:	This string attribute is the user name. If the string is shorter than 25-bytes, it
		must be null terminated (Note). (R,-W) (mandatory) (25-bytes)

	Password
		Password:	This string attribute is the password. If the string is shorter than 25-bytes, it must
		be null terminated. (R,-W) (mandatory) (25-bytes)

	Realm
		Realm:	This string attribute specifies the realm used in digest authentication. If the string is
		shorter than 25-bytes, it must be null terminated. (R,-W) (mandatory) (25-bytes)

	Username 2
		NOTE - The total username is the concatenation of the username 1 and username 2 attributes if
		and only if: a) username 1 comprises 25 non-null characters; b) username 2 is supported by the
		ONU; and c) username 2 contains a leading non-null character string. Otherwise, the total
		username is simply the value of the username 1 attribute.

type BbfTr069ManagementServer ¶

type BbfTr069ManagementServer struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

BbfTr069ManagementServer (class ID #340)

If functions within the ONU are managed by [BBF TR-069], this ME allows OMCI configuration of
the autoconfiguration server (ACS) URL and related authentication information for an ACS
connection initiated by the ONU. [BBF TR-069] supports other means to discover its ACS, so not
all BBF-TR069-compatible ONUs necessarily support this ME. Furthermore, even if the ONU does
support this ME, some operators may choose not to use it.

An ONU that supports OMCI configuration of ACS information automatically creates instances of
this ME.

Relationships
	An instance of the BBF TR-069 management server ME exists for each instance of a BBF TR-069
	management domain within the ONU.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of a VEIP that links to the BBF TR-069
		management domain. (R) (mandatory) (2-bytes)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
		ME. When the administrative state is locked, the functions of this ME are disabled. BBF TR-069
		connectivity to an ACS may be possible through means that do not depend on this ME. The default
		value of this attribute is locked. (R,W) (mandatory) (1-byte)

	Acs Network Address
		ACS network address: This attribute points to an instance of a network address ME that contains
		URL and authentication information associated with the ACS URL. (R, W) (mandatory) (2 bytes)

	Associated Tag
		Associated tag: This attribute is a TCI value for BBF TR-069 management traffic passing through
		the VEIP. A TCI, comprising user priority, CFI and VID, is represented by 2-bytes. The value
		0xFFFF specifies that BBF TR-069 management traffic passes through the VEIP with neither a VLAN
		nor a priority tag. (R, W) (mandatory) (2-bytes)

type CallControlPerformanceMonitoringHistoryData ¶

type CallControlPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

CallControlPerformanceMonitoringHistoryData (class ID #140)

This ME collects PM data related to the call control channel. Instances of this ME are created
and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the PPTP POTS UNI ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PPTP POTS UNI. (R, setbycreate)
		(mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Call Setup Failures
		Call setup failures: This attribute counts call set-up failures. (R) (mandatory) (4-bytes)

	Call Setup Timer
		Call setup timer: This attribute is a high water-mark that records the longest duration of a
		single call set-up detected during this interval. Time is measured in milliseconds from the time
		an initial set-up was requested by the subscriber until the time at which a response was
		provided to the subscriber in the form of busy tone, audible ring tone, etc. (R) (mandatory)
		(4-bytes)

	Call Terminate Failures
		Call terminate failures: This attribute counts the number of calls that were terminated with
		cause. (R) (mandatory) (4-bytes)

	Analog Port Releases
		Analog port releases: This attribute counts the number of analogue port releases without
		dialling detected (abandoned calls). (R) (mandatory) (4-bytes)

	Analog Port Off_Hook Timer
		Analog port off-hook timer: This attribute is a high water-mark that records the longest period
		of a single off-hook detected on the analogue port. Time is measured in milliseconds. (R)
		(mandatory) (4-bytes)

type Cardholder ¶

type Cardholder struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Cardholder (class ID #5)

The cardholder represents the fixed equipment slot configuration of the ONU. Each cardholder can
contain 0 or 1 circuit packs; the circuit pack models equipment information that can change over
the lifetime of the ONU, e.g., through replacement.

One instance of this ME exists for each physical slot in an ONU that has pluggable circuit
packs. One or more instances of this ME may also exist in an integrated ONU, to represent
virtual slots. Instances of this ME are created automatically by the ONU, and the status
attributes are populated according to data within the ONU itself.

Slot 0 is intended to be used only in an integrated ONU. If an integrated ONU is modelled with a
universal slot 0, it is recommended that it does not contain additional (non-zero) virtual
slots. A cardholder for virtual slot 0 is recommended.

There is potential for conflict in the semantics of the expected plug-in unit type, the expected
port count and the expected equipment ID, both when the slot is not populated and when a new
circuit pack is inserted. The expected plug-in unit type and the plug-in type mismatch alarm are
mandatory, although plug-and-play/unknown (circuit pack type 255) may be used as a way to
minimize their significance. It is recommended that an ONU deny the provisioning of inconsistent
combinations of expected equipment attributes.

When a circuit pack is plugged into a cardholder or when a cardholder is pre-provisioned to
expect a circuit pack of a given type, it may trigger the ONU to instantiate a number of MEs and
update the values of others, depending on the circuit pack type. The ONU may also delete a
variety of other MEs when a circuit pack is reprovisioned to not expect a circuit pack or to
expect a circuit pack of a different type. These actions are described in the definitions of the
various MEs.

Expected equipment ID and expected port count are alternate ways to trigger the same
preprovisioning effects. These tools may be useful if an ONU is prepared to accept more than one
circuit pack of a given type but with different port counts, or if a circuit pack is a hybrid
that matches none of the types in Table 9.1.5-1, but whose identification (e.g., part number) is
known.

Relationships
	An ONU may contain zero or more instances of the cardholder, each of which may contain an
	instance of the circuit pack ME. The slot ID, real or virtual, is a fundamental identification
	mechanism for MEs that bear some relationship to a physical location.

Attributes
	Managed Entity Id
		NOTE 1 - Some xDSL MEs use the two MSBs of the slot number for other purposes. An ONU that
		supports these services may have slot limitations or restrictions.

	Actual Plug In Unit Type
		Actual plugin unit type: This attribute is equal to the type of the circuit pack in the
		cardholder, or 0 if the cardholder is empty. When the cardholder is populated, this attribute is
		the same as the type attribute of the corresponding circuit pack ME. Circuit pack types are
		defined in Table 9.1.5-1. (R) (mandatory) (1-byte)

	Expected Plug_In Unit Type
		Expected plug-in unit type: This attribute provisions the type of circuit pack for the slot. For
		type coding, see Table 9.1.5-1. The value 0 means that the cardholder is not provisioned to
		contain a circuit pack. The value 255 means that the cardholder is configured for plug-and-play.
		Upon ME instantiation, the ONU sets this attribute to 0. For integrated interfaces, this
		attribute may be used to represent the type of interface. (R,-W) (mandatory) (1-byte)

	Expected Port Count
		Expected port count: This attribute permits the OLT to specify the number of ports it expects in
		a circuit pack. Prior to provisioning by the OLT, the ONU initializes this attribute to 0.
		(R,-W) (optional) (1-byte)

	Expected Equipment Id
		Expected equipment ID: This attribute provisions the specific type of expected circuit pack.
		This attribute applies only to ONUs that do not have integrated interfaces. In some
		environments, this may contain the expected CLEI code. Upon ME instantiation, the ONU sets this
		attribute to all spaces. (R,-W) (optional) (20-bytes)

	Actual Equipment Id
		Actual equipment ID: This attribute identifies the specific type of circuit pack, once it is
		installed. This attribute applies only to ONUs that do not have integrated interfaces. In some
		environments, this may include the CLEI code. When the slot is empty or the equipment ID is not
		known, this attribute should be set to all spaces. (R) (optional) (20-bytes)

	Protection Profile Pointer
		Protection profile pointer: This attribute specifies an equipment protection profile that may be
		associated with the cardholder. Its value is the least significant byte of the ME ID of the
		equipment protection profile with which it is associated, or 0 if equipment protection is not
		used. (R) (optional) (1-byte)

	Invoke Protection Switch
		When circuit packs that support a PON interface (IF) function are switched, the response should
		be returned on the same PON that received the command. However, the OLT should also be prepared
		to accept a response on the redundant PON. (R,-W) (optional) (1-byte)

	Alarm _ Reporting Control
		Alarm-reporting control (ARC): See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

type CesServiceProfile ¶

type CesServiceProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

CesServiceProfile (class ID #21)

NOTE - In [ITU-T G.984.4], this ME is called a CES service profile-G.

An instance of this ME organizes data that describe the CES service functions of the ONU.
Instances of this ME are created and deleted by the OLT.

Relationships
	An instance of this ME may be associated with zero or more instances of a GEM IW TP.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Ces Buffered Cdv Tolerance
		CES buffered CDV tolerance: This attribute represents the duration of user data that must be
		buffered by the CES IW entity to offset packet delay variation. It is expressed in 10-us
		increments. 75 (750-vs) is suggested as a default value. (R,-W, setbycreate) (mandatory)
		(2-bytes)

	Channel Associated Signalling Cas
		(R,-W, setbycreate) (optional) (1-byte)

type CircuitPack ¶

type CircuitPack struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

CircuitPack (class ID #6)

This ME models a real or virtual circuit pack that is equipped in a real or virtual ONU slot.
For ONUs with integrated interfaces, this ME may be used to distinguish available types of
interfaces (the port-mapping package is another way).

For ONUs with integrated interfaces, the ONU automatically creates an instance of this ME for
each instance of the virtual cardholder ME. The ONU also creates an instance of this ME when the
OLT provisions the cardholder to expect a circuit pack, i.e., when the OLT sets the expected
plug-in unit type or equipment ID of the cardholder to a circuit pack type, as defined in Table
9.1.5-1. The ONU also creates an instance of this ME when a circuit pack is installed in a
cardholder whose expected plug-in unit type is 255-= plugandplay, and whose equipment ID is not
provisioned. Finally, when the cardholder is provisioned for plug-and-play, an instance of this
ME can be created at the request of the OLT.

The ONU deletes an instance of this ME when the OLT de-provisions the circuit pack (i.e., when
the OLT sets the expected plug-in unit type or equipment ID of the cardholder to 0-= no LIM).
The ONU also deletes an instance of this ME on request of the OLT if the expected plug-in unit
type attribute of the corresponding cardholder is equal to 255, plug-and-play, and the expected
equipment ID is blank (a string of all spaces). ONUs with integrated interfaces do not delete
circuit pack instances.

NOTE - Creation and deletion by the OLT is retained for backward compatibility.

Relationships
	An instance of this ME is contained by an instance of the cardholder ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Its value is the
		same as that of the cardholder ME containing this circuit pack instance. (R, setbycreate if
		applicable) (mandatory) (2-bytes)

	Type
		Type:	This attribute identifies the circuit pack type. This attribute is a code as defined in
		Table 9.1.5-1. The value 255 means unknown or undefined, i.e., the inserted circuit pack is not
		recognized by the ONU or is not mapped to an entry in Table 9.1.5-1. In the latter case, the
		equipment ID attribute may contain inventory information. Upon autonomous ME instantiation, the
		ONU sets this attribute to 0 or to the type of the circuit pack that is physically present. (R,
		setbycreate if applicable) (mandatory) (1-byte)

	Number Of Ports
		Number of ports: This attribute is the number of access ports on the circuit pack. If the port-
		mapping package is supported for this circuit pack, this attribute should be set to the total
		number of ports of all types. (R) (optional) (1-byte)

	Serial Number
		Serial number: The serial number is expected to be unique for each circuit pack, at least within
		the scope of the given vendor. Note that the serial number may contain the vendor ID or version
		number. For integrated ONUs, this value is identical to the value of the serial number attribute
		of the ONU-G ME. Upon creation in the absence of a physical circuit pack, this attribute
		comprises all spaces. (R) (mandatory) (8-bytes)

	Version
		Version:	This attribute is a string that identifies the version of the circuit pack as defined
		by the vendor. The value 0 indicates that version information is not available or applicable.
		For integrated ONUs, this value is identical to the value of the version attribute of the ONU-G
		ME. Upon creation in the absence of a physical circuit pack, this attribute comprises all
		spaces. (R) (mandatory) (14-bytes)

	Vendor Id
		Vendor ID:	This attribute identifies the vendor of the circuit pack. For ONUs with integrated
		interfaces, this value is identical to the value of the vendor ID attribute of the ONU-G ME.
		Upon creation in the absence of a physical circuit pack, this attribute comprises all spaces.
		(R) (optional) (4-bytes)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
		ME. Administrative state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte)

	Operational State
		Operational state: This attribute indicates whether the circuit pack is capable of performing
		its function. Valid values are enabled (0), disabled (1) and unknown (2). Pending completion of
		initialization and self-test on an installed circuit pack, the ONU sets this attribute to 2. (R)
		(optional) (1-byte)

	Bridged Or Ip Ind
		(R,-W) (optional, only applicable for circuit packs with Ethernet interfaces) (1-byte)

	Equipment Id
		Equipment ID: This attribute may be used to identify the vendor's specific type of circuit pack.
		In some environments, this attribute may include the CLEI code. Upon ME instantiation, the ONU
		sets this attribute to all spaces or to the equipment ID of the circuit pack that is physically
		present. (R) (optional) (20-bytes)

	Card Configuration
		Upon autonomous instantiation, this attribute is set to 0. (R,-W, setbycreate if applicable)
		(mandatory for configurable circuit packs) (1-byte)

	Total T_Cont Buffer Number
		Total T-CONT buffer number: This attribute reports the total number of T-CONT buffers associated
		with the circuit pack. Upon ME instantiation, the ONU sets this attribute to 0 or to the value
		supported by the physical circuit pack. (R) (mandatory for circuit packs that provide a traffic
		scheduler function) (1-byte)

	Total Priority Queue Number
		Total priority queue number: This value reports the total number of priority queues associated
		with the circuit pack. Upon ME instantiation, the ONU sets the attribute to 0 or to the value
		supported by the physical circuit pack. (R) (mandatory for circuit packs that provide a traffic
		scheduler function) (1-byte)

	Total Traffic Scheduler Number
		Total traffic scheduler number: This value reports the total number of traffic schedulers
		associated with the circuit pack. The ONU supports null function, strict priority scheduling and
		WRR from the priority control, and guarantee of minimum rate control points of view. If the
		circuit pack has no traffic scheduler, this attribute should be absent or have the value 0. Upon
		ME instantiation, the ONU sets the attribute to 0 or to the value supported by the physical
		circuit pack. (R) (mandatory for circuit packs that provide a traffic scheduler function)
		(1-byte)

	Power Shed Override
		Power shed override: This attribute allows ports to be excluded from the power shed control
		defined in clause 9.1.7. It is a bit mask that takes port 1 as the MSB; a bit value of 1 marks
		the corresponding port to override the power shed timer. For hardware that cannot shed power per
		port, this attribute is a slot override rather than a port override, with any non-zero port
		value causing the entire circuit pack to override power shedding. (R,-W) (optional) (4-bytes)

type ClassAccess ¶ added in v0.11.0

type ClassAccess int

ClassAccess specifies whether the ONU, OLT, or both are responsible for creating this Managed Entity

func (ca ClassAccess) String() string

type ClassID ¶ added in v0.0.7

type ClassID uint16

ClassID is a 16-bit value that uniquely defines a Managed Entity clas from the ITU-T G.988 specification.

const Aal5PerformanceMonitoringHistoryDataClassID ClassID = ClassID(18)

const Aal5ProfileClassID ClassID = ClassID(16)

const AniGClassID ClassID = ClassID(263)

const AttributeMeClassID ClassID = ClassID(289)

const AuthenticationSecurityMethodClassID ClassID = ClassID(148)

const BbfTr069ManagementServerClassID ClassID = ClassID(340)

const CallControlPerformanceMonitoringHistoryDataClassID ClassID = ClassID(140)

const CardholderClassID ClassID = ClassID(5)

const CesServiceProfileClassID ClassID = ClassID(21)

const CircuitPackClassID ClassID = ClassID(6)

const Dot1AgCfmStackClassID ClassID = ClassID(305)

const Dot1AgChassisManagementInfoClassID ClassID = ClassID(306)

const Dot1AgDefaultMdLevelClassID ClassID = ClassID(301)

const Dot1AgMaintenanceAssociationClassID ClassID = ClassID(300)

const Dot1AgMaintenanceDomainClassID ClassID = ClassID(299)

const Dot1AgMepClassID ClassID = ClassID(302)

const Dot1RateLimiterClassID ClassID = ClassID(298)

const Dot1XConfigurationProfileClassID ClassID = ClassID(291)

const Dot1XPerformanceMonitoringHistoryDataClassID ClassID = ClassID(292)

const Dot1XPortExtensionPackageClassID ClassID = ClassID(290)

const EfmBondingGroupClassID ClassID = ClassID(419)

const EfmBondingGroupPerformanceMonitoringHistoryDataClassID ClassID = ClassID(421)

const EfmBondingGroupPerformanceMonitoringHistoryDataPart2ClassID ClassID = ClassID(422)

const EfmBondingLinkClassID ClassID = ClassID(420)

const EfmBondingLinkPerformanceMonitoringHistoryDataClassID ClassID = ClassID(423)

const EfmBondingPortPerformanceMonitoringHistoryDataClassID ClassID = ClassID(424)

const EfmBondingPortPerformanceMonitoringHistoryDataPart2ClassID ClassID = ClassID(425)

const EnergyConsumptionPerformanceMonitoringHistoryDataClassID ClassID = ClassID(343)

const EnhancedFecPerformanceMonitoringHistoryDataClassID ClassID = ClassID(453)

const EnhancedSecurityControlClassID ClassID = ClassID(332)

const EnhancedTcPerformanceMonitoringHistoryDataClassID ClassID = ClassID(454)

const EquipmentExtensionPackageClassID ClassID = ClassID(160)

const EthernetFlowTerminationPointClassID ClassID = ClassID(286)

const EthernetFrameExtendedPm64BitClassID ClassID = ClassID(426)

const EthernetFrameExtendedPmClassID ClassID = ClassID(334)

const EthernetFramePerformanceMonitoringHistoryDataDownstreamClassID ClassID = ClassID(321)

const EthernetFramePerformanceMonitoringHistoryDataUpstreamClassID ClassID = ClassID(322)

const EthernetPerformanceMonitoringHistoryData2ClassID ClassID = ClassID(89)

const EthernetPerformanceMonitoringHistoryData3ClassID ClassID = ClassID(296)

const EthernetPerformanceMonitoringHistoryDataClassID ClassID = ClassID(24)

const EthernetPseudowireParametersClassID ClassID = ClassID(400)

const ExtendedVlanTaggingOperationConfigurationDataClassID ClassID = ClassID(171)

const FastChannelConfigurationProfileClassID ClassID = ClassID(432)

const FastDataPathConfigurationProfileClassID ClassID = ClassID(433)

const FastLineInventoryAndStatusDataPart2ClassID ClassID = ClassID(436)

const FastVectoringLineConfigurationExtensionsClassID ClassID = ClassID(434)

const FastXtuCPerformanceMonitoringHistoryDataClassID ClassID = ClassID(437)

const FastXtuRPerformanceMonitoringHistoryDataClassID ClassID = ClassID(438)

const GalEthernetPerformanceMonitoringHistoryDataClassID ClassID = ClassID(276)

const GalEthernetProfileClassID ClassID = ClassID(272)

const GemInterworkingTerminationPointClassID ClassID = ClassID(266)

const GemPortNetworkCtpClassID ClassID = ClassID(268)

const GemPortNetworkCtpPerformanceMonitoringHistoryDataClassID ClassID = ClassID(341)

const Ieee8021PMapperServiceProfileClassID ClassID = ClassID(130)

const InterworkingVccTerminationPointClassID ClassID = ClassID(14)

const IpHostConfigDataClassID ClassID = ClassID(134)

const IpHostPerformanceMonitoringHistoryDataClassID ClassID = ClassID(135)

const MacBridgeConfigurationDataClassID ClassID = ClassID(46)

const MacBridgePerformanceMonitoringHistoryDataClassID ClassID = ClassID(51)

const MacBridgePortBridgeTableDataClassID ClassID = ClassID(50)

const MacBridgePortConfigurationDataClassID ClassID = ClassID(47)

const MacBridgePortDesignationDataClassID ClassID = ClassID(48)

const MacBridgePortFilterPreAssignTableClassID ClassID = ClassID(79)

const MacBridgePortFilterTableDataClassID ClassID = ClassID(49)

const MacBridgePortIcmpv6ProcessPreAssignTableClassID ClassID = ClassID(348)

const MacBridgePortPerformanceMonitoringHistoryDataClassID ClassID = ClassID(52)

const MacBridgeServiceProfileClassID ClassID = ClassID(45)

const ManagedEntityMeClassID ClassID = ClassID(288)

const MgcConfigDataClassID ClassID = ClassID(155)

const MgcPerformanceMonitoringHistoryDataClassID ClassID = ClassID(156)

const MocaEthernetPerformanceMonitoringHistoryDataClassID ClassID = ClassID(163)

const MplsPseudowireTerminationPointClassID ClassID = ClassID(333)

const MulticastGemInterworkingTerminationPointClassID ClassID = ClassID(281)

const MulticastSubscriberConfigInfoClassID ClassID = ClassID(310)

const MulticastSubscriberMonitorClassID ClassID = ClassID(311)

const NetworkAddressClassID ClassID = ClassID(137)

const NetworkDialPlanTableClassID ClassID = ClassID(145)

const OctetStringClassID ClassID = ClassID(307)

const OltGClassID ClassID = ClassID(131)

const OmciClassID ClassID = ClassID(287)

const Onu2GClassID ClassID = ClassID(257)

const OnuDataClassID ClassID = ClassID(2)

const OnuDynamicPowerManagementControlClassID ClassID = ClassID(336)

const OnuGClassID ClassID = ClassID(256)

const OnuPowerSheddingClassID ClassID = ClassID(133)

const PhysicalPathTerminationPointCesUniClassID ClassID = ClassID(12)

const PhysicalPathTerminationPointEthernetUniClassID ClassID = ClassID(11)

const PhysicalPathTerminationPointLctUniClassID ClassID = ClassID(83)

const PhysicalPathTerminationPointMocaUniClassID ClassID = ClassID(162)

const PhysicalPathTerminationPointPotsUniClassID ClassID = ClassID(53)

const PhysicalPathTerminationPointReUniClassID ClassID = ClassID(314)

const PhysicalPathTerminationPointVideoAniClassID ClassID = ClassID(90)

const PhysicalPathTerminationPointVideoUniClassID ClassID = ClassID(82)

const PhysicalPathTerminationPointXdslUniPart1ClassID ClassID = ClassID(98)

const PhysicalPathTerminationPointXdslUniPart2ClassID ClassID = ClassID(99)

const PriorityQueueClassID ClassID = ClassID(277)

const PseudowireMaintenanceProfileClassID ClassID = ClassID(284)

const PseudowirePerformanceMonitoringHistoryDataClassID ClassID = ClassID(285)

const PseudowireTerminationPointClassID ClassID = ClassID(282)

const PwAtmConfigurationDataClassID ClassID = ClassID(337)

const PwAtmPerformanceMonitoringHistoryDataClassID ClassID = ClassID(338)

const PwEthernetConfigurationDataClassID ClassID = ClassID(339)

const RadiusPerformanceMonitoringHistoryDataClassID ClassID = ClassID(293)

const ReAniGClassID ClassID = ClassID(313)

const ReCommonAmplifierParametersClassID ClassID = ClassID(328)

const ReDownstreamAmplifierClassID ClassID = ClassID(316)

const ReUpstreamAmplifierClassID ClassID = ClassID(315)

const RtpPerformanceMonitoringHistoryDataClassID ClassID = ClassID(144)

const RtpProfileDataClassID ClassID = ClassID(143)

const RtpPseudowireParametersClassID ClassID = ClassID(283)

const SipAgentConfigDataClassID ClassID = ClassID(150)

const SipAgentPerformanceMonitoringHistoryDataClassID ClassID = ClassID(151)

const SipCallInitiationPerformanceMonitoringHistoryDataClassID ClassID = ClassID(152)

const SipUserDataClassID ClassID = ClassID(153)

const SnmpConfigurationDataClassID ClassID = ClassID(335)

const SoftwareImageClassID ClassID = ClassID(7)

const TContClassID ClassID = ClassID(262)

const TcAdaptorPerformanceMonitoringHistoryDataXdslClassID ClassID = ClassID(116)

const TcpUdpConfigDataClassID ClassID = ClassID(136)

const TcpUdpPerformanceMonitoringHistoryDataClassID ClassID = ClassID(342)

const ThresholdData1ClassID ClassID = ClassID(273)

const ThresholdData2ClassID ClassID = ClassID(274)

const TrafficDescriptorClassID ClassID = ClassID(280)

const TrafficSchedulerClassID ClassID = ClassID(278)

const TwdmChannelManagedEntityClassID ClassID = ClassID(443)

const TwdmChannelOmciPerformanceMonitoringHistoryDataClassID ClassID = ClassID(452)

const TwdmChannelPhyLodsPerformanceMonitoringHistoryDataClassID ClassID = ClassID(444)

const TwdmChannelPloamPerformanceMonitoringHistoryDataPart1ClassID ClassID = ClassID(446)

const TwdmChannelPloamPerformanceMonitoringHistoryDataPart2ClassID ClassID = ClassID(447)

const TwdmChannelPloamPerformanceMonitoringHistoryDataPart3ClassID ClassID = ClassID(448)

const TwdmChannelTuningPerformanceMonitoringHistoryDataPart1ClassID ClassID = ClassID(449)

const TwdmChannelTuningPerformanceMonitoringHistoryDataPart2ClassID ClassID = ClassID(450)

const TwdmChannelTuningPerformanceMonitoringHistoryDataPart3ClassID ClassID = ClassID(451)

const TwdmChannelXgemPerformanceMonitoringHistoryDataClassID ClassID = ClassID(445)

const UniGClassID ClassID = ClassID(264)

const Vdsl2LineConfigurationExtensions2ClassID ClassID = ClassID(323)

const Vdsl2LineConfigurationExtensions3ClassID ClassID = ClassID(410)

const Vdsl2LineInventoryAndStatusDataPart1ClassID ClassID = ClassID(168)

const Vdsl2LineInventoryAndStatusDataPart2ClassID ClassID = ClassID(169)

const Vdsl2LineInventoryAndStatusDataPart3ClassID ClassID = ClassID(170)

const VirtualEthernetInterfacePointClassID ClassID = ClassID(329)

const VlanTaggingFilterDataClassID ClassID = ClassID(84)

const VlanTaggingOperationConfigurationDataClassID ClassID = ClassID(78)

const VoiceServiceProfileClassID ClassID = ClassID(58)

const VoipApplicationServiceProfileClassID ClassID = ClassID(146)

const VoipConfigDataClassID ClassID = ClassID(138)

const VoipFeatureAccessCodesClassID ClassID = ClassID(147)

const VoipLineStatusClassID ClassID = ClassID(141)

const VoipMediaProfileClassID ClassID = ClassID(142)

const VoipVoiceCtpClassID ClassID = ClassID(139)

const VpNetworkCtpClassID ClassID = ClassID(269)

const VpPerformanceMonitoringHistoryDataClassID ClassID = ClassID(62)

const XdslChannelConfigurationProfileClassID ClassID = ClassID(107)

const XdslChannelConfigurationProfilePart2ClassID ClassID = ClassID(412)

const XdslChannelDownstreamStatusDataClassID ClassID = ClassID(102)

const XdslChannelUpstreamStatusDataClassID ClassID = ClassID(103)

const XdslDownstreamRfiBandsProfileClassID ClassID = ClassID(111)

const XdslImpulseNoiseMonitorPerformanceMonitoringHistoryDataClassID ClassID = ClassID(324)

const XdslLineConfigurationProfilePart2ClassID ClassID = ClassID(105)

const XdslLineConfigurationProfilePart3ClassID ClassID = ClassID(106)

const XdslLineInventoryAndStatusDataPart1ClassID ClassID = ClassID(100)

const XdslLineInventoryAndStatusDataPart2ClassID ClassID = ClassID(101)

const XdslLineInventoryAndStatusDataPart5ClassID ClassID = ClassID(325)

const XdslLineInventoryAndStatusDataPart8ClassID ClassID = ClassID(414)

const XdslPsdMaskProfileClassID ClassID = ClassID(110)

const XdslSubcarrierMaskingDownstreamProfileClassID ClassID = ClassID(108)

const XdslSubcarrierMaskingUpstreamProfileClassID ClassID = ClassID(109)

const XdslXtuCChannelPerformanceMonitoringHistoryDataClassID ClassID = ClassID(114)

const XdslXtuCPerformanceMonitoringHistoryDataClassID ClassID = ClassID(112)

const XdslXtuCPerformanceMonitoringHistoryDataPart2ClassID ClassID = ClassID(408)

const XdslXtuRChannelPerformanceMonitoringHistoryDataClassID ClassID = ClassID(115)

const XdslXtuRPerformanceMonitoringHistoryDataClassID ClassID = ClassID(113)

const XgPonDownstreamManagementPerformanceMonitoringHistoryDataClassID ClassID = ClassID(345)

const XgPonTcPerformanceMonitoringHistoryDataClassID ClassID = ClassID(344)

const XgPonUpstreamManagementPerformanceMonitoringHistoryDataClassID ClassID = ClassID(346)

const XtuDataGatheringConfigurationClassID ClassID = ClassID(413)

func GetSupportedClassIDs() []ClassID

func (cid ClassID) String() string

type ClassSupport ¶ added in v0.11.0

type ClassSupport int

ClassSupport specifies the support for this Managed Entity by the ONU

func (cs ClassSupport) String() string

type CreateME ¶

type CreateME func(params ...ParamData) (*ManagedEntity, OmciErrors)

CreateME wraps a function that makes it a creator of a Managed Entity

type DeviceBusyError ¶

type DeviceBusyError struct {
	OmciError
}

DeviceBusyError means that the command could not be processed due to process-related congestion at the ONU. This result code may also be used as a pause indication to the OLT while the ONU conducts a time-consuming operation such as storage of a software image into non-volatile memory.

type Dot1AgCfmStack ¶

type Dot1AgCfmStack struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1AgCfmStack (class ID #305)

This ME reports the maintenance status of a bridge port at any given time. An ONU that supports
[IEEE 802.1ag] functionality automatically creates an instance of the dot1ag CFM stack ME for
each MAC bridge or IEEE 802.1p mapper, depending on its provisioning model.

The dot1ag CFM stack also lists any VLANs and bridge ports against which configuration errors
are currently identified. The ONU should reject operations that create configuration errors.
However, these errors can arise because of operations on other MEs that are not necessarily
possible to detect during CFM configuration.

Relationships
	An ONU that supports [IEEE 802.1ag] creates one instance of this ME for each MAC bridge or IEEE
	802.1p mapper, depending on its provisioning model. It should not create an instance for an
	IEEE-802.1p mapper that is associated with a MAC bridge.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies an instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge service profile ME
		or an IEEE 802.1p mapper ME. It is expected that an ONU will implement CFM on bridges or on
		IEEE-802.1p mappers, but not both. For precision, the reference is disambiguated by the value of
		the layer 2 type pointer attribute. (R) (mandatory) (2-bytes)

	Layer 2 Type
		Layer 2 type:	This attribute specifies whether the dot1ag CFM stack is associated with a MAC
		bridge service profile (value 0) or an IEEE 802.1p mapper (value 1). (R) (mandatory) (1-byte)

	Mp Status Table
		(R) (mandatory) (18N bytes)

	Configuration Error List Table
		(R) (mandatory) (5N bytes)

type Dot1AgChassisManagementInfo ¶ added in v0.13.0

type Dot1AgChassisManagementInfo struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1AgChassisManagementInfo (class ID #306)

This ME represents the system-level chassis ID or management address for [IEEE-802.1ag] CFM
messages, and potentially for other IEEE 802-based functions. Although [IEEE-802.1AB] allows for
several management addresses (synonyms in different formats or with granularity to the component
level), [IEEE-802.1ag] does not provide for more than one. Nor is it expected that an ONU would
require more than one format. Accordingly, this ME provides for only one.

According to sender ID permission attributes in several dot1ag MEs, transmitted IEEE-802.1ag CFM
messages may include either or both of the chassis ID or management address
fields.[IEEE-802.1ag] requires that CCMs do not exceed 128-bytes, of which 74 are separately
allocated to other purposes; the sender ID TLV, if present, must accommodate this requirement.
The chassis info and management info must fit, with a minimum of 4 additional overhead bytes,
into the remaining 54-bytes. This limit is exploited in defining the maximum size of the ME's
attributes.

Relationships
	If an ONU supports [IEEE 802.1ag] functionality, it automatically creates an instance of this
	ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies this ME. There is at most one instance,
		whose value is 0. (R) (mandatory) (2-bytes)

	Chassis Id Length
		Chassis ID length: The length of the chassis ID attribute (not including the chassis ID subtype
		attribute), default value 0. (R,-W) (mandatory) (1-byte)

	Chassis Id Subtype
		(R,-W) (mandatory) (1-byte)

	Chassis Id Part 1 Chassis Id Part 2
		Chassis ID part 1, Chassis ID part 2: These two attributes may be regarded as an octet string of
		up to 50-bytes whose length is given by the chassis ID length attribute and whose value is the
		left-justified chassis ID. (R,-W) (mandatory) (25-bytes-*-2 attributes)

	Management Address Domain Length
		Management address domain length: The length of the management address domain attribute, default
		value 0. If this attribute has the value 0, all of the other management address attributes are
		undefined. (R,-W) (mandatory) (1-byte)

	Management Address Domain 1, Management Address Domain 2
		Management address domain 1, Management address domain 2: These two attributes may be regarded
		as an octet string of up to 50-bytes whose length is given by the management address domain
		length attribute and whose value is the left-justified management address domain. The attribute
		is coded as an object identifier (OID) as per [ITUT X.690], referring to a TDomain as defined in
		[IETF RFC 2579]. Typical domain values include snmpUDPDomain (from SNMPv2-TM [IETF RFC 3417])
		and snmpIeee802Domain (from SNMP-IEEE 802-TM-MIB [IETF RFC 4789]). (R,-W) (mandatory) (25-bytes
		* 2 attributes)

	Management Address Length
		Management address length: The length of the management address attribute, default value 0.
		(R,-W) (mandatory) (1-byte)

	Management Address 1 Management Address 2
		Management address 1, Management address 2: These two attributes may be regarded as an octet
		string of up to 50-bytes whose length is given by the management address length attribute and
		whose value is the left-justified management address. (R,-W) (mandatory) (25-bytes * 2
		attributes)

type Dot1AgDefaultMdLevel ¶

type Dot1AgDefaultMdLevel struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1AgDefaultMdLevel (class ID #301)

The collection of the functionality called a maintenance half-function (MHF) is not explicitly
modelled as a ME by either [IEEE 802.1ag] or the OMCI. The ONU automatically creates MHFs
according to parameters specified in a dot1ag MD or a dot1ag MA ME; the dot1ag default MD level
ME catches the corner cases not covered by other MEs, specifically VLANs not included by any
defined MA.

The dot1ag default MD level comprises a configurable table, each entry of which specifies
default MHF functionality for some set of VLANs. Once a set of VLANs is defined, operations to
different table entries or to dot1ag MAs that conflict with the set membership should be denied.
In addition, catch-all attributes are defined to specify MHF functionality when there is no
match to either a table entry or an MA.

Relationships
	An ONU that supports [IEEE 802.1ag] automatically creates one instance of this ME for each MAC
	bridge or IEEE 802.1p mapper, depending on the ONU's provisioning model. It should not create an
	instance for an IEEE 802.1p mapper that is associated with a MAC bridge.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies an instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge service profile ME
		or an IEEE 802.1p mapper ME. It is expected that an ONU will implement CFM on bridges or on
		IEEE-802.1p mappers, but not both, depending on its provisioning model. For precision, the
		reference is disambiguated by the value of the layer 2 type pointer attribute. (R) (mandatory)
		(2-bytes)

	Layer 2 Type
		Layer 2 type: This attribute specifies whether the dot1ag default MD level ME is associated with
		a MAC bridge service profile (value 0) or an IEEE 802.1p mapper (value-1). (R) (mandatory)
		(1-byte)

	Catchall Level
		Catchall level: This attribute ranges from 0..7 and specifies the MD level of MHFs created when
		no specific match is found. (R,-W) (mandatory) (1-byte)

	Catchall Mhf Creation
		(R,-W) (mandatory) (1-byte)

	Catchall Sender Id Permission
		Catchall sender ID permission: This attribute determines the contents of the sender ID TLV
		included in CFM messages transmitted by MPs when no more specific match is found. This attribute
		is identical to that defined in the description of the dot1ag MD ME (i.e., excluding code point
		5, defer). (R,-W) (mandatory) (1-byte)

	Default Md Level Table
		(R,-W) (mandatory) (29-bytes * N entries)

type Dot1AgMaintenanceAssociation ¶

type Dot1AgMaintenanceAssociation struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1AgMaintenanceAssociation (class ID #300)

This ME models an [IEEE 802.1ag] service defined on a bridge port. An MA is a set of endpoints
on opposite sides of a network, all existing at a defined maintenance level. One of the
endpoints resides on the local ONU; the others are understood to be configured in a consistent
way on external equipment. [ITUT Y.1731] refers to the MA as a maintenance entity group (MEG).

An MA is created and deleted by the OLT.

Relationships
	Any number of MAs may be associated with a given MD, or may stand on their own without an MD.
	One or more MAs may be associated with a MAC bridge or an IEEE 802.1p mapper. An MA exists at
	one of eight possible maintenance levels.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies an instance of this ME. The values 0 and
		0xFFFF are reserved. (R, setbycreate) (mandatory) (2-bytes)

	Md Pointer
		MD pointer:	This pointer specifies the dot1ag maintenance domain with which this MA is
		associated. A null pointer specifies that the MA is not associated with an MD. (R,-W,
		setbycreate) (mandatory) (2-bytes)

	Short Ma Name Format
		Short MA name format: This attribute specifies one of several possible formats for the short MA
		name attribute. Value 1, the primary VLAN ID, is recommended to be the default. (R,-W,
		setbycreate) (mandatory) (1-byte)

	Short Ma Name 1, Short Ma Name 2
		Short MA name 1, Short MA name 2: These two attributes may be regarded as an octet string whose
		value is the left-justified MA name. Because the MA name may or may not be a printable character
		string, an octet string is the appropriate representation. If the short MA name format specifies
		a character string, the string is null-terminated; otherwise, its length is determined by the
		short MA name format. Note that binary comparisons of the short MA name are made in other CFM
		state machines, so blanks, alphabetic case, etc., are significant. Also, note that the MD name
		and the MA short name must be packed (with additional bytes) into 48-byte CFM message headers.
		(R,-W) (mandatory) (25-bytes * 2 attributes)

	Continuity Check Message Ccm Interval
		Short intervals should be used judiciously, as they can interfere with the network's ability to
		handle subscriber traffic. The recommended value is 1-s. (R,-W, setbycreate) (mandatory)
		(1-byte)

	Associated Vlans
		Associated VLANs: This attribute is a list of up to 12 VLAN IDs with which this MA is
		associated. Once a set of VLANs is defined, the ONU should deny operations to other dot1ag MAs
		or dot1ag default MD level entries that conflict with the set membership. The all-zeros value
		indicates that this MA is not associated with any VLANs. Assuming that the attribute is not 0,
		the first entry is understood to be the primary VLAN. Except forwarded linktrace messages
		(LTMs), CFM messages emitted by MPs in this MA are tagged with the primary VLAN ID. (R,-W)
		(mandatory) (2-bytes/entry * 12-entries-=-24-bytes)

	Mhf Creation
		(R,-W, setbycreate) (mandatory) (1-byte)

	Sender Id Permission
		(R,-W, setbycreate) (mandatory) (1-byte)

type Dot1AgMaintenanceDomain ¶

type Dot1AgMaintenanceDomain struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1AgMaintenanceDomain (class ID #299)

In [IEEE 802.1ag], a maintenance domain (MD) is a context within which configuration fault
management (CFM) connectivity verification can occur. Individual services (maintenance
associations, MAs) exist within an MD. An MD is created and deleted by the OLT. The MD ME is
specified by [IEEE 802.1ag] in such a way that the same provisioning can be used for all
associated systems in a network; the OMCI definition accordingly avoids ONU-specific information
such as pointers.

Relationships
	Several MDs may be associated with a given bridge, at various MD levels, and a given MD may be
	associated with any number of bridges.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies an instance of this ME. The values 0 and
		0xFFFF are reserved. (R, setbycreate) (mandatory) (2-bytes)

	Md Level
		MD level:	This attribute ranges from 0..7 and specifies the maintenance level of this MD. Higher
		numbers have wider geographic scope. (R,-W, setbycreate) (mandatory) (1-byte)

	Md Name Format
		MD name format: This attribute specifies one of several possible formats for the MD name
		attribute. (R,-W, setbycreate) (mandatory) (1-byte)

	Md Name 1 Md Name 2
		MD name 1, MD name 2:These two attributes may be regarded as a 50-byte octet string whose value
		is the left-justified maintenance domain name. The MD name may or may not be a printable
		character string, so an octet string is the appropriate representation. If the MD name format
		specifies a DNS-like name or a character string, the string is null-terminated; otherwise, its
		length is determined by the MD name format. If the MD has no name (MD name format-=-0), this
		attribute is undefined. Note that binary comparisons of the MD name are made in other CFM state
		machines, so blanks, alphabetic case, etc., are significant. Also, note that the MD name and the
		MA name must be packed (with additional bytes) into 48-byte CFM message headers. (R,-W)
		(mandatory if MD name format is not 1) (25-bytes * 2 attributes)

	Maintenance Domain Intermediate Point Half Function Mhf Creation
		(R,-W, setbycreate) (mandatory) (1-byte)

	Sender Id Permission
		(R,-W, setbycreate) (mandatory) (1-byte)

type Dot1AgMep ¶

type Dot1AgMep struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1AgMep (class ID #302)

This ME models an MEP as defined primarily in [IEEE 802.1ag] and secondarily in [ITUT Y.1731].
It is created and deleted by the OLT. An MEP exists at one of eight possible maintenance levels,
and resides at the boundary of a MD. It inherits a name, and optionally a set of associated
VLANs, from its associated MA.

Relationships
	One or more MEPs may be associated with a MAC bridge port or an IEEE 802.1p mapper in the
	absence of a MAC bridge. An MEP is also associated with zero or more VLANs and an MA.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Layer 2 Entity Pointer
		Layer 2 entity pointer: Depending on the value of the layer 2 type attribute, this pointer
		specifies the MAC bridge port configuration data ME or the IEEE 802.1p mapper service profile ME
		with which this MEP is associated. (R,-W, setbycreate) (mandatory) (2-bytes)

	Layer 2 Type
		Layer 2 type:	This attribute specifies whether the MA is associated with a MAC bridge port
		(value 0) or an IEEE 802.1p mapper (value 1). (R,-W, setbycreate) (mandatory) (1-byte)

	Ma Pointer
		MA pointer:	This pointer specifies the maintenance association with which this MEP is
		associated. (R,-W, setbycreate) (mandatory) (2-bytes)

	Mep Id
		MEP ID:	This attribute specifies the MEP's own identity in the MA. For a given MA, the MEP ID
		must be unique throughout the network defined by the MD. The MEP ID is defined in the range
		1..8191. The value 0 indicates that no MEP ID is (yet) configured. (R,-W, setbycreate)
		(mandatory) (2-bytes)

	Mep Control
		(R,-W, setbycreate) (mandatory) (1-byte)

	Primary Vlan
		Primary VLAN: This attribute is a 12-bit VLAN ID. The value 0 indicates that the MEP inherits
		its primary VLAN from its parent MA. CFM messages, except forwarded LTMs, are tagged with the
		primary VLAN ID. If explicitly specified, the value of this attribute must be one of the VLANs
		associated with the parent MA. (R,-W, setbycreate) (mandatory) (2-bytes)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
		ME. Administrative state is further described in clause A.1.6. (R,-W, setbycreate) (mandatory)
		(1-byte)

	Ccm And Ltm Priority
		CCM and LTM priority: Ranging from 0..7, this attribute permits CCM and LTM frames to be
		explicitly prioritized, which may be needed if flows are separated, e.g., by 802.1p priority.
		The priority specified in this attribute is also used in linktrace reply (LTR) frames originated
		by this MEP. The value 0xFF selects the IEEE 802.1ag default, whereby CCM and LTM frames are
		transmitted with the highest Ethernet priority available. (R,-W, setbycreate) (mandatory)
		(1-byte)

	Egress Identifier
		Egress identifier: This attribute comprises 8-bytes to be included in LTMs. They allow received
		LTRs to be directed to the correct originator. The attribute includes the originator MAC address
		and a locally defined identifier. If this field is 0, the ONU uses the MEP's MAC address, with 0
		as the locally defined identifier. (R,-W, setbycreate) (mandatory) (8-bytes)

	Peer Mep Ids
		Peer MEP IDs: This attribute lists the expected peer MEPs for CCMs, 2-bytes per MEP ID. [IEEE
		802.1ag] allows for multipoint networks, and therefore a list of peer MEPs. This attribute
		allows for up to 12 peers for a given MEP, though GPON applications are expected to need only a
		single peer. Missing or unexpected messages trigger alarm declaration after a soak interval.
		Unused peer MEP slots should be set to 0. (R,-W) (mandatory) (24-bytes)

	Eth Ais Control
		(R,-W, setbycreate) (mandatory if ETH AIS is enabled) (1-byte)

	Fault Alarm Threshold
		(R,-W, setbycreate) (optional) (1-byte)

	Alarm Declaration Soak Time
		Alarm declaration soak time: This attribute defines the defect soak time that must elapse before
		the MEP declares an alarm. It is expressed in 10-ms units with a range of 250 to 1000, i.e.,
		2.5-s to 10-s. The default is recommended to be 2.5 seconds. (R,-W) (mandatory) (2-bytes)

	Alarm Clear Soak Time
		Alarm clear soak time: This attribute defines the defect-free soak time that must elapse before
		the MEP clears an alarm. It is expressed in intervals of 10-ms with a range of 250 to 1-000,
		i.e., 2.5-s to 10-s. The default is recommended to be 10-s. (R,-W) (mandatory) (2-bytes)

type Dot1RateLimiter ¶

type Dot1RateLimiter struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1RateLimiter (class ID #298)

This ME allows rate limits to be defined for various types of upstream traffic that are
processed by IEEE 802.1 bridges or related structures.

Relationships
	An instance of this ME may be linked to an instance of a MAC bridge service profile or an IEEE
	802.1p mapper.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Parent Me Pointer
		Parent ME pointer: This attribute points to an instance of a ME. The type of ME is determined by
		the TP type attribute. (R,-W, setbycreate) (mandatory) (2-bytes)

	Tp Type
		(R,-W, setbycreate) (mandatory) (1-byte)

	Upstream Unicast Flood Rate Pointer
		Upstream unicast flood rate pointer: This attribute points to an instance of the traffic
		descriptor that governs the rate of upstream unicast packets whose DA is unknown to the bridge.
		A null pointer specifies that no administrative limit is to be imposed. (R,-W, setbycreate)
		(optional) (2-bytes)

	Upstream Broadcast Rate Pointer
		Upstream broadcast rate pointer: This attribute points to an instance of the traffic descriptor
		that governs the rate of upstream broadcast packets. A null pointer specifies that no
		administrative limit is to be imposed. (R,-W, setbycreate) (optional) (2-bytes)

	Upstream Multicast Payload Rate Pointer
		Upstream multicast payload rate pointer: This attribute points to an instance of the traffic
		descriptor that governs the rate of upstream multicast payload packets. A null pointer specifies
		that no administrative limit is to be imposed. (R,-W, setbycreate) (optional) (2-bytes)

type Dot1XConfigurationProfile ¶

type Dot1XConfigurationProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1XConfigurationProfile (class ID #291)

An instance of this ME represents a set of attributes that control an ONU's 802.1X operation
with regard to IEEE 802 services. An instance of this ME is created by the ONU if it is capable
of supporting [IEEE 802.1X] authentication of CPE.

Relationships
	One instance of this ME governs the ONU's 802.1X CPE authentication behaviour.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute provides a unique number for each instance of this ME. There
		is at most one instance, number 0. (R) (mandatory) (2-bytes)

	Circuit Id Prefix
		Circuit ID prefix: This attribute is a pointer to a large string ME whose content appears as the
		prefix of the NAS port ID in radius access-request messages. The remainder of the NAS port ID
		field is local information (for example, slot-port, appended by the ONU itself). The default
		value of this attribute is the null pointer 0. (R,-W) (mandatory) (2-bytes)

	Fallback Policy
		Fallback policy: When set to 1 (deny), this attribute causes IEEE-802.1X conversations to fail
		when no external authentication server is accessible, such that no Ethernet service is provided.
		The default value 0 causes IEEE-802.1X conversations to succeed when no external authentication
		server is accessible. (R,-W) (mandatory) (1-byte)

	Auth Server 1
		Auth server 1: This attribute is a pointer to a large string ME that contains the URI of the
		first choice radius authentication server. The value 0 indicates that no radius authentication
		server is specified. (R,-W) (mandatory) (2-bytes)

	Shared Secret Auth1
		Shared secret auth1: This attribute is the shared secret for the first radius authentication
		server. It is a null-terminated character string. (R,-W) (mandatory) (25-bytes)

	Auth Server 2
		Auth server 2:	(R,-W) (optional) (2-bytes)

	Shared Secret Auth2
		Shared secret auth2:	(R,-W) (optional) (25-bytes)

	Auth Server 3
		Auth server 3:	(R,-W) (optional) (2-bytes)

	Shared Secret Auth3
		Shared secret auth3:	(R,-W) (optional) (25-bytes)

	Olt Proxy Address
		OLT proxy address: This attribute indicates the IP address of a possible proxy at the OLT for
		IEEE-802.1X radius messages. The default value 0.0.0.0 indicates that no proxy is required.
		(R,-W) (optional) (4-bytes)

	Calling Station Id Format
		Other values are reserved.

type Dot1XPerformanceMonitoringHistoryData ¶

type Dot1XPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1XPerformanceMonitoringHistoryData (class ID #292)

This ME collects performance statistics on an ONU's IEEE 802.1X CPE authentication operation.
Instances of this ME are created and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME may be associated with each UNI that can perform IEEE-802.1X
	authentication of CPE.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of a PPTP. (R, setbycreate)
		(mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
		that contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)

	Eapol Frames Received
		EAPOL frames received: This attribute counts received valid EAPOL frames of any type. (R)
		(mandatory) (4-bytes)

	Eapol Frames Transmitted
		EAPOL frames transmitted: This attribute counts transmitted EAPOL frames of any type. (R)
		(mandatory) (4-bytes)

	Eapol Start Frames Received
		EAPOL start frames received: This attribute counts received EAPOL start frames. (R) (mandatory)
		(4-bytes)

	Eapol Logoff Frames Received
		EAPOL logoff frames received: This attribute counts received EAPOL logoff frames. (R)
		(mandatory) (4-bytes)

	Invalid Eapol Frames Received
		Invalid EAPOL frames received: This attribute counts received EAPOL frames in which the frame
		type was not recognized. (R) (mandatory) (4-bytes)

	Eap Resp_Id Frames Received
		EAP resp/id frames received: This attribute counts received EAP response frames containing an
		identifier type field. (R) (mandatory) (4-bytes)

	Eap Response Frames Received
		EAP response frames received: This attribute counts received EAP response frames, other than
		resp/id frames. (R) (mandatory) (4-bytes)

	Eap Initial Request Frames Transmitted
		EAP initial request frames transmitted: This attribute counts transmitted request frames
		containing an identifier type field. In [IEEE 802.1X], this is also called ReqId. (R)
		(mandatory) (4-bytes)

	Eap Request Frames Transmitted
		EAP request frames transmitted: This attribute counts transmitted request frames, other than
		request/id frames. (R) (mandatory) (4-bytes)

	Eap Length Error Frames Received
		EAP length error frames received: This attribute counts received EAPOL frames whose packet body
		length field was invalid. (R) (mandatory) (4-bytes)

	Eap Success Frames Generated Autonomously
		EAP success frames generated autonomously: This attribute counts EAPOL success frames generated
		according to the local fallback policy because no radius server was available. (R) (mandatory)
		(4-bytes)

	Eap Failure Frames Generated Autonomously
		EAP failure frames generated autonomously: This attribute counts EAPOL failure frames generated
		according to the local fallback policy because no radius server was available. (R) (mandatory)
		(4-bytes)

type Dot1XPortExtensionPackage ¶

type Dot1XPortExtensionPackage struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1XPortExtensionPackage (class ID #290)

An instance of this ME represents a set of attributes that control a port's IEEE 802.1X
operation. It is created and deleted autonomously by the ONU upon the creation or deletion of a
PPTP that supports [IEEE 802.1X] authentication of customer premises equipment (CPE).

Relationships
	An instance of this ME is associated with a PPTP that performs IEEE 802.1X authentication of CPE
	(e.g., Ethernet or DSL).

Attributes
	Managed Entity Id
		Managed entity ID: This attribute provides a unique number for each instance of this ME. Its
		value is the same as that of its associated PPTP (i.e., slot and port number). (R) (mandatory)
		(2-bytes)

	Dot1X Enable
		Dot1x enable: If true, this Boolean attribute forces the associated port to authenticate via
		[IEEE 802.1X] as a precondition of normal service. The default value false does not impose IEEE
		802.1X authentication on the associated port. (R,-W) (mandatory) (1-byte)

	Action Register
		(W) (mandatory) (1-byte)

	Authenticator Pae State
		(R) (optional) (1-byte)

	Backend Authentication State
		(R) (optional) (1-byte)

	Admin Controlled Directions
		Admin controlled directions: This attribute controls the directionality of the port's
		authentication requirement. The default value 0 indicates that control is imposed in both
		directions. The value 1 indicates that control is imposed only on traffic from the subscriber
		towards the network. (R,-W) (optional) (1-byte)

	Operational Controlled Directions
		Operational controlled directions: This attribute indicates the directionality of the port's
		current authentication state. The value 0 indicates that control is imposed in both directions.
		The value 1 indicates that control is imposed only on traffic from the subscriber towards the
		network. (R) (optional) (1-byte)

	Authenticator Controlled Port Status
		Authenticator controlled port status: This attribute indicates whether the controlled port is
		currently authorized (1) or unauthorized (2). (R) (optional) (1-byte)

	Quiet Period
		Quiet period: This attribute specifies the interval between EAP request/identity invitations
		sent to the peer. Other events such as carrier present or EAPOL start frames from the peer may
		trigger an EAP request/identity frame from the ONU at any time; this attribute controls the
		ONU's periodic behaviour in the absence of these other inputs. It is expressed in seconds.
		(R,-W) (optional) (2-bytes)

	Server Timeout Period
		Server timeout period: This attribute specifies the time the ONU will wait for a response from
		the radius server before timing out. Within this maximum interval, the ONU may initiate several
		retransmissions with exponentially increasing delay. Upon timeout, the ONU may try another
		radius server if there is one, or invoke the fallback policy, if no alternate radius servers are
		available. Server timeout is expressed in seconds, with a default value of 30 and a maximum
		value of 65535. (R,-W) (optional) (2-bytes)

	Re_Authentication Period
		Re-authentication period: This attribute records the re-authentication interval specified by the
		radius authentication server. It is expressed in seconds. The attribute is only meaningful after
		a port has been authenticated. (R) (optional) (2-bytes)

	Re_Authentication Enabled
		Re-authentication enabled: This Boolean attribute records whether the radius authentication
		server has enabled re-authentication on this service (true) or not (false). The attribute is
		only meaningful after a port has been authenticated. (R) (optional) (1-byte)

	Key Transmission Enabled
		Key transmission enabled: This Boolean attribute indicates whether key transmission is enabled
		(true) or not (false). This feature is not required; the parameter is listed here for
		completeness vis-`a-vis [IEEE 802.1X]. (R,-W) (optional) (1-byte)

type EfmBondingGroup ¶ added in v0.13.0

type EfmBondingGroup struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EfmBondingGroup (class ID #419)

The EFM bonding group represents a group of links that are bonded. In [IEEE 802.3], a bonding
group is known as a PAF [physical medium entity (PME) aggregation function] and a link is known
as a PME instance of this ME are created and deleted by the OLT.

Relationships
	An instance of this ME may be associated with zero or more instances of an EFM bonding link.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The value 0 is
		reserved. (R, setbycreate) (mandatory) (2-bytes)

	Group Id
		Group ID: This attribute is the unique number representing this bonding group. See clause
		C.3.1.1 of [ITU-T G.998.2]. (R,-W, setbycreate) (mandatory) (6-bytes)

	Minimum Upstream Group Rate
		Minimum upstream group rate: This attribute sets the minimum upstream group rate, in bits per
		second, for this EFM Group. This attribute is used to determine the group US rate low alarm
		status. The group US rate low alarm means that the aggregate upstream rate of all active links
		associated with this group is less than the minimum upstream group rate. The default value for
		this rate is zero. (R,-W) (mandatory, setbycreate) (4-bytes)

	Minimum Downstream Group Rate
		Minimum downstream group rate: This attribute sets the minimum downstream group rate, in bits
		per second, for this EFM Group. This attribute is used to determine the group DS rate low alarm
		status. The group DS rate low alarm means that the aggregate downstream rate of all active links
		associated with this group is less than the minimum downstream group rate. The default value for
		this rate is zero. (R,-W) (mandatory) (4-bytes, setbycreate)

	Group Alarm Enable
		(R,-W, setbycreate) (mandatory) (1-byte)

type EfmBondingGroupPerformanceMonitoringHistoryData ¶

type EfmBondingGroupPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EfmBondingGroupPerformanceMonitoringHistoryData (class ID #421)

This ME collects PM data as seen at the xTU-C. Instances of this ME are created and deleted by
the OLT.

Relationships
	An instance of this ME is associated with an xDSL UNI.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the EFM bonding group. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
		that contain PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)

	Rx Bad Fragments
		Rx bad fragments: Clause 45.2.3.33 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

	Rx Lost Fragments
		Rx lost fragments: Clause 45.2.3.34 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

	Rx Lost Starts
		Rx lost starts: Clause 45.2.3.35 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

	Rx Lost Ends
		Rx lost ends: Clause 45.2.3.36 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

	Rx Frames
		Rx frames: Number of Ethernet frames received over this group. (R) (mandatory) (4-bytes)

	Tx Frames
		Tx frames: Number of Ethernet frames transmitted over this group. (R) (mandatory) (4-bytes)

	Rx Bytes
		Rx bytes: Number of bytes contained in the Ethernet frames received over this group. (R)
		(mandatory) (8-bytes)

	Tx Bytes
		Tx bytes: Number of bytes contained in the Ethernet frames transmitted over this group. (R)
		(mandatory) (8-bytes)

	Tx Discarded Frames
		Tx discarded frames: Number of Ethernet frames discarded by the group transmit function. (R)
		(mandatory) (4-bytes)

	Tx Discarded Bytes
		Tx discarded bytes: Number of bytes contained in the Ethernet frames discarded by the group
		transmit function. (R) (mandatory) (4-bytes)

type EfmBondingGroupPerformanceMonitoringHistoryDataPart2 ¶

type EfmBondingGroupPerformanceMonitoringHistoryDataPart2 struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EfmBondingGroupPerformanceMonitoringHistoryDataPart2 (class ID #422)

This ME collects PM data as seen at the xTU-C. Instances of this ME are created and deleted by
the OLT.

Relationships
	An instance of this ME is associated with an xDSL UNI.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the EFM bonding group. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
		that contain PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)

	Rx Unicast Frames
		Rx unicast frames: Number of unicast Ethernet frames received over this group. (R) (mandatory)
		(4-bytes)

	Tx Unicast Frames
		Tx unicast frames: Number of unicast Ethernet frames transmitted over this group. (R)
		(mandatory) (4-bytes)

	Rx Unicast Bytes
		Rx unicast bytes: Number of bytes contained in the unicast Ethernet frames received over this
		group. (R) (mandatory) (8-bytes)

	Tx Unicast Bytes
		Tx unicast bytes: Number of bytes contained in the unicast Ethernet frames transmitted over this
		group. (R) (mandatory) (8-bytes)

	Rx Broadcast Frames
		Rx broadcast frames: Number of broadcast Ethernet frames received over this group. (R)
		(mandatory) (4-bytes)

	Tx Broadcast Frames
		Tx broadcast frames: Number of broadcast Ethernet frames transmitted over this group. (R)
		(mandatory) (4-bytes)

	Rx Broadcast Bytes
		Rx broadcast bytes: Number of bytes contained in the broadcast Ethernet frames received over
		this group. (R) (mandatory) (8-bytes)

	Tx Broadcast Bytes
		Tx broadcast bytes: Number of bytes contained in the broadcast Ethernet frames transmitted over
		this group. (R) (mandatory) (8-bytes)

	Rx Multicast Frames
		Rx multicast frames: Number of multicast Ethernet frames received over this group. (R)
		(mandatory) (4-bytes)

	Tx Multicast Frames
		Tx multicast frames: Number of multicast Ethernet frames transmitted over this group. (R)
		(mandatory) (4-bytes)

	Rx Multicast Bytes
		Rx multicast bytes: Number of bytes contained in the multicast Ethernet frames received over
		this group. (R) (mandatory) (8-bytes)

	Tx Multicast Bytes
		Tx multicast bytes: Number of bytes contained in the multicast Ethernet frames transmitted over
		this group. (R) (mandatory) (8-bytes)

type EfmBondingLink ¶

type EfmBondingLink struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EfmBondingLink (class ID #420)

The EFM bonding link represents a link that can be bonded with other links to form a group. In
[IEEE 802.3], a bonding group is known as a PAF and a link is known as a PME. Instances of this
ME are created and deleted by the OLT.

Relationships
	An instance of this ME may be associated with zero or one instance of an EFM bonding group.

Attributes
	Managed Entity Id
		NOTE - This attribute has the same meaning as the Stream ID in clause C.3.1.2 of [ITU-T
		G.998.2], except that it cannot be changed. (R, setbycreate) (mandatory) (2-bytes)

	Associated Group Me Id
		Associated group ME ID: This attribute is the ME ID of the bonding group to which this link is
		associated. Changing this attribute moves the link from one group to another. Setting this
		attribute to an ME ID that has not yet been provisioned will result in this link being placed in
		a single-link group that contains only this link. The default value for this attribute is the
		null pointer, 0xFFFF. (R,-W, setbycreate) (mandatory) (2-bytes)

	Link Alarm Enable
		(R,-W, setbycreate) (mandatory) (1-bytes)

type EfmBondingLinkPerformanceMonitoringHistoryData ¶

type EfmBondingLinkPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EfmBondingLinkPerformanceMonitoringHistoryData (class ID #423)

This ME collects PM data as seen at the xTU-C. Instances of this ME are created and deleted by
the OLT.

Relationships
	An instance of this ME is associated with an xDSL UNI.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the EFM bonding link. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
		that contain PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)

	Rx Errored Fragments
		Rx errored fragments: Clause 45.2.3.29 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

	Rx Small Fragments
		Rx small fragments: Clause 45.2.3.30 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

	Rx Large Fragments
		Rx large fragments: Clause 45.2.3.31 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

	Rx Discarded Fragments
		Rx discarded fragments: Clause 45.2.3.32 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

	Rx Fcs Errors
		Rx FCS errors: Clause 45.2.6.11 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

	Rx Coding Errors
		Rx coding errors: Clause 45.2.6.12 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

	Rx Fragments
		Rx fragments: Number of fragments received over this link. (R) (mandatory) (4-bytes)

	Tx Fragments
		Tx fragments: Number of fragments transmitted over this link. (R) (mandatory) (4-bytes)

type EfmBondingPortPerformanceMonitoringHistoryData ¶

type EfmBondingPortPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EfmBondingPortPerformanceMonitoringHistoryData (class ID #424)

This ME collects PM data as seen at the xTU-C. Instances of this ME are created and deleted by
the OLT.

Relationships
	An instance of this ME is associated with an xDSL UNI.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The two MSBs of
		the first byte are the bearer channel ID. Excluding the first 2-bits of the first byte, the
		remaining part of the ME ID is identical to that of this ME's parent PPTP xDSL UNI part 1. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
		that contain PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)

	Rx Frames
		Rx frames: Number of Ethernet frames received over this port. (R) (mandatory) (4-bytes)

	Tx Frames
		Tx frames: Number of Ethernet frames transmitted over this port. (R) (mandatory) (4-bytes)

	Rx Bytes
		Rx bytes: Number of bytes contained in the Ethernet frames received over this port. (R)
		(mandatory) (4-bytes)

	Tx Bytes
		Tx bytes: Number of bytes contained in the Ethernet frames transmitted over this port. (R)
		(mandatory) (4-bytes)

	Tx Discarded Frames
		Tx discarded frames: Number of Ethernet frames discarded by the port transmit function. (R)
		(mandatory) (4-bytes)

	Tx Discarded Bytes
		Tx discarded bytes: Number of bytes contained in the Ethernet frames discarded by the port
		transmit function. (R) (mandatory) (4-bytes)

type EfmBondingPortPerformanceMonitoringHistoryDataPart2 ¶

type EfmBondingPortPerformanceMonitoringHistoryDataPart2 struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EfmBondingPortPerformanceMonitoringHistoryDataPart2 (class ID #425)

This ME collects PM data as seen at the xTU-C. Instances of this ME are created and deleted by
the OLT.

Relationships
	An instance of this ME is associated with an xDSL UNI.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The two MSBs of
		the first byte are the bearer channel ID. Excluding the first 2-bits of the first byte, the
		remaining part of the ME ID is identical to that of this ME's parent PPTP xDSL UNI part 1. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
		that contain PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)

	Rx Unicast Frames
		Rx unicast frames: Number of unicast Ethernet frames received over this port. (R) (mandatory)
		(4-bytes)

	Tx Unicast Frames
		Tx unicast frames: Number of unicast Ethernet frames transmitted over this port. (R) (mandatory)
		(4-bytes)

	Rx Unicast Bytes
		Rx unicast bytes: Number of bytes contained in the unicast Ethernet frames received over this
		port. (R) (mandatory) (4-bytes)

	Tx Unicast Bytes
		Tx unicast bytes: Number of bytes contained in the unicast Ethernet frames transmitted over this
		port. (R) (mandatory) (4-bytes)

	Rx Broadcast Frames
		Rx broadcast frames: Number of broadcast Ethernet frames received over this port. (R)
		(mandatory) (4-bytes)

	Tx Broadcast Frames
		Tx broadcast frames: Number of broadcast Ethernet frames transmitted over this port. (R)
		(mandatory) (4-bytes)

	Rx Broadcast Bytes
		Rx broadcast bytes: Number of bytes contained in the broadcast Ethernet frames received over
		this port. (R) (mandatory) (4-bytes)

	Tx Broadcast Bytes
		Tx broadcast bytes: Number of bytes contained in the broadcast Ethernet frames transmitted over
		this port. (R) (mandatory) (4-bytes)

	Rx Multicast Frames
		Rx multicast frames: Number of multicast Ethernet frames received over this port. (R)
		(mandatory) (4-bytes)

	Tx Multicast Frames
		Tx multicast frames: Number of multicast Ethernet frames transmitted over this port. (R)
		(mandatory) (4-bytes)

	Rx Multicast Bytes
		Rx multicast bytes: Number of bytes contained in the multicast Ethernet frames received over
		this port. (R) (mandatory) (4-bytes)

	Tx Multicast Bytes
		Tx multicast bytes: Number of bytes contained in the multicast Ethernet frames transmitted over
		this port. (R) (mandatory) (4-bytes)

type EnergyConsumptionPerformanceMonitoringHistoryData ¶

type EnergyConsumptionPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EnergyConsumptionPerformanceMonitoringHistoryData (class ID #343)

This ME collects PM data associated with the ONU's energy consumption. The time spent in various
low-power states is recorded as a measure of their utility. Furthermore, the ONU may also
include the equivalent of a watt-hour meter, which can be sampled from time to time to measure
actual power consumed.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with the ONU in its entirety.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The ME ID must
		be 0. (R, set-by-create) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: No thresholds are defined for this ME. For uniformity with other PMs, the
		attribute is retained and shown as mandatory, but it should be set to a null pointer. (R,-W,
		set-by-create) (mandatory) (2-bytes)

	Doze Time
		Doze time: This attribute records the time during which the ONU was in doze energy conservation
		mode, measured in microseconds. If watchful sleep is enabled in the ONU dynamic power management
		control ME, the ONU ignores this attribute. (R) (mandatory) (4-bytes)

	Cyclic Sleep Time
		Cyclic sleep time: This attribute records the time during which the ONU was in cyclic sleep
		energy conservation mode, measured in microseconds. If watchful sleep is enabled in the ONU
		dynamic power management control ME, the ONU ignores this attribute. (R) (mandatory) (4-bytes)

	Watchful Sleep Time
		Watchful sleep time: This attribute records the time during which the ONU was in watchful sleep
		energy conservation mode, measured in microseconds. (R) (mandatory) (4-bytes)

	Energy Consumed
		Energy consumed: This attribute records the energy consumed by the ONU, measured in millijoules.
		(R) (optional) (4-bytes)

type EnhancedFecPerformanceMonitoringHistoryData ¶ added in v0.13.0

type EnhancedFecPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EnhancedFecPerformanceMonitoringHistoryData (class ID #453)

This ME collects PM data associated with PON downstream FEC counters for XGS-PON and subsequent
ITU-T PON systems. Instances of this ME are created and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the ANI-G ME or an instance of the TWDM
	channel ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the ANI-G or a TWDM channel. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 64 Bit Id
		Threshold data 64-bit ID: This attribute points to an instance of the threshold data 64-bit ME
		that contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)

	Corrected Bytes
		Corrected bytes: This attribute counts the number of bytes that were corrected by the FEC
		function. (R) (mandatory) (8-bytes)

	Corrected Code Words
		Corrected code words: This attribute counts the code words that were corrected by the FEC
		function. (R) (mandatory) (8-bytes)

	Uncorrectable Code Words
		Uncorrectable code words: This attribute counts errored code words that could not be corrected
		by the FEC function. (R) (mandatory) (8-bytes)

	Total Code Words
		Total code words: This attribute counts the total received code words. (R) (mandatory) (8-bytes)

	Fec Seconds
		FEC seconds:	This attribute counts seconds during which there was an FEC anomaly. (R)
		(mandatory) (2-bytes)

type EnhancedSecurityControl ¶

type EnhancedSecurityControl struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EnhancedSecurityControl (class ID #332)

This ME contains the capabilities, parameters and controls of enhanced GPON security features
when they are negotiated via the OMCI (Note). The attributes in this ME are intended to be used
to implement a symmetric-key-based three step authentication process as described in the
supplemental information section in the following.

NOTE - If an ITU-T G.987 system uses 802.1X authentication as defined in [ITU-T G.987.3], the
only applicable attribute of this ME is the broadcast key table.

Relationships
	One instance of this ME is associated with the ONU ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. There is only
		one instance, number 0. (R) (mandatory) (2 bytes)

	Olt Crypto Capabilities
		(W) (mandatory) (16 bytes)

	Olt Random Challenge Table
		NOTE - It is assumed that the length of OLT_challenge is always an integer multiple of 16-bytes.

	Olt Challenge Status
		The ONU initializes this attribute to the value false. (R, W) (mandatory) (1-byte)

	Onu Selected Crypto Capabilities
		ONU selected crypto capabilities: This attribute specifies the cryptographic capability selected
		by the ONU in authentication step 2. Its value specifies one of the bit positions that has the
		value 1 in the OLT crypto capabilities attribute. (R) (mandatory) (1 byte)

	Onu Random Challenge Table
		ONU random challenge table: This attribute specifies the random challenge ONU_challenge issued
		by the ONU during authentication step 2. It is structured as a table, with each entry being
		16-bytes of content. ONU_challenge is the concatenation of all 16-byte content fields in the
		table. Once the OLT triggers a response to be generated using the OLT challenge status
		attribute, the ONU generates the response and writes the table (in a single operation). The AVC
		generated by this attribute signals to the OLT that the challenge is ready, so that the OLT can
		commence a get/get-next sequence to obtain the table's contents. (R) (mandatory) (16 * P-bytes)

	Onu Authentication Result Table
		Once the OLT triggers a response to be generated using the OLT challenge status attribute, the
		ONU generates ONU_result and writes the table (in a single operation). The AVC generated by this
		attribute signals to the OLT that the response is ready, so that the OLT can commence a get/get-
		next sequence to obtain the table's contents. (R) (mandatory) (16 * Q-bytes)

	Olt Authentication Result Table
		This attribute is structured as a table, with each entry being 17 bytes. The first byte is the
		table row number, starting at 1; the remaining 16 bytes are content. OLT_result is the
		concatenation of all 16-byte content fields. The OLT writes all entries into the table, and then
		triggers the ONU's processing of the table using the OLT result status attribute. The number of
		rows R is implicit in the choice of hash algorithm. The OLT can clear the table with a set
		operation to row 0. (W) (mandatory) (17 * R-bytes)

	Olt Result Status
		(R, W) (mandatory) (1 byte)

	Onu Authentication Status
		(R) (mandatory) (1 byte)

	Master Session Key Name
		Upon the invalidation of a master session key (e.g., due to an ONU reset or deactivation, or due
		to an ONU-local decision that the master session key has expired), the ONU sets the master
		session key name to all zeros. (R) (mandatory) (16 bytes)

	Broadcast Key Table
		(R, W) (optional) (18N bytes)

	Effective Key Length
		Effective key length: This attribute specifies the maximum effective length, in bits, of keys
		generated by the ONU. (R) (optional) (2 bytes)

type EnhancedTcPerformanceMonitoringHistoryData ¶ added in v0.13.0

type EnhancedTcPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EnhancedTcPerformanceMonitoringHistoryData (class ID #454)

This ME collects PM data associated with the XGS-PON and subsequent ITU-T PON systems' TC layer.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an ANI-G.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the ANI-G. (R, set-by-create)
		(mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 64 Bit Id
		Threshold data 64-bit ID: This attribute points to an instance of the threshold data 64-bit ME
		that contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)

	Psbd Hec Error Count
		PSBd HEC error count: This attribute counts HEC errors in any of the fields of the downstream
		physical sync block. (R) (optional) (4-bytes)

	Xgtc Hec Error Count
		XGTC HEC error count: This attribute counts HEC errors detected in the XGTC header. In [ITU-T
		G.9807.1], this attribute is used for FS HEC error count management. (R) (optional) (4-bytes)

	Unknown Profile Count
		Unknown profile count: This attribute counts the number of grants received whose specified
		profile was not known to the ONU. (R) (optional) (4-bytes)

	Transmitted Xgem Frames
		Transmitted XGEM frames: This attribute counts the number of non-idle XGEM frames transmitted.
		If an SDU is fragmented, each fragment is an XGEM frame and is counted as such. (R) (mandatory)
		(8 bytes)

	Fragment Xgem Frames
		Fragment XGEM frames: This attribute counts the number of XGEM frames that represent fragmented
		SDUs, as indicated by the LF bit = 0. (R) (optional) (8-bytes)

	Xgem Hec Lost Words Count
		XGEM HEC lost words count: This attribute counts the number of 4-byte words lost because of an
		XGEM frame HEC error. In general, all XGTC payload following the error is lost, until the next
		PSBd event. (R) (optional) (8 bytes)

	Xgem Key Errors
		(R) (mandatory) (8 bytes)

	Xgem Hec Error Count
		XGEM HEC error count: This attribute counts the number of instances of an XGEM frame HEC error.
		(R) (mandatory) (8 bytes)

	Transmitted Bytes In Non_Idle Xgem Frames
		Transmitted bytes in non-idle XGEM frames: This attribute counts the number of transmitted bytes
		in non-idle XGEM frames. (R) (mandatory) (8 bytes)

	Received Bytes In Non_Idle Xgem Frames
		Received bytes in non-idle XGEM frames: This attribute counts the number of received bytes in
		non-idle XGEM frames. (R) (optional) (8 bytes)

	Lods Event Count
		LODS event count: This attribute counts the number of state transitions from O5.1 to O6. (R)
		(optional) (4-bytes)

	Lods Event Restored Count
		LODS event restored count: This attribute counts the number of LODS cleared events. (R)
		(optional) (4-bytes)

	Onu Reactivation By Lods Events
		ONU reactivation by LODS events: This attribute counts the number of LODS events resulting in
		ONU reactivation without synchronization being reacquired. (R) (optional) (4-bytes)

type EquipmentExtensionPackage ¶

type EquipmentExtensionPackage struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EquipmentExtensionPackage (class ID #160)

This ME supports optional extensions to circuit pack MEs. If the circuit pack supports these
features, the ONU creates and deletes this ME along with its associated real or virtual circuit
pack.

Relationships
	An equipment extension package may be contained by an ONU-G or cardholder.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the ONU-G or cardholder. (R)
		(mandatory) (2-bytes)

	Environmental Sense
		NOTE - Some specific sense point applications are already defined on the ONU-G ME. It is the
		vendor's choice how to configure and report sense points that appear both generically and
		specifically.

	Contact Closure Output
		On read, the left bit in each pair should be set to 0 at the ONU and ignored at the OLT. The
		right bit indicates a released output point with 0 and an operated contact point with 1. (R,-W)
		(optional) (2-bytes)

type EthernetFlowTerminationPoint ¶

type EthernetFlowTerminationPoint struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetFlowTerminationPoint (class ID #286)

The Ethernet flow TP contains the attributes necessary to originate and terminate Ethernet
frames in the ONU. It is appropriate when transporting pseudowire services via layer-2.
Instances of this ME are created and deleted by the OLT.

Relationships
	One Ethernet flow TP ME exists for each distinct pseudowire service that is transported via
	layer 2.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to a pseudowire TP ME. (R, setbycreate) (mandatory)
		(2-bytes)

	Destination Mac
		Destination MAC: This attribute specifies the destination MAC address of upstream Ethernet
		frames. (R,-W, setbycreate) (mandatory) (6-bytes)

	Source Mac
		Source MAC: This attribute specifies the near-end MAC address. It is established by nonOMCI
		means (e.g., factory programmed into ONU flash memory) and is included here for information
		only. (R) (mandatory) (6-bytes)

	Tag Policy
		(R,-W, setbycreate) (mandatory) (1-byte)

	Tci
		TCI:	If the tag policy calls for tagging of upstream Ethernet frames, this attribute specifies
		the tag control information, which includes the VLAN tag, P bits and CFI bit. (R,-W) (optional)
		(2-bytes)

	Loopback
		(R,-W) (mandatory) (1-byte)

type EthernetFrameExtendedPm ¶

type EthernetFrameExtendedPm struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetFrameExtendedPm (class ID #334)

This ME collects some of the PM data at a point where an Ethernet flow can be observed. It is
based on the Etherstats group of [IETF RFC 2819]. Instances of this ME are created and deleted
by the OLT. References to received frames are to be interpreted as the number of frames entering
the monitoring point in the direction specified by the control block.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME may be associated with an instance of an ME at any Ethernet interface
	within the ONU. The specific ME is identified in the control block attribute.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. To facilitate
		discovery, the identification of instances sequentially starting with 1 is encouraged. (R,
		setbycreate) (mandatory) (2 bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. If
		continuous accumulation is enabled in the control block, this attribute is not used and has the
		fixed value 0. (R) (mandatory) (1 byte)

	Control Block
		(R, W, setbycreate) (mandatory) (16 bytes)

	Drop Events
		Drop events:	The total number of events in which frames were dropped due to a lack of resources.
		This is not necessarily the number of frames dropped; it is the number of times this event was
		detected. (R) (mandatory) (4 bytes)

	Octets
		Octets:	The total number of octets received, including those in bad frames, excluding framing
		bits, but including FCS. (R) (mandatory) (4 bytes)

	Frames
		Frames:	The total number of frames received, including bad frames, broadcast frames and
		multicast frames. (R) (mandatory) (4 bytes)

	Broadcast Frames
		Broadcast frames: The total number of received good frames directed to the broadcast address.
		This does not include multicast frames. (R) (mandatory) (4 bytes)

	Multicast Frames
		Multicast frames: The total number of received good frames directed to a multicast address. This
		does not include broadcast frames. (R) (mandatory) (4 bytes)

	Crc Errored Frames
		CRC errored frames: The total number of frames received that had a length (excluding framing
		bits, but including FCS octets) of between 64 and 1518 octets, inclusive, but had either a bad
		FCS with an integral number of octets (FCS error) or a bad FCS with a non-integral number of
		octets (alignment error). (R) (mandatory) (4 bytes)

	Undersize Frames
		Undersize frames: The total number of frames received that were less than 64 octets long but
		were otherwise well formed (excluding framing bits, but including FCS octets). (R) (mandatory)
		(4 bytes)

	Oversize Frames
		Oversize frames: The total number of frames received that were longer than 1518 octets
		(excluding framing bits, but including FCS octets) and were otherwise well formed. (R)
		(mandatory) (4 bytes)

	Frames 64 Octets
		Frames 64 octets: The total number of received frames (including bad frames) that were 64-octets
		long, excluding framing bits but including FCS. (R) (mandatory) (4-bytes)

	Frames 65 To 127 Octets
		Frames 65 to 127 octets: The total number of received frames (including bad frames) that were
		65..127 octets long, excluding framing bits but including FCS. (R) (mandatory) (4 bytes)

	Frames 128 To 255 Octets
		Frames 128 to 255 octets: The total number of frames (including bad frames) received that were
		128..255 octets long, excluding framing bits but including FCS. (R) (mandatory) (4 bytes)

	Frames 256 To 511 Octets
		Frames 256 to 511 octets: The total number of frames (including bad frames) received that were
		256..511 octets long, excluding framing bits but including FCS. (R) (mandatory) (4 bytes)

	Frames 512 To 1 023 Octets
		Frames 512 to 1-023 octets: The total number of frames (including bad frames) received that were
		512..1-023 octets long, excluding framing bits but including FCS. (R) (mandatory) (4 bytes)

	Frames 1024 To 1518 Octets
		Frames 1024 to 1518 octets: The total number of frames (including bad frames) received that were
		1024..1518 octets long, excluding framing bits but including FCS. (R) (mandatory) (4 bytes)

type EthernetFrameExtendedPm64Bit ¶ added in v0.1.0

type EthernetFrameExtendedPm64Bit struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetFrameExtendedPm64Bit (class ID #426)

This ME collects some of the PM data at a point where an Ethernet flow can be observed. It is
based on the Etherstats group of [IETF RFC 2819] and [IETF RFC 2863]. Instances of this ME are
created and deleted by the OLT. References to received frames are to be interpreted as the
number of frames entering the monitoring point in the direction specified by the control block.

For a complete discussion of generic PM architecture, refer to clause I.4.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. To facilitate
		discovery, the identification of instances sequentially starting with 1 is encouraged. (R,
		setbycreate) (mandatory) (2 bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. If
		continuous accumulation is enabled in the control block, this attribute is not used and has the
		fixed value 0. (R) (mandatory) (1 byte)

	Control Block
		(R, W, setbycreate) (mandatory) (16 bytes)

	Drop Events
		Drop events:	The total number of events in which frames were dropped due to a lack of resources.
		This is not necessarily the number of frames dropped; it is the number of times this event was
		detected. (R) (mandatory) (4 bytes)

	Octets
		Octets:	The total number of octets received, including those in bad frames, excluding framing
		bits, but including FCS. (R) (mandatory) (4 bytes)

	Frames
		Frames:	The total number of frames received, including bad frames, broadcast frames and
		multicast frames. (R) (mandatory) (4 bytes)

	Broadcast Frames
		Broadcast frames: The total number of received good frames directed to the broadcast address.
		This does not include multicast frames. (R) (mandatory) (4 bytes)

	Multicast Frames
		Multicast frames: The total number of received good frames directed to a multicast address. This
		does not include broadcast frames. (R) (mandatory) (4 bytes)

	Crc Errored Frames
		CRC errored frames: The total number of frames received that had a length (excluding framing
		bits, but including FCS octets) of between 64 and 1518 octets, inclusive, but had either a bad
		FCS with an integral number of octets (FCS error) or a bad FCS with a non-integral number of
		octets (alignment error). (R) (mandatory) (4 bytes)

	Undersize Frames
		Undersize frames: The total number of frames received that were less than 64 octets long but
		were otherwise well formed (excluding framing bits, but including FCS octets). (R) (mandatory)
		(4 bytes)

	Oversize Frames
		Oversize frames: The total number of frames received that were longer than 1518 octets
		(excluding framing bits, but including FCS octets) and were otherwise well formed. (R)
		(mandatory) (4 bytes)

	Frames 64 Octets
		Frames 64 octets: The total number of received frames (including bad frames) that were 64-octets
		long, excluding framing bits but including FCS. (R) (mandatory) (4-bytes)

	Frames 65 To 127 Octets
		Frames 65 to 127 octets: The total number of received frames (including bad frames) that were
		65..127 octets long, excluding framing bits but including FCS. (R) (mandatory) (4 bytes)

	Frames 128 To 255 Octets
		Frames 128 to 255 octets: The total number of frames (including bad frames) received that were
		128..255 octets long, excluding framing bits but including FCS. (R) (mandatory) (4 bytes)

	Frames 256 To 511 Octets
		Frames 256 to 511 octets: The total number of frames (including bad frames) received that were
		256..511 octets long, excluding framing bits but including FCS. (R) (mandatory) (4 bytes)

	Frames 512 To 1 023 Octets
		Frames 512 to 1-023 octets: The total number of frames (including bad frames) received that were
		512..1-023 octets long, excluding framing bits but including FCS. (R) (mandatory) (4 bytes)

	Frames 1024 To 1518 Octets
		Frames 1024 to 1518 octets: The total number of frames (including bad frames) received that were
		1024..1518 octets long, excluding framing bits but including FCS. (R) (mandatory) (4 bytes)

type EthernetFramePerformanceMonitoringHistoryDataDownstream ¶

type EthernetFramePerformanceMonitoringHistoryDataDownstream struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetFramePerformanceMonitoringHistoryDataDownstream (class ID #321)

This ME is identical to the Ethernet frame PM history data upstream ME, with the exception that
it monitors downstream traffic.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of a MAC bridge port configuration
		data. (R, setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Drop Events
		Drop events:	The total number of events in which packets were dropped due to a lack of
		resources. This is not necessarily the number of packets dropped; it is the number of times this
		event was detected. (R) (mandatory) (4-bytes)

	Octets
		Octets:	The total number of upstream octets received, including those in bad packets, excluding
		framing bits, but including FCS. (R) (mandatory) (4-bytes)

	Packets
		Packets:	The total number of upstream packets received, including bad packets, broadcast packets
		and multicast packets. (R) (mandatory) (4-bytes)

	Broadcast Packets
		Broadcast packets: The total number of upstream good packets received that were directed to the
		broadcast address. This does not include multicast packets. (R) (mandatory) (4-bytes)

	Multicast Packets
		Multicast packets: The total number of upstream good packets received that were directed to a
		multicast address. This does not include broadcast packets. (R) (mandatory) (4-bytes)

	Crc Errored Packets
		CRC errored packets: The total number of upstream packets received that had a length (excluding
		framing bits, but including FCS octets) of between 64-octets and 1518-octets, inclusive, but had
		either a bad FCS with an integral number of octets (FCS error) or a bad FCS with a non-integral
		number of octets (alignment error). (R) (mandatory) (4-bytes)

	Undersize Packets
		Undersize packets: The total number of upstream packets received that were less than 64-octets
		long, but were otherwise well formed (excluding framing bits, but including FCS). (R)
		(mandatory) (4-bytes)

	Oversize Packets
		NOTE 2 - If 2-000-byte Ethernet frames are supported, counts in this performance parameter are
		not necessarily errors.

	Packets 64 Octets
		Packets 64 octets: The total number of upstream received packets (including bad packets) that
		were 64-octets long, excluding framing bits but including FCS. (R) (mandatory) (4-bytes)

	Packets 65 To 127 Octets
		Packets 65 to 127 octets: The total number of upstream received packets (including bad packets)
		that were 65..127 octets long, excluding framing bits but including FCS. (R) (mandatory)
		(4-bytes)

	Packets 128 To 255 Octets
		Packets 128 to 255 octets: The total number of upstream packets (including bad packets) received
		that were 128..255 octets long, excluding framing bits but including FCS. (R) (mandatory)
		(4-bytes)

	Packets 256 To 511 Octets
		Packets 256 to 511 octets: The total number of upstream packets (including bad packets) received
		that were 256..511 octets long, excluding framing bits but including FCS. (R) (mandatory)
		(4-bytes)

	Packets 512 To 1023 Octets
		Packets 512 to 1023 octets: The total number of upstream packets (including bad packets)
		received that were 512..1-023 octets long, excluding framing bits but including FCS. (R)
		(mandatory) (4-bytes)

	Packets 1024 To 1518 Octets
		Packets 1024 to 1518 octets: The total number of upstream packets (including bad packets)
		received that were 1024..1518 octets long, excluding framing bits, but including FCS. (R)
		(mandatory) (4-bytes)

type EthernetFramePerformanceMonitoringHistoryDataUpstream ¶

type EthernetFramePerformanceMonitoringHistoryDataUpstream struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetFramePerformanceMonitoringHistoryDataUpstream (class ID #322)

This ME collects PM data associated with upstream Ethernet frame delivery. It is based on the
Etherstats group of [IETF RFC 2819]. Instances of this ME are created and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

NOTE 1 - Implementers are encouraged to consider the Ethernet frame extended PM ME defined in
clause-9.3.32, which collects the same counters in a more generalized way.

Relationships
	An instance of this ME is associated with an instance of a MAC bridge port configuration data.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of a MAC bridge port configuration
		data. (R, setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Drop Events
		Drop events:	The total number of events in which packets were dropped due to a lack of
		resources. This is not necessarily the number of packets dropped; it is the number of times this
		event was detected. (R) (mandatory) (4-bytes)

	Octets
		Octets:	The total number of upstream octets received, including those in bad packets, excluding
		framing bits, but including FCS. (R) (mandatory) (4-bytes)

	Packets
		Packets:	The total number of upstream packets received, including bad packets, broadcast packets
		and multicast packets. (R) (mandatory) (4-bytes)

	Broadcast Packets
		Broadcast packets: The total number of upstream good packets received that were directed to the
		broadcast address. This does not include multicast packets. (R) (mandatory) (4-bytes)

	Multicast Packets
		Multicast packets: The total number of upstream good packets received that were directed to a
		multicast address. This does not include broadcast packets. (R) (mandatory) (4-bytes)

	Crc Errored Packets
		CRC errored packets: The total number of upstream packets received that had a length (excluding
		framing bits, but including FCS octets) of between 64-octets and 1518-octets, inclusive, but had
		either a bad FCS with an integral number of octets (FCS error) or a bad FCS with a non-integral
		number of octets (alignment error). (R) (mandatory) (4-bytes)

	Undersize Packets
		Undersize packets: The total number of upstream packets received that were less than 64-octets
		long, but were otherwise well formed (excluding framing bits, but including FCS). (R)
		(mandatory) (4-bytes)

	Oversize Packets
		NOTE 2 - If 2-000-byte Ethernet frames are supported, counts in this performance parameter are
		not necessarily errors.

	Packets 64 Octets
		Packets 64 octets: The total number of upstream received packets (including bad packets) that
		were 64-octets long, excluding framing bits but including FCS. (R) (mandatory) (4-bytes)

	Packets 65 To 127 Octets
		Packets 65 to 127 octets: The total number of upstream received packets (including bad packets)
		that were 65..127 octets long, excluding framing bits but including FCS. (R) (mandatory)
		(4-bytes)

	Packets 128 To 255 Octets
		Packets 128 to 255 octets: The total number of upstream packets (including bad packets) received
		that were 128..255 octets long, excluding framing bits but including FCS. (R) (mandatory)
		(4-bytes)

	Packets 256 To 511 Octets
		Packets 256 to 511 octets: The total number of upstream packets (including bad packets) received
		that were 256..511 octets long, excluding framing bits but including FCS. (R) (mandatory)
		(4-bytes)

	Packets 512 To 1023 Octets
		Packets 512 to 1023 octets: The total number of upstream packets (including bad packets)
		received that were 512..1-023 octets long, excluding framing bits but including FCS. (R)
		(mandatory) (4-bytes)

	Packets 1024 To 1518 Octets
		Packets 1024 to 1518 octets: The total number of upstream packets (including bad packets)
		received that were 1024..1518 octets long, excluding framing bits, but including FCS. (R)
		(mandatory) (4-bytes)

type EthernetPerformanceMonitoringHistoryData ¶

type EthernetPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetPerformanceMonitoringHistoryData (class ID #24)

This ME collects some of the PM data for a physical Ethernet interface. Instances of this ME are
created and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the PPTP Ethernet UNI.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PPTP Ethernet UNI. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
		that contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)

	Fcs Errors
		FCS errors:	This attribute counts frames received on a particular interface that were an
		integral number of octets in length but failed the FCS check. The count is incremented when the
		MAC service returns the frameCheckError status to the link layer control (LLC) or other MAC
		user. Received frames for which multiple error conditions are obtained are counted according to
		the error status presented to the LLC. (R) (mandatory) (4-bytes)

	Excessive Collision Counter
		Excessive collision counter: This attribute counts frames whose transmission failed due to
		excessive collisions.-(R) (mandatory) (4-bytes)

	Late Collision Counter
		Late collision counter: This attribute counts the number of times that a collision was detected
		later than 512 bit times into the transmission of a packet. (R) (mandatory) (4-bytes)

	Frames Too Long
		Frames too long: This attribute counts received frames that exceeded the maximum permitted frame
		size. The count is incremented when the MAC service returns the frameTooLong status to the LLC.
		(R) (mandatory) (4-bytes)

	Buffer Overflows On Receive
		Buffer overflows on receive: This attribute counts the number of times that the receive buffer
		overflowed. (R) (mandatory) (4-bytes)

	Buffer Overflows On Transmit
		Buffer overflows on transmit: This attribute counts the number of times that the transmit buffer
		overflowed. (R) (mandatory) (4-bytes)

	Single Collision Frame Counter
		Single collision frame counter: This attribute counts successfully transmitted frames whose
		transmission was delayed by exactly one collision. (R) (mandatory) (4-bytes)

	Multiple Collisions Frame Counter
		Multiple collisions frame counter: This attribute counts successfully transmitted frames whose
		transmission was delayed by more than one collision. (R) (mandatory) (4-bytes)

	Sqe Counter
		SQE counter: This attribute counts the number of times that the SQE test error message was
		generated by the PLS sublayer. (R) (mandatory) (4-bytes)

	Deferred Transmission Counter
		Deferred transmission counter: This attribute counts frames whose first transmission attempt was
		delayed because the medium was busy. The count does not include frames involved in collisions.
		(R) (mandatory) (4-bytes)

	Internal Mac Transmit Error Counter
		Internal MAC transmit error counter: This attribute counts frames whose transmission failed due
		to an internal MAC sublayer transmit error. (R) (mandatory) (4-bytes)

	Carrier Sense Error Counter
		Carrier sense error counter: This attribute counts the number of times that carrier sense was
		lost or never asserted when attempting to transmit a frame. (R) (mandatory) (4-bytes)

	Alignment Error Counter
		Alignment error counter: This attribute counts received frames that were not an integral number
		of octets in length and did not pass the FCS check. (R) (mandatory) (4-bytes)

	Internal Mac Receive Error Counter
		Internal MAC receive error counter: This attribute counts frames whose reception failed due to
		an internal MAC sublayer receive error. (R) (mandatory) (4-bytes)

type EthernetPerformanceMonitoringHistoryData2 ¶

type EthernetPerformanceMonitoringHistoryData2 struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetPerformanceMonitoringHistoryData2 (class ID #89)

This ME collects additional PM data for a physical Ethernet interface. Instances of this ME are
created and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this Ethernet PM history data 2 ME is associated with an instance of the PPTP
	Ethernet UNI.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PPTP Ethernet UNI. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Pppoe Filtered Frame Counter
		PPPoE filtered frame counter: This attribute counts the number of frames discarded due to PPPoE
		filtering. (R) (mandatory) (4-bytes)

type EthernetPerformanceMonitoringHistoryData3 ¶

type EthernetPerformanceMonitoringHistoryData3 struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetPerformanceMonitoringHistoryData3 (class ID #296)

This ME collects PM data associated with an Ethernet interface. It includes parameters defined
in the Ethernet statistics group of [IETF RFC 2819] that are not already covered by previously
defined Ethernet monitoring MEs. The received direction is from the CPE towards the network
(upstream).

NOTE 1 - Several of the same counters are available from the Ethernet frame PM history data MEs,
which are associated with MAC bridge ports. MAC bridge port association allows those MEs to be
used for any Ethernet flow, in both upstream and downstream directions, while the Ethernet PM
history data 3 ME can only be used on a physical IEEE 802.3 port.

Instances of this ME are created and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

NOTE 2 - Implementers are encouraged to consider the Ethernet frame extended PM ME defined in
clause-9.3.32, which collects the same counters in a more generalized way.

Relationships
	An instance of this ME is associated with an instance of the PPTP Ethernet UNI.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PPTP Ethernet UNI. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Drop Events
		Drop events:	The total number of events in which packets were dropped due to a lack of
		resources. This is not necessarily the number of packets dropped; it is the number of times this
		event was detected. (R) (mandatory) (4-bytes)

	Octets
		Octets:	The total number of octets received from the CPE, including those in bad packets,
		excluding framing bytes, but including FCS. (R) (mandatory) (4-bytes)

	Packets
		Packets:	The total number of packets received, including bad packets, broadcast packets and
		multicast packets. (R) (mandatory) (4-bytes)

	Broadcast Packets
		Broadcast packets: The total number of received good packets directed to the broadcast address.
		This does not include multicast packets. (R) (mandatory) (4-bytes)

	Multicast Packets
		Multicast packets: The total number of received good packets directed to a multicast address.
		This does not include broadcast packets. (R) (mandatory) (4-bytes)

	Undersize Packets
		Undersize packets: The total number of packets received that were less than 64 octets long, but
		were otherwise well formed (excluding framing bits, but including FCS). (R) (mandatory)
		(4-bytes)

	Fragments
		Fragments:	The total number of packets received that were less than 64 octets long, excluding
		framing bits but including FCS octets, and had either a bad FCS with an integral number of
		octets (FCS error) or a bad FCS with a non-integral number of octets (alignment error). It is
		entirely normal for this attribute to increment. This is because it counts both runts (which are
		normal occurrences due to collisions) and noise hits. (R) (mandatory) (4-bytes)

	Jabbers
		Jabbers:	The total number of packets received that were longer than 1518 octets, excluding
		framing bits but including FCS octets, and had either a bad FCS with an integral number of
		octets (FCS error) or a bad FCS with a non-integral number of octets (alignment error). The
		range to detect jabber is between 20 ms and 150 ms. (R) (mandatory) (4-bytes)

	Packets 64 Octets
		Packets 64 octets: The total number of received packets (including bad packets) that were
		64-octets long, excluding framing bits but including FCS. (R) (mandatory) (4-bytes)

	Packets 65 To 127 Octets
		Packets 65 to 127 octets: The total number of received packets (including bad packets) that were
		65..127 octets long, excluding framing bits but including FCS. (R) (mandatory) (4-bytes)

	Packets 128 To 255 Octets
		Packets 128 to 255 octets: The total number of packets (including bad packets) received that
		were 128..255 octets long, excluding framing bits but including FCS. (R) (mandatory) (4-bytes)

	Packets 256 To 511 Octets
		Packets 256 to 511 octets: The total number of packets (including bad packets) received that
		were 256..511 octets long, excluding framing bits but including FCS. (R) (mandatory) (4-bytes)

	Packets 512 To 1023 Octets
		Packets 512 to 1023 octets: The total number of packets (including bad packets) received that
		were 512..1023 octets long, excluding framing bits but including FCS. (R) (mandatory) (4-bytes)

	Packets 1024 To 1518 Octets
		Packets 1024 to 1518 octets: The total number of packets (including bad packets) received that
		were 1024..1518 octets long, excluding framing bits but including FCS. (R) (mandatory) (4-bytes)

type EthernetPseudowireParameters ¶

type EthernetPseudowireParameters struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetPseudowireParameters (class ID #400)

This ME contains the Ethernet pseudowire parameters. Instances of this ME are created and
deleted by the OLT.

Relationships
	An instance of this ME is associated with an instance of the PW Ethernet configuration data ME.

Attributes
	Managed Entity Id
		Managed entity ID:	This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PW Ethernet configuration data
		ME. (R, set-by-create) (mandatory) (2 bytes)

	Mtu
		MTU:	This attribute identifies the maximum transmission unit (bytes) that can be received from
		the CPE in the upstream direction. Larger frames are discarded. (R, W, set-by-create)
		(mandatory) (2 bytes)

type ExtendedVlanTaggingOperationConfigurationData ¶

type ExtendedVlanTaggingOperationConfigurationData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

ExtendedVlanTaggingOperationConfigurationData (class ID #171)

This ME organizes data associated with VLAN tagging. Regardless of its point of attachment, the
specified tagging operations refer to the upstream direction. Instances of this ME are created
and deleted by the OLT.

Relationships
	Zero or one instance of this ME may exist for an instance of any ME that can terminate or modify
	an Ethernet stream.////		When this ME is associated with a UNI-side TP, it performs its upstream classification and
	tagging operations before offering the upstream frame to other filtering, bridging or switching
	functions. In the downstream direction, the defined inverse operation is the last operation
	performed on the frame before offering it to the UNI-side termination.////		When this ME is associated with an ANI-side TP, it performs its upstream classification and
	tagging operations as the last step before transmission to the OLT, after having received the
	upstream frame from other filtering, bridging or switching functions. In the downstream
	direction, the defined inverse operation is the first operation performed on the frame before
	offering it to possible filter, bridge or switch functions.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute provides a unique number for each instance of this ME. (R,
		setbycreate) (mandatory) (2-bytes)

	Association Type
		When the extended VLAN tagging ME is associated with the ANI side, it behaves as an upstream
		egress rule, and as a downstream ingress rule when the downstream mode attribute is equal to 0.
		When the extended VLAN tagging ME is associated with the UNI side, the extended VLAN tagging ME
		behaves as an upstream ingress rule, and as a downstream egress rule when the downstream mode
		attribute is equal to 0.

	Received Frame Vlan Tagging Operation Table Max Size
		Received frame VLAN tagging operation table max size: This attribute indicates the maximum
		number of entries that can be set in the received frame VLAN tagging operation table. (R)
		(mandatory) (2-bytes)

	Input Tpid
		Input TPID:	This attribute gives the special TPID value for operations on the input (filtering)
		side of the table. Typical values include 0x88A8 and 0x9100. (R,-W) (mandatory) (2-bytes)

	Output Tpid
		Output TPID: This attribute gives the special TPID value for operations on the output (tagging)
		side of the table. Typical values include 0x88A8 and 0x9100. (R,-W) (mandatory) (2-bytes)

	Downstream Mode
		All other values are reserved. (R, W) (mandatory) (1 byte)

	Received Frame Vlan Tagging Operation Table
		111	Set TPID-=-output TPID, DEI = 1

	Associated Me Pointer
		NOTE 5 - When the association type is xDSL, the two MSBs may be used to indicate a bearer
		channel.

	Dscp To P Bit Mapping
		NOTE 6 - If certain bits in the DSCP field are to be ignored in the mapping process, the
		attribute should be provisioned such that all possible values of those bits produce the same
		P-bit mapping. This can be applied to the case where instead of full DSCP, the operator wishes
		to adopt the priority mechanism based on IP precedence, which needs only the three MSBs of the
		DSCP field.

type FastChannelConfigurationProfile ¶

type FastChannelConfigurationProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

FastChannelConfigurationProfile (class ID #432)

This ME contains the FAST channel configuration profile for an xDSL UNI. An instance of this ME
is created and deleted by the OLT.

Relationships
	An instance of this ME may be associated with zero or more instances of the PPTP xDSL UNI part
	1.

Attributes
	Maximum Net Data Rate Maxndr
		Maximum net data rate (MAXNDR): This attribute specifies the value of the maximum net data rate.
		See clause 11.4.2.2 of [ITU-T G.9701]. Valid values range from 0 (0-kbit/s) to 4294967295
		(2^32-1-kbit/s). See clause 7.2.1.1 of [ITUT-G.997.2]. (R, W) (mandatory) (4 bytes)

	Minimum Expected Throughput Minetr
		Minimum expected throughput (MINETR): This attribute specifies the value of the minimum expected
		throughput. See clause 11.4.2.1 of [ITU-T G.9701]. Valid values range from 0 (0-kbit/s) to
		4294967295 (2^32-1-kbit/s). See clause-7.2.1.2 of [ITU-T G.997.2]. (R, W) (mandatory) (4 bytes)

	Maximum Gamma Data Rate Maxgdr
		Maximum gamma data rate (MAXGDR): This attribute specifies the maximum value of the GDR (see
		clause 7.11.1.3). The GDR shall not exceed MAXGDR at the start of showtime and during showtime.
		Valid values range from 0 (0-kbit/s) to 4294967295 (2^32-1-kbit/s). See clause 7.2.1.3 of [ITU-T
		G.997.2]. (R, W) (mandatory) (4 bytes)

	Minimum Gamma Data Rate Mingdr
		Minimum gamma data rate (MINGDR): This attribute specifies the minimum value of the GDR (see
		clause 7.11.1.3). The GDR may be lower than MINGDR. If the GDR is lower than MINGDR at
		initialization or when GDR becomes lower than MINGDR during showtime, a TCA occurs. Valid values
		range from 0 (0-kbit/s) to 4294967295 (2^32-1-kbit/s). See clause 7.2.1.4 of [ITU-T G.997.2].
		(R, W) (mandatory) (4 bytes)

	Maximum Delay Delaymax
		Maximum delay (DELAYMAX): This attribute specifies the maximum allowed delay for retransmission.
		See clause 9.8 of [ITU-T G.9701]. The ITUT-G.9701 control parameter delay_max is set to the same
		value as the maximum delay. See clause 11.4.2.3 of [ITU-T G.9701]. Valid values range from 4
		(1-ms) to 252 (63-ms) in steps of 0.25-ms. See clause 7.2.2.1 of [ITUT-G.997.2]. (R, W)
		(mandatory) (4 bytes)

	Minimum Impulse Noise Protection Against Shine Inpmin_Shine
		Minimum impulse noise protection against SHINE (INPMIN_SHINE): This attribute specifies the
		minimum INP against SHINE. See clause 9.8 of [ITU-T G.9701]. The ITU-T G.9701 control parameter
		INP_min_shine is set to the same value as the minimum INP against SHINE. See clause 11.4.2.4 of
		[ITU-T G.9701]. Valid values range from 0 to 520 (520 symbol periods). See clause 7.2.2.2 of
		[ITUT G.997.2]. (R, W) (mandatory) (2-bytes)

	Shine Ratio Shineratio
		SHINE ratio (SHINERATIO): This attribute specifies the SHINE ratio that is used in the
		definition of the expected throughput rate (ETR). See clause 9.8 of [ITUT-G.9701]. The ITU-T
		G.9701 control parameter SHINEratio is set to the same value as the SHINE ratio. See clause
		11.4.2.5 of [ITU-T G.9701]. The value is expressed in units of 0.001, Valid values range from 0
		to 100 (0.01) in steps of 0.001. See clause 7.2.2.3 of [ITU-T G.997.2]. (R, W) (mandatory)
		(1-byte)

	Minimum Impulse Noise Protection Against Rein Inpmin_Rein
		Minimum impulse noise protection against REIN (INPMIN_REIN): This attribute specifies the
		minimum INP against REIN. See clause 9.8 of [ITU-T G.9701]. The ITU-T G.9701 control parameter
		INP_min_rein is set to the same value as the minimum INP against REIN. See clause 11.4.2.6 of
		[ITU-T G.9701]. Valid values range from 0 to 63 (63-symbol periods). See clause 7.2.2.4 of
		[ITU-T G.997.2]. (R, W) (mandatory) (1 byte)

	Rein Inter_Arrival Time Iat_Rein
		(R, W) (mandatory) (1 byte)

	Minimum Reed_Solomon Rfec_Nfec Ratio Rnratio
		Minimum Reed-Solomon RFEC/NFEC ratio (RNRATIO): This attribute specifies the minimal required
		ratio, RFEC/NFEC, of Reed-Solomon code parameters. The ITU-T G.9701 control parameter rnratio is
		set to the same value as the minimum Reed-Solomon RFEC/NFEC ratio. See clause 11.4.2.8 of
		[ITUT-G.9701]. The value is expressed in units of 1/32, Valid values range from 0 to 8 (1/4).
		See clause 7.2.2.6 of [ITU-T G.997.2]. (R, W) (mandatory) (1 byte)

	Rtx_Tc Testmode Rtx_Testmode
		RTX-TC testmode (RTX_TESTMODE): This Boolean attribute specifies whether the retransmission test
		mode defined in clause 9.8.3.1.2 [ITU-T G.9701] is enabled-(true) or disabled (disabled). See
		clause 7.2.2.7 of [ITU-T G.997.2]. (R,-W) (optional) (1 byte)

type FastDataPathConfigurationProfile ¶

type FastDataPathConfigurationProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

FastDataPathConfigurationProfile (class ID #433)

This ME contains FAST the data path configuration profile for an xDSL UNI. An instance of this
ME is created and deleted by the OLT.

Relationships
	An instance of this ME may be associated with zero or more instances of the PPTP xDSL UNI part
	1.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The value 0 is
		reserved. (R, set-by-create) (mandatory) (2 bytes)

	Tps_Tc Testmode Tps_Testmode
		TPS-TC testmode (TPS_TESTMODE): This Boolean attribute specifies whether the TPSTC test mode
		defined in clause 8.3.1 [ITU-T G.9701] is enabled (true) or disabled (disabled). See clause
		7.3.1 of [ITUT-G.997.2]. (R,-W) (mandatory) (1 byte)

type FastLineInventoryAndStatusDataPart2 ¶

type FastLineInventoryAndStatusDataPart2 struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

FastLineInventoryAndStatusDataPart2 (class ID #436)

This ME contains part 3 of the FAST line inventory and status data with attributes specific to
[ITU T G.997.2]. The ONU automatically creates or deletes an instance of this ME upon the
creation or deletion of a PPTP xDSL UNI part 1.

Relationships
	This is one of the status data MEs associated with an xDSL UNI. It is required only if FAST is
	supported by the PPTP. The ONU automatically creates or deletes an instance of this ME upon
	creation or deletion of a PPTP xDSL UNI part 1 that supports these attributes.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PPTP xDSL UNI part 1. (R)
		(mandatory) (2-bytes)

	Date_Time_Stamping Of Last Successful Downstream Fra Operation Stamp_Frads
		(R) (optional) (7 bytes)

	Date_Time_Stamping Of Last Successful Upstream Fra Operation Stamp_Fraus
		Date/time-stamping of last successful upstream FRA operation (STAMP-FRAus): This parameter
		reports the date/time of the last successful FTU-O initiated FRA execution that has modified the
		bits allocation. See clause 7.10.14.6 of [ITUT-G.997.2]. The format of this parameter is the
		same as STAMPTESTNE. (R) (optional) (7 bytes)

	Date_Time_Stamping Of Last Successful Downstream Rpa Operation Stamp_Rpads
		Date/time-stamping of last successful downstream RPA operation (STAMP-RPAds): This parameter
		reports the date/time of the last successful FTU-R initiated RPA execution that has modified the
		bits allocation for the RMC. See clause-7.10.14.7 of [ITU-T G.997.2]. The format of this
		parameter is the same as STAMP-TEST-NE. (R) (optional) (7 bytes)

	Date_Time_Stamping Of Last Successful Upstream Rpa Operation Stamp_Rpaus
		Date/time-stamping of last successful upstream RPA operation (STAMP-RPAus): This parameter
		reports the date/time of the last successful FTU-O initiated RPA execution that has modified the
		bits allocation for the RMC. See clause-7.10.14.8 of [ITU-T G.997.2]. The format of this
		parameter is the same as STAMP-TEST-NE. (R) (optional) (7 bytes)

	Date_Time_Stamping Of Last Successful Downstream Tiga Operation Stamp_Tiga
		Date/time-stamping of last successful downstream TIGA operation (STAMP-TIGA): This parameter
		reports the date/time of the last successful FTU-O initiated TIGA execution. See clause
		7.10.14.9 of [ITU-T G.997.2]. The format of this parameter is the same as STAMP-TEST-NE. (R)
		(optional) (7 bytes)

type FastVectoringLineConfigurationExtensions ¶

type FastVectoringLineConfigurationExtensions struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

FastVectoringLineConfigurationExtensions (class ID #434)

This ME extends FAST line configuration MEs with attributes that are specific to vectoring. An
instance of this ME is created and deleted by the OLT.

Relationships
	An instance of this ME may be associated with zero or more instances of an xDSL UNI.////		The overall FAST line configuration MEs is modelled in several parts, all of which are
	associated together through a common ME ID (the client PPTP xDSL UNI part 3 has a single
	pointer, which refers to the entire set of line configuration parts).

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The value 0 is
		reserved. (R, set-by-create) (mandatory) (2 bytes)

	Fext Cancellation Enabling_Disabling Upstream Fext_To_Cancel_Enableus
		FEXT cancellation enabling/disabling upstream (FEXT_TO_CANCEL_ENABLEus): A value of 1 enables
		and a value of 0 disables FEXT cancellation in the upstream direction from all the other
		vectored lines into the line in the vectored group. See clause 7.1.7.2 of [ITU-T G.997.2].
		(R,-W) (mandatory) (1-byte)

	Fext Cancellation Enabling_Disabling Downstream Fext_To_Cancel_Enableds
		FEXT cancellation enabling/disabling downstream (FEXT_TO_CANCEL_ENABLEds): A value of 1 enables
		and a value of 0 disables FEXT cancellation in the downstream direction from all the other
		vectored lines into the line in the vectored group. See clause 7.1.7.1 of [ITUT-G.997.2]. (R,-W)
		(mandatory) (1-byte)

type FastXtuCPerformanceMonitoringHistoryData ¶

type FastXtuCPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

FastXtuCPerformanceMonitoringHistoryData (class ID #437)

This ME collects PM data on the xTU C to xTU R path as seen from the xTU-C. Instances of this ME
are created and deleted by the OLT.

Relationships
	An instance of this ME is associated with an xDSL UNI.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PPTP xDSL UNI part 1. (R, set-
		by-create) (mandatory) (2 bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1 byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
		that contain PM threshold values. (R, W, set-by-create) (mandatory) (2 bytes)

	Successful Fra Counter
		Successful FRA counter: This attribute counts the successful FRA primitives (success_FRA). The
		successful FRA primitive (success_FRA) is defined in clause 11.3.1.6 of [ITU-T G.9701]. See
		clause 7.7.22 of [ITU-T G.997.2]. (R) (mandatory) (4-bytes)

	Successful Rpa Counter
		Successful RPA counter: This attribute counts the successful RPA primitives (success_RPA). The
		successful RPA primitive (success_RPA) is defined in clause 11.3.1.6 of [ITU-T G.9701]. See
		clause 7.7.23 of [ITU-T G.997.2] (R) (optional) (4 bytes)

	Successful Tiga Counter
		Successful TIGA counter: This attribute counts the successful TIGA primitives (success_TIGA).
		The successful TIGA primitive (success_TIGA) is defined in clause 11.3.1.6 of [ITU-T G.9701].
		Reported only with the near-end measured time, invalid data flag and timestamp. See clause
		7.7.24 of [ITUT-G.997.2] (R) (optional) (4 bytes)

type FastXtuRPerformanceMonitoringHistoryData ¶

type FastXtuRPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

FastXtuRPerformanceMonitoringHistoryData (class ID #438)

This ME collects PM data of the xTU C to xTU R path as seen from the xTU-R. Instances of this ME
are created and deleted by the OLT. For a complete discussion of generic PM architecture, refer
to clause I.4.

Relationships
	An instance of this ME is associated with an xDSL UNI.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PPTP xDSL UNI part 1. (R, set-
		by-create) (mandatory) (2 bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1 byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
		that contain PM threshold values. (R, W, set-by-create) (mandatory) (2 bytes)

	Successful Fra Counter
		Successful FRA counter: This attribute counts the successful FRA primitives (success_FRA). The
		successful FRA primitive (success_FRA) is defined in clause 11.3.1.6 of [ITU-T G.9701]. See
		clause 7.7.22 of [ITU-T G.997.2] (R) (mandatory) (4-bytes)

	Successful Rpa Counter
		Successful RPA counter: This attribute counts the successful RPA primitives (success_RPA). The
		successful RPA primitive (success_RPA) is defined in clause 11.3.1.6 of [ITU-T G.9701]. See
		clause 7.7.23 of [ITU-T G.997.2] (R) (optional) (4 bytes)

type GalEthernetPerformanceMonitoringHistoryData ¶

type GalEthernetPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

GalEthernetPerformanceMonitoringHistoryData (class ID #276)

This ME collects PM data associated with a GEM IW TP when the GEM layer supports an Ethernet
service. Instances of this ME are created and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the GEM IW TP ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the GEM IW TP. (R, setbycreate)
		(mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Discarded Frames
		Discarded frames: This attribute counts the number of downstream GEM frames discarded for any
		reason [erroneous frame check sequence (FCS), too long length, buffer overflow, etc.]. (R)
		(mandatory) (4-bytes)

type GalEthernetProfile ¶

type GalEthernetProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

GalEthernetProfile (class ID #272)

This ME organizes data that describe the gigabit-capable passive optical network transmission
convergence layer (GTC) adaptation layer processing functions of the ONU for Ethernet services.
It is used with the GEM IW TP ME.

Instances of this ME are created and deleted on request of the OLT.

Relationships
	An instance of this ME may be associated with zero or more instances of the GEM IW TP ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Maximum Gem Payload Size
		Maximum GEM payload size: This attribute defines the maximum payload size generated in the
		associated GEM IW TP ME. (R,-W, setbycreate) (mandatory) (2-bytes)

type GemInterworkingTerminationPoint ¶

type GemInterworkingTerminationPoint struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

GemInterworkingTerminationPoint (class ID #266)

An instance of this ME represents a point in the ONU where the IW of a bearer service (usually
Ethernet) to the GEM layer takes place. At this point, GEM packets are generated from the bearer
bit stream (e.g., Ethernet) or the bearer bit stream is reconstructed from GEM packets.

Instances of this ME are created and deleted by the OLT.

Relationships
	One instance of this ME exists for each transformation of a data stream into GEM frames and vice
	versa.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Gem Port Network Ctp Connectivity Pointer
		GEM port network CTP connectivity pointer: This attribute points to an instance of the GEM port
		network CTP. (R,-W, setbycreate) (mandatory) (2-bytes)

	Interworking Option
		(R,-W, setbycreate) (mandatory) (1-byte)

	Service Profile Pointer
		NOTE - The video return path (VRP) service profile is defined in [ITU-T G.984.4].

	Interworking Termination Point Pointer
		In all other GEM services, the relationship between the related service TP and this GEM IW TP is
		derived from other ME relations; this attribute is set to a null pointer and not used. (R,-W,
		setbycreate) (mandatory) (2-bytes)

	Pptp Counter
		PPTP counter: This value reports the number of PPTP ME instances associated with this GEM IW TP.
		(R) (optional) (1-byte)

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Gal Profile Pointer
		(R,-W, setbycreate) (mandatory) (2-bytes)

	Gal Loopback Configuration
		The default value of this attribute is 0. When the IW option is 6 (downstream broadcast), this
		attribute is not used. (R,-W) (mandatory) (1-byte)

type GemPortNetworkCtp ¶

type GemPortNetworkCtp struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

GemPortNetworkCtp (class ID #268)

This ME represents the termination of a GEM port on an ONU. This ME aggregates connectivity
functionality from the network view and alarms from the network element view as well as
artefacts from trails.

Instances of the GEM port network CTP ME are created and deleted by the OLT. An instance of GEM
port network CTP can be deleted only when no GEM IW TP or GEM port network CTP PM history data
are associated with it. It is the responsibility of the OLT to make sure that the ONU
configuration meets this condition.

In ITU-T G.984 systems, when a GEM port network CTP is created, its encryption state is by
default not encrypted. If the OLT wishes to configure the GEM port to use encryption, it must
send the appropriate PLOAM message. This applies equally to new CTPs and to CTPs that are re-
created after an MIB reset.

In ITU-T G.987 systems, GEM ports are dynamically encrypted. If it is intended to encrypt the
GEM port, the OLT must configure a key ring to be used, and the key must be known to the ONU at
run time.

Relationships
	An instance of the GEM port network CTP ME may be associated with an instance of the T-CONT and
	GEM IW TP MEs.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Port_Id
		NOTE 1 - While nothing forbids the existence of several GEM port network CTPs with the same
		port-ID value, downstream traffic is modelled as being delivered to all such GEM port network
		CTPs. Be aware of potential difficulties associated with defining downstream flows and
		aggregating PM statistics.

	T_Cont Pointer
		T-CONT pointer: This attribute points to a T-CONT instance. (R,-W, setbycreate) (mandatory)
		(2-bytes)

	Direction
		Direction:	This attribute specifies whether the GEM port is used for UNI-to-ANI (1), ANI-to-UNI
		(2), or bidirectional (3) connection. (R,-W, setbycreate) (mandatory) (1-byte)

	Traffic Management Pointer For Upstream
		Traffic management pointer for upstream: If the traffic management option attribute in the ONU-G
		ME is 0 (priority controlled) or 2 (priority and rate controlled), this pointer specifies the
		priority queue ME serving this GEM port network CTP. If the traffic management option attribute
		is 1 (rate controlled), this attribute redundantly points to the TCONT serving this GEM port
		network CTP. (R,-W, setbycreate) (mandatory) (2-bytes)

	Traffic Descriptor Profile Pointer For Upstream
		See also Appendix II.

	Uni Counter
		UNI counter: This attribute reports the number of instances of UNI-G ME associated with this GEM
		port network CTP. (R) (optional) (1-byte)

	Priority Queue Pointer For Down Stream
		NOTE 2 - If the GEM port network CTP is associated with more than one UNI (downstream
		multicast), the downstream priority queue pointer defines a pattern (e.g., queue number 3 for a
		given UNI) to be replicated (i.e., to queue number 3) at the other affected UNIs.

	Encryption State
		Encryption state: This attribute indicates the current state of the GEM port network CTP's
		encryption. Legal values are defined to be the same as those of the security mode attribute of
		the ONU2-G, with the exception that attribute value 0 indicates an unencrypted GEM port. (R)
		(optional) (1-byte)

	Traffic Descriptor Profile Pointer For Downstream
		See also Appendix II.

	Encryption Key Ring
		Other values are reserved.

type GemPortNetworkCtpPerformanceMonitoringHistoryData ¶

type GemPortNetworkCtpPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

GemPortNetworkCtpPerformanceMonitoringHistoryData (class ID #341)

This ME collects GEM frame PM data associated with a GEM port network CTP. Instances of this ME
are created and deleted by the OLT.

NOTE 1 - One might expect to find some form of impaired or discarded frame count associated with
a GEM port. However, the only impairment that might be detected at the GEM frame level would be
a corrupted GEM frame header. In this case, no part of the header could be considered reliable
including the port ID. For this reason, there is no impaired or discarded frame count in this
ME.

NOTE 2 - This ME replaces the GEM port performance history data ME and is preferred for new
implementations.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the GEM port network CTP ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the GEM port network CTP. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Transmitted Gem Frames
		Transmitted GEM frames: This attribute counts GEM frames transmitted on the monitored GEM port.
		(R) (mandatory) (4-bytes)

	Received Gem Frames
		Received GEM frames: This attribute counts GEM frames received correctly on the monitored GEM
		port. A correctly received GEM frame is one that does not contain uncorrectable errors and has a
		valid header error check (HEC). (R) (mandatory) (4-bytes)

	Received Payload Bytes
		Received payload bytes: This attribute counts user payload bytes received on the monitored GEM
		port. (R) (mandatory) (8-bytes)

	Transmitted Payload Bytes
		Transmitted payload bytes: This attribute counts user payload bytes transmitted on the monitored
		GEM port. (R) (mandatory) (8-bytes)

	Encryption Key Errors
		NOTE 4 - GEM PM counts each non-idle GEM frame, whether it contains an entire user frame or only
		a fragment of a user frame.

type IManagedEntity ¶ added in v0.0.7

type IManagedEntity interface {
	IManagedEntityDefinition
	GetManagedEntityDefinition() IManagedEntityDefinition

	GetEntityID() uint16
	SetEntityID(uint16) error

	GetAttributeMask() uint16

	GetAttributeValueMap() AttributeValueMap
	GetAttribute(string) (interface{}, error)
	GetAttributeByIndex(uint) (interface{}, error)

	SetAttribute(string, interface{}) error
	SetAttributeByIndex(uint, interface{}) error

	DeleteAttribute(string) error
	DeleteAttributeByIndex(uint) error
}

type IManagedEntityDefinition ¶

type IManagedEntityDefinition interface {
	GetName() string
	GetClassID() ClassID
	GetMessageTypes() mapset.Set
	GetAllowedAttributeMask() uint16
	GetAttributeDefinitions() AttributeDefinitionMap

	DecodeAttributes(uint16, []byte, gopacket.PacketBuilder, byte) (AttributeValueMap, error)
	SerializeAttributes(AttributeValueMap, uint16, gopacket.SerializeBuffer, byte, int, bool) (error, uint16)
}

type IOctetStream ¶ added in v0.10.0

type IOctetStream interface {
	ToOctetString() ([]byte, error)
	FromOctetString([]byte) (interface{}, error)
}

IOctetStream interface defines a way to convert a custom type to/from an octet stream.

type Ieee8021PMapperServiceProfile ¶

type Ieee8021PMapperServiceProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Ieee8021PMapperServiceProfile (class ID #130)

This ME associates the priorities of IEEE 802.1p [IEEE 802.1D] priority tagged frames with
specific connections. This ME directs upstream traffic to the designated GEM ports. Downstream
traffic arriving on any of the IEEE 802.1p mapper's GEM ports is directed to the mapper's root
TP. Other mechanisms exist to direct downstream traffic, specifically a direct pointer to a
downstream queue from the GEM port network CTP. If such an alternative is used, it should be
provisioned to be consistent with the flow model of the mapper.

Instances of this ME are created and deleted by the OLT.

Relationships
	At its root, an instance of this ME may be associated with zero or one instance of a PPTP UNI,
	MAC bridge port configuration data, or any type of IW TP ME that carries IEEE 802 traffic. Each
	of its eight branches is associated with zero or one GEM IW TP.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Tp Pointer
		(R,-W, setbycreate) (mandatory) (2-bytes)

	Interwork Tp Pointer For P_Bit Priority 0
		Interwork TP pointer for P-bit priority 0:	(R,-W, setbycreate) (mandatory) (2-bytes)

	Interwork Tp Pointer For P_Bit Priority 1
		Interwork TP pointer for P-bit priority 1:	(R,-W, setbycreate) (mandatory) (2-bytes)

	Interwork Tp Pointer For P_Bit Priority 2
		Interwork TP pointer for P-bit priority 2:	(R,-W, setbycreate) (mandatory) (2-bytes)

	Interwork Tp Pointer For P_Bit Priority 3
		Interwork TP pointer for P-bit priority 3:	(R,-W, setbycreate) (mandatory) (2-bytes)

	Interwork Tp Pointer For P_Bit Priority 4
		Interwork TP pointer for P-bit priority 4:	(R,-W, setbycreate) (mandatory) (2-bytes)

	Interwork Tp Pointer For P_Bit Priority 5
		Interwork TP pointer for P-bit priority 5:	(R,-W, setbycreate) (mandatory) (2-bytes)

	Interwork Tp Pointer For P_Bit Priority 6
		Interwork TP pointer for P-bit priority 6:	(R,-W, setbycreate) (mandatory) (2-bytes)

	Interwork Tp Pointer For P_Bit Priority 7
		Interwork TP pointer for P-bit priority 7:	(R,-W, setbycreate) (mandatory) (2-bytes)

	Unmarked Frame Option
		Untagged downstream frames are passed through the mapper transparently.

	Dscp To P Bit Mapping
		NOTE - If certain bits in the DSCP field are to be ignored in the mapping process, the attribute
		should be provisioned such that all possible values of those bits produce the same P-bit
		mapping. This can be applied to the case where instead of full DSCP, the operator wishes to
		adopt the priority mechanism based on IP precedence, which needs only the three MSBs of the DSCP
		field.

	Default P Bit Assumption
		Default P-bit assumption: This attribute is valid when the unmarked frame option attribute is
		set to 1. In its LSBs, the default Pbit assumption attribute contains the default PCP field to
		be assumed. The unmodified frame is then directed to the GEM IW TP indicated by the interwork TP
		pointer mappings. (R,-W, setbycreate) (mandatory) (1-byte)

	Tp Type
		(R,-W, setbycreate) (optional) (1-byte)

type InstanceExistsError ¶

type InstanceExistsError struct {
	OmciError
}

InstanceExistsError means that the ONU already has a managed entity instance that corresponds to the one the OLT is attempting to create.

type InterworkingVccTerminationPoint ¶

type InterworkingVccTerminationPoint struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

InterworkingVccTerminationPoint (class ID #14)

An instance of this ME represents a point in the ONU where the IW of a service or underlying
physical infrastructure (e.g., ADSL) to an ATM layer takes place. At this point, ATM cells are
generated from a bit stream (e.g., Ethernet) or a bit stream is reconstructed from ATM cells.

Instances of this ME are created and deleted by the OLT.

Relationships
	One instance of this ME exists for each occurrence of transformation of a data stream into ATM
	cells and vice versa.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R,-setbycreate)
		(mandatory) (2-bytes)

	Vci Value
		VCI value:	This attribute identifies the VCI value associated with this IW VCC TP. (R,-W,
		setbycreate) (mandatory) (2-bytes)

	Vp Network Ctp Connectivity Pointer
		VP network CTP connectivity pointer: This attribute points to the VP network CTP associated with
		this IW VCC TP. (R,-W, setbycreate) (mandatory) (2-bytes)

	Deprecated 1
		Deprecated 1: Not used; should be set to 0. (R,-W, setbycreate) (mandatory) (1-byte)

	Deprecated 2
		Deprecated 2: Not used; should be set to 0. (R,-W, setbycreate) (mandatory) (2-bytes)

	Aal5 Profile Pointer
		AAL5 profile pointer: This attribute points to an instance of the AAL5 profile. (R,-W,
		setbycreate) (mandatory) (2-bytes)

	Deprecated 3
		Deprecated 3: Not used; should be set to 0. (R,-W, setbycreate) (mandatory) (2-bytes)

	Aal Loopback Configuration
		The default value of this attribute is 0. (R,-W) (mandatory) (1-byte)

	Pptp Counter
		PPTP counter: This value is the number of instances of PPTP MEs associated with this instance of
		the IW VCC TP. (R) (optional) (1-byte)

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

type IpHostConfigData ¶

type IpHostConfigData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

IpHostConfigData (class ID #134)

The IP host config data configures IPv4 based services offered on the ONU. The ONU automatically
creates instances of this ME if IP host services are available. A possible IPv6 stack is
supported through the IPv6 host config data ME. In this clause, references to IP addresses are
understood to mean IPv4.

Relationships
	An instance of this ME is associated with the ONU ME. Any number of TCP/UDP config data MEs can
	point to the IP host config data, to model any number of ports and protocols. Performance may be
	monitored through an implicitly linked IP host PM history data ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The ONU creates
		as many instances as there are independent IPv4 stacks on the ONU. To facilitate discovery, IP
		host config data MEs should be numbered from 0 upwards. The ONU should create IP(v4) and IPv6
		host config data MEs with separate ME IDs, such that other MEs can use a single TP type
		attribute to link with either. (R) (mandatory) (2 bytes)

	Ip Options
		(R,-W) (mandatory) (1-byte)

	Mac Address
		MAC address: This attribute indicates the MAC address used by the IP node. (R) (mandatory)
		(6-bytes)

	Onu Identifier
		Onu identifier: A unique ONU identifier string. If set to a non-null value, this string is used
		instead of the MAC address in retrieving dynamic host configuration protocol (DHCP) parameters.
		If the string is shorter than 25 characters, it must be null terminated. Its default value is 25
		null bytes. (R,-W) (mandatory) (25-bytes)

	Ip Address
		IP address:	The address used for IP host services; this attribute has the default value 0.
		(R,-W) (mandatory) (4-bytes)

	Mask
		Mask:	The subnet mask for IP host services; this attribute has the default value 0. (R,-W)
		(mandatory) (4-bytes)

	Gateway
		Gateway:	The default gateway address used for IP host services; this attribute has the default
		value 0. (R,-W) (mandatory) (4-bytes)

	Primary Dns
		Primary DNS: The address of the primary DNS server; this attribute has the default value 0.
		(R,-W) (mandatory) (4-bytes)

	Secondary Dns
		Secondary DNS: The address of the secondary DNS server; this attribute has the default value 0.
		(R,-W) (mandatory) (4-bytes)

	Current Address
		Current address: Current address of the IP host service. (R) (optional) (4-bytes)

	Current Mask
		Current mask: Current subnet mask for the IP host service. (R) (optional) (4-bytes)

	Current Gateway
		Current gateway: Current default gateway address for the IP host service. (R) (optional)
		(4-bytes)

	Current Primary Dns
		Current primary DNS: Current primary DNS server address. (R) (optional) (4-bytes)

	Current Secondary Dns
		Current secondary DNS: Current secondary DNS server address. (R) (optional) (4-bytes)

	Domain Name
		Domain name: If DHCP indicates a domain name, it is presented here. If no domain name is
		indicated, this attribute is set to a null string. If the string is shorter than 25-bytes, it
		must be null terminated. The default value is 25 null bytes. (R) (mandatory) (25-bytes)

	Host Name
		Host name:	If DHCP indicates a host name, it is presented here. If no host name is indicated,
		this attribute is set to a null string. If the string is shorter than 25-bytes, it must be null
		terminated. The default value is 25 null bytes. (R) (mandatory) (25-bytes)

	Relay Agent Options
		2/3/4:atm/123.4567

type IpHostPerformanceMonitoringHistoryData ¶

type IpHostPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

IpHostPerformanceMonitoringHistoryData (class ID #135)

This ME collects PM data related to an IP host. Instances of this ME are created and deleted by
the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the IP host config data or IPv6 host
	config data ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the IP host configuration data or
		IPv6 host configuration data ME. (R, set-by-create) (mandatory) (2 bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, set-by-create) (mandatory) (2-bytes)

	Icmp Errors
		ICMP errors: This attribute counts ICMP errors received. (R) (mandatory) (4-bytes)

	Dns Errors
		DNS errors:	This attribute counts DNS errors received. (R) (mandatory) (4-bytes)

	Dhcp Timeouts
		DHCP timeouts:	This attribute counts DHCP timeouts. (R) (optional) (2 bytes)

	Ip Address Conflict
		IP address conflict: This attribute is incremented whenever the ONU detects a conflicting IP
		address on the network. A conflicting IP address is one that has the same value as the one
		currently assigned to the ONU. (R) (optional) (2 bytes)

	Out Of Memory
		Out of memory: This attribute is incremented whenever the ONU encounters an out of memory
		condition in the IP stack. (R) (optional) (2 bytes)

	Internal Error
		Internal error: This attribute is incremented whenever the ONU encounters an internal error
		condition such as a driver interface failure in the IP stack. (R) (optional) (2-bytes)

type MacBridgeConfigurationData ¶

type MacBridgeConfigurationData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgeConfigurationData (class ID #46)

This ME organizes status data associated with a MAC bridge. The ONU automatically creates or
deletes an instance of this ME upon the creation or deletion of a MAC bridge service profile.

Relationships
	This ME is associated with one instance of a MAC bridge service profile.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge service profile. (R)
		(mandatory) (2-bytes)

	Bridge Mac Address
		Bridge MAC address: This attribute indicates the MAC address used by the bridge. The ONU sets
		this attribute to a value based on criteria beyond the scope of this Recommendation, e.g.,
		factory settings. (R) (mandatory) (6-bytes)

	Bridge Priority
		Bridge priority: This attribute reports the priority of the bridge. The ONU copies this
		attribute from the priority attribute of the associated MAC bridge service profile. The value of
		this attribute changes with updates to the MAC bridge service profile priority attribute. (R)
		(mandatory) (2-bytes)

	Designated Root
		Designated root: This attribute identifies the bridge at the root of the spanning tree. It
		comprises bridge priority (2-bytes) and MAC address (6-bytes). (R) (mandatory) (8-bytes)

	Root Path Cost
		Root path cost: This attribute reports the cost of the best path to the root as seen from this
		bridge. Upon ME instantiation, the ONU sets this attribute to 0. (R) (mandatory) (4-bytes)

	Bridge Port Count
		Bridge port count: This attribute records the number of ports linked to this bridge. (R)
		(mandatory) (1-byte)

	Root Port Num
		Root port num: This attribute contains the port number that has the lowest cost from the bridge
		to the root bridge. The value 0 means that this bridge is itself the root. Upon ME
		instantiation, the ONU sets this attribute to 0. (R) (mandatory) (2-bytes)

	Hello Time
		NOTE - [IEEE 802.1D] specifies the compatibility range for hello time to be 1..2-s.

	Forward Delay
		Forward delay: This attribute is the forwarding delay time received from the designated root (in
		256ths of a second). Its range is 0x0400 to 0x1E00 (4..30-s) in accordance with [IEEE 802.1D].
		(R) (optional) (2-bytes)

type MacBridgePerformanceMonitoringHistoryData ¶

type MacBridgePerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePerformanceMonitoringHistoryData (class ID #51)

This ME collects PM data associated with a MAC bridge. Instances of this ME are created and
deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	This ME is associated with an instance of a MAC bridge service profile.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge service profile. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. Since no threshold value attribute number exceeds 7, a threshold data 2
		ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Bridge Learning Entry Discard Count
		Bridge learning entry discard count: This attribute counts forwarding database entries that have
		been or would have been learned, but were discarded or replaced due to a lack of space in the
		database table. When used with the MAC learning depth attribute of the MAC bridge service
		profile, the bridge learning entry discard count may be particularly useful in detecting MAC
		spoofing attempts. (R) (mandatory) (4-bytes)

type MacBridgePortBridgeTableData ¶ added in v0.1.0

type MacBridgePortBridgeTableData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePortBridgeTableData (class ID #50)

This ME reports status data associated with a bridge port. The ONU automatically creates or
deletes an instance of this ME upon the creation or deletion of a MAC bridge port configuration
data.

Relationships
	An instance of this ME is associated with an instance of a MAC bridge port configuration data
	ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge port configuration
		data ME. (R) (mandatory) (2-bytes)

	Bridge Table
		Upon ME instantiation, this attribute is an empty list. (R) (mandatory) (8-*-M-bytes, where M is
		the number of entries in the list.)

type MacBridgePortConfigurationData ¶

type MacBridgePortConfigurationData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePortConfigurationData (class ID #47)

This ME models a port on a MAC bridge. Instances of this ME are created and deleted by the OLT.

Relationships
	An instance of this ME is linked to an instance of the MAC bridge service profile. Additional
	bridge port control capabilities are provided by implicitly linked instances of some or all of:////		o	MAC bridge port filter table data;////		o	MAC bridge port filter pre-assign table;////		o	VLAN tagging filter data;////		o	Dot1 rate limiter.////		Real-time status of the bridge port is provided by implicitly linked instances of:////		o	MAC bridge port designation data;////		o	MAC bridge port bridge table data;////		o	Multicast subscriber monitor.////		Bridge port PM collection is provided by implicitly linked instances of:////		o	MAC bridge port PM history data;////		o	Ethernet frame PM history data upstream and downstream;////		o	Ethernet frame extended PM (preferred).

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Bridge Id Pointer
		Bridge ID pointer: This attribute points to an instance of the MAC bridge service profile.
		(R,-W, setbycreate) (mandatory) (2-bytes)

	Port Num
		Port num:	This attribute is the bridge port number. It must be unique among all ports associated
		with a particular MAC bridge service profile. (R,-W, setbycreate) (mandatory) (1-byte)

	Tp Type
		(R,-W, setbycreate) (mandatory) (1-byte)

	Tp Pointer
		NOTE 1 - When the TP type is very high-speed digital subscriber line (VDSL) or xDSL, the two
		MSBs may be used to indicate a bearer channel.

	Port Priority
		Port priority:	This attribute denotes the priority of the port for use in (rapid) spanning tree
		algorithms. The range is 0..255. (R,-W, setbycreate) (optional) (2-bytes)

	Port Path Cost
		Port path cost: This attribute specifies the contribution of the port to the path cost towards
		the spanning tree root bridge. The range is 1..65535. (R,-W, setbycreate) (mandatory) (2-bytes)

	Port Spanning Tree Ind
		Port spanning tree ind: The Boolean value true enables (R)STP LAN topology change detection at
		this port. The value false disables topology change detection. (R,-W, setbycreate) (mandatory)
		(1-byte)

	Deprecated 1
		Deprecated 1: This attribute is not used. If present, it should be ignored by both the ONU and
		the OLT, except as necessary to comply with OMCI message definitions. (R,-W, setbycreate)
		(optional) (1-byte)

	Deprecated 2
		Deprecated 2: This attribute is not used. If present, it should be ignored by both the ONU and
		the OLT, except as necessary to comply with OMCI message definitions. (R,-W, setbycreate)
		(1-byte) (optional)

	Port Mac Address
		Port MAC address: If the TP associated with this port has a MAC address, this attribute
		specifies it. (R) (optional) (6-bytes)

	Outbound Td Pointer
		Outbound TD pointer: This attribute points to a traffic descriptor that limits the traffic rate
		leaving the MAC bridge. (R,-W) (optional) (2-byte)

	Inbound Td Pointer
		Inbound TD pointer: This attribute points to a traffic descriptor that limits the traffic rate
		entering the MAC bridge. (R,-W) (optional) (2-byte)

	Mac Learning Depth
		NOTE 2 - If this attribute is not zero, its value overrides the value set in the MAC learning
		depth attribute of the MAC bridge service profile.

type MacBridgePortDesignationData ¶

type MacBridgePortDesignationData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePortDesignationData (class ID #48)

This ME records data associated with a bridge port. The ONU automatically creates or deletes an
instance of this managed entity upon the creation or deletion of a MAC bridge port configuration
data ME.

Relationships
	An instance of this managed entity is associated with one MAC bridge port configuration data ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge port configuration
		data. (R) (mandatory) (2-bytes)

	Designated Bridge Root Cost Port
		Upon ME instantiation, the ONU sets this attribute to 0. (R) (mandatory) (24-bytes)

	Port State
		The value (R)stp_off is introduced to denote the port status where the (rapid) spanning tree
		protocol has been disabled by setting the port spanning tree ind attribute of the MAC bridge
		port configuration data to false, and the Ethernet link state is up. This value distinguishes
		whether frame forwarding is under the control of (R)STP.

type MacBridgePortFilterPreAssignTable ¶

type MacBridgePortFilterPreAssignTable struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePortFilterPreAssignTable (class ID #79)

This ME provides an alternate approach to DA filtering from that supported through the MAC
bridge port filter table data ME. This alternate approach is useful when all groups of addresses
are stored beforehand in the ONU, and the MAC bridge port filter pre-assign table ME designates
which groups are valid or invalid for filtering. On a circuit pack in which all groups of
addresses are pre-assigned and stored locally, the ONU creates or deletes an instance of this ME
automatically upon creation or deletion of a MAC bridge port configuration data ME.

Relationships
	An instance of this ME is associated with an instance of a MAC bridge port configuration data
	ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge port configuration
		data ME. (R) (mandatory) (2-bytes)

	Ipv4 Multicast Filtering
		IPv4 multicast filtering:	(R,-W) (mandatory) (1-byte)

	Ipv6 Multicast Filtering
		IPv6 multicast filtering:	(R,-W) (mandatory) (1-byte)

	Ipv4 Broadcast Filtering
		IPv4 broadcast filtering:	(R,-W) (mandatory) (1-byte)

	Rarp Filtering
		RARP filtering:	(R,-W) (mandatory) (1-byte)

	Ipx Filtering
		IPX filtering:		(R,-W) (mandatory) (1-byte)

	Netbeui Filtering
		NetBEUI filtering:	(R,-W) (mandatory) (1-byte)

	Appletalk Filtering
		AppleTalk filtering:	(R,-W) (mandatory) (1-byte)

	Bridge Management Information Filtering
		2	Addresses from 01.80.C2.00.00.20 to 01.80.C2.00.00.2F are used for generic attribute
		registration protocol (GARP) applications.

	Arp Filtering
		ARP filtering:	(R,-W) (mandatory) (1-byte)

	Point_To_Point Protocol Over Ethernet Pppoe Broadcast Filtering
		Point-to-point protocol over Ethernet (PPPoE) broadcast filtering:	(R,-W) (mandatory) (1-byte)

type MacBridgePortFilterTableData ¶ added in v0.1.0

type MacBridgePortFilterTableData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePortFilterTableData (class ID #49)

This ME organizes data associated with a bridge port. The ONU automatically creates or deletes
an instance of this ME upon the creation or deletion of a MAC bridge port configuration data ME.

NOTE - The OLT should disable the learning mode in the MAC bridge service profile before writing
to the MAC filter table.

Relationships
	An instance of this ME is associated with an instance of a MAC bridge port configuration data
	ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge port configuration
		data ME. (R) (mandatory) (2-bytes)

	Mac Filter Table
		(R,-W) (Mandatory) (8N bytes, where N is the number of entries in the list)

type MacBridgePortIcmpv6ProcessPreAssignTable ¶

type MacBridgePortIcmpv6ProcessPreAssignTable struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePortIcmpv6ProcessPreAssignTable (class ID #348)

This ME provides an approach to ICMPv6 message processing configuration to those ONUs that
support IPv6 awareness. For every message, the MAC bridge port ICMPv6 process pre-assign table
can designate a forward, discard or snoop operation. The ONU creates or deletes an instance of
this ME automatically upon creation or deletion of a MAC bridge port configuration data ME.

The MAC bridge port ICMPv6 process pre-assign table ME filters layer 2 traffic between the UNI
and ANI. The operation of this ME is completely independent of the operation and traffic
generated or received by a possible IPv6 host config data ME.

Relationships
	An instance of this ME is associated with an instance of a MAC bridge port configuration data
	ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge port configuration
		data ME. (R) (mandatory) (2-bytes)

	Icmpv6 Error Messages Processing
		ICMPv6 error messages processing:	(R,-W) (mandatory) (1-byte)

	Icmpv6 Informational Messages Processing
		ICMPv6 informational messages processing:	(R,-W) (mandatory) (1-byte)

	Router Solicitation Processing
		Router solicitation processing:	(R,-W) (mandatory) (1-byte)

	Router Advertisement Processing
		Router advertisement processing:	(R,-W) (mandatory) (1-byte)

	Neighbour Solicitation Processing
		Neighbour solicitation processing:	(R,-W) (mandatory) (1-byte)

	Neighbour Advertisement Processing
		Neighbour advertisement processing:	(R,-W) (mandatory) (1-byte)

	Redirect Processing
		Redirect processing:	(R,-W) (mandatory) (1-byte)

	Multicast Listener Query Processing
		NOTE - If the ONU participates in multicast services, MLD queries should be controlled through
		the multicast operations profile ME. In such a case, it is strongly recommended not to provision
		the downstream direction of the multicast listener query processing attribute to any value other
		than forwarding.

	Unknown Icmpv6 Processing
		Unknown ICMPv6 processing:	(R,-W) (mandatory) (1-byte)

type MacBridgePortPerformanceMonitoringHistoryData ¶

type MacBridgePortPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePortPerformanceMonitoringHistoryData (class ID #52)

This ME collects PM data associated with a MAC bridge port. Instances of this ME are created and
deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of a MAC bridge port configuration data
	ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge port configuration
		data ME. (R, setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Forwarded Frame Counter
		Forwarded frame counter: This attribute counts frames transmitted successfully on this port. (R)
		(mandatory) (4-bytes)

	Delay Exceeded Discard Counter
		Delay exceeded discard counter: This attribute counts frames discarded on this port because
		transmission was delayed. (R) (mandatory) (4-bytes)

	Maximum Transmission Unit Mtu Exceeded Discard Counter
		Maximum transmission unit (MTU) exceeded discard counter: This attribute counts frames discarded
		on this port because the MTU was exceeded. (R) (mandatory) (4-bytes)

	Received Frame Counter
		Received frame counter: This attribute counts frames received on this port. (R) (mandatory)
		(4-bytes)

	Received And Discarded Counter
		Received and discarded counter: This attribute counts frames received on this port that were
		discarded due to errors. (R) (mandatory) (4-bytes)

type MacBridgeServiceProfile ¶

type MacBridgeServiceProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgeServiceProfile (class ID #45)

This ME models a MAC bridge in its entirety; any number of ports may be associated with the
bridge through pointers to the MAC bridge service profile ME. Instances of this ME are created
and deleted by the OLT.

Relationships
	Bridge ports are modelled by MAC bridge port configuration data MEs, any number of which can
	point to a MAC bridge service profile. The real-time status of the bridge is available from an
	implicitly linked MAC bridge configuration data ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The first byte
		is the slot ID. In an integrated ONU, this value is 0. The second byte is the bridge group ID.
		(R, setbycreate) (mandatory) (2-bytes)

	Spanning Tree Ind
		Spanning tree ind: The Boolean value true specifies that a spanning tree algorithm is enabled.
		The value false disables (rapid) spanning tree. (R,-W, setbycreate) (mandatory) (1-byte)

	Learning Ind
		Learning ind: The Boolean value true specifies that bridge learning functions are enabled. The
		value false disables bridge learning. (R,-W, setbycreate) (mandatory) (1-byte)

	Port Bridging Ind
		Port bridging ind: The Boolean value true specifies that bridging between UNI ports is enabled.
		The value false disables local bridging. (R,-W, setbycreate) (mandatory) (1-byte)

	Priority
		Priority:	This attribute specifies the bridge priority in the range 0..65535. The value of this
		attribute is copied to the bridge priority attribute of the associated MAC bridge configuration
		data ME. (R,-W, setbycreate) (mandatory) (2-bytes)

	Max Age
		Max age:	This attribute specifies the maximum age (in 256ths of a second) of received protocol
		information before its entry in the spanning tree listing is discarded. The range is 0x0600 to
		0x2800 (6..40-s) in accordance with [IEEE-802.1D]. (R,-W, setbycreate) (mandatory) (2-bytes)

	Hello Time
		NOTE - [IEEE 802.1D] specifies the compatibility range for hello time to be 1..2-s.

	Forward Delay
		Forward delay: This attribute specifies the forwarding delay (in 256ths of a second) when the
		bridge acts as the root. The range is 0x0400 to 0x1E00 (4..30-s) in accordance with [IEEE
		802.1D]. (R,-W, set-by-create) (mandatory) (2-bytes)

	Unknown Mac Address Discard
		Unknown MAC address discard: The Boolean value true specifies that MAC frames with unknown DAs
		be discarded. The value false specifies that such frames be forwarded to all allowed ports.
		(R,-W, setbycreate) (mandatory) (1-byte)

	Mac Learning Depth
		MAC learning depth: This attribute specifies the maximum number of UNI MAC addresses to be
		learned by the bridge. The default value 0 specifies that there is no administratively imposed
		limit. (R,-W, setbycreate) (optional) (1-byte)

	Dynamic Filtering Ageing Time
		Dynamic filtering ageing time: This attribute specifies the age of dynamic filtering entries in
		the bridge database, after which unrefreshed entries are discarded. In accordance with clause
		7.9.2 of [IEEE 802.1D] and clause 8.8.3 of [IEEE 802.1Q], the range is 10..1 000 000-s, with a
		resolution of 1-s and a default of 300-s. The value 0 specifies that the ONU uses its internal
		default. (R, W, set-by-create) (optional) (4 bytes)

type ManagedEntity ¶ added in v0.0.7

type ManagedEntity struct {
	// contains filtered or unexported fields
}

ManagedEntity provides a complete instance of a Managed Entity

func (entity *ManagedEntity) DecodeAttributes(mask uint16, data []byte, p gopacket.PacketBuilder, msgType byte) (AttributeValueMap, error)

func (entity *ManagedEntity) DecodeFromBytes(data []byte, p gopacket.PacketBuilder, msgType byte) error

func (entity *ManagedEntity) DeleteAttribute(name string) error

func (entity *ManagedEntity) DeleteAttributeByIndex(index uint) error

func (entity ManagedEntity) GetAllowedAttributeMask() uint16

func (entity *ManagedEntity) GetAttribute(name string) (interface{}, error)

func (entity *ManagedEntity) GetAttributeByIndex(index uint) (interface{}, error)

func (entity ManagedEntity) GetAttributeDefinitions() AttributeDefinitionMap

func (entity *ManagedEntity) GetAttributeMask() uint16

func (entity *ManagedEntity) GetAttributeValueMap() AttributeValueMap

func (entity ManagedEntity) GetClassID() ClassID

func (entity *ManagedEntity) GetEntityID() uint16

func (entity *ManagedEntity) GetManagedEntityDefinition() ManagedEntityDefinition

func (entity ManagedEntity) GetMessageTypes() mapset.Set

func (entity ManagedEntity) GetName() string

func (entity *ManagedEntity) GetRequestedAttributeMask() uint16

func (entity *ManagedEntity) SerializeAttributes(attr AttributeValueMap, mask uint16,
	b gopacket.SerializeBuffer, msgType byte, bytesAvailable int, packData bool) (error, uint16)

func (entity *ManagedEntity) SerializeTo(b gopacket.SerializeBuffer, msgType byte, bytesAvailable int, opts gopacket.SerializeOptions) error

func (entity *ManagedEntity) SetAttribute(name string, value interface{}) OmciErrors

func (entity *ManagedEntity) SetAttributeByIndex(index uint, value interface{}) error

func (entity *ManagedEntity) SetEntityID(eid uint16) error

func (entity *ManagedEntity) SetRequestedAttributeMask(mask uint16)

func (entity *ManagedEntity) String() string

type ManagedEntityDefinition ¶ added in v0.0.7

type ManagedEntityDefinition struct {
	Name         string
	ClassID      ClassID
	MessageTypes mapset.Set // Mandatory
	// TODO: Support Optional Message types  (this has just been fixed in the code generator)
	AllowedAttributeMask uint16
	AttributeDefinitions AttributeDefinitionMap
	Access               ClassAccess
	Support              ClassSupport
}

ManagedEntityDefinition defines a Manage Entity

func (bme ManagedEntityDefinition) DecodeAttributes(mask uint16, data []byte, p gopacket.PacketBuilder, msgType byte) (AttributeValueMap, error)

func (bme ManagedEntityDefinition) GetAllowedAttributeMask() uint16

func (bme ManagedEntityDefinition) GetAttributeDefinitions() AttributeDefinitionMap

func (bme ManagedEntityDefinition) GetClassID() ClassID

func (bme ManagedEntityDefinition) GetMessageTypes() mapset.Set

func (bme ManagedEntityDefinition) GetName() string

func (bme ManagedEntityDefinition) SerializeAttributes(attr AttributeValueMap, mask uint16,
	b gopacket.SerializeBuffer, msgType byte, bytesAvailable int, packData bool) (error, uint16)

func (bme *ManagedEntityDefinition) String() string

type ManagedEntityInfo ¶

type ManagedEntityInfo struct {
	New func(params ...ParamData) (*ManagedEntity, error)
}

ManagedEntityInfo provides ManagedEntity information

type ManagedEntityMe ¶ added in v0.1.0

type ManagedEntityMe struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

ManagedEntityMe (class ID #288)

The ME describes the details of each ME that is supported by the ONU. This ME is not included in
an MIB upload.

Relationships
	One or more MEs are related to the OMCI object entity.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Its value is
		equal to the ME type value, and is the same as the code found in the ME type table attribute of
		the OMCI ME and Table-11.2.41. (R) (mandatory) (2-bytes)

	Name
		Name:	This attribute contains a 25-byte ASCII coded mnemonic tag for the ME type. Strings
		shorter than 25-bytes are padded with null characters. (R) (mandatory) (25-bytes)

	Attributes Table
		NOTE - The ME ID attribute is not included in the list, since the type of this attribute is
		fixed.

	Access
		(R) (mandatory) (1-byte)

	Alarms Table
		Alarms table: This attribute lists the alarm codes that are supported. (R) (mandatory) (Y bytes,
		where Y is the number of entries in the table.)

	Avcs Table
		AVCs table:	This attribute lists the AVCs that are supported. (R) (mandatory) (Z bytes, where Z
		is the number of entries in the table.)

	Actions
		Actions:	This attribute lists the action codes supported on this object, formatted as a bit map.
		The action codes are the MTs from Table-11.2.2-1. The LSB represents action 0, and so on. (R)
		(mandatory) (4-bytes)

	Instances Table
		Instances table: This attribute is a list of pointers to all instances of this ME. (R)
		(mandatory) (2 * V bytes, where V is the number of entries in the table.)

	Support
		(R) (mandatory) (1-byte)

type MessageTruncatedError ¶ added in v0.0.7

type MessageTruncatedError struct {
	OmciError
}

MessageTruncatedError means that the requested attributes could not be added to the frame due to size limitations. This is typically an OMCI Error returned internally by support functions in the OMCI library and used by the frame encoding routines to eventually return an AttributeFailureError result (code 1001)

type MgcConfigData ¶

type MgcConfigData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MgcConfigData (class ID #155)

The MGC config data ME defines the MGC configuration associated with an MG subscriber. It is
conditionally required for ONUs that support ITU-T H.248 VoIP services. If a non-OMCI interface
is used to manage VoIP signalling, this ME is unnecessary.

Instances of this ME are created and deleted by the OLT.

Relationships
	An instance of this ME may be associated with one or more VoIP voice CTP MEs.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Primary Mgc
		Primary MGC: This attribute points to a network address ME that contains the name (IP-address or
		resolved name) of the primary MGC that controls the signalling messages. The port is optional
		and defaults to 2944 for text message formats and 2955 for binary message formats. (R,-W,
		setbycreate) (mandatory) (2-bytes)

	Secondary Mgc
		Secondary MGC: This attribute points to a network address ME that contains the name (IP-address
		or resolved name) of the secondary or backup MGC that controls the signalling messages. The port
		is optional and defaults to 2944 for text message formats and 2955 for binary message formats.
		(R,-W, setbycreate) (mandatory) (2-bytes)

	Tcp_Udp Pointer
		TCP/UDP pointer: This attribute points to the TCP/UDP config data ME to be used for
		communication with the MGC. (R,-W, setbycreate) (mandatory) (2-bytes)

	Version
		Version:	This integer attribute reports the version of the Megaco protocol in use. The ONU
		should deny an attempt by the OLT to set or create a value that it does not support. The value 0
		indicates that no particular version is specified. (R,-W, setbycreate) (mandatory) (1-byte)

	Message Format
		The default value is recommended to be 0. (R,-W, setbycreate) (mandatory) (1-byte)

	Maximum Retry Time
		Maximum retry time: This attribute specifies the maximum retry time for MGC transactions, in
		seconds. The default value 0 specifies vendor-specific implementation. (R,-W) (optional)
		(2-bytes)

	Maximum Retry Attempts
		Maximum retry attempts: This attribute specifies the maximum number of times a message is
		retransmitted to the MGC. The recommended default value 0 specifies vendor-specific
		implementation. (R,-W, setbycreate) (optional) (2-bytes)

	Service Change Delay
		Service change delay: This attribute specifies the service status delay time for changes in line
		service status. This attribute is specified in seconds. The default value 0 specifies no delay.
		(R,-W) (optional) (2-bytes)

	Termination Id Base
		Termination ID base: This attribute specifies the base string for the ITU-T H.248 physical
		termination ID(s) for this ONU. This string is intended to uniquely identify an ONU. Vendor-
		specific termination identifiers (port IDs) are optionally added to this string to uniquely
		identify a termination on a specific ONU. (R,-W) (optional) (25-bytes)

	Softswitch
		Softswitch:	This attribute identifies the gateway softswitch vendor. The format is four ASCII
		coded alphabetic characters [A..Z] as defined in [ATIS0300220]. A value of four null bytes
		indicates an unknown or unspecified vendor. (R,-W, setbycreate) (mandatory) (4-bytes)

	Message Id Pointer
		Message ID pointer: This attribute points to a large string whose value specifies the message
		identifier string for ITU-T H.248 messages originated by the ONU. (R, W, setbycreate) (optional)
		(2 bytes)

type MgcPerformanceMonitoringHistoryData ¶

type MgcPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MgcPerformanceMonitoringHistoryData (class ID #156)

The MGC monitoring data ME provides run-time statistics for an active MGC association. Instances
of this ME are created and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the MGC config data or MGC config
	portal ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the associated MGC config data or
		to the MGC config portal ME. If a non-OMCI configuration method is used for VoIP, there can be
		only one live ME instance, associated with the MGC config portal, and with ME ID 0. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Received Messages
		Received messages: This attribute counts the number of received Megaco messages on this
		association, as defined by [ITUT H.341]. (R) (mandatory) (4-bytes)

	Received Octets
		Received octets: This attribute counts the total number of octets received on this association,
		as defined by [ITU-T H.341]. (R) (mandatory) (4-bytes)

	Sent Messages
		Sent messages: This attribute counts the total number of Megaco messages sent over this
		association, as defined by [ITU-T H.341]. (R) (mandatory) (4-bytes)

	Sent Octets
		Sent octets:	This attribute counts the total number of octets sent over this association, as
		defined by [ITU-T H.341]. (R) (mandatory) (4-bytes)

	Protocol Errors
		(R) (mandatory) (4-bytes)

	Transport Losses
		Transport losses: This attribute counts the total number of transport losses (e.g., socket
		problems) detected on this association. A link loss is defined as loss of communication with the
		remote entity due to hardware/transient problems, or problems in related software. (R)
		(mandatory) (4-bytes)

	Last Detected Event
		(R) (mandatory) (1-byte)

	Last Detected Event Time
		Last detected event time: This attribute reports the time in seconds since the last event on
		this association was detected, as defined by [ITU-T H.341]. (R) (mandatory) (4-bytes)

	Last Detected Reset Time
		Last detected reset time: This attribute reports the time in seconds since these statistics were
		last reset, as defined by [ITU-T H.341]. Under normal circumstances, a get action on this
		attribute would return 900-s to indicate a completed 15-min interval. (R) (mandatory) (4-bytes)

type MocaEthernetPerformanceMonitoringHistoryData ¶

type MocaEthernetPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MocaEthernetPerformanceMonitoringHistoryData (class ID #163)

This ME collects PM data for an MoCA Ethernet interface. Instances of this ME are created and
deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the PPTP MoCA UNI ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PPTP MoCA UNI. (R, setbycreate)
		(mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
		that contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)

	Incoming Unicast Packets
		Incoming unicast packets:	(R) (optional) (4-bytes)

	Incoming Discarded Packets
		Incoming discarded packets:	(R) (optional) (4-bytes)

	Incoming Errored Packets
		Incoming errored packets:	(R) (optional) (4-bytes)

	Incoming Unknown Packets
		Incoming unknown packets:	(R) (optional) (4-bytes)

	Incoming Multicast Packets
		Incoming multicast packets:	(R) (optional) (4-bytes)

	Incoming Broadcast Packets
		Incoming broadcast packets:	(R) (optional) (4-bytes)

	Incoming Octets
		Incoming octets:	(R) (optional) (4-bytes)

	Outgoing Unicast Packets
		Outgoing unicast packets:	(R) (optional) (4-bytes)

	Outgoing Discarded Packets
		Outgoing discarded packets:	(R) (optional) (4-bytes)

	Outgoing Errored Packets
		Outgoing errored packets:	(R) (optional) (4-bytes)

	Outgoing Unknown Packets
		Outgoing unknown packets:	(R) (optional) (4-bytes)

	Outgoing Multicast Packets
		Outgoing multicast packets:	(R) (optional) (4-bytes)

	Outgoing Broadcast Packets
		Outgoing broadcast packets:	(R) (optional) (4-bytes)

	Outgoing Octets
		Outgoing octets:	(R) (optional) (4-bytes)

type MplsPseudowireTerminationPoint ¶

type MplsPseudowireTerminationPoint struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MplsPseudowireTerminationPoint (class ID #333)

This ME contains the configuration data of a pseudowire whose underlying transport method is
MPLS. Instances of this ME are created and deleted by the OLT.

Relationships
	Zero or one instance of this ME is associated with each instance of the pseudowire TP ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R,
		setbycreate)-(mandatory) (2 bytes)

	Tp Type
		(R, W, setbycreate) (mandatory) (1 byte)

	Tp Pointer
		TP pointer:	This attribute points to the instance of the TP associated with this MPLS PW TP. The
		type of the associated TP is determined by the TP type attribute. (R, W, setbycreate)
		(mandatory) (2 bytes)

	Mpls Label Indicator
		(R, W, setbycreate) (mandatory) (1 byte)

	Mpls Pw Direction
		(R, W, setbycreate) (mandatory) (1 byte)

	Mpls Pw Uplink Label
		MPLS PW uplink label: This attribute specifies the label of the inner MPLS pseudowire upstream.
		The attribute is not meaningful for unidirectional downstream PWs. (R, W, setbycreate)
		(mandatory) (4 bytes)

	Mpls Pw Downlink Label
		MPLS PW downlink label: This attribute specifies the label of the inner MPLS pseudowire
		downstream. The attribute is not meaningful for unidirectional upstream PWs. (R, W, setbycreate)
		(mandatory) (4 bytes)

	Mpls Pw Tc
		NOTE 1 - The TC field was previously known as EXP. Refer to [bIETF-RFC-5462].

	Mpls Tunnel Direction
		(R, W, setbycreate) (mandatory for double-labelled case) (1 byte)

	Mpls Tunnel Uplink Label
		MPLS tunnel uplink label: This attribute specifies the (outer) label for the upstream MPLS
		tunnel. If the MPLS tunnel is downstream only, this attribute should be set to 0. (R, W,
		setbycreate) (mandatory for double-labelled case) (4 bytes)

	Mpls Tunnel Downlink Label
		MPLS tunnel downlink label: This attribute specifies the (outer) label for the downstream MPLS
		tunnel. If the MPLS tunnel is upstream only, this attribute should be set to 0. (R, W,
		setbycreate) (mandatory for double-labelled case) (4 bytes)

	Mpls Tunnel Tc
		NOTE 2 - The TC field was previously known as EXP. Refer to [bIETF-RFC-5462].

	Pseudowire Type
		(R, W, setbycreate) (mandatory) (2 bytes)

	Pseudowire Control Word Preference
		Pseudowire control word preference: When set to true, this Boolean attribute specifies that a
		control word is to be sent with each packet. Some PW types mandate the use of a control word in
		any event. In such cases, the value configured for this attribute has no effect on the presence
		of the control word. (R, W, setbycreate) (optional) (1 byte)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by the
		MPLS pseudowire TP. Administrative state is further described in clause-A.1.6. (R,-W) (optional)
		(1-byte)

	Operational State
		Operational state: This attribute reports whether the ME is currently capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

type MsgType ¶

type MsgType byte

MsgType represents a OMCI message-type

const (
	// Message Types
	Create                MsgType = 4
	Delete                MsgType = 6
	Set                   MsgType = 8
	Get                   MsgType = 9
	GetAllAlarms          MsgType = 11
	GetAllAlarmsNext      MsgType = 12
	MibUpload             MsgType = 13
	MibUploadNext         MsgType = 14
	MibReset              MsgType = 15
	AlarmNotification     MsgType = 16
	AttributeValueChange  MsgType = 17
	Test                  MsgType = 18
	StartSoftwareDownload MsgType = 19
	DownloadSection       MsgType = 20
	EndSoftwareDownload   MsgType = 21
	ActivateSoftware      MsgType = 22
	CommitSoftware        MsgType = 23
	SynchronizeTime       MsgType = 24
	Reboot                MsgType = 25
	GetNext               MsgType = 26
	TestResult            MsgType = 27
	GetCurrentData        MsgType = 28
	SetTable              MsgType = 29 // Defined in Extended Message Set Only
)

func (mt MsgType) String() string

type MulticastGemInterworkingTerminationPoint ¶

type MulticastGemInterworkingTerminationPoint struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MulticastGemInterworkingTerminationPoint (class ID #281)

An instance of this ME represents a point in a G-PON ONU where a multicast service interworks
with the GEM layer. At this point, a multicast bit stream is reconstructed from GEM packets.

Instances of this ME are created and deleted by the OLT.

Multicast interworking GEM modes of operation

The default multicast operation of the PON is where all the multicast content streams are
carried in one PON layer connection (GEM port). This connection is then specified in the first
entry of the IPv4 or IPv6 multicast address table, as the case may be. This single entry also
specifies an all-inclusive IP multicast destination address (DA) range (e.g., 224.0.0.0 to
239.255.255.255 in the case of IPv4). The ONU then filters the traffic based on either Ethernet
MAC addresses or IP addresses. The associated GEM port network CTP ME specifies the GEM port-ID
that supports all multicast connections.

In the default multicast operation, all multicast content streams are placed in one PON layer
connection (GEM port). The OLT sets up a completely conventional model, a pointer from the
multicast GEM IW termination to a GEM port network CTP. The OLT configures the GEM port-ID of
the GEM port network CTP into the appropriate multicast address table attribute(s), along with
the other table fields that specify the range of IP multicast DAs. The ONU accepts the entire
multicast stream through the designated GEM port, then filters the traffic based on either the
Ethernet MAC address or IP DA.

An optional multicast configuration supports separate multicast streams carried over separate
PON layer connections, i.e., on separate GEM ports. This permits the ONU to filter multicast
streams at the GEM level, which is efficient in hardware, while ignoring other multicast streams
that may be of interest to other ONUs on the PON.

After configuring the explicit model for the first multicast GEM port, the OLT supports multiple
multicast GEM ports by then configuring additional entries into the multicast address table(s),
entries with different GEM port-IDs. The OMCI model is defined such that these ports are
implicitly grouped together and served by the single explicit GEM port network CTP. No
additional GEM network CTPs need be created or linked for the additional GEM ports.

Several multicast GEM IW TPs can exist, each linked to separate bridge ports or mappers to serve
different communities of interest in a complex ONU.

Discovery of multicast support

The OLT uses the multicast GEM IW TP entity as the means to discover the ONU's multicast
capability. This entity is mandatory if multicast is supported by the ONU. If the OLT attempts
to create this entity on an ONU that does not support multicast, the create command fails. The
create or set command also fails if the OLT attempts to exploit optional features that the ONU
does not support, e.g., in attempting to write a multicast address table with more than a single
entry or to create multiple multicast GEM IW TPs.

This ME is defined by a similarity to the unicast GEM IW TP, and a number of its attributes are
not meaningful in a multicast context. These attributes are set to 0 and not used, as indicated
in the following.

Relationships
	An instance of this ME exists for each occurrence of transformation of GEM packets into a
	multicast data stream.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The value 0xFFFF
		is reserved. (R, setbycreate) (mandatory) (2-bytes)

	Gem Port Network Ctp Connectivity Pointer
		GEM port network CTP connectivity pointer: This attribute points to an instance of the GEM port
		network CTP that is associated with this multicast GEM IW TP. (R,-W, setbycreate) (mandatory)
		(2-bytes)

	Interworking Option
		(R,-W, setbycreate) (mandatory) (1-byte)

	Service Profile Pointer
		Service profile pointer: This attribute is set to 0 and not used. For backward compatibility, it
		may also be set to point to a MAC bridge service profile or IEEE 802.1p mapper service profile.
		(R,-W, setbycreate) (mandatory) (2-bytes)

	Not Used 1
		Not used 1:	This attribute is set to 0 and not used. (R,-W, setbycreate) (mandatory) (2-bytes)

	Pptp Counter
		PPTP counter: This attribute represents the number of instances of PPTP MEs associated with this
		instance of the multicast GEM IW TP. This attribute conveys no information that is not available
		elsewhere; it may be set to 0xFF and not used. (R) (optional) (1-byte)

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Gal Profile Pointer
		GAL profile pointer: This attribute is set to 0 and not used. For backward compatibility, it may
		also be set to point to a GAL Ethernet profile. (R,-W, setbycreate) (mandatory) (2-bytes)

	Not Used 2
		Not used 2:	This attribute is set to 0 and not used. (R,-W, setbycreate) (mandatory) (1-byte)

	Ipv4 Multicast Address Table
		IPv4 multicast address table: This attribute maps IP multicast addresses to PON layer addresses.
		Each entry contains the following.

	Ipv6 Multicast Address Table
		(R,-W) (optional) (24N bytes, where N is the number of entries in the list.)

type MulticastSubscriberConfigInfo ¶

type MulticastSubscriberConfigInfo struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MulticastSubscriberConfigInfo (class ID #310)

This ME organizes data associated with multicast management at subscriber ports of IEEE-802.1
bridges, including IEEE-802.1p mappers when the provisioning model is mapper-based rather than
bridge-based. Instances of this ME are created and deleted by the OLT. Because of backward
compatibility considerations, a subscriber port without an associated multicast subscriber
config info ME would be expected to support unrestricted multicast access; this ME may therefore
be viewed as restrictive, rather than permissive.

Through separate attributes, this ME supports either a single multicast operations profile in
its backward compatible form, or a list of multicast operations profiles instead (the list may
of course contain a single entry). The OLT can determine whether the ONU supports the multiple
profile capability by performing a get operation on the optional multicast service package table
attribute, which exists only on ONUs that are prepared to support the feature.

Relationships
	An instance of this ME is associated with one instance of the MAC bridge port configuration data
	or the IEEE-802.1p mapper service profile.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge port configuration
		data or IEEE-802.1p mapper ME. (R, setbycreate) (mandatory) (2-bytes)

	Me Type
		(R,-W, setbycreate) (mandatory) (1-byte)

	Multicast Operations Profile Pointer
		Multicast operations profile pointer: This attribute points to an instance of the multicast
		operations profile. This attribute is ignored by the ONU if a non-empty multicast service
		package table attribute is present. (R,W, set-by-create) (mandatory) (2 bytes)

	Max Simultaneous Groups
		Max simultaneous groups: This attribute specifies the maximum number of dynamic multicast groups
		that may be replicated to the client port at any one time. The recommended default value 0
		specifies that no administrative limit is to be imposed. (R,-W, setbycreate) (optional)
		(2-bytes)

	Max Multicast Bandwidth
		Max multicast bandwidth: This attribute specifies the maximum imputed dynamic bandwidth, in
		bytes per second, that may be delivered to the client port at any one time. The recommended
		default value 0 specifies that no administrative limit is to be imposed. (R,-W, setbycreate)
		(optional) (4-bytes)

	Bandwidth Enforcement
		Bandwidth enforcement: The recommended default value of this Boolean attribute is false, and
		specifies that attempts to exceed the max multicast bandwidth be counted but honoured. The value
		true specifies that such attempts be counted and denied. The imputed bandwidth value is taken
		from the dynamic access control list table, both for a new join request and for pre-existing
		groups. (R,-W, setbycreate) (optional) (1-byte)

	Multicast Service Package Table
		(R,-W) (optional) (20N bytes, where N is the number of entries in the table)

	Allowed Preview Groups Table
		Each list entry begins with a table control field:

type MulticastSubscriberMonitor ¶

type MulticastSubscriberMonitor struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MulticastSubscriberMonitor (class ID #311)

This ME provides the current status of each port with respect to its multicast subscriptions. It
may be useful for status monitoring or debugging purposes. The status table includes all dynamic
groups currently subscribed by the port.

Relationships
	Instances of this ME are created and deleted at the request of the OLT. One instance may exist
	for each IEEE-802.1 UNI configured to support multicast subscription.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the MAC bridge port configuration
		data or IEEE-802.1p mapper ME. (R,-setbycreate) (mandatory) (2-bytes)

	Me Type
		(R,-W, setbycreate) (mandatory) (1-byte)

	Current Multicast Bandwidth
		Current multicast bandwidth: This attribute is the ONU's (BE) estimate of the actual bandwidth
		currently being delivered to this particular MAC bridge port over all dynamic multicast groups.
		(R) (optional) (4-bytes)

	Join Messages Counter
		Join messages counter: This attribute counts the number of times the corresponding subscriber
		sent a join message that was accepted. When full, the counter rolls over to 0. (R) (optional)
		(4-bytes)

	Bandwidth Exceeded Counter
		Bandwidth exceeded counter: This attribute counts the number of join messages that did exceed,
		or would have exceeded, the max multicast bandwidth, whether accepted or denied. When full, the
		counter rolls over to 0. (R) (optional) (4-bytes)

	Ipv4 Active Group List Table
		(R) (mandatory) (24N bytes)

	Ipv6 Active Group List Table
		(R) (optional) (58N bytes)

type NetworkAddress ¶

type NetworkAddress struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

NetworkAddress (class ID #137)

The network address ME associates a network address with security methods required to access a
server. It is conditionally required for ONUs that support VoIP services. The address may take
the form of a URL, a fully qualified path or IP address represented as an ACII string.

If a non-OMCI interface is used to manage VoIP signalling, this ME is unnecessary.

Instances of this ME are created and deleted by the OLT or the ONU, depending on the method used
and case.

Relationships
	Any ME that requires a network address may link to an instance of this ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Instances of
		this ME created autonomously by the ONU have IDs in the range 0..0x7FFF. Instances created by
		the OLT have IDs in the range 0x8000..0xFFFE. The value 0xFFFF is reserved. (R, setbycreate)
		(mandatory) (2-bytes)

	Security Pointer
		Security pointer: This attribute points to an authentication security method ME. The
		authentication security method indicates the username and password to be used when retrieving
		the network address indicated by this ME. A null pointer indicates that security attributes are
		not defined for this network address. (R,-W, setbycreate) (mandatory) (2-bytes)

	Address Pointer
		Address pointer: This attribute points to the large string ME that contains the network address.
		It may contain a fully qualified domain name, URI or IP address. The URI may also contain a port
		identifier (e.g., "x.y.z.com:5060"). A null pointer indicates that no network address is
		defined. (R,-W, setbycreate) (mandatory) (2-bytes)

type NetworkDialPlanTable ¶

type NetworkDialPlanTable struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

NetworkDialPlanTable (class ID #145)

The network dial plan table ME is optional for ONUs providing VoIP services. This ME is used to
provision dial plans from the OLT. Instances of this ME are created and deleted by the OLT. If a
non-OMCI interface is used to manage SIP for VoIP, this ME is unnecessary.

Relationships
	An instance of this ME may be associated with one or more instances of the SIP user data ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Dial Plan Number
		Dial plan number: This attribute indicates the current number of dial plans in the dial plan
		table. (R) (mandatory) (2-bytes)

	Dial Plan Table Max Size
		Dial plan table max size: This attribute defines the maximum number of dial plans that can be
		stored in the dial plan table. (R, setbycreate) (mandatory) (2-bytes)

	Critical Dial Timeout
		Critical dial timeout: This attribute defines the critical dial timeout for digit map
		processing, in milliseconds. The recommended default value is 4000-ms. (R,-W, setbycreate)
		(mandatory) (2-bytes)

	Partial Dial Timeout
		Partial dial timeout: This attribute defines the partial dial timeout for digit map processing,
		in milliseconds. The recommended default value is 16000-ms. (R,-W, setbycreate) (mandatory)
		(2-bytes)

	Dial Plan Format
		(R,-W, setbycreate) (mandatory) (1-byte)

	Dial Plan Table
		(R,-W) (mandatory) (30 * N bytes, where N is the number of dial plans)

type NotSupportedError ¶

type NotSupportedError struct {
	OmciError
}

NotSupportedError means that the message type indicated in byte 3 is not supported by the ONU.

type OctetString ¶ added in v0.13.0

type OctetString struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

OctetString (class ID #307)

The octet string is modelled on the large string ME. The large string is constrained to
printable characters because it uses null as a trailing delimiter. The octet string has a length
attribute and is therefore suitable for arbitrary sequences of bytes.

Instances of this ME are created and deleted by the OLT. To use this ME, the OLT instantiates
the octet string ME and then points to the created ME from other ME instances. Systems that
maintain the octet string should ensure that the octet string ME is not deleted while it is
still linked.

Relationships
	An instance of this ME may be cited by any ME that requires an octet string that can exceed
	25-bytes in length.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The values 0 and
		0xFFFF are reserved. (R, setbycreate) (mandatory) (2-bytes)

	Length
		Length:	This attribute specifies the number of octets that comprise the sequence of octets. This
		attribute defaults to 0 to indicate no octet string is defined. The maximum value of this
		attribute is 375 (15 parts, 25-bytes each). (R,-W) (mandatory) (2-bytes)

	Part 1, Part 2, Part 3, Part 4, Part 5, Part 6, Part 7, Part 8, Part 9, Part 10, Part 11, Part 12, Part 13, Part 14, Part 15
		Part 1, Part 2, Part 3, Part 4, Part 5, Part 6, Part 7, Part 8, Part 9,  Part 10, Part 11, Part
		12, Part 13, Part 14, Part 15:  (R,-W) (part 1 mandatory, others optional) (25-bytes * 15
		attributes)

type OltG ¶

type OltG struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

OltG (class ID #131)

This optional ME identifies the OLT to which an ONU is connected. This ME provides a way for the
ONU to configure itself for operability with a particular OLT. It also provides a way for the
OLT to communicate the time of day to the ONU.

An ONU that supports this ME automatically creates an instance of it. Immediately following the
start-up phase, the OLT should set the ONU to the desired configuration. Interpretation of the
OLT vendor ID, equipment ID and version attributes is a matter for negotiation between the two
vendors involved.

Relationships
	The single instance of this ME is associated with the ONU ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. There is only
		one instance, number 0. (R) (mandatory) (2-bytes)

	Olt Vendor Id
		OLT vendor ID: This attribute identifies the OLT vendor. It is the same as the four most
		significant bytes of an ONU serial number specified in the respective TC layer specification.
		Upon instantiation, this attribute comprises all spaces. (R,-W) (mandatory) (4-bytes)

	Equipment Id
		Equipment ID: This attribute may be used to identify the specific type of OLT. The default value
		of all spaces indicates that equipment ID information is not available or applicable to the OLT
		being represented. (R,-W) (mandatory) (20-bytes)

	Version
		Version:	This attribute identifies the version of the OLT as defined by the vendor. The default
		left-justified ASCII string "0" (padded with trailing nulls) indicates that version information
		is not available or applicable to the OLT being represented. (R,-W) (mandatory) (14-bytes)

	Time Of Day Information
		NOTE - In ITU-T G.987/ITU-T G.989 systems, the superframe count field of the time of day
		information attribute contains the 32 LSBs of the actual counter.

type Omci ¶

type Omci struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Omci (class ID #287)

This ME describes the ONU's general level of support for OMCI MEs and messages. This ME is not
included in an MIB upload.

Relationships
	One instance exists in the ONU. The ME entities are related to the OMCI entity.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. There is only
		one instance, number 0. (R) (mandatory) (2-bytes)

	Me Type Table
		ME type table: This attribute lists the ME classes supported by the ONU. Each entry contains the
		ME class value (see Table 11.2.4-1) of an ME type. (R) (mandatory) (2 * N bytes, where N is the
		number of entries in the list.)

	Message Type Table
		Message type table: This attribute is a list of message types (MTs) supported by the ONU. Each
		entry contains the MT of an OMCI message (see Table-11.2.2-1). (R) (mandatory) (M bytes, where M
		is the number of entries in the list.)

type OmciError ¶

type OmciError struct {
	// contains filtered or unexported fields
}

func (e *OmciError) Error() string

func (e *OmciError) GetError() error

func (e *OmciError) GetFailureMask() uint16

func (e *OmciError) GetUnsupporteMask() uint16

func (e *OmciError) StatusCode() Results

type OmciErrors ¶ added in v0.0.8

type OmciErrors interface {
	Error() string
	StatusCode() Results
	GetError() error
	GetFailureMask() uint16
	GetUnsupporteMask() uint16
}

Custom Go Error messages for common OMCI errors

Response Status code related errors

func MergeInDefaultValues(classID ClassID, attributes AttributeValueMap) OmciErrors

func NewAttributeFailureError(failedMask uint16, unsupportedMask uint16, args ...interface{}) OmciErrors

func NewDeviceBusyError(args ...interface{}) OmciErrors

func NewInstanceExistsError(args ...interface{}) OmciErrors

func NewMessageTruncatedError(args ...interface{}) OmciErrors

func NewNonStatusError(args ...interface{}) OmciErrors

func NewNotSupportedError(args ...interface{}) OmciErrors

func NewOmciSuccess() OmciErrors

func NewParameterError(mask uint16, args ...interface{}) OmciErrors

func NewProcessingError(args ...interface{}) OmciErrors

func NewUnknownEntityError(args ...interface{}) OmciErrors

func NewUnknownInstanceError(args ...interface{}) OmciErrors

type OmciProcessingError ¶

type OmciProcessingError struct {
	OmciError
}

type Onu2G ¶

type Onu2G struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Onu2G (class ID #257)

This ME contains additional attributes associated with a PON ONU. The ONU automatically creates
an instance of this ME. Its attributes are populated according to data within the ONU itself.

This ME is the same as the ONT2-G of [ITUT G.984.4], with extensions.

Relationships
	This ME is paired with the ONU-G entity.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. There is only
		one instance, number 0. (R) (mandatory) (2-bytes)

	Equipment Id
		Equipment ID: This attribute may be used to identify the specific type of ONU. In some
		environments, this attribute may include the common language equipment identification (CLEI)
		code. (R) (optional) (20-bytes)

	Optical Network Unit Management And Control Channel Omcc Version
		(R) (mandatory) (1-byte)

	Vendor Product Code
		Vendor product code: This attribute contains a vendor-specific product code for the ONU. (R)
		(optional) (2-bytes)

	Security Capability
		(R) (mandatory) (1-byte)

	Security Mode
		Upon ME instantiation, the ONU sets this attribute to 1, AES-128. Attribute value 1 does not
		imply that any channels are encrypted; that process is negotiated at the PLOAM layer. It only
		signifies that the advanced encryption standard (AES) with 128-bit keys is the security mode to
		be used on any channels that the OLT may choose to encrypt. (R,-W) (mandatory) (1-byte)

	Total Priority Queue Number
		Total priority queue number: This attribute reports the total number of upstream priority queues
		that are not associated with a circuit pack, but with the ONU in its entirety. Upon ME
		instantiation, the ONU sets this attribute to the value that represents its capabilities. (R)
		(mandatory) (2-bytes)

	Total Traffic Scheduler Number
		Total traffic scheduler number: This attribute reports the total number of traffic schedulers
		that are not associated with a circuit pack, but with the ONU in its entirety. The ONU supports
		null function, strict priority scheduling and weighted round robin (WRR) from the priority
		control and guarantee of minimum rate control points of view, respectively. If the ONU has no
		global traffic schedulers, this attribute is 0. (R) (mandatory) (1-byte)

	Deprecated
		Deprecated:	This attribute should always be set to 1 by the ONU and ignored by the OLT. (R)
		(mandatory) (1-byte)

	Total Gem Port_Id Number
		Total GEM port-ID number: This attribute reports the total number of GEM port-IDs supported by
		the ONU. The maximum value is specified in the corresponding TC recommendations. Upon ME
		instantiation, the ONU sets this attribute to the value that represents its capabilities. (R)
		(optional) (2-bytes)

	Sysuptime
		SysUpTime:	This attribute counts 10 ms intervals since the ONU was last initialized. It rolls
		over to 0 when full (see [IETF RFC 1213]). (R) (optional) (4-bytes)

	Connectivity Capability
		(R) (optional) (2 bytes)

	Current Connectivity Mode
		(R, W) (optional) (1 byte)

	Quality Of Service Qos Configuration Flexibility
		The ME ID of both the T-CONT and traffic scheduler contains a slot number. Even when attributes
		in the above list are RW, it is never permitted to change the slot number in a reference. That
		is, configuration flexibility never extends across slots. It is also not permitted to change the
		directionality of an upstream queue to downstream or vice versa.

	Priority Queue Scale Factor
		NOTE 3 - Some legacy implementations may take the queue scale factor from the GEM block length
		attribute of the ANI-G ME. That option is discouraged in new implementations.

type OnuData ¶

type OnuData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

OnuData (class ID #2)

This ME models the MIB itself. Clause I.1.3 explains the use of this ME with respect to MIB
synchronization.

The ONU automatically creates an instance of this ME, and updates the associated attributes
according to data within the ONU itself.

Relationships
	One instance of this ME is contained in an ONU.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. There is only
		one instance, number 0. (R) (mandatory) (2-bytes)

	Mib Data Sync
		MIB data sync: This attribute is used to check the alignment of the MIB of the ONU with the
		corresponding MIB in the OLT. MIB data sync relies on this attribute, which is a sequence number
		that can be checked by the OLT to see if the MIB snapshots for the OLT and ONU match. Refer to
		clause I.1.2.1 for a detailed description of this attribute. Upon ME instantiation, the ONU sets
		this attribute to 0. (R,-W) (mandatory) (1-byte)

type OnuDynamicPowerManagementControl ¶

type OnuDynamicPowerManagementControl struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

OnuDynamicPowerManagementControl (class ID #336)

This ME models the ONU's ability to enter power conservation modes in cooperation with the OLT
in an ITU-T G.987 system. [ITUT G.987.3] originally specified two alternative modes, doze and
cyclic sleep. The subsequent revision of [ITUT G.987.3] simplified the specification providing a
single power conservation mode, watchful sleep.

An ONU that supports power conservation modes automatically creates an instance of this ME.

Relationships
	One instance of this ME is associated with the ONU ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. There is only
		one instance, number 0. (R) (mandatory) (2-bytes)

	Power Reduction Management Capability
		5..255	Reserved

	Power Reduction Management Mode
		Power reduction management mode: This attribute enables one or more of the ONU's managed power
		conservation modes. It is a bit map in which the bit value 0 disables the mode, while the value
		1 enables the mode. Bit assignments are the same as those of the power reduction management
		capability attribute. The default value of each bit is 0. (R,-W) (mandatory) (1-byte)

	Itransinit
		Itransinit:	This attribute is the ONU vendor's statement of the complete transceiver
		initialization time: the worst-case time required for the ONU to regain full functionality when
		leaving the asleep state in cyclic sleep mode or low-power state in watchful sleep mode (i.e.,
		turning on both the receiver and the transmitter and acquiring synchronization to the downstream
		flow), measured in units of 125-us frames. The value zero indicates that the sleeping ONU can
		respond to a bandwidth grant without delay. (R) (mandatory) (2-bytes)

	Itxinit
		Itxinit:	This attribute is the ONU vendor's statement of the transmitter initialization time:
		the time required for the ONU to regain full functionality when leaving the listen state (i.e.,
		turning on the transmitter), measured in units of 125-us frames. The value zero indicates that
		the dozing ONU can respond to a bandwidth grant without delay. If watchful sleep is enabled, the
		ONU ignores this attribute. (R) (mandatory) (2 bytes)

	Maximum Sleep Interval
		Maximum sleep interval: The Isleep/Ilowpower attribute specifies the maximum time the ONU spends
		in its asleep, listen, or low-power states, as a count of 125-us frames. Local or remote events
		may truncate the ONU's sojourn in these states. The default value of this attribute is 0. (R,-W)
		(mandatory) (4-bytes)

	Maximum Receiver_Off Interval
		Maximum receiver-off interval: The Irxoff attribute specifies the maximum time the OLT can
		afford to wait from the moment it decides to wake up an ONU in the low-power state of the
		watchful sleep mode until the ONU is fully operational, specified as a count of 125-us frames.
		(R,-W) (mandatory) (4-bytes)

	Minimum Aware Interval
		Minimum aware interval: The Iaware attribute specifies the time the ONU spends in its aware
		state, as a count of 125-us frames, before it re-enters asleep or listen states. Local or remote
		events may independently cause the ONU to enter an active state rather than returning to a sleep
		state. The default value of this attribute is 0. (R,-W) (mandatory) (4-bytes)

	Minimum Active Held Interval
		Minimum active held interval: The Ihold attribute specifies the minimum time during which the
		ONU remains in the active held state, as a count of 125-us frames. Its initial value is zero.
		(R, W) (mandatory) (2-bytes)

	Maximum Sleep Interval Extension
		(R,-W) (optional) (8-bytes)

	Ethernet Passive Optical Network Epon Capability Extension
		-	Configurations: ackEnable configuration = enable, Sleep indication configuration = disable,
		Early wake-up configuration = enable

	Epon Setup Extension
		(R,-W) (optional) (1-byte)

	Missing Consecutive Bursts Threshold
		Missing consecutive bursts threshold: The Clobi attribute specifies the maximum number of
		missing consecutive scheduled bursts from the ONU that the OLT is willing to tolerate without
		raising an alarm. The value of this attribute defaults to 4. (R,-W) (mandatory) (4-bytes)

type OnuG ¶

type OnuG struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

OnuG (class ID #256)

This ME represents the ONU as equipment. The ONU automatically creates an instance of this ME.
It assigns values to read-only attributes according to data within the ONU itself.

This ME has evolved from the ONT-G of [ITUT G.984.4].

Relationships
	In ITU-T GTC based PON applications, all other MEs in this Recommendation are related directly
	or indirectly to the ONU-G entity.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. There is only
		one instance, number 0. (R) (mandatory) (2-bytes)

	Vendor Id
		Vendor ID:	This attribute identifies the vendor of the ONU. It is the same as the four most
		significant bytes of the ONU serial number as specified in the respective transmission
		convergence (TC) layer specification. (R) (mandatory) (4-bytes)

	Version
		Version:	This attribute identifies the version of the ONU as defined by the vendor. The
		character value 0 indicates that version information is not available or applicable. (R)
		(mandatory) (14-bytes)

	Serial Number
		Serial number: The serial number is unique for each ONU. It is defined in the respective TC
		layer specification and contains the vendor ID and version number. The first four bytes are an
		ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number,
		under the control of the ONU vendor. (R) (mandatory) (8-bytes)

	Traffic Management Option
		Upon ME instantiation, the ONU sets this attribute to the value that describes its
		implementation. The OLT must adapt its model to conform to the ONU's selection. (R) (mandatory)
		(1-byte)

	Deprecated
		Deprecated:	This attribute is not used. If it is present, it should be set to 0. (R) (optional)
		(1-byte)

	Battery Backup
		Battery backup: This Boolean attribute controls whether the ONU performs backup battery
		monitoring (assuming it is capable of doing so). False disables battery alarm monitoring; true
		enables battery alarm monitoring. (R,-W) (mandatory) (1-byte)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by the
		ONU as an entirety. Administrative state is further described in clause A.1.6. (R,-W)
		(mandatory) (1-byte)

	Operational State
		Operational state: This attribute reports whether the ME is currently capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Onu Survival Time
		ONU survival time: This attribute indicates the minimum guaranteed time in milliseconds between
		the loss of external power and the silence of the ONU. This does not include survival time
		attributable to a backup battery. The value zero implies that the actual time is not known. (R)
		(optional) (1-byte)

	Logical Onu Id
		Logical ONU ID: This attribute provides a way for the ONU to identify itself. It is a text
		string, null terminated if it is shorter than 24 bytes, with a null default value. The mechanism
		for creation or modification of this information is beyond the scope of this Recommendation, but
		might include, for example, a web page displayed to a user. (R) (optional) (24 bytes)

	Logical Password
		Logical password: This attribute provides a way for the ONU to submit authentication
		credentials. It is a text string, null terminated if it is shorter than 12 bytes, with a null
		default value. The mechanism for creation or modification of this information is beyond the
		scope of this Recommendation. (R) (optional) (12-bytes)

	Credentials Status
		Other values are reserved.

	Extended Tc_Layer Options
		(R) (optional) (2-bytes)

type OnuPowerShedding ¶

type OnuPowerShedding struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

OnuPowerShedding (class ID #133)

This ME models the ONU's ability to shed services when the ONU goes into battery operation mode
after AC power failure. Shedding classes are defined in the following table, which may span
multiple circuit pack types. This feature works in conjunction with the power shed override
attribute of the circuit pack ME, which can selectively prevent power shedding of priority
ports.

An ONU that supports power shedding automatically creates an instance of this ME.

The following table defines the binding of shedding class and PPTP type. The coding is taken
from Table 9.1.5-1. In the case of hybrid circuit pack types, multiple shedding classes may
affect a circuit pack if the hardware is capable of partial power shedding.

An ONU may choose to model its ports with the port-mapping package of clause 9.1.8, rather than
with real or virtual circuit packs. In this case, power shedding pertains to individual PPTPs
(listed in column 2 of the table).

Relationships
	One instance of this ME is associated with the ONU ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. There is only
		one instance, number 0. (R) (mandatory) (2-bytes)

	Restore Power Timer Reset Interval
		Restore power timer reset interval: The time delay, in seconds, before resetting the power-
		shedding timers after full power restoration. Upon ME instantiation, the ONU sets this attribute
		to 0. (R,-W) (mandatory) (2-bytes)

	Data Class Shedding Interval
		Data class shedding interval:	(R,-W) (mandatory) (2-bytes)

	Voice Class Shedding Interval
		Voice class shedding interval: This attribute only pertains to voice services that terminate on
		the ONU and are under the management control of the OMCI. 	(R,-W) (mandatory) (2-bytes)

	Video Overlay Class Shedding Interval
		Video overlay class shedding interval:	(R,-W) (mandatory) (2-bytes)

	Video Return Class Shedding Interval
		Video return class shedding interval:	(R,-W) (mandatory) (2-bytes)

	Digital Subscriber Line Class Shedding Interval
		Digital subscriber line (DSL) class shedding interval:	(R,-W) (mandatory) (2-bytes)

	Atm Class Shedding Interval
		ATM class shedding interval:	(R,-W) (mandatory) (2-bytes)

	Ces Class Shedding Interval
		CES class shedding interval:	(R,-W) (mandatory) (2-bytes)

	Frame Class Shedding Interval
		Frame class shedding interval:	(R,-W) (mandatory) (2-bytes)

	Sdh_Sonet Class Shedding Interval
		Sdh-sonet class shedding interval:	(R,-W) (mandatory) (2-bytes)

	Shedding Status
		The ONU sets each bit to 1 when power shedding is active, and clears it to 0 when the service is
		restored. (R) (optional) (2-bytes)

type ParamData ¶

type ParamData struct {
	EntityID   uint16
	Attributes AttributeValueMap
}

ParamData can be passed to the 'New' function to dictate how the returned Managed Entity is created. You should supply either zero or one ParamData structure to 'New'.

If No ParamData is passed, the returned Managed Entity can only be used for providing validation of other structures. This is commonly done in a packet encoder/decoder to assist in that process.

If One ParamData is passed, the returned Managed Entity will be initialized with the given values/attributes and then validated. This is commonly done when you wish to create an ME for transmission, storage or removal from a persistent database, or some other similar purpose.

type ParamError ¶

type ParamError struct {
	OmciError
}

ParamError means that the command message received by the ONU was errored. It would be appropriate if an attribute mask were out of range, for example. In practice, this result code is frequently used interchangeably with code 1001. However, the optional attribute and attribute execution masks in the reply messages are only defined for code 1001.

type PhysicalPathTerminationPointCesUni ¶

type PhysicalPathTerminationPointCesUni struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PhysicalPathTerminationPointCesUni (class ID #12)

This ME represents the point at a CES UNI in the ONU where the physical path terminates and
physical level functions are performed.

The ONU automatically creates an instance of this ME per port:

o	when the ONU has CES ports built into its factory configuration;

o	when a cardholder is provisioned to expect a circuit pack of a CES type;

o	when a cardholder provisioned for plug-and-play is equipped with a circuit pack of a CES type.
Note that the installation of a plug-and-play card may indicate the presence of CES ports via
equipment ID as well as its type and indeed may cause the ONU to instantiate a port-mapping
package that specifies CES ports.

The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
expect a CES circuit pack, nor is it equipped with a CES circuit pack.

Relationships
	An instance of this ME is associated with each real or pre-provisioned CES port. It can be
	linked from a GEM IW TP, a pseudowire TP or a logical N * 64 kbit/s CTP.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2 byte
		number indicates the physical position of the UNI. The first byte is the slot ID (defined in
		clause 9.1.5). The second byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes)

	Expected Type
		Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory) (1-byte)

	Sensed Type
		Sensed type:	If the value of expected type is not 0, then the value of sensed type equals the
		value of expected type. If expected type-= 0, then the value of sensed type is one of the
		compatible values from Table-9.1.5-1. Upon ME instantiation, the ONU sets this attribute to 0 or
		to the value that reflects the physically present equipment. (R) (mandatory if the ONU supports
		circuit packs with configurable interface types, e.g., C1.5/2/6.3) (1-byte)

	Ces Loopback Configuration
		Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory) (1-byte)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
		ME. Administrative state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte)

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Framing
		Upon ME instantiation, the ONU sets this attribute to a value that reflects the vendor's
		default. (R,-W) (optional) (1-byte)

	Encoding
		Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory for DS1 and DS3
		interfaces) (1-byte)

	Line Length
		Line length:	This attribute specifies the length of the twisted pair cable from a DS1 physical
		UNI to the DSX-1 cross-connect point or the length of coaxial cable from a DS3 physical UNI to
		the DSX-3 cross-connect point. Valid values are given in Table 9.8.1-1. Upon ME instantiation
		for a DS1 interface, the ONU assigns the value 0 for non-power feed type DS1 and the value 6 for
		power feed type DS1. Upon ME instantiation for a DS3 interface, the ONU sets this attribute to
		0x0F. (R,-W) (optional) (1-byte)

	Ds1 Mode
		In the event of conflicting values between this attribute and the (also optional) line length
		attribute, the line length attribute is taken to be valid. This permits the separation of line
		build-out (LBO) and power settings from smart jack and FDL behaviour. Upon ME instantiation, the
		ONU sets this attribute to 0. (R,-W) (optional) (1-byte)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Line Type
		(R,-W) (mandatory for DS3, E3 and multi-configuration interfaces, not applicable to other
		interfaces) (1-byte)

type PhysicalPathTerminationPointEthernetUni ¶

type PhysicalPathTerminationPointEthernetUni struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PhysicalPathTerminationPointEthernetUni (class ID #11)

This ME represents the point at an Ethernet UNI where the physical path terminates and Ethernet
physical level functions are performed.

The ONU automatically creates an instance of this ME per port:

o	when the ONU has Ethernet ports built into its factory configuration;

o	when a cardholder is provisioned to expect a circuit pack of the Ethernet type;

o	when a cardholder provisioned for plug-and-play is equipped with a circuit pack of the
Ethernet type. Note that the installation of a plug-and-play card may indicate the presence of
Ethernet ports via equipment ID as well as its type, and indeed may cause the ONU to instantiate
a port-mapping package that specifies Ethernet ports.

The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
expect an Ethernet circuit pack, nor is it equipped with an Ethernet circuit pack.

Relationships
	An instance of this ME is associated with each instance of a pre-provisioned or real Ethernet
	port.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2 byte
		number indicates the physical position of the UNI. The first byte is the slot ID (defined in
		clause 9.1.5). The second byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes)

	Expected Type
		Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory) (1-byte)

	Sensed Type
		(R) (mandatory if the ONU supports circuit packs with configurable interface types, e.g., 10/100
		BASE-T card) (1-byte)

	Auto Detection Configuration
		Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory for interfaces with
		autodetection options) (1-byte)

	Ethernet Loopback Configuration
		Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory) (1-byte)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
		ME. Administrative state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte)

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Configuration Ind
		The value 0 indicates that the configuration status is unknown (e.g., Ethernet link is not
		established or the circuit pack is not yet installed). Upon ME instantiation, the ONU sets this
		attribute to 0. (R) (mandatory) (1-byte)

	Max Frame Size
		Max frame size: This attribute denotes the maximum frame size allowed across this interface.
		Upon ME instantiation, the ONU sets the attribute to 1518. (R,-W) (mandatory for G-PON, optional
		for ITU-T G.986 systems) (2 bytes)

	Dte Or Dce Ind
		(R,-W) (mandatory) (1-byte)

	Pause Time
		Pause time:	This attribute allows the PPTP to ask the subscriber terminal to temporarily suspend
		sending data. Units are in pause quanta (1 pause quantum is 512 bit times of the particular
		implementation). Values: 0..0xFFFF. Upon ME instantiation, the ONU sets this attribute to 0.
		(R,-W) (optional) (2-bytes)

	Bridged Or Ip Ind
		Upon ME instantiation, the ONU sets this attribute to 2. (R,-W) (optional) (1-byte)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Pppoe Filter
		PPPoE filter: This attribute controls filtering of PPPoE packets on this Ethernet port. The
		value 0 allows packets of all types. The value 1 discards everything but PPPoE packets. The
		default value is 0. (R,-W) (optional) (1-byte)

	Power Control
		NOTE - This attribute is the equivalent of the acPSEAdminControl variable defined in clause
		30.9.1.2.1 of [IEEE 802.3]. Other variables related to PoE appear in the PoE control ME.

type PhysicalPathTerminationPointLctUni ¶

type PhysicalPathTerminationPointLctUni struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PhysicalPathTerminationPointLctUni (class ID #83)

This ME models debug access to the ONU from any physical or logical port, for example, via a
dedicated LCT UNI, via ordinary subscriber UNIs, or via the IP host config ME.

The ONU automatically creates an instance of this ME per port:

o	when the ONU has an LCT port built into its factory configuration;

o	when a cardholder is provisioned to expect a circuit pack of the LCT type;

o	when a cardholder provisioned for plug-and-play is equipped with a circuit pack of the LCT
type;

NOTE - The installation of a plug-and-play card may indicate the presence of LCT ports via
equipment ID as well as its type, and indeed may cause the ONU to instantiate a port-mapping
package that specifies LCT ports.

o	when the ONU supports debug access through some other physical or logical means.

The ONU automatically deletes an instance of this ME when a cardholder is neither provisioned to
expect an LCT circuit pack, nor is it equipped with an LCT circuit pack, or if the ONU is
reconfigured in such a way that it no longer supports debug access.

LCT instances are not reported during an MIB upload.

Relationships
	An instance of this ME is associated with an instance of a real or virtual circuit pack ME
	classified as an LCT type. An instance of this ME may also be associated with the ONU as a
	whole, if the ONU supports debug access through means other than a dedicated physical LCT port.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
		number indicates the physical position of the UNI. The first byte is the slot ID (defined in
		clause 9.1.5). The second byte is the port ID, with the range 1..255. If the LCT UNI is
		associated with the ONU as a whole, its ME ID should be 0. (R) (mandatory) (2 bytes)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
		ME. Administrative state is described generically in clause-A.1.6. The LCT has additional
		administrative state behaviour. When the administrative state is set to lock, debug access
		through all physical or logical means is blocked, except that the operation of a possible ONU
		remote debug ME is not affected. Administrative lock of ME instance 0 overrides administrative
		lock of any other PPTP LCT UNIs that may exist. (R, W) (mandatory) (1-byte)

type PhysicalPathTerminationPointMocaUni ¶

type PhysicalPathTerminationPointMocaUni struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PhysicalPathTerminationPointMocaUni (class ID #162)

This ME represents an MoCA UNI, where physical paths terminate and physical path level functions
are performed.

The ONU automatically creates an instance of this ME per port as follows.

o	When the ONU has MoCA ports built into its factory configuration.

o	When a cardholder is provisioned to expect a circuit pack of the MoCA type.

o	When a cardholder provisioned for plug-and-play is equipped with a circuit pack of the MoCA
type. Note that the installation of a plug-and-play card may indicate the presence of MoCA ports
via equipment ID as well as its type, and indeed may cause the ONU to instantiate a port-mapping
package that specifies MoCA ports.

The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
expect an MoCA circuit pack, nor is it equipped with an MoCA circuit pack.

Relationships
	An instance of this ME is associated with each real or pre-provisioned MoCA port.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
		number is directly associated with the physical position of the UNI. The first byte is the slot
		ID (defined in clause 9.1.5). The second byte is the port ID, with the range 1..255. (R)
		(mandatory) (2-bytes)

	Loopback Configuration
		Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (optional) (1-byte)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
		ME. Administrative state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte)

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Max Frame Size
		Max frame size: This attribute denotes the maximum frame size allowed across this interface.
		Upon ME instantiation, the ONU sets this attribute to 1518. (R,-W) (mandatory) (2-bytes)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Pppoe Filter
		PPPoE filter: This attribute controls filtering of PPPoE packets on this MoCA port. When its
		value is 1, all packets other than PPPoE packets are discarded. The default 0 accepts packets of
		all types. (R,-W) (optional) (1-byte)

	Network Status
		(R) (mandatory) (1-byte)

	Password
		Password:	This attribute specifies the MoCA encryption key. It is an ASCII string of 17 decimal
		digits. Upon ME instantiation, the ONU sets this attribute to 17 null bytes. (R,-W) (mandatory)
		(17-bytes)

	Privacy Enabled
		Privacy enabled: This attribute activates (1) link-layer security. The default value 0
		deactivates it. (R,-W) (mandatory) (1-byte)

	Minimum Bandwidth Alarm Threshold
		Minimum bandwidth alarm threshold: This attribute specifies the minimum desired PHY link
		bandwidth between two nodes. If the actual bandwidth is lower, an LL alarm is declared. Valid
		values are 0 to 0x0410 (260-Mbit/s) in 0.25-Mbit/s increments. The default value is 0x02D0
		(180-Mbit/s). The value 0 disables the threshold. (R,-W) (optional) (2-bytes)

	Frequency Mask
		Frequency mask: This attribute is a bit map of the centre frequencies that the interface is
		permitted to use, where each bit represents a centre frequency. The LSB (b[1]) corresponds to
		centre frequency 800-MHz. The next significant bit (b[2]) corresponds to centre frequency
		825-MHz. The 28th bit (b[28]) corresponds to centre frequency 1500-MHz. The four MSBs are not
		used. (R,-W) (optional) (4-bytes)

	Rf Channel
		RF channel:	This attribute reports the frequency to which the MoCA interface is currently tuned,
		in megahertz. (R) (mandatory) (2-bytes)

	Last Operational Frequency
		Last operational frequency: This attribute reports the frequency to which the MoCA interface was
		tuned when last operational, in megahertz. (R) (mandatory) (2-bytes)

type PhysicalPathTerminationPointPotsUni ¶

type PhysicalPathTerminationPointPotsUni struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PhysicalPathTerminationPointPotsUni (class ID #53)

This ME represents a POTS UNI in the ONU, where a physical path terminates and physical path
level functions (analogue telephony) are performed.

The ONU automatically creates an instance of this ME per port as follows.

o	When the ONU has POTS ports built into its factory configuration.

o	When a cardholder is provisioned to expect a circuit pack of the POTS type.

o	When a cardholder provisioned for plug-and-play is equipped with a circuit pack of the POTS
type. Note that the installation of a plug-and-play card may indicate the presence of POTS ports
via equipment ID as well as type, and indeed may cause the ONU to instantiate a port-mapping
package that specifies POTS ports.

The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
expect a POTS circuit pack, nor is it equipped with a POTS circuit pack.

Relationships
	An instance of this ME is associated with each real or pre-provisioned POTS port. Either a SIP
	or a VoIP voice CTP links to the POTS UNI. Status is available from a VoIP line status ME, and
	RTP and call control PM may be collected on this point.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
		number indicates the physical position of the UNI. The first byte is the slot ID (defined in
		clause 9.1.5). The second byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes)

	Administrative State
		When the administrative state is set to lock, all user functions of this UNI are blocked, and
		alarms, TCAs and AVCs for this ME and all dependent MEs are no longer generated. Selection of a
		default value for this attribute is outside the scope of this Recommendation. (R, W) (mandatory)
		(1 byte)

	Deprecated
		Deprecated: This attribute is not used and should not be supported. (R,-W) (optional) (2-bytes)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Impedance
		where C1, R1, and R2 are related as shown in Figure 9.9.1-1. Upon ME instantiation, the ONU sets
		this attribute to 0. (R,-W) (optional) (1-byte)

	Transmission Path
		Transmission path: This attribute allows setting the POTS UNI either to full-time on-hook
		transmission (0) or part-time on-hook transmission (1). Upon ME instantiation, the ONU sets this
		attribute to 0. (R,-W) (optional) (1-byte)

	Rx Gain
		Rx gain:	This attribute specifies a gain value for the received signal in the form of a 2s
		complement number. Valid values are -120 (12.0-dB) to 60 (+6.0-dB). The direction of the
		affected signal is in the D to A direction, towards the telephone set. Upon ME instantiation,
		the ONU sets this attribute to 0. (R, W) (optional) (1 byte)

	Tx Gain
		Tx gain:	This attribute specifies a gain value for the transmit signal in the form of a 2s
		complement number. Valid values are -120 (12.0-dB) to 60 (+6.0-dB). The direction of the
		affected signal is in the A to D direction, away from the telephone set. Upon ME instantiation,
		the ONU sets this attribute to 0. (R, W) (optional) (1 byte)

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Hook State
		Hook state:	This attribute indicates the current state of the subscriber line: 0-= on hook, 1-=
		off hook (R) (optional) (1-byte)

	Pots Holdover Time
		POTS holdover time: This attribute determines the time during which the POTS loop voltage is
		held up when a LOS or softswitch connectivity is detected (please refer to the following table
		for description of behaviours).. After the specified time elapses, the ONU drops the loop
		voltage, and may thereby cause premises intrusion alarm or fire panel circuits to go active.
		When the ONU ranges successfully on the PON or softswitch connectivity is restored, it restores
		the POTS loop voltage immediately and resets the timer to zero. The attribute is expressed in
		seconds. The default value 0 selects the vendor's factory policy. (R,-W) (optional) (2-bytes)

	Nominal Feed Voltage
		Nominal feed voltage: This attribute indicates the designed nominal feed voltage of the POTS
		loop. It is an absolute value with resolution 1-V. This attribute does not represent the actual
		voltage measured on the loop, which is available through the test command. (R,-W) (optional)
		(1-byte)

	Loss Of Softswitch
		Loss of softswitch: This Boolean attribute controls whether the T/R holdover initiation
		criteria. False disables loss of softswitch connectivity detection as criteria for initiating
		the POTS holdover timer. True enables loss of softswitch connectivity detection as criteria for
		initiating the POTS holdover timer. This attribute is optional (if not implemented, the POTS
		holdover time is triggered on a LOS when POTS holdover is greater than zero). (R,-W) (optional)
		(1-byte)

type PhysicalPathTerminationPointReUni ¶ added in v0.13.0

type PhysicalPathTerminationPointReUni struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PhysicalPathTerminationPointReUni (class ID #314)

This ME represents an S'/R' interface in a mid-span PON RE that supports OEO regeneration in at
least one direction, where physical paths terminate and physical path level functions are
performed (transmit or receive).

Such an RE automatically creates an instance of this ME for each S'/R' interface port as
follows.

o	When the RE has mid-span PON RE UNI interface ports built into its factory configuration.

o	When a cardholder is provisioned to expect a circuit pack of the mid-span PON RE UNI type.

o	When a cardholder provisioned for plug-and-play is equipped with a circuit pack of the midspan
PON RE UNI type. Note that the installation of a plug-and-play card may indicate the presence of
a mid-span PON RE UNI port via equipment ID as well as its type attribute, and indeed may cause
the management ONU to instantiate a port-mapping package to specify the ports precisely.

The management ONU automatically deletes instances of this ME when a cardholder is neither
provisioned to expect a mid-span PON RE UNI circuit pack, nor is it equipped with a mid-span PON
RE UNI circuit pack.

As illustrated in Figure 8.2.10-3, a PPTP RE UNI may share the physical port with an RE upstream
amplifier. The ONU declares a shared configuration through the port-mapping package combined
port table, whose structure defines one ME as the master. It is recommended that the PPTP RE UNI
be the master, with the RE upstream amplifier as a secondary ME.

The administrative state, operational state and ARC attributes of the master ME override similar
attributes in secondary MEs associated with the same port. In the secondary ME, these attributes
are present, but cause no action when written and have undefined values when read. The RE
upstream amplifier should use its provisionable upstream alarm thresholds and should declare
upstream alarms as necessary; other isomorphic alarms should be declared by the PPTP RE UNI. The
test action should be addressed to the master ME.

Relationships
	An instance of this ME is associated with each instance of a mid-span PON RE S'/R' physical
	interface of an RE that includes OEO regeneration in either direction, and it may also be
	associated with an RE upstream amplifier.

Attributes
	Managed Entity Id
		NOTE 1 - This ME ID may be identical to that of an RE upstream amplifier if it shares the same
		physical slot and port.

	Administrative State
		NOTE 2 - Administrative lock of a PPTP RE UNI results in loss of signal to any downstream ONUs.

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Re Ani_G Pointer
		RE ANI-G pointer: This attribute points to an RE ANI-G instance. (R,-W) (mandatory) (2-bytes)

	Total Optical Receive Signal Level Table
		Total optical receive signal level table: This table attribute reports a series of measurements
		of time averaged received upstream optical signal power. The measurement circuit should have a
		temporal response similar to a simple 1-pole low pass filter, with an effective time constant of
		the order of a GTC frame time. Each table entry has a 2-byte frame counter field (most
		significant end), and a 2-byte power measurement field. The frame counter field contains the
		least significant 16-bits of the superframe counter received closest to the time of the
		measurement. The power measurement field is a 2s complement integer referred to 1-mW (i.e.,
		dBm), with 0.002-dB granularity. The RE equipment should add entries to this table as frequently
		as is reasonable. The RE should clear the table once it is read by the OLT. (R) (optional) (4-*
		N-bytes, where N is the number of measurements present.)

	Per Burst Receive Signal Level Table
		Per burst receive signal level table: This table attribute reports the most recent measurement
		of received burst upstream optical signal power. Each table entry has a 2-byte ONU-ID field
		(most significant end), and a 2-byte power measurement field. The power measurement field is a
		2s complement integer referred to 1-mW (i.e.,-dBm), with 0.002-dB granularity. (R) (optional)
		(4-* N-bytes, where N is the number of distinct ONUs connected to the S'/R' interface.)

	Lower Receive Optical Threshold
		Lower receive optical threshold: This attribute specifies the optical level that the RE uses to
		declare the burst mode low received optical power alarm. Valid values are  -127-dBm (coded as
		254) to 0-dBm (coded as 0) in 0.5-dB increments. The default value 0xFF selects the RE's
		internal policy. (R,-W) (optional) (1-byte)

	Upper Receive Optical Threshold
		Upper receive optical threshold: This attribute specifies the optical level that the RE uses to
		declare the burst mode high optical power alarm. Valid values are  -127-dBm (coded as 254) to
		0-dBm (coded as 0) in 0.5-dB increments. The default value 0xFF selects the RE's internal
		policy. (R,-W) (optional) (1-byte)

	Transmit Optical Level
		Transmit optical level: This attribute reports the current measurement of the downstream mean
		optical launch power. Its value is a 2s complement integer referred to 1-mW (i.e., dBm), with
		0.002-dB granularity. (R) (optional) (2-bytes)

	Lower Transmit Power Threshold
		Lower transmit power threshold: This attribute specifies the downstream minimum mean optical
		launch power at the S'/R' interface that the RE uses to declare the low transmit optical power
		alarm. Its value is a 2s complement integer referred to 1-mW (i.e., dBm), with 0.5-dB
		granularity. The default value 0x7F selects the RE's internal policy. (R,-W) (optional) (1-byte)

	Upper Transmit Power Threshold
		Upper transmit power threshold: This attribute specifies the downstream maximum mean optical
		launch power at the S'/R' interface that the RE uses to declare the high transmit optical power
		alarm. Its value is a 2s complement integer referred to 1-mW (i.e., dBm), with 0.5-dB
		granularity. The default value 0x7F selects the RE's internal policy. (R,-W) (optional) (1-byte)

	A Dditional Preamble
		Additional preamble: This attribute indicates the number of bytes of PLOu preamble that are
		unavoidably consumed while passing the RE. (R) (mandatory) (1-byte)

	A Dditional Guard Time
		Additional guard time: This attribute indicates the number of bytes of extra guard time that are
		needed to ensure correct operation with the RE. (R) (mandatory) (1-byte)

type PhysicalPathTerminationPointVideoAni ¶

type PhysicalPathTerminationPointVideoAni struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PhysicalPathTerminationPointVideoAni (class ID #90)

This ME represents an RF video ANI in the ONU, where physical paths terminate and physical path
level functions are performed.

The ONU automatically creates an instance of this ME per port as follows.

o	When the ONU has video ANI ports built into its factory configuration.

o	When a cardholder is provisioned to expect a circuit pack of the video ANI type.

o	When a cardholder provisioned for plug-and-play is equipped with a circuit pack of the video
ANI type. Note that the installation of a plug-and-play card may indicate the presence of video
ANI ports via equipment ID as well as its type, and indeed may cause the ONU to instantiate a
port-mapping package that specifies video ANI ports.

The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
expect a video ANI circuit pack, nor is it equipped with a video ANI circuit pack.

Relationships
	An instance of this ME is associated with each instance of a real or pre-provisioned video ANI
	port.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
		number indicates the physical position of the ANI. The first byte is the slot ID (defined in
		clause 9.1.5). The second byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
		ME. Administrative state is further described in clause-A.1.6. (R,-W) (mandatory) (1-byte)

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Frequency Range Low
		(R) (mandatory) (1-byte)

	Frequency Range High
		(R) (mandatory) (1-byte)

	Signal Capability
		(R) (mandatory) (1-byte)

	Optical Signal Level
		(R) (optional) (1-byte)

	Pilot Signal Level
		(R) (optional) (1-byte)

	Signal Level Min
		Signal level min: This attribute indicates the minimum optical RF power per channel that results
		in a CNR of 47-dBc for a channel of 4.5 MHz bandwidth at a receive optical power of -5-dBm. The
		unit of this attribute is decibel-microwatt optical. (R) (mandatory) (1-byte)

	Signal Level Max
		Signal level max: This attribute indicates the maximum optical RF power per channel that results
		in a CTB of -57-dBc for an 80-channel ensemble of carriers at a perchannel optical modulation
		index (OMI) of 3.5%. The unit of this attribute is decibel-microwatt optical. (R) (mandatory)
		(1-byte)

	Pilot Frequency
		(R,-W) (optional) (4-bytes)

	Agc Mode
		(R,-W) (optional) (1-byte)

	Agc Setting
		(R,-W) (optional) (1-byte)

	Video Lower Optical Threshold
		NOTE - Because the power measurement returned in the optical signal level attribute has a
		resolution of 1-dB, it is possible that the measured value could appear to be in-range, even
		though an out-of-range alarm has been declared against a threshold with 0.1-dB resolution.

	Video Upper Optical Threshold
		Video upper optical threshold: This attribute specifies the optical level used to declare the
		video OOR high alarm. Valid values are -12 to +6-dBm in 0.1-dB increments, represented as a 2s
		complement integer. (Coding -120 to +60, 0x00-= 0-dBm, 0x88-= -12.0-dBm, etc.) Upon ME
		instantiation, the ONU sets this attribute to 0x19 (+2.5-dBm). (R,-W) (optional) (1-byte)

type PhysicalPathTerminationPointVideoUni ¶

type PhysicalPathTerminationPointVideoUni struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PhysicalPathTerminationPointVideoUni (class ID #82)

This ME represents an RF video UNI in the ONU, where physical paths terminate and physical path
level functions are performed.

The ONU automatically creates an instance of this ME per port:

o	when the ONU has RF video UNI ports built into its factory configuration;

o	when a cardholder is provisioned to expect a circuit pack of the video UNI type;

o	when a cardholder provisioned for plug-and-play is equipped with a circuit pack of the video
UNI type. Note that the installation of a plug-and-play card may indicate the presence of video
ports via equipment ID as well as its type, and indeed may cause the ONU to instantiate a port-
mapping package that specifies video ports.

The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
expect a video circuit pack, nor is it equipped with a video circuit pack.

Relationships
	One or more instances of this ME are associated with an instance of a real or virtual circuit
	pack classified as video type.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
		number indicates the physical position of the UNI. The first byte is the slot ID (defined in
		clause 9.1.5). The second byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
		ME. Administrative state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte)

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Power Control
		Power control: This attribute controls whether power is provided from the ONU to an external
		equipment over the video PPTP. Value 1 enables power over coaxial cable. The default value 0
		disables power feed. (R,-W) (optional) (1-byte)

type PhysicalPathTerminationPointXdslUniPart1 ¶

type PhysicalPathTerminationPointXdslUniPart1 struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PhysicalPathTerminationPointXdslUniPart1 (class ID #98)

This ME represents the point where physical paths terminate on an xDSL CO modem (xTU-C). The
xDSL ME family is used for ADSL VDSL2 and FAST services. A legacy family of VDSL MEs remains
valid for ITUT G.993.1 VDSL, if needed. It is documented in [ITUT G.983.2].

The ONU automatically creates an instance of this ME per port:

o	when the ONU has xDSL ports built into its factory configuration;

o	when a cardholder is provisioned to expect a circuit pack of the xDSL type;

o	when a cardholder provisioned for plug-and-play is equipped with a circuit pack of the xDSL
type. Note that the installation of a plug-and-play card may indicate the presence of xDSL ports
via equipment ID as well as its type, and indeed may cause the ONU to instantiate a port-mapping
package that specifies xDSL ports.

The ONU automatically deletes instances of this ME when a cardholder is neither provisioned to
expect an xDSL circuit pack, nor is it equipped with an xDSL circuit pack.

Relationships
	An instance of this ME is associated with each instance of a real or pre-provisioned xDSL port.

Attributes
	Managed Entity Id
		Managed entity ID:	This attribute uniquely identifies each instance of this ME. This 2 byte
		number indicates the physical position of the UNI. The six LSBs of the first byte are the slot
		ID, defined in clause 9.1.5. The two MSBs indicate the channel number in some of the implicitly
		linked MEs, and must be 0 in the PPTP itself. This reduces the possible number of physical slots
		to 64. The second byte is the port ID, with the range 1..255. (R) (mandatory) (2-bytes)

	Loopback Configuration
		Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory) (1-byte)

	Administrative State
		Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
		ME. Administrative state is further described in clause A.1.6. (R,-W) (mandatory) (1-byte)

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Xdsl Line Configuration Profile
		xDSL line configuration profile: This attribute points to an instance of the xDSL line
		configuration profiles (part 1, 2 and 3) MEs, and if necessary, also to VDSL2 line configuration
		extensions (1 and 2) MEs, also to vectoring line configuration extension MEs. Upon ME
		instantiation, the ONU sets this attribute to 0, a null pointer. (R,-W) (mandatory) (2-bytes)

	Xdsl Subcarrier Masking Downstream Profile
		xDSL subcarrier masking downstream profile: This attribute points to an instance of the xDSL
		subcarrier masking downstream profile ME. Upon ME instantiation, the ONU sets this attribute to
		0, a null pointer. (R,-W) (mandatory) (2-bytes)

	Xdsl Subcarrier Masking Upstream Profile
		xDSL subcarrier masking upstream profile: This attribute points to an instance of the xDSL
		subcarrier masking upstream profile ME. Upon ME instantiation, the ONU sets this attribute to 0,
		a null pointer. (R,-W) (mandatory) (2-bytes)

	Xdsl Downstream Power Spectral Density Psd Mask Profile
		xDSL downstream power spectral density (PSD) mask profile: This attribute points to an instance
		of the xDSL PSD mask profile ME that defines downstream parameters. Upon ME instantiation, the
		ONU sets this attribute to 0, a null pointer. (R,-W) (mandatory) (2-bytes)

	Xdsl Downstream Rfi Bands Profile
		xDSL downstream RFI bands profile: This attribute points to an instance of the xDSL downstream
		RFI bands profile ME. Upon ME instantiation, the ONU sets this attribute to 0, a null pointer.
		(R,-W) (mandatory) (2-bytes)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Modem Type
		NOTE - Many newer VDSL2 chip sets support only PTM. The ATM default is retained for backward
		compatibility, but implementers should be aware that the default may need to be overridden by
		provisioning before the xDSL UNI can be brought into service.

	Upstream Psd Mask Profile
		Upstream PSD mask profile: This attribute points to an instance of the xDSL PSD mask profile
		that defines upstream parameters. Upon ME instantiation, the ONU sets this attribute to 0, a
		null pointer. (R,-W) (optional) (2-bytes)

	Network Specific Extensions Pointer
		Network specific extensions pointer: This attribute points to a network address ME that contains
		the path and name of a file containing network specific parameters for the associated UNI. Upon
		ME instantiation, the ONU sets this attribute to 0xFFFF, a null pointer. (R,-W) (optional)
		(2-bytes)

type PhysicalPathTerminationPointXdslUniPart2 ¶

type PhysicalPathTerminationPointXdslUniPart2 struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PhysicalPathTerminationPointXdslUniPart2 (class ID #99)

This ME represents the point in the ONU where physical paths terminate on an xDSL CO modem
(xTU-C). Standards and chip sets support several forms of DSL, including VDSL2, and the xDSL ME
family is used for all of them, with specific extensions for technology variations.

The ONU creates or deletes an instance of this ME at the same time it creates or deletes the
corresponding PPTP xDSL UNI part 1.

Relationships
	An instance of this ME is associated with each instance of a PPTP xDSL UNI part 1.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PPTP xDSL UNI part 1. (R)
		(mandatory) (2-bytes)

	Xdsl Channel Configuration Profile For Bearer Channel 0 Downstream
		xDSL channel configuration profile for bearer channel 0 downstream: 	(R,-W) (optional) (2-bytes)

	Xdsl Channel Configuration Profile For Bearer Channel 1 Downstream
		xDSL channel configuration profile for bearer channel 1 downstream: 	(R,-W) (optional) (2-bytes)

	Xdsl Channel Configuration Profile For Bearer Channel 2 Downstream
		xDSL channel configuration profile for bearer channel 2 downstream: 	(R,-W) (optional) (2-bytes)

	Xdsl Channel Configuration Profile For Bearer Channel 3 Downstream
		xDSL channel configuration profile for bearer channel 3 downstream: 	(R,-W) (optional) (2-bytes)

	Xdsl Channel Configuration Profile For Bearer Channel 0 Upstream
		xDSL channel configuration profile for bearer channel 0 upstream: 	(R,-W) (optional) (2-bytes)

	Xdsl Channel Configuration Profile For Bearer Channel 1 Upstream
		xDSL channel configuration profile for bearer channel 1 upstream: 	(R,-W) (optional) (2-bytes)

	Xdsl Channel Configuration Profile For Bearer Channel 2 Upstream
		xDSL channel configuration profile for bearer channel 2 upstream: 	(R,-W) (optional) (2-bytes)

	Xdsl Channel Configuration Profile For Bearer Channel 3 Upstream
		xDSL channel configuration profile for bearer channel 3 upstream: 	(R,-W) (optional) (2-bytes)

type PriorityQueue ¶

type PriorityQueue struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PriorityQueue (class ID #277)

NOTE 1 - In [ITU-T G.984.4], this is called a priority queue-G.

This ME specifies the priority queue used by a GEM port network CTP in the upstream direction.
The upstream priority queue ME is also related to a T-CONT ME. By default, this relationship is
fixed by the ONU hardware architecture, but some ONUs may also permit the relationship to be
configured through the OMCI, as indicated by the QoS configuration flexibility attribute of the
ONU2G ME.

In the downstream direction, priority queues are associated with UNIs. Again, the association is
fixed by default, but some ONUs may permit the association to be configured through the OMCI.

If an ONU as a whole contains priority queues, it instantiates these queues autonomously.
Priority queues may also be localized to pluggable circuit packs, in which case the ONU creates
and deletes them in accordance with circuit pack pre-provisioning and the equipped
configuration.

The OLT can find all the queues by reading the priority queue ME instances. If the OLT tries to
retrieve a non-existent priority queue, the ONU denies the get action with an error indication.

See also Appendix II.

Priority queues can exist in the ONU core and circuit packs serving both UNI and ANI functions.
Therefore, they can be indirectly created and destroyed through cardholder provisioning actions.

In the upstream direction, the weight attribute permits the configuring of an optional traffic
scheduler. Several attributes support back pressure operation, whereby a back-pressure signal is
sent backwards and causes the attached terminal to temporarily suspend sending data.

In the downstream direction, strict priority discipline among the queues serving a given UNI is
the default, with priorities established through the related port attribute. If two or more non-
empty queues have the same priority, capacity is allocated among them in proportion to their
weights. Note that the details of the downstream model differ from those of the upstream model.

The yellow packet drop thresholds specify the drop probability for a packet that has been marked
yellow (drop eligible) by a traffic descriptor or by external equipment such as a residential
gateway (RG). If the current average queue occupancy is less than the minimum threshold, the
yellow packet drop probability is zero. If the current average queue occupancy is greater than
or equal to the maximum threshold, the yellow packet drop probability is one. The yellow drop
probability increases linearly between 0 and max_p as the current average queue occupancy
increases from the minimum to the maximum threshold.

The same model can be configured for green packets, those regarded as being within the traffic
contract.

Drop precedence colour marking indicates the method by which a packet is marked as drop eligible
(yellow). For discard eligibility indicator (DEI) and priority code point (PCP) marking, a drop
eligible indicator is equivalent to yellow colour; otherwise, the colour is green. For
differentiated services code point (DSCP) assured forwarding (AF) marking, the lowest drop
precedence is equivalent to green; otherwise, the colour is yellow.

Relationships
	One or more instances of this ME are associated with the ONU-G ME to model upstream priority
	queues if the traffic management option attribute in the ONU-G ME is 0 or 2.////		One or more instances of this ME are associated with a PPTP UNI ME as downstream priority
	queues. Downstream priority queues may or may not be provided for a virtual Ethernet interface
	point (VEIP).

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The MSB
		represents the direction (1: upstream, 0:-downstream). The 15 LSBs represent a queue ID. The
		queue ID is numbered in ascending order by the ONU itself. It is strongly encouraged that the
		queue ID be formulated to simplify finding related queues. One way to do this is to number the
		queues such that the related port attributes are in ascending order (for the downstream and
		upstream queues separately). The range of downstream queue ids is 0 to 0x7FFF and the range of
		upstream queue ids is 0x8000 to 0xFFFF. (R) (mandatory) (2-bytes)

	Queue Configuration Option
		Queue configuration option: This attribute identifies the buffer partitioning policy. The value
		1 means that several queues share one buffer of maximum queue size, while the value 0 means that
		each queue has an individual buffer of maximum queue size. (R) (mandatory) (1-byte)

	Maximum Queue Size
		NOTE 2 - In this and the other similar attributes of the priority queue ME, some legacy
		implementations may take the queue scale factor from the GEM block length attribute of the ANI-G
		ME. This option is discouraged in new implementations.

	Allocated Queue Size
		Allocated queue size: This attribute identifies the allocated size of this queue, in bytes,
		scaled by the priority queue scale factor attribute of the ONU2G. (R, W) (mandatory) (2 bytes)

	Discard_Block Counter Reset Interval
		Discard-block counter reset interval: This attribute represents the interval in milliseconds at
		which the counter resets itself. (R,-W) (optional) (2-bytes)

	Threshold Value For Discarded Blocks Due To Buffer Overflow
		Threshold value for discarded blocks due to buffer overflow: This attribute specifies the
		threshold for the number of bytes (scaled by the priority queue scale factor attribute of the
		ONU2G) discarded on this queue due to buffer overflow. Its value controls the declaration of the
		block loss alarm. (R, W) (optional) (2-bytes)

	Related Port
		If flexible configuration is not supported, the ONU should reject an attempt to set the related
		port with a parameter error result-reason code.

	Traffic Scheduler Pointer
		The ONU should reject an attempt to violate these conditions with a parameter error result-
		reason code.

	Weight
		Weight:	This attribute represents weight for WRR scheduling. At a given priority level, capacity
		is distributed to non-empty queues in proportion to their weights. In the upstream direction,
		this weight is meaningful if several priority queues are associated with a traffic scheduler or
		T-CONT whose policy is WRR. In the downstream direction, this weight is used by a UNI in a WRR
		fashion. Upon ME instantiation, the ONU sets this attribute to 1. (R,-W) (mandatory) (1-byte)

	Back Pressure Operation
		Back pressure operation: This attribute enables (0) or disables (1) back pressure operation. Its
		default value is 0. (R,-W) (mandatory) (2-bytes)

	Back Pressure Time
		Back pressure time: This attribute specifies the duration in microseconds of the backpressure
		signal. It can be used as a pause time for an Ethernet UNI. Upon ME instantiation, the ONU sets
		this attribute to 0. (R,-W) (mandatory) (4-bytes)

	Back Pressure Occur Queue Threshold
		Back pressure occur queue threshold: This attribute identifies the threshold queue occupancy, in
		bytes, scaled by the priority queue scale factor attribute of the ONU2G, to start sending a
		back-pressure signal. (R, W) (mandatory) (2-bytes)

	Back Pressure Clear Queue Threshold
		Back pressure clear queue threshold: This attribute identifies the threshold queue occupancy, in
		bytes, scaled by the priority queue scale factor attribute of the ONU2G, to stop sending a back-
		pressure signal. (R, W) (mandatory) (2-bytes)

	Packet Drop Queue Thresholds
		Packet drop queue thresholds: This attribute is a composite of four 2-byte values, a minimum and
		a maximum threshold, measured in bytes, scaled by the priority queue scale factor attribute of
		the ONU2-G, for green and yellow packets. The first value is the minimum green threshold, the
		queue occupancy below which all green packets are admitted to the queue. The second value is the
		maximum green threshold, the queue occupancy at or above which all green packets are discarded.
		The third value is the minimum yellow threshold, the queue occupancy below which all yellow
		packets are admitted to the queue. The fourth value is the maximum yellow threshold, the queue
		occupancy at or above which all yellow packets are discarded. The default is that all thresholds
		take the value of the maximum queue size. (R,-W) (optional) (8-bytes)

	Packet Drop Max_P
		Packet drop max_p: This attribute is a composite of two 1-byte values, the probability of
		dropping a coloured packet when the queue occupancy lies just below the maximum threshold for
		packets of that colour. The first value is the green packet max_p, and the second value is the
		yellow packet max_p. The probability, max_p, is determined by adding one to the unsigned value
		(0..255) of this attribute and dividing the result by 256. The default for each value is 255.
		(R,-W) (optional) (2-bytes)

	Queue Drop W_Q
		Queue drop w_q: This attribute determines the averaging coefficient, w_q, as described in
		[b-Floyd]. The averaging coefficient, w_q, is equal to 2Queue_drop_w_q. For example, when queue
		drop_w_q has the value 9, the averaging coefficient, w_q, is 1/512-= 0.001-9. The default value
		is 9. (R,-W) (optional) (1-byte)

	Drop Precedence Colour Marking
		(R,-W) (optional) (1-byte)

type PseudowireMaintenanceProfile ¶

type PseudowireMaintenanceProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PseudowireMaintenanceProfile (class ID #284)

The pseudowire maintenance profile permits the configuration of pseudowire service exception
handling. It is created and deleted by the OLT.

The settings, and indeed existence, of a pseudowire maintenance profile affect the behaviour of
the pseudowire PM history data ME only in establishing criteria for counting SESs, but in no
other way. The pseudowire maintenance profile primarily affects the alarms declared by the
subscribing pseudowire TP.

Relationships
	One or more instances of the pseudowire TP may point to an instance of the pseudowire
	maintenance profile. If the pseudowire TP does not refer to a pseudowire maintenance profile,
	the ONU's default exception handling is implied.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The value 0 is
		reserved. (R, setbycreate) (mandatory) (2-bytes)

	Jitter Buffer Maximum Depth
		Jitter buffer maximum depth: This attribute specifies the desired maximum depth of the playout
		buffer in the PSN to the TDM direction. The value is expressed as a multiple of the 125-vs frame
		rate. The default value 0 selects the ONU's internal policy. (R,-W, setbycreate) (optional)
		(2-bytes)

	Jitter Buffer Desired Depth
		Jitter buffer desired depth: This attribute specifies the desired nominal fill depth of the
		playout buffer in the PSN to the TDM direction. The value is expressed as a multiple of the
		125-vs frame rate. The default value 0 selects the ONU's internal policy. (R,-W, setbycreate)
		(optional) (2-bytes)

	Fill Policy
		(R,-W, setbycreate) (optional) (1-byte)

	Misconnected Packets Declaration Policy
		Misconnected packets declaration policy: (R,-W, setbycreate) (optional) (1-byte)

	Misconnected Packets Clear Policy
		Misconnected packets clear policy: (R,-W, setbycreate) (optional) (1-byte)

	Loss Of Packets Declaration Policy
		Loss of packets declaration policy: (R,-W, setbycreate) (optional) (1-byte)

	Loss Of Packets Clear Policy
		Loss of packets clear policy: (R,-W, setbycreate) (optional) (1-byte)

	Buffer Overrun_Underrun Declaration Policy
		Buffer overrun/underrun declaration policy: (R,-W, setbycreate) (optional) (1-byte)

	Buffer Overrun_Underrun Clear Policy
		Buffer overrun/underrun clear policy: (R,-W, setbycreate) (optional) (1-byte)

	Malformed Packets Declaration Policy
		Malformed packets declaration policy: (R,-W, setbycreate) (optional) (1-byte)

	Malformed Packets Clear Policy
		Malformed packets clear policy: (R,-W, setbycreate) (optional) (1-byte)

	R_Bit Transmit Set Policy
		R-bit transmit set policy: This attribute defines the number of consecutive lost packets that
		causes the transmitted R bit to be set in the TDM to the PSN direction, indicating lost packets
		to the far end. The default value 0 selects the ONU's internal policy. (R,-W, setbycreate)
		(optional) (1-byte)

	R_Bit Transmit Clear Policy
		R-bit transmit clear policy: This attribute defines the number of consecutive valid packets that
		causes the transmitted R bit to be cleared in the TDM to the PSN direction, removing the remote
		failure indication to the far end. The default value 0 selects the ONU's internal policy. (R,-W,
		setbycreate) (optional) (1-byte)

	R_Bit Receive Policy
		(R,-W, setbycreate) (optional) (1-byte)

	L Bit Receive Policy
		(R,-W, setbycreate) (optional) (1-byte)

	Ses Threshold
		SES threshold: Number of lost, malformed or otherwise unusable packets expected in the PSN to
		the TDM direction within a 1-s interval that causes an SES to be counted. Stray packets do not
		count towards an SES, nor do packets whose L bit is set at the far end. The value 0 specifies
		that the ONU uses its internal default, which is not necessarily the same as the recommended
		default value 3. (R, W, set-by-create) (optional) (2 bytes)

type PseudowirePerformanceMonitoringHistoryData ¶

type PseudowirePerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PseudowirePerformanceMonitoringHistoryData (class ID #285)

This ME collects PM for a pseudowire TP. Most of the attributes monitor packets received from
the PSN, and may therefore be considered egress PM. For the most part, ingress PM is collected
at the CES PPTP ME.

NOTE - The pseudowire PM history data ME collects data similar, but not identical, to that
available from the MAC bridge port PM history data ME associated with a MAC bridge. When the
pseudowire is bridge-based, it may not be necessary to collect both.

Instances of this ME are created and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the pseudowire TP.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the pseudowire TP. (R, setbycreate)
		(mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 and 2 MEs
		that contains PM threshold values. (R,-W, setbycreate) (mandatory) (2-bytes)

	Received Packets
		Received packets: This attribute counts the total number of packets, both payload and
		signalling, received in the PSN to the TDM direction. (R) (mandatory) (4-bytes)

	Transmitted Packets
		Transmitted packets: This attribute counts the total number of packets, both payload and
		signalling, transmitted in the TDM to the PSN direction. The count includes packets whose L bit
		is set and which may therefore not contain a payload. (R) (mandatory) (4-bytes)

	Missing Packets
		Missing packets: This attribute counts the number of lost packets, as indicated by gaps in the
		control word numbering sequence. Both payload and signalling packets, if any, contribute to this
		count. (R) (mandatory) (4-bytes)

	Misordered Packets, Usable
		Misordered packets, usable: This attribute counts the number of packets received out of order,
		but which were able to be successfully re-ordered and played out. Both payload and signalling
		packets, if any, contribute to this count. (R) (mandatory) (4-bytes)

	Misordered Packets Dropped
		Misordered packets dropped: This attribute counts the number of packets received out of sequence
		that were discarded, either because the ONU did not support reordering or because it was too
		late to reorder them. Both payload and signalling packets, if any, contribute to this count. (R)
		(mandatory) (4-bytes)

	Playout Buffer Underruns_Overruns
		Playout buffer underruns/overruns: This attribute counts the number of packets that were
		discarded because they arrived too late or too early to be played out. Both payload and
		signalling packets, if any, contribute to this count. (R) (mandatory) (4-bytes)

	Malformed Packets
		Malformed packets: This attribute counts the number of malformed packets, e.g., because the
		packet length was not as expected or because of an unexpected RTP payload type. Both payload and
		signalling packets, if any, contribute to this count. (R) (mandatory) (4-bytes)

	Stray Packets
		Stray packets: This attribute counts the number of packets whose ECID or RTP SSRC failed to
		match the expected value, or which are otherwise known to have been misdelivered. Stray packets
		are discarded without affecting any of the other PM counters. Both payload and signalling
		packets, if any, contribute to this count. (R) (mandatory) (4-bytes)

	Remote Packet Loss
		Remote packet loss: This attribute counts received packets whose R bit is set, indicating the
		loss of packets at the far end. Both payload and signalling packets, if any, contribute to this
		count. (R) (mandatory) (4-bytes)

	Tdm L_Bit Packets Transmitted
		TDM L-bit packets transmitted: This attribute counts the number of packets transmitted with the
		L bit set, indicating a near-end TDM fault. Both payload and signalling packets, if any,
		contribute to this count. (R) (mandatory) (4-bytes)

	Es
		ES:	This attribute counts errored seconds. Any discarded, lost, malformed or unusable packet
		received from the PSN during a given second causes this counter to increment. Both payload and
		signalling packets, if any, contribute to this count. (R) (mandatory) (4-bytes)

	Ses
		SES:	This attribute counts severely errored seconds. The criterion for an SES may be configured
		through the pseudowire maintenance profile ME. Both payload and signalling packets, if any,
		contribute to this count. (R) (mandatory) (4-bytes)

	Uas
		UAS:	This attribute counts unavailable seconds. An unavailable second begins at the onset of 10
		consecutive SES and ends at the onset of 10 consecutive seconds that are not severely errored. A
		service is unavailable if either its payload or its signalling, if any, are unavailable. During
		unavailable time, only UAS should be counted; other anomalies should not be counted. (R)
		(mandatory) (4-bytes)

type PseudowireTerminationPoint ¶

type PseudowireTerminationPoint struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PseudowireTerminationPoint (class ID #282)

The pseudowire TP supports packetized (rather than TDM) transport of TDM services, transported
either directly over Ethernet, over UDP/IP or over MPLS. Instances of this ME are created and
deleted by the OLT.

Relationships
	One pseudowire TP ME exists for each distinct TDM service that is mapped to a pseudowire.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Underlying Transport
		(R,-W, setbycreate) (mandatory) (1-byte)

	Service Type
		(R,-W, setbycreate) (mandatory) (1-byte)

	Signalling
		(R,-W, setbycreate) (mandatory for structured service type) (1-byte)

	Tdm Uni Pointer
		TDM UNI pointer: If service type-= structured, this attribute points to a logical N-* 64-kbit/s
		subport CTP. Otherwise, this attribute points to a PPTP CES UNI. (R,-W, setbycreate) (mandatory)
		(2-bytes)

	North_Side Pointer
		North-side pointer: When the pseudowire service is transported via IP, as indicated by the
		underlying transport attribute, the northside pointer attribute points to an instance of the
		TCP/UDP config data ME. When the pseudowire service is transported directly over Ethernet, the
		north-side pointer attribute is not used - the linkage to the Ethernet flow TP is implicit in
		the ME IDs. When the pseudowire service is transported over MPLS, the northside pointer
		attribute points to an instance of the MPLS PW TP. (R, W, setbycreate) (mandatory) (2 bytes)

	Far_End Ip Info
		A null pointer is appropriate if the pseudowire is not transported via IP. (R,-W, setbycreate)
		(mandatory for IP transport) (2-bytes)

	Payload Size
		(R,-W, setbycreate) (mandatory for unstructured service) (2-bytes)

	Payload Encapsulation Delay
		(R,-W, setbycreate) (mandatory for structured service) (1-byte)

	Timing Mode
		(R,-W) (mandatory) (1-byte)

	Transmit Circuit Id
		(R,-W) (mandatory for MEF 8 transport) (8-bytes)

	Expected Circuit Id
		(R,-W) (optional for MEF 8 transport) (8-bytes)

	Received Circuit Id
		Received circuit ID: This attribute indicates the actual ECID(s) received on the payload and
		signalling channels, respectively. It may be used for diagnostic purposes. (R) (optional for MEF
		8 transport) (8-bytes)

	Exception Policy
		Exception policy: This attribute points to an instance of the pseudowire maintenance profile ME.
		If the pointer has its default value 0, the ONU's internal defaults apply. (R,-W) (optional)
		(2-bytes)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

type PwAtmConfigurationData ¶ added in v0.13.0

type PwAtmConfigurationData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PwAtmConfigurationData (class ID #337)

This ME contains generic configuration data for an ATM pseudowire. Definitions of attributes are
from PW-ATM-MIB [IETF RFC 5605]. Instances of this ME are created and deleted by the OLT.

Relationships
	An instance of this ME is associated with an instance of the MPLS pseudowire TP ME with a
	pseudowire type attribute equal to one of the following.////		2	ATM AAL5 SDU VCC transport////		3	ATM transparent cell transport////		9	ATM n-to-one VCC cell transport////		10	ATM n-to-one VPC cell transport////		12	ATM one-to-one VCC cell mode////		13	ATM one-to-one VPC cell mode////		14	ATM AAL5 PDU VCC transport////		Alternatively, an instance of this ME may be associated with an Ethernet flow TP or a TCP/UDP
	config data ME, depending on the transport layer of the pseudowire.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R,
		setbycreate)-(mandatory) (2 bytes)

	Tp Type
		2	TCP/UDP config data

	Transport Tp Pointer
		Transport TP pointer: This attribute points to an associated instance of the transport layer TP,
		whose type is specified by the TP type attribute. (R, W, setbycreate) (mandatory) (2 bytes)

	Pptp Atm Uni Pointer
		PPTP ATM UNI pointer: This attribute points to an associated instance of the ITU-T G.983.2 PPTP
		ATM UNI. Refer to [ITUT G.983.2] for the definition of the target ME. (R, W, setbycreate)
		(mandatory) (2 bytes)

	Max C Ell C Oncatenation
		Max cell concatenation: This attribute specifies the maximum number of ATM cells that can be
		concatenated into one PW packet in the upstream direction. (R, W, setbycreate) (mandatory) (2
		bytes)

	Far End M Ax C Ell C Oncatenation
		Far-end max cell concatenation: This attribute specifies the maximum number of ATM cells that
		can be concatenated into one PW packet as provisioned at the far end. This attribute may be used
		for error checking of downstream traffic. The value 0 specifies that the ONU uses its internal
		default. (R, W, set-by-create) (optional) (2 bytes)

	Atm Cell Loss Priority Clp Qos Mapping
		The value 0 specifies that the ONU uses its internal default. (R, W, setbycreate) (optional) (1
		byte)

	Timeout Mode
		The value 0 specifies that the ONU uses its internal default. (R, W, setbycreate) (optional) (1
		byte)

	Pw Atm Mapping Table
		(R,-W) (mandatory) (21N bytes, where N is the number of entries in the list)

type PwAtmPerformanceMonitoringHistoryData ¶

type PwAtmPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PwAtmPerformanceMonitoringHistoryData (class ID #338)

This ME collects PM data associated with an ATM pseudowire. Instances of this ME are created and
deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the PW ATM configuration data ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to the instance of the PW ATM configuration data ME.
		(R, setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Downstream Missing Packets Counter
		Downstream missing packets counter: This attribute counts missing packets, as detected via
		control word sequence number gaps. (R) (mandatory) (4-bytes)

	Downstream Reordered Packets Counter
		Downstream reordered packets counter: This attribute counts packets detected out of sequence via
		the control word sequence number, but successfully reordered. Some implementations may not
		support this feature. (R) (optional) (4-bytes)

	Downstream Misordered Packets Counter
		Downstream misordered packets counter: This attribute counts packets detected out of order via
		the control word sequence numbers. (R) (mandatory) (4-bytes)

	Upstream Timeout Packets Counter
		Upstream timeout packets counter: This attribute counts packets transmitted due to timeout
		expiration while attempting to collect cells. (R) (mandatory) (4-bytes)

	Upstream Transmitted Cells Counter
		Upstream transmitted cells counter: This attribute counts transmitted cells. (R) (mandatory)
		(4-bytes)

	Upstream Dropped Cells Counter
		Upstream dropped cells counter: This attribute counts dropped cells. (R) (mandatory) (4-bytes)

	Upstream Received Cells Counter
		Upstream received cells counter: This attribute counts received cells. (R) (mandatory) (4-bytes)

type PwEthernetConfigurationData ¶

type PwEthernetConfigurationData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

PwEthernetConfigurationData (class ID #339)

This ME contains the Ethernet pseudowire configuration data. Instances of this ME are created
and deleted by the OLT.

Relationships
	An instance of this ME is associated with an instance of the MPLS pseudowire TP ME with a
	pseudowire type attribute equal to the following.////		5	Ethernet

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R,
		setbycreate)-(mandatory) (2 bytes)

	Mpls Pseudowire Tp Pointer
		MPLS pseudowire TP pointer: This attribute points to an instance of the MPLS pseudowire TP ME
		associated with this ME. (R, W, setbycreate) (mandatory) (2 bytes)

	Tp Type
		(R,-W, setbycreate) (mandatory) (1-byte)

	Uni Pointer
		UNI pointer: This attribute points to the associated instance of a UNI-side ME. The type of UNI
		is determined by the TP type attribute. (R, W, setbycreate) (mandatory) (2 bytes)

type RadiusPerformanceMonitoringHistoryData ¶

type RadiusPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

RadiusPerformanceMonitoringHistoryData (class ID #293)

This ME collects performance statistics on an ONU's radius client, particularly as related to
its IEEE-802.1X operation.

Instances of this ME are created and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an ONU.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID (namely 0), this ME is implicitly linked to an instance of a dot1X configuration
		profile. (R, setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Access_Request Packets Transmitted
		Access-request packets transmitted: This attribute counts transmitted radius access-request
		messages, including retransmissions. (R) (mandatory) (4-bytes)

	Access_Request Retransmission Count
		Access-request retransmission count: This attribute counts radius access-request
		retransmissions. (R) (mandatory) (4-bytes)

	Access_Challenge Packets Received
		Access-challenge packets received: This attribute counts received radius access-challenge
		messages. (R) (mandatory) (4-bytes)

	Access_Accept Packets Received
		Access-accept packets received: This attribute counts received radius access-accept messages.
		(R) (mandatory) (4-bytes)

	Access_Reject Packets Received
		Access-reject packets received: This attribute counts received radius access-reject messages.
		(R) (mandatory) (4-bytes)

	Invalid Radius Packets Received
		Invalid radius packets received: This attribute counts received invalid radius messages. (R)
		(mandatory) (4-bytes)

type ReAniG ¶

type ReAniG struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

ReAniG (class ID #313)

This ME organizes data associated with each R'/S' physical interface of an RE if the RE supports
OEO regeneration in either direction. The management ONU automatically creates one instance of
this ME for each R'/S' physical port (uni- or bidirectional) as follows.

o	When the RE has mid-span PON RE ANI interface ports built into its 	factory configuration.

o	When a cardholder is provisioned to expect a circuit pack of the mid-span PON RE ANI type.

o	When a cardholder provisioned for plug-and-play is equipped with a circuit pack of the midspan
PON RE ANI type. Note that the installation of a plug-and-play card may indicate the presence of
a mid-span PON RE ANI port via equipment ID as well as its type attribute, and indeed may cause
the management ONU to instantiate a port-mapping package to specify the ports precisely.

The management ONU automatically deletes instances of this ME when a cardholder is neither
provisioned to expect a mid-span PON RE ANI circuit pack, nor is it equipped with a mid-span PON
RE ANI circuit pack.

As illustrated in Figure 8.2.10-4, an RE ANI-G may share the physical port with an RE downstream
amplifier. The ONU declares a shared configuration through the port-mapping package combined
port table, whose structure defines one ME as the master. It is recommended that the RE ANI-G be
the master, with the RE downstream amplifier as a secondary ME.

The administrative state, operational state and ARC attributes of the master ME override similar
attributes in secondary MEs associated with the same port. In the secondary ME, these attributes
are present, but cause no action when written and have undefined values when read. The RE
downstream amplifier should use its provisionable downstream alarm thresholds and should declare
downstream alarms as necessary; other isomorphic alarms should be declared by the RE ANI-G. The
test action should be addressed to the master ME.

Relationships
	An instance of this ME is associated with each R'/S' physical interface of an RE that includes
	OEO regeneration in either direction, and with one or more instances of the PPTP RE UNI. It may
	also be associated with an RE downstream amplifier.

Attributes
	Managed Entity Id
		NOTE 1 - This ME ID may be identical to that of an RE downstream amplifier if it shares the same
		physical slot and port.

	Administrative State
		NOTE 2 - When an RE supports multiple PONs, or protected access to a single PON, its primary
		ANI-G cannot be completely shut down, due to a loss of the management communications capability.
		Complete blocking of service and removal of power may nevertheless be appropriate for secondary
		RE ANI-Gs. Administrative lock suppresses alarms and notifications for an RE ANI-G, be it either
		primary or secondary.

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Optical Signal Level
		Optical signal level: This attribute reports the current measurement of total downstream optical
		power. Its value is a 2s complement integer referred to 1-mW (i.e., dBm), with 0.002-dB
		granularity. (R) (optional) (2-bytes)

	Lower Optical Threshold
		Lower optical threshold: This attribute specifies the optical level that the RE uses to declare
		the downstream low received optical power alarm. Valid values are  -127-dBm (coded as 254) to
		0-dBm (coded as 0) in 0.5-dB increments. The default value 0xFF selects the RE's internal
		policy. (R,-W) (optional) (1-byte)

	Upper Optical Threshold
		Upper optical threshold: This attribute specifies the optical level that the RE uses to declare
		the downstream high received optical power alarm. Valid values are  -127-dBm (coded as 254) to
		0-dBm (coded as 0) in 0.5 dB increments. The default value 0xFF selects the RE's internal
		policy. (R,-W) (optional) (1-byte)

	Transmit Optical Level
		Transmit optical level: This attribute reports the current measurement of mean optical launch
		power. Its value is a 2s complement integer referred to 1-mW (i.e., dBm), with 0.002-dB
		granularity. (R) (optional) (2-bytes)

	Lower Transmit Power Threshold
		Lower transmit power threshold: This attribute specifies the minimum mean optical launch power
		that the RE uses to declare the low transmit optical power alarm. Its value is a 2s-complement
		integer referred to 1-mW (i.e., dBm), with 0.5-dB granularity. The default value 0x7F selects
		the RE's internal policy. (R,-W) (optional) (1-byte)

	Upper Transmit Power Threshold
		Upper transmit power threshold: This attribute specifies the maximum mean optical launch power
		that the RE uses to declare the high transmit optical power alarm. Its value is a 2s-complement
		integer referred to 1-mW (i.e., dBm), with 0.5-dB granularity. The default value 0x7F selects
		the RE's internal policy. (R,-W) (optional) (1-byte)

	Usage Mode
		3	This R'/S' interface is used as the uplink for both the embedded management ONU and one or
		more PPTP RE UNI(s) (in a time division fashion).

	Target Upstream Frequency
		Target upstream frequency: This attribute specifies the frequency of the converted upstream
		signal on the optical trunk line (OTL), in gigahertz. The converted frequency must conform to
		the frequency plan specified in [ITUT G.984.6]. The value 0 means that the upstream signal
		frequency remains the same as the original frequency; no frequency conversion is done. If the RE
		does not support provisionable upstream frequency (wavelength), this attribute should take the
		fixed value representing the RE's capability and the RE should deny attempts to set the value of
		the attribute. If the RE does support provisionable upstream frequency conversion, the default
		value of this attribute is 0. (R, W) (optional) (4 bytes).

	Target Downstream Frequency
		Target downstream frequency: This attribute specifies the frequency of the downstream signal
		received by the RE on the OTL, in gigahertz. The incoming frequency must conform to the
		frequency plan specified in [ITUT G.984.6]. The default value 0 means that the downstream
		frequency remains the same as its original frequency; no frequency conversion is done. If the RE
		does not support provisionable downstream frequency selectivity, this attribute should take the
		fixed value representing the RE's capability, and the RE should deny attempts to set the value
		of the attribute. If the RE does support provisionable downstream frequency selectivity, the
		default value of this attribute is 0. (R, W) (optional) (4 bytes).

	Upstream Signal Transmission Mode
		Upstream signal transmission mode: When true, this Boolean attribute enables conversion from
		burst mode to continuous mode. The default value false specifies burst mode upstream
		transmission. If the RE does not have the ability to convert from burst to continuous mode
		transmission, it should deny attempts to set this attribute to true. (R, W) (optional) (1 byte)

type ReCommonAmplifierParameters ¶

type ReCommonAmplifierParameters struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

ReCommonAmplifierParameters (class ID #328)

This ME organizes data associated with each OA supported by the RE. The management ONU
automatically creates one instance of this ME for each upstream or downstream OA.

Relationships
	An instance of this ME is associated with an instance of the RE downstream amplifier or RE
	upstream amplifier ME.

Attributes
	Managed Entity Id
		NOTE - The type of the linked ME can be determined by uniqueness of slot and port.

	Gain
		Gain:	This attribute reports the current measurement of the OA's gain, in decibels. Its value is
		a 2s complement integer with 0.25-dB granularity, and with a range from -32-dB to 31.5-dB. The
		value 0x7F indicates that the current measured gain is 0, i.e., negative infinity in decibels
		terms. (R) (optional) (1-byte)

	Lower Gain Threshold
		Lower gain threshold: This attribute specifies the gain the RE uses to declare the low gain
		alarm. Valid values are 0-dB (coded as 0x00) to 63.5-dB (coded as 0xFE). The default value 0xFF
		selects the RE's internal policy. (R,-W) (optional) (1-byte)

	Upper Gain Threshold
		Upper gain threshold: This attribute specifies the gain the RE uses to declare the high gain
		alarm. Valid values are 0-dB (coded as 0x00) to 63.5-dB (coded as 0xFE). The default value 0xFF
		selects the RE's internal policy. (R,-W) (optional) (1-byte)

	Target Gain
		Target gain:	This attribute specifies the target gain, when the operational mode of the parent
		RE downstream or upstream amplifier is set to constant gain mode. Valid values are 0-dB (coded
		as 0x00) to 63.5-dB (coded as 0xFE). The default value 0xFF selects the RE's internal policy.
		(R,-W) (optional) (1-byte)

	Device Temperature
		Device temperature: This attribute reports the temperature in degrees Celcius of the active
		device (SOA or pump) in the OA. Its value is a 2s complement integer with granularity
		1/256-degree-C. (R) (optional) (2-bytes)

	Lower Device Temperature Threshold
		Lower device temperature threshold: This attribute is a 2s complement integer that specifies the
		temperature the RE uses to declare the low temperature alarm. Valid values are -64 to
		+63-degree-C in 0.5-degree-C increments. The default value 0x7F selects the RE's internal
		policy. (R,-W) (optional) (1-byte)

	Upper Device Temperature Threshold
		Upper device temperature threshold: This attribute is a 2s complement integer that specifies the
		temperature the RE uses to declare the high temperature alarm. Valid values are -64 to
		+63-degree-C in 0.5-degree-C increments. The default value 0x7F selects the RE's internal
		policy. (R,-W) (optional) (1-byte)

	Device Bias Current
		Device bias current: This attribute contains the measured bias current applied to the SOA or
		pump laser. Its value is an unsigned integer with granularity 2-mA. Valid values are 0 to
		512-mA. (R) (optional) (1-byte)

	Amplifier Saturation Output Power
		Amplifier saturation output power: This attribute reports the saturation output power of the
		amplifier as specified by the manufacturer. Its value is an unsigned integer referred to 1-mW
		(i.e., dBm), with 0.1-dB granularity. (R) (optional) (2-bytes)

	Amplifier Noise Figure
		Amplifier noise figure: This attribute reports the intrinsic noise figure of the amplifier, as
		specified by the manufacturer. Its value is an unsigned integer with 0.1-dB granularity (R)
		(optional) (1-byte)

	Amplifier Saturation Gain
		Amplifier saturation gain: This attribute reports the gain of the amplifier at saturation, as
		specified by the manufacturer. Its value is an unsigned integer with 0.25-dB granularity, and
		with a range from 0 to 63.75-dB. (R) (optional) (1-byte)

type ReDownstreamAmplifier ¶

type ReDownstreamAmplifier struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

ReDownstreamAmplifier (class ID #316)

This ME organizes data associated with each OA for downstream data supported by the RE. The
management ONU automatically creates one instance of this ME for each downstream OA as follows.

o	When the RE has mid-span PON RE downstream OA ports built into its factory configuration.

o	When a cardholder is provisioned to expect a circuit pack of the mid-span PON RE downstream OA
type.

o	When a cardholder provisioned for plug-and-play is equipped with a circuit pack of the midspan
PON RE downstream OA type. Note that the installation of a plug-and-play card may indicate the
presence of a mid-span PON RE downstream OA via equipment ID as well as its type attribute, and
indeed may cause the management ONU to instantiate a port-mapping package to specify the ports
precisely.

The management ONU automatically deletes instances of this ME when a cardholder is neither
provisioned to expect a mid-span PON RE downstream OA circuit pack, nor is it equipped with a
mid-span PON RE downstream OA circuit pack.

Relationships
	An instance of this ME is associated with a downstream OA and with an instance of a circuit
	pack. If the RE includes OEO regeneration in either direction, the RE downstream amplifier is
	also associated with an RE ANI-G. Refer to clause-9.14.1 for further discussion.

Attributes
	Managed Entity Id
		NOTE 1 - This ME ID may be identical to that of an RE ANI-G if it shares the same physical slot-
		port.

	Administrative State
		NOTE 2- When an RE supports multiple PONs, or protected access to a single PON, its primary
		ANI-G cannot be completely shut down, due to a loss of the management communications capability.
		Complete blocking of service and removal of power may nevertheless be appropriate for secondary
		RE ANI-Gs. Administrative lock suppresses alarms and notifications for both primary and
		secondary RE ANI-Gs. Administrative lock suppresses alarms and notifications for an RE
		downstream amplifier, be it either primary or secondary.

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Operational Mode
		(R,W) (mandatory) (1-byte)

	Input Optical Signal Level
		Input optical signal level: This attribute reports the current measurement of the input optical
		signal power of the downstream OA. Its value is a 2s-complement integer referred to 1-mW (i.e.,
		dBm), with 0.002-dB granularity. (R) (optional) (2-bytes)

	Lower Input Optical Threshold
		Lower input optical threshold: This attribute specifies the optical level the RE uses to declare
		the low received optical power alarm. Valid values are -127-dBm (coded as 254) to 0-dBm (coded
		as 0) in 0.5-dB increments. The default value 0xFF selects the RE's internal policy. (R,-W)
		(optional) (1-byte)

	Upper Input Optical Threshold
		Upper input optical threshold: This attribute specifies the optical level the RE uses to declare
		the high received optical power alarm. Valid values are -127-dBm (coded as 254) to 0-dBm (coded
		as 0) in 0.5-dB increments. The default value 0xFF selects the RE's internal policy. (R,-W)
		(optional) (1-byte)

	Output Optical Signal Level
		Output optical signal level: This attribute reports the current measurement of the mean optical
		launch power of the downstream OA. Its value is a 2s-complement integer referred to 1-mW (i.e.,
		dBm), with 0.002-dB granularity. (R) (optional) (2-bytes)

	Lower Output Optical Threshold
		Lower output optical threshold: This attribute specifies the minimum mean optical launch power
		that the RE uses to declare the low transmit optical power alarm. Its value is a 2s complement
		integer referred to 1-mW (i.e., dBm), with 0.5-dB granularity. The default value 0x7F selects
		the RE's internal policy. (R,-W) (optional) (1-byte)

	Upper Output Optical Threshold
		Upper output optical threshold: This attribute specifies the maximum mean optical launch power
		that the RE uses to declare the high transmit optical power alarm. Its value is a 2s complement
		integer referred to 1-mW (i.e., dBm), with 0.5-dB granularity. The default value 0x7F selects
		the RE's internal policy. (R,-W) (optional) (1-byte)

	R'S' Splitter Coupling Ratio
		R'S' splitter coupling ratio: This attribute reports the coupling ratio of the splitter at the
		R'/S' interface that connects the embedded management ONU and the amplifiers to the OTL. Valid
		values are 99:1 (coded as 99-decimal) to 1:99 (coded as 1 decimal), where the first value is the
		value encoded and is the percentage of the optical signal connected to the amplifier. The
		default value 0xFF indicates that there is no splitter connected to this upstream/downstream
		amplifier pair. (R) (optional) (1-byte)

type ReUpstreamAmplifier ¶ added in v0.13.0

type ReUpstreamAmplifier struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

ReUpstreamAmplifier (class ID #315)

This ME organizes data associated with each upstream RE optical amplifier (OA) supported by the
RE. The management ONU automatically creates one instance of this ME for each upstream OA as
follows.

o	When the RE has mid-span PON RE upstream OA ports built into its factory configuration.

o	When a cardholder is provisioned to expect a circuit pack of the mid-span PON RE upstream OA
type.

o	When a cardholder provisioned for plug-and-play is equipped with a circuit pack of the mid-
span PON RE upstream OA type. Note that the installation of a plug-and-play card may indicate
the presence of a mid-span PON RE upstream OA via equipment ID as well as its type attribute,
and indeed may cause the management ONU to instantiate a port-mapping package to specify the
ports precisely.

The management ONU automatically deletes instances of this ME when a cardholder is neither
provisioned to expect a mid-span PON RE upstream OA circuit pack, nor is it equipped with a mid-
span PON RE upstream OA circuit pack.

Relationships
	An instance of this ME is associated with an upstream OA, and with an instance of a circuit
	pack. If the RE includes OEO regeneration in either direction, the RE upstream amplifier is also
	associated with a PPTP RE UNI. Refer to clause-9.14.2 for further discussion.

Attributes
	Managed Entity Id
		NOTE 1 - This ME ID may be identical to that of a PPTP RE UNI if it shares the same physical
		slot and port.

	Administrative State
		NOTE 2 - Administrative lock of an RE upstream amplifier results in LOS from any downstream
		ONUs.

	Operational State
		Operational state: This attribute indicates whether the ME is capable of performing its
		function. Valid values are enabled (0) and disabled (1). (R) (optional) (1-byte)

	Operational Mode
		(R,-W) (mandatory) (1-byte)

	Arc
		ARC:	See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Arc Interval
		ARC interval: See clause A.1.4.3. (R,-W) (optional) (1-byte)

	Re Downstream Amplifier Pointer
		RE downstream amplifier pointer: This attribute points to an RE downstream amplifier instance.
		The default value is 0xFFFF, a null pointer. (R,-W) (mandatory) (2-bytes)

	Total Optical Receive Signal Level Table
		Total optical receive signal level table: This table attribute reports a series of measurements
		of time-averaged input upstream optical signal power. The measurement circuit should have a
		temporal response similar to a simple 1 pole low pass filter, with an effective time constant on
		the order of a GTC frame time. Each table entry has a 2-byte frame counter field (most
		significant end), and a 2-byte power measurement field. The frame counter field contains the
		least significant 16-bits of the superframe counter received closest to the time of the
		measurement. The power measurement field is a 2s-complement integer referred to 1-mW (i.e.,
		dBm), with 0.002-dB granularity. The RE equipment should add entries to this table as frequently
		as is reasonable. The RE should clear the table once it is read by the OLT. (R) (optional) (4-*
		N-bytes, where N is the number of measurements present.)

	Per Burst Receive Signal Level Table
		Per burst receive signal level table: This table attribute reports the most recent measurement
		of received burst upstream optical signal power. Each table entry has a 2-byte ONU-ID field
		(most significant end), and a 2-byte power measurement field. The power measurement field is a
		2s-complement integer referred to 1-mW (i.e.,-dBm), with 0.002-dB granularity. (R) (optional)
		(4-* N-bytes, where N is the number of distinct ONUs connected to the S'/R' interface.)

	Lower Receive Optical Threshold
		Lower receive optical threshold: This attribute specifies the optical level that the RE uses to
		declare the low received optical power alarm. Valid values are -127-dBm (coded as 254) to 0-dBm
		(coded as 0) in 0.5-dB increments. The default value 0xFF selects the RE's internal policy.
		(R,-W) (optional) (1-byte)

	Upper Receive Optical Threshold
		Upper receive optical threshold: This attribute specifies the optical level that the RE uses to
		declare the high received optical power alarm. Valid values are -127-dBm (coded as 254) to 0-dBm
		(coded as 0) in 0.5-dB increments. The default value 0xFF selects the RE's internal policy.
		(R,-W) (optional) (1-byte)

	Transmit Optical Signal Level
		Transmit optical signal level: This attribute reports the current measurement of the mean
		optical launch power of the upstream OA. Its value is a 2s-complement integer referred to 1-mW
		(i.e., dBm), with 0.002-dB granularity. (R) (optional) (2-bytes)

	Lower Transmit Optical Threshold
		Lower transmit optical threshold: This attribute specifies the minimum mean optical launch power
		that the RE uses to declare the low transmit optical power alarm. Its value is a 2s-complement
		integer referred to 1-mW (i.e., dBm), with 0.5-dB granularity. The default value 0x7F selects
		the RE's internal policy. (R,-W) (optional) (1-byte)

	Upper Transmit Optical Threshold
		Upper transmit optical threshold: This attribute specifies the maximum mean optical launch power
		that the RE uses to declare the high transmit optical power alarm. Its value is a 2s complement
		integer referred to 1-mW (i.e., dBm), with 0.5-dB granularity. The default value 0x7F selects
		the RE's internal policy. (R,-W) (optional) (1-byte)

type Results ¶

type Results byte

MsgType represents the status field in a OMCI Response frame

const (
	// Response status codes
	Success          Results = 0 // command processed successfully
	ProcessingError  Results = 1 // command processing error
	NotSupported     Results = 2 // command not supported
	ParameterError   Results = 3 // parameter error
	UnknownEntity    Results = 4 // unknown managed entity
	UnknownInstance  Results = 5 // unknown managed entity instance
	DeviceBusy       Results = 6 // device busy
	InstanceExists   Results = 7 // instance exists
	AttributeFailure Results = 9 // Attribute(s) failed or unknown
)

func (rc Results) String() string

type RtpPerformanceMonitoringHistoryData ¶

type RtpPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

RtpPerformanceMonitoringHistoryData (class ID #144)

This ME collects PM data related to an RTP session. Instances of this ME are created and deleted
by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the PPTP POTS UNI ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PPTP POTS UNI ME. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Rtp Errors
		RTP errors:	This attribute counts RTP packet errors. (R) (mandatory) (4-bytes)

	Packet Loss
		Packet loss:	This attribute represents the fraction of packets lost. This attribute is
		calculated at the end of the 15-min interval, and is undefined under the get current data
		action. The value 0 indicates no packet loss, scaling linearly to 0xFFFF FFFF to indicate 100%
		packet loss (zero divided by zero is defined to be zero). (R) (mandatory) (4-bytes)

	Maximum Jitter
		Maximum jitter: This attribute is a high water-mark that represents the maximum jitter
		identified during the measured interval, expressed in RTP timestamp units. (R) (mandatory)
		(4-bytes)

	Maximum Time Between Real_Time Transport Control Protocol Rtcp Packets
		Maximum time between real-time transport control protocol (RTCP) packets: This attribute is a
		high water-mark that represents the maximum time between RTCP packets during the measured
		interval, in milliseconds. (R) (mandatory) (4-bytes)

	Buffer Underflows
		Buffer underflows: This attribute counts the number of times the reassembly buffer underflows.
		In the case of continuous underflow caused by a loss of IP packets, a single buffer underflow
		should be counted. If the IW function is implemented with multiple buffers, such as a packet
		level buffer and a bit level buffer, then the underflow of either buffer increments this
		counter. (R) (mandatory) (4-bytes)

	Buffer Overflows
		Buffer overflows: This attribute counts the number of times the reassembly buffer overflows. If
		the IW function is implemented with multiple buffers, such as a packet level buffer and a bit
		level buffer, then the overflow of either buffer increments this counter. (R) (mandatory)
		(4-bytes)

type RtpProfileData ¶

type RtpProfileData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

RtpProfileData (class ID #143)

This ME configures RTP. It is conditionally required for ONUs that offer VoIP service. If a non-
OMCI interface is used to manage VoIP, this ME is unnecessary.

An instance of this ME is created and deleted by the OLT. An RTP profile is needed for each
unique set of attributes.

Relationships
	An instance of this ME may be associated with one or more VoIP media profile MEs.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Local Port Min
		Local port min: This attribute defines the base UDP port that should be used by RTP for voice
		traffic. The recommended default is 50000 (R,-W, set-by-create) (mandatory) (2-bytes)

	Local Port Max
		Local port max: This attribute defines the highest UDP port used by RTP for voice traffic. The
		value must be greater than the local port minimum. The value 0 specifies that the local port
		maximum be equal to the local port minimum. (R,-W, set-by-create) (optional) (2-bytes)

	Dscp Mark
		DSCP mark:	Diffserv code point to be used for outgoing RTP packets for this profile. The
		recommended default value is expedited forwarding (EF)-= 0x2E. (R,-W, setbycreate) (mandatory)
		(1-byte)

	Piggyback Events
		(R,-W, setbycreate) (mandatory) (1-byte)

	Tone Events
		(R,-W, setbycreate) (mandatory) (1-byte)

	Dtmf Events
		(R,-W, setbycreate) (mandatory) (1-byte)

	Cas Events
		(R,-W, setbycreate) (mandatory) (1-byte)

	Ip Host Config Pointer
		IP host config pointer: This optional pointer associates the bearer (voice) flow with an IP host
		config data or IPv6 host config data ME. If this attribute is not present or is not populated
		with a valid pointer value, the bearer flow uses the same IP stack that is used for signalling,
		indicated by the TCP/UDP pointer in the associated SIP agent or MGC config data. The default
		value is 0xFFFF, a null pointer. (R,-W) (optional) (2-bytes)

type RtpPseudowireParameters ¶

type RtpPseudowireParameters struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

RtpPseudowireParameters (class ID #283)

If a pseudowire service uses RTP, the RTP pseudowire parameters ME provides configuration
information for the RTP layer. Instances of this ME are created and deleted by the OLT. The use
of RTP on a pseudowire is optional, and is determined by the existence of the RTP pseudowire
parameters ME.

Relationships
	An instance of the RTP pseudowire parameters ME may exist for each pseudowire TP ME, to which it
	is implicitly bound by a common ME ID.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the pseudowire TP ME. (R,
		setbycreate) (mandatory) (2-bytes)

	Clock Reference
		Clock reference: This attribute specifies the frequency of the common timing reference, in
		multiples of 8 kHz. (R,-W, setbycreate) (mandatory) (2-bytes)

	Rtp Timestamp Mode
		(R,-W, setbycreate) (mandatory) (1-byte)

	Ptype
		PTYPE:	This attribute specifies the RTP payload type in the TDM to the PSN direction. It
		comprises two 1-byte values. The first is for the payload channel, the second, for the optional
		separate signalling channel. Assignable PTYPEs lie in the dynamic range 96..127. If signalling
		is not transported in its own channel, the second value should be set to 0. (R,-W, setbycreate)
		(mandatory) (2-bytes)

	Ssrc
		SSRC:	This attribute specifies the RTP synchronization source in the TDM to the PSN direction.
		It comprises two 4-byte values. The first is for the payload channel, the second, for the
		optional separate signalling channel. If signalling is not transported in its own channel, the
		second value should be set to 0. (R,-W, setbycreate) (mandatory) (8-bytes)

	Expected Ptype
		Expected PTYPE: This attribute specifies the RTP payload type in the PSN to the TDM direction.
		The received payload type may be used to detect malformed packets. It comprises two 1-byte
		values. The first is for the payload channel, the second, for the optional separate signalling
		channel. To disable either or both of the check functions, set the corresponding value to its
		default value 0. (R,-W, setbycreate) (optional) (2-bytes)

	Expected Ssrc
		Expected SSRC: This attribute specifies the RTP synchronization source in the PSN to the TDM
		direction. The received SSRC may be used to detect misconnection (stray packets). It comprises
		two 4-byte values. The first is for the payload channel, the second, for the optional separate
		signalling channel. To disable either or both of the check functions, set the corresponding
		value to its default value 0. (R,-W, setbycreate) (optional) (8-bytes)

type SipAgentConfigData ¶

type SipAgentConfigData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

SipAgentConfigData (class ID #150)

The SIP agent config data ME models a SIP signalling agent. It defines the configuration
necessary to establish communication for signalling between the SIP user agent (UA) and a SIP
server.

NOTE 1 - If a non-OMCI interface is used to manage SIP for VoIP, this ME is unnecessary. The
non-OMCI interface supplies the necessary data, which may be read back to the OLT via the SIP
config portal ME.

Instances of this ME are created and deleted by the OLT.

Relationships
	An instance of this ME serves one or more SIP user data MEs and points to a TCP/UDP config data
	that carries signalling messages. Other pointers establish additional agent parameters such as
	proxy servers.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Proxy Server Address Pointer
		Proxy server address pointer: This attribute points to a large string ME that contains the name
		(IP address or URI) of the SIP proxy server for SIP signalling messages. (R,-W, setbycreate)
		(mandatory) (2-bytes)

	Outbound Proxy Address Pointer
		Outbound proxy address pointer: An outbound SIP proxy may or may not be required within a given
		network. If an outbound SIP proxy is used, the outbound proxy address pointer attribute must be
		set to point to a valid large string ME that contains the name (IP address or URI) of the
		outbound proxy server for SIP signalling messages. If an outbound SIP proxy is not used, the
		outbound proxy address pointer attribute must be set to a null pointer. (R,-W, setbycreate)
		(mandatory) (2-bytes)

	Primary Sip Dns
		Primary SIP DNS: This attribute specifies the primary SIP DNS IP address. If the value of this
		attribute is 0, the primary DNS server is defined in the corresponding IP host config data or
		IPv6 host config data ME. If the value is non-zero, it takes precedence over the primary DNS
		server defined in the IP host config data or IPv6 host config data ME. (R,-W, set-by-create)
		(mandatory) (4-bytes)

	Secondary Sip Dns
		Secondary SIP DNS: This attribute specifies the secondary SIP DNS IP address. If the value of
		this attribute is 0, the secondary DNS server is defined in the corresponding IP host config
		data or IPv6 host config data ME. If the value is non-zero, it takes precedence over the
		secondary DNS server defined in the IP host config data or IPv6 host config data ME. (R,-W, set-
		by-create) (mandatory) (4-bytes)

	Tcp_Udp Pointer
		TCP/UDP pointer: This pointer associates the SIP agent with the TCP/UDP config data ME to be
		used for communication with the SIP server. The default value is 0xFFFF, a null pointer. (R,-W)
		(mandatory) (2-bytes)

	Sip Reg Exp Time
		SIP reg exp time: This attribute specifies the SIP registration expiration time in seconds. If
		its value is 0, the SIP agent does not add an expiration time to the registration requests and
		does not perform reregistration. The default value is 3600-s. (R,-W) (mandatory) (4-bytes)

	Sip Rereg Head Start Time
		SIP rereg head start time: This attribute specifies the time in seconds prior to timeout that
		causes the SIP agent to start the re-registration process. The default value is 360-s. (R,-W)
		(mandatory) (4-bytes)

	Host Part Uri
		Host part URI: This attribute points to a large string ME that contains the host or domain part
		of the SIP address of record for users connected to this ONU. A null pointer indicates that the
		current address in the IP host config ME is to be used. (R,-W, setbycreate) (mandatory)
		(2-bytes)

	Sip Status
		(R) (mandatory) (1-byte)

	Sip Registrar
		SIP registrar: This attribute points to a network address ME that contains the name (IP address
		or resolved name) of the registrar server for SIP signalling messages. Examples: "10.10.10.10"
		and "proxy.voip.net". (R,-W, set-by-create) (mandatory) (2-bytes)

	Softswitch
		Softswitch:	This attribute identifies the SIP gateway softswitch vendor. The format is four
		ASCII coded alphabetic characters [A..Z] as defined in [ATIS0300220]. A value of four null bytes
		indicates an unknown or unspecified vendor. (R,-W, setbycreate) (mandatory) (4-bytes)

	Sip Response Table
		NOTE 2 - This model assumes that SIP response tones and text are common to all POTS lines that
		share a given SIP agent.

	Sip Option Transmit Control
		SIP option transmit control: This Boolean attribute specifies that the ONU is (true) or is not
		(false) enabled to transmit SIP options. The default value is recommended to be false. (R, W,
		setbycreate) (optional) (1 byte)

	Sip Uri Format
		SIP URI format: This attribute specifies the format of the URI in outgoing SIP messages. The
		recommended default value 0 specifies TEL URIs; the value 1 specifies SIP URIs. Other values are
		reserved. (R, W, setbycreate) (optional) (1 byte)

	Redundant Sip Agent Pointer
		Redundant SIP agent pointer: This attribute points to another SIP agent config data ME, which is
		understood to provide redundancy. The initial SIP agent is determined by the pointer from the
		SIP user data ME. It is the manager's responsibility to provision a group of redundant SIP
		agents with mutually consistent attributes. (R, W, setbycreate) (optional) (2 bytes)

type SipAgentPerformanceMonitoringHistoryData ¶

type SipAgentPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

SipAgentPerformanceMonitoringHistoryData (class ID #151)

This ME collects PM data for the associated VoIP SIP agent. Instances of this ME are created and
deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with a SIP agent config data or SIP config portal object.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the corresponding SIP agent config
		data or to the SIP config portal. If a non-OMCI configuration method is used for VoIP, there can
		be only one live ME instance, associated with the SIP config portal, and with ME ID 0. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Transactions
		Transactions: This attribute counts the number of new transactions that were initiated. (R)
		(optional) (4-bytes)

	Rx Invite Reqs
		Rx invite reqs: This attribute counts received invite messages, including retransmissions. (R)
		(optional) (4-bytes)

	Rx Invite Retrans
		Rx invite retrans: This attribute counts received invite retransmission messages. (R) (optional)
		(4-bytes)

	Rx Noninvite Reqs
		Rx noninvite reqs: This attribute counts received non-invite messages, including
		retransmissions. (R) (optional) (4-bytes)

	Rx Noninvite Retrans
		Rx noninvite retrans: This attribute counts received non-invite retransmission messages. (R)
		(optional) (4-bytes)

	Rx Response
		Rx response:	This attribute counts total responses received. (R) (optional) (4-bytes)

	Rx Response Retransmissions
		Rx response retransmissions: This attribute counts total response retransmissions received. (R)
		(optional) (4-bytes)

	Tx Invite Reqs
		Tx invite reqs: This attribute counts transmitted invite messages, including retransmissions.
		(R) (optional) (4-bytes)

	Tx Invite Retrans
		Tx invite retrans: This attribute counts transmitted invite retransmission messages. (R)
		(optional) (4-bytes)

	Tx Noninvite Reqs
		Tx noninvite reqs: This attribute counts transmitted non-invite messages, including
		retransmissions. (R) (optional) (4-bytes)

	Tx Noninvite Retrans
		Tx noninvite retrans: This attribute counts transmitted non-invite retransmission messages. (R)
		(optional) (4-bytes)

	Tx Response
		Tx response: This attribute counts the total responses sent. (R) (optional) (4-bytes)

	Tx Response Retransmissions
		Tx response retransmissions: This attribute counts total response retransmissions sent. (R)
		(optional) (4-bytes)

type SipCallInitiationPerformanceMonitoringHistoryData ¶

type SipCallInitiationPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

SipCallInitiationPerformanceMonitoringHistoryData (class ID #152)

This ME collects PM data related to call initiations of a VoIP SIP agent. Instances of this ME
are created and deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the SIP agent config data or SIP config
	portal ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the SIP agent config data or the
		SIP config portal ME. If a nonOMCI configuration method is used for VoIP, there can be only one
		live ME instance, associated with the SIP config portal, and with ME ID 0. (R, setbycreate)
		(mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Failed To Connect Counter
		Failed to connect counter: This attribute counts the number of times that the SIP UA failed to
		reach/connect its TCP/UDP peer during SIP call initiations. (R) (mandatory) (4-bytes)

	Failed To Validate Counter
		Failed to validate counter: This attribute counts the number of times that the SIP UA failed to
		validate its peer during SIP call initiations. (R) (mandatory) (4-bytes)

	Timeout Counter
		Timeout counter: This attribute counts the number of times that the SIP UA timed out during SIP
		call initiations. (R) (mandatory) (4-bytes)

	Failure Received Counter
		Failure received counter: This attribute counts the number of times that the SIP UA received a
		failure error code during SIP call initiations. (R) (mandatory) (4-bytes)

	Failed To Authenticate Counter
		Failed to authenticate counter: This attribute counts the number of times that the SIP UA failed
		to authenticate itself during SIP call initiations. (R) (mandatory) (4-bytes)

type SipUserData ¶

type SipUserData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

SipUserData (class ID #153)

The SIP user data defines the user specific configuration attributes associated with a specific
VoIP CTP. This entity is conditionally required for ONUs that offer VoIP SIP services. If a non-
OMCI interface is used to manage SIP for VoIP, this ME is unnecessary. The non-OMCI interface
supplies the necessary data, which may be read back to the OLT via the SIP config portal ME.

An instance of this ME is created and deleted by the OLT. A SIP user data instance is required
for each POTS UNI port using SIP protocol and configured by the OMCI.

Relationships
	An instance of this ME is associated with one VoIP voice CTP ME and a PPTP POTS UNI.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Sip Agent Pointer
		SIP agent pointer: This attribute points to the SIP agent config data ME to be used for
		signalling. (R,-W, setbycreate) (mandatory) (2-bytes)

	User Part Aor
		User part AOR: This attribute points to a large string that contains the user identification
		part of the address of record. This can take the form of an alphanumeric string or the
		subscriber's directory number. A null pointer indicates the absence of an AOR. (R,-W,
		setbycreate) (mandatory) (2-bytes)

	Sip Display Name
		SIP display name: This ASCII string attribute defines the customer ID used for the display
		attribute in outgoing SIP messages. The default value is null (all zero bytes) (R,-W)
		(mandatory) (25-bytes)

	Username And Password
		Username and password: This attribute points to an authentication security method ME that
		contains the SIP user name and password used for authentication. A null pointer indicates no
		username and password. (R,-W, setbycreate) (mandatory) (2)

	Voicemail Server Sip Uri
		Voicemail server SIP URI: This attribute points to a network address ME that contains the name
		(IP address or URI) of the SIP voicemail server for SIP signalling messages. A null pointer
		indicates the absence of a SIP voicemail server. (R,-W, setbycreate) (mandatory) (2-bytes)

	Voicemail Subscription Expiration Time
		Voicemail subscription expiration time: This attribute defines the voicemail subscription
		expiration time in seconds. If this value is 0, the SIP agent uses an implementation-specific
		value. This attribute is recommended to be set to 3600-s by default. (R,-W, setbycreate)
		(mandatory) (4-bytes)

	Network Dial Plan Pointer
		Network dial plan pointer: This attribute points to a network dial plan table. A null pointer
		indicates the absence of a network dial plan. (R,-W, setbycreate) (mandatory) (2-bytes)

	Application Services Profile Pointer
		Application services profile pointer: This attribute points to a VoIP application services
		profile. (R,-W, setbycreate) (mandatory) (2-bytes)

	Feature Code Pointer
		Feature code pointer: This attribute points to the VoIP feature access codes ME for this
		subscriber. A null pointer indicates the absence of a VoIP feature access codes ME. (R,-W, set-
		by-create) (mandatory) (2-bytes)

	Pptp Pointer
		PPTP pointer: This attribute points to the PPTP POTS UNI ME that provides the analogue telephony
		adaptor (ATA) function. (R,-W, setbycreate) (mandatory) (2-bytes)

	Release Timer
		Release timer: This attribute contains a release timer defined in seconds. The value 0 specifies
		that the ONU is to use its internal default. The default value of this attribute is 10-s. (R,-W)
		(optional) (1-byte)

	Receiver Off Hook Roh Timer
		Receiver off hook (ROH) timer:	This attribute defines the time in seconds for the ROH condition
		before ROH tone is applied. The value 0 disables ROH timing. The value 0xFF specifies that the
		ONU is to use its internal default, which may or may not be the same as the 15-s OMCI default
		value. (R,-W) (optional) (1-byte)

type SnmpConfigurationData ¶

type SnmpConfigurationData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

SnmpConfigurationData (class ID #335)

The SNMP configuration data ME provides a way for the OLT to provision an IP path for an SNMP
management agent.

The SNMP configuration data ME is created and deleted by the OLT.

Relationships
	One instance of this ME is created by the OLT for each SNMP management path termination.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The ME IDs 0 and
		0xFFFF are reserved. (R, setbycreate) (mandatory) (2-bytes)

	Snmp Version
		SNMP version: This integer attribute is the SNMP protocol version to be supported. (R,-W,
		setbycreate) (mandatory) (2-bytes)

	Snmp Agent Address
		SNMP agent address: This attribute is a pointer to a TCP/UDP config data ME, which provides the
		SNMP agent. (R, W, setbycreate) (mandatory) (2 bytes)

	Snmp Server Address
		SNMP server address: This attribute is the IP address of the SNMP server. (R, W, setbycreate)
		(mandatory) (4 bytes)

	Snmp Server Port
		SNMP server port: This attribute is the UDP port number of the SNMP server. (R, W, setbycreate)
		(mandatory) (2 bytes)

	Security Name Pointer
		Security name pointer: This attribute points to a large string whose content represents the SNMP
		security name in a human-readable format that is independent of the security model. SecurityName
		is defined in [b-IETF RFC 2571]. (R, W, setbycreate) (mandatory) (2 bytes)

	Community For Read
		Community for read: This attribute is a pointer to a large string that contains the name of the
		read community. (R, W, setbycreate) (mandatory) (2 bytes)

	Community For Write
		Community for write: This attribute is a pointer to a large string that contains the name of the
		write community. (R, W, setbycreate) (mandatory) (2 bytes)

	Sys Name Pointer
		Sys name pointer: This attribute points to a large string whose content identifies the SNMP
		system name. SysName is defined in [b-IETF RFC-3418]. (R, W, setbycreate) (mandatory) (2 bytes)

type SoftwareImage ¶

type SoftwareImage struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

SoftwareImage (class ID #7)

This ME models an executable software image stored in the ONU (documented here as its
fundamental usage). It may also be used to represent an opaque vendor-specific file
(vendorspecific usage).

Fundamental usage

The ONU automatically creates two instances of this ME upon the creation of each ME that
contains independently manageable software, either the ONU itself or an individual circuit pack.
It populates ME attributes according to data within the ONU or the circuit pack.

Some pluggable equipment may not contain software. Others may contain software that is
intrinsically bound to the ONU's own software image. No software image ME need exist for such
equipment, though it may be convenient for the ONU to create them to support software version
audit from the OLT. In this case, the dependent MEs would support only the get action.

A slot may contain various equipment over its lifetime, and if software image MEs exist, the ONU
must automatically create and delete them as the equipped configuration changes. The identity of
the software image is tied to the cardholder.

When an ONU controller packs are duplicated, each can be expected to contain two software image
MEs, managed through reference to the individual controller packs themselves. When this occurs,
the ONU should not have a global pair of software images MEs (instance 0), since an action
(download, activate, commit) directed to instance 0 would be ambiguous.

Relationships
	Two instances of the software image ME are associated with each instance of the ONU or
	cardholder whose software is independently managed.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. The first byte
		indicates the physical location of the equipment hosting the software image, either the ONU (0)
		or a cardholder (1..254). The second byte distinguishes between the two software image ME
		instances (0..1). (R) (mandatory) (2-bytes)

	Version
		Version:	This string attribute identifies the version of the software. (R) (mandatory)
		(14-bytes)

	Is Committed
		Is committed: This attribute indicates whether the associated software image is committed (1) or
		uncommitted (0). By definition, the committed software image is loaded and executed upon reboot
		of the ONU or circuit pack. During normal operation, one software image is always committed,
		while the other is uncommitted. Under no circumstances are both software images allowed to be
		committed at the same time. On the other hand, both software images could be uncommitted at the
		same time if both were invalid. Upon ME instantiation, instance 0 is initialized to committed,
		while instance 1 is initialized to uncommitted (i.e., the ONU ships from the factory with image
		0 committed). (R) (mandatory) (1-byte)

	Is Active
		Is active:	This attribute indicates whether the associated software image is active (1) or
		inactive (0). By definition, the active software image is one that is currently loaded and
		executing in the ONU or circuit pack. Under normal operation, one software image is always
		active while the other is inactive. Under no circumstances are both software images allowed to
		be active at the same time. On the other hand, both software images could be inactive at the
		same time if both were invalid. (R) (mandatory) (1-byte)

	Is Valid
		Is valid:	This attribute indicates whether the associated software image is valid (1) or invalid
		(0). By definition, a software image is valid if it has been verified to be an executable code
		image. The verification mechanism is not subject to standardization; however, it should include
		at least a data integrity check [e.g., a cyclic redundancy check (CRC)] of the entire code
		image. Upon ME instantiation or software download completion, the ONU validates the associated
		code image and sets this attribute according to the result. (R) (mandatory) (1-byte)

	Product Code
		Product code:	This attribute provides a way for a vendor to indicate product code information on
		a file. It is a character string, padded with trailing nulls if it is shorter than 25 bytes. (R)
		(optional) (25 bytes)

	Image Hash
		Image hash:	This attribute is an MD5 hash of the software image. It is computed at completion of
		the end download action. (R) (optional) (16-bytes)

type TCont ¶

type TCont struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

TCont (class ID #262)

An instance of the traffic container ME T-CONT represents a logical connection group associated
with a G-PON PLOAM layer alloc-ID. A T-CONT can accommodate GEM packets in priority queues or
traffic schedulers that exist in the GEM layer.

The ONU autonomously creates instances of this ME. The OLT can discover the number of TCONT
instances via the ANI-G ME. When the ONU's MIB is reset or created for the first time, all
supported T-CONTs are created. The OLT provisions alloc-IDs to the ONU via the PLOAM channel.
Via the OMCI, the OLT must then set the alloc-ID attributes in the T-CONTs that it wants to
activate for user traffic, to create the appropriate association with the allocation ID in the
PLOAM channel. There should be a one-to-one relationship between allocation IDs and T-CONT MEs;
the connection of multiple T-CONTs to a single allocation ID is undefined.

The allocation ID that matches the ONU-ID itself is defined to be the default alloc-ID. This
allocID is used to carry the OMCC. The default alloc-ID can also be used to carry user traffic,
and hence can be assigned to one of the T-CONT MEs. However, this OMCI relationship only
pertains to user traffic, and the OMCC relationship is unaffected. It can also be true that the
OMCC is not contained in any T-CONT ME construct; rather, that the OMCC remains outside of the
OMCI, and that the OMCI is not used to manage the OMCC in any way. Multiplexing of the OMCC and
user data in GPON systems is discussed in clause B.2.4.

Relationships
	One or more instances of this ME are associated with an instance of a circuit pack that supports
	a PON interface function, or with the ONU-G itself.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
		number indicates the physical capability that realizes the TCONT. It may be represented as
		0xSSBB, where SS indicates the slot ID that contains this T-CONT (0 for the ONU as a whole), and
		BB is the TCONT ID, numbered by the ONU itself. T-CONTs are numbered in ascending order, with
		the range 0..255 in each slot. (R) (mandatory) (2-bytes)

	Alloc_Id
		Alloc-ID:	This attribute links the T-CONT with the alloc-ID assigned by the OLT in the
		assign_alloc-ID PLOAM message. The respective TC layer specification should be referenced for
		the legal values for that system. Prior to the setting of this attribute by the OLT, this
		attribute has an unambiguously unusable initial value, namely the value 0x00FF or 0xFFFF for
		ITU-T G.984 systems, and the value 0xFFFF for all other ITU-T GTC based PON systems. (R,-W)
		(mandatory) (2-bytes)

	Deprecated
		Deprecated:	The ONU should set this attribute to the value 1, and the OLT should ignore it. (R)
		(mandatory) (1-byte)

	Policy
		NOTE - This attribute is read-only, unless otherwise specified by the QoS configuration
		flexibility attribute of the ONU2-G ME. If flexible configuration is not supported, the ONU
		should reject an attempt to set it with a parameter error result-reason code.

type TableInfo ¶

type TableInfo struct {
	Value interface{} // See comment above
	Size  int         // Table Row Size
}

TableInfo is an early prototype of how to better model some tables that are difficult to code.

The Value member may be one of the following:

nil    : Empty, no default, ...
value  : A specific value that equates to one row, ie) 6  or toOctets("base64")
array  : One or more rows of values.  [2]uint16{2, 3}

func (t *TableInfo) String() string

type TcAdaptorPerformanceMonitoringHistoryDataXdsl ¶

type TcAdaptorPerformanceMonitoringHistoryDataXdsl struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

TcAdaptorPerformanceMonitoringHistoryDataXdsl (class ID #116)

This ME collects PM data of an xTUC to xTUR ATM data path. Instances of this ME are created and
deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an xDSL UNI.

Attributes
	Managed Entity Id
		Managed entity ID:	This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the PPTP xDSL UNI part 1. (R)
		(mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data1/2 ID: This attribute points to an instance of the threshold data1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Near_End Hec Violation Count
		Near-end HEC violation count: This attribute counts near-end HEC anomalies in the ATM data path.
		(R) (mandatory) (2-bytes)

	Near_End Delineated Total Cell Count Cd P
		Near-end delineated total cell count (CDP): This attribute counts the total number of cells
		passed through the cell delineation and HEC function process operating on the ATM data path
		while in the SYNC state. (R) (mandatory) (4-bytes)

	Near_End User Total Cell Count Cu_P
		Near-end user total cell count(CU-P): This attribute counts the total number of cells in the ATM
		data path delivered at the V-C interface. (R) (mandatory) (4-bytes)

	Near_End Idle Cell Bit Error Count
		Near-end idle cell bit error count: This attribute counts cells with bit errors in the ATM data
		path idle payload received at the near end. (R) (mandatory) (2-bytes)

	Far_End Hec Violation Count
		Far-end HEC violation count: This attribute counts far-end HEC anomalies in the ATM data path.
		(R) (mandatory) (2-bytes)

	Far_End Delineated Total Cell Count Cd_Pfe
		Far-end delineated total cell count (CD-PFE): This attribute counts the total number of cells
		passed through the cell delineation process and HEC function operating on the ATM data path
		while in the SYNC state. (R) (mandatory) (4-bytes)

	Far_End User Total Cell Count Cu_Pfe
		Far-end user total cell count (CU-PFE): This attribute counts the total number of cells in the
		ATM data path delivered at the T-R interface. (R) (mandatory) (4-bytes)

	Far_End Idle Cell Bit Error Count
		Far-end idle cell bit error count: This attribute counts cells with bit errors in the ATM data
		path idle payload received at the far end. (R) (mandatory) (2-bytes)

type TcpUdpConfigData ¶

type TcpUdpConfigData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

TcpUdpConfigData (class ID #136)

The TCP/UDP config data ME configures services based on the transmission control protocol (TCP)
and user datagram protocol (UDP) that are offered from an IP host. If a non-OMCI interface is
used to manage an IP service, this ME is unnecessary; the non-OMCI interface supplies the
necessary data.

An instance of this ME is created and deleted on request of the OLT.

Relationships
	One or more instances of this ME may be associated with an instance of an IP host config data or
	IPv6 host config data ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. It is
		recommended that the ME ID be the same as the port number. (R, setbycreate) (mandatory)
		(2-bytes)

	Port Id
		Port ID:	This attribute specifies the port number that offers the TCP/UDP service. (R,-W,
		setbycreate) (mandatory) (2-bytes)

	Protocol
		Protocol:	This attribute specifies the protocol type as defined by [b-IANA] (protocol numbers),
		for example UDP (0x11). (R,-W, setbycreate) (mandatory) (1-byte)

	Tos_Diffserv Field
		TOS/diffserv field: This attribute specifies the value of the TOS/diffserv field of the IPv4
		header. The contents of this attribute may contain the type of service per [IETF RFC 2474] or a
		DSCP. Valid values for DSCP are as defined by [b-IANA] (differentiated services field code
		points). (R,-W, set-by-create) (mandatory) (1-byte)

	Ip Host Pointer
		IP host pointer: This attribute points to the IP host config data or IPv6 host config data ME
		associated with this TCP/UDP data. Any number of ports and protocols may be associated with an
		IP host. (R, W, set-by-create) (mandatory) (2 bytes)

type TcpUdpPerformanceMonitoringHistoryData ¶

type TcpUdpPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

TcpUdpPerformanceMonitoringHistoryData (class ID #342)

This ME collects PM data related to a TCP or UDP port. Instances of this ME are created and
deleted by the OLT.

For a complete discussion of generic PM architecture, refer to clause I.4.

Relationships
	An instance of this ME is associated with an instance of the TCP/UDP config data ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
		identical ID, this ME is implicitly linked to an instance of the TCP/UDP config data ME. (R,
		setbycreate) (mandatory) (2-bytes)

	Interval End Time
		Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
		(mandatory) (1-byte)

	Threshold Data 1_2 Id
		Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
		contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
		data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)

	Socket Failed
		Socket failed:	This attribute is incremented when an attempt to create a socket associated with
		a port fails. (R) (mandatory) (2-bytes)

	Listen Failed
		Listen failed:	This attribute is incremented when an attempt by a service to listen for a
		request on a port fails. (R) (mandatory) (2-bytes)

	Bind Failed
		Bind failed:	This attribute is incremented when an attempt by a service to bind to a port fails.
		(R) (mandatory) (2-bytes)

	Accept Failed
		Accept failed: This attribute is incremented when an attempt to accept a connection on a port
		fails. (R) (mandatory) (2-bytes)

	Select Failed
		Select failed:	This attribute is incremented when an attempt to perform a select on a group of
		ports fails. (R) (mandatory) (2-bytes)

type ThresholdData1 ¶

type ThresholdData1 struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

ThresholdData1 (class ID #273)

Threshold data are partitioned into two MEs for historical reasons. An instance of this ME,
together with an optional instance of the threshold data 2 ME, contains threshold values for
counters in PM history data MEs.

For a complete discussion of generic PM architecture, refer to clause I.4.

Instances of this ME are created and deleted by the OLT.

Relationships
	An instance of this ME may be related to multiple instances of PM history data type MEs.////		Paired instances of threshold data 1 ME and threshold data 2 ME are implicitly linked together
	through a common ME ID.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Threshold Value_1
		Threshold value-1: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_2
		Threshold value-2: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_3
		Threshold value-3: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_4
		Threshold value-4: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_5
		Threshold value-5: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_6
		Threshold value-6: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_7
		Threshold value-7: (R,-W, setbycreate) (mandatory) (4-bytes)

type ThresholdData2 ¶

type ThresholdData2 struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

ThresholdData2 (class ID #274)

Together with an instance of the threshold data 1 ME, an instance of this ME contains threshold
values for counters maintained in one or more instances of PM history data MEs.

For a complete discussion of generic PM architecture, refer to clause-I.4.

Instances of this ME are created and deleted by the OLT.

Relationships
	Refer to the relationships of the threshold data 1 ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. Its value is the
		same as that of the paired threshold data-1-instance. (R, setbycreate) (mandatory) (2-bytes)

	Threshold Value_8
		Threshold value-8: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_9
		Threshold value-9: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_10
		Threshold value-10: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_11
		Threshold value-11: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_12
		Threshold value-12: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_13
		Threshold value-13: (R,-W, setbycreate) (mandatory) (4-bytes)

	Threshold Value_14
		Threshold value-14: (R,-W, setbycreate) (mandatory) (4-bytes)

type TrafficDescriptor ¶

type TrafficDescriptor struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

TrafficDescriptor (class ID #280)

The traffic descriptor is a profile that allows for traffic management. A priority controlled
ONU can point from a MAC bridge port configuration data ME to a traffic descriptor in order to
implement traffic management (marking, policing). A rate controlled ONU can point to a traffic
descriptor from either a MAC bridge port configuration data ME or a GEM port network CTP to
implement traffic management (marking, shaping).

Packets are determined to be green, yellow or red as a function of the ingress packet rate and
the settings in this ME. The colour indicates drop precedence (eligibility), subsequently used
by the priority queue ME to drop packets conditionally during congestion conditions. Packet
colour is also used by the optional mode 1 DBA status reporting function described in [ITUT
G.984.3]. Red packets are dropped immediately. Yellow packets are marked as drop eligible, and
green packets are marked as not drop eligible, according to the egress colour marking attribute.

The algorithm used to determine the colour marking is specified by the meter type attribute. If
[bIETF RFC 4115] is used, then:

CIR4115-=-CIR

EIR4115-=-PIR - CIR (EIR: excess information rate)

CBS4115-=-CBS

EBS4115-=-PBS - CBS.

Relationships
	This ME is associated with a GEM port network CTP or a MAC bridge port configuration data ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Cir
		CIR:	This attribute specifies the committed information rate, in bytes per second. The default
		is 0. (R,-W, setbycreate) (optional) (4-bytes)

	Pir
		PIR:	This attribute specifies the peak information rate, in bytes per second. The default value
		0 accepts the ONU's factory policy. (R,-W, setbycreate) (optional) (4-bytes)

	Cbs
		CBS:	This attribute specifies the committed burst size, in bytes. The default is 0. (R,-W,
		setbycreate) (optional) (4-bytes)

	Pbs
		PBS:	This attribute specifies the peak burst size, in bytes. The default value 0 accepts the
		ONU's factory policy. (R,-W, setbycreate) (optional) (4-bytes)

	Colour Mode
		(R,-W, setbycreate) (optional) (1-byte)

	Ingress Colour Marking
		(R,-W, setbycreate) (optional) (1-byte)

	Egress Colour Marking
		(R,-W, setbycreate) (optional) (1-byte)

	Meter Type
		(R, setbycreate) (optional) (1-byte)

type TrafficScheduler ¶

type TrafficScheduler struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

TrafficScheduler (class ID #278)

NOTE 1 - In [ITU-T G.984.4], this ME is called a traffic scheduler-G.

An instance of this ME represents a logical object that can control upstream GEM packets. A
traffic scheduler can accommodate GEM packets after a priority queue or other traffic scheduler
and transfer them towards the next traffic scheduler or T-CONT. Because T-CONTs and traffic
schedulers are created autonomously by the ONU, the ONU vendor predetermines the most complex
traffic handling model it is prepared to support; the OLT may use less than the ONU's full
capabilities, but cannot ask for more. See Appendix II for more details.

After the ONU creates instances of the T-CONT ME, it then autonomously creates instances of the
traffic scheduler ME.

Relationships
	The traffic scheduler ME may be related to a T-CONT or other traffic schedulers through pointer
	attributes.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
		number indicates the physical capability that realizes the traffic scheduler. The first byte is
		the slot ID of the circuit pack with which this traffic scheduler is associated. For a traffic
		scheduler that is not associated with a circuit pack, the first byte is 0xFF. The second byte is
		the traffic scheduler id, assigned by the ONU itself. Traffic schedulers are numbered in
		ascending order with the range 0..0xFF in each circuit pack or in the ONU core. (R) (mandatory)
		(2-bytes)

	T_Cont Pointer
		NOTE 2 - This attribute is read-only unless otherwise specified by the QoS configuration
		flexibility attribute of the ONU2-G ME. If flexible configuration is not supported, the ONU
		should reject an attempt to set the TCONT pointer attribute with a parameter error result-reason
		code.

	Traffic Scheduler Pointer
		Traffic scheduler pointer: This attribute points to another traffic scheduler ME instance that
		may serve this traffic scheduler. This pointer is used when this traffic scheduler is connected
		to another traffic scheduler; it is null (0) otherwise. (R) (mandatory) (2-bytes)

	Policy
		NOTE 3 - This attribute is read-only unless otherwise specified by the QoS configuration
		flexibility attribute of the ONU2-G ME. If flexible configuration is not supported, the ONU
		should reject an attempt to set the policy attribute with a parameter error result-reason code.

	Priority_Weight
		Upon ME instantiation, the ONU sets this attribute to 0. (R,-W) (mandatory) (1-byte)

type TwdmChannelManagedEntity ¶

type TwdmChannelManagedEntity struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

TwdmChannelManagedEntity (class ID #443)

This ME provides an anchor for the MEs involved in collection of PM statistics per TWDM channel,
as stipulated by clause 14 of [ITU-T-G.989.3]. Instances of this ME are instantiated
autonomously by the ONU.

Relationships
	One or more instances of this ME are implicitly associated with the TWDM System profile ME. The
	number of instances created is announced by the total TWDM channel number attribute of the TWDM
	system profile ME.

Attributes
	Managed Entity Id
		Managed entity ID: This attribute uniquely identifies each instance of this ME. This 2-byte
		number is represented as 0xSSBB, where SS indicates the ONU slot ID, and BB is the TWDM channel
		ME number assigned by the ONU itself, starting from 0 in the ascending order. (R) (mandatory)
		(2-bytes)

	Active Channel Indication
		Active channel indication: The default value is false. The ONU sets the attribute to true when
		it receives the Channel_Profile PLOAM messages for that channel. The ONU clears the attribute
		when it receives the Channel_Profile PLOAM message marked ``void'' for that channel. (R)
		(mandatory) (1-byte)

	Operational Channel Indication
		Operational channel indication: A Boolean attribute that is set to true for an active TWDM
		channel in which the ONT is currently operating. The operational statistic is accumulated in the
		PM history data MEs associated with that TWDM channel. (R) (mandatory) (1-byte)

	Downstream Wavelength Channel
		Downstream wavelength channel: For an active TWDM channel, this attribute identifies the
		downstream wavelength channel in reference to Table 11-2 of [ITU-T-G.989.2]. For an inactive
		channel it has value 0xFF. (R) (mandatory) (1-byte)

	Upstream Wavelength Channel
		Upstream wavelength channel: For an active TWDM channel, this attribute identifies the upstream
		wavelength channel in reference to Table VIII-5 of [ITU-T-G.989.2]. For an inactive channel its
		value of 0xFF. (R) (mandatory) (1-byte)

type TwdmChannelOmciPerformanceMonitoringHistoryData ¶

type TwdmChannelOmciPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}