generated

type Aal5PerformanceMonitoringHistoryData ¶

type Aal5PerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Aal5PerformanceMonitoringHistoryData (Class ID: #18 / 0x0012)

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
		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
		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
		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
		This attribute counts CRC violations detected on incoming SAR PDUs. (R) (mandatory) (4-bytes)

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

	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
		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 / 0x0010)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory)
		(2-bytes)

	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
		This attribute specifies the AAL mode as follows.

		0	Message assured

		1	Message unassured

		2	Streaming assured

		3	Streaming non assured

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

	Sscs Type
		This attribute specifies the SSCS type for the AAL. Valid values are as follows.

		0	Null

		1	Data SSCS based on SSCOP, assured operation

		2	Data SSCS based on SSCOP, non-assured operation

		3	Frame relay SSCS

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

type AlarmMap ¶

type AlarmMap map[uint8]string

AlarmMap is a mapping of alarm bit numbers to alarm names and can be used during decode of Alarm Notification messages

type AniG ¶

type AniG struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

AniG (Class ID: #263 / 0x0107)

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
		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
		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
		This attribute indicates the total number of T-CONTs that can be supported on this ANI. (R)
		(mandatory) (2-bytes)

	Gem Block Length
		This attribute specifies the queue occupancy reporting granularity for DBA, expressed in bytes.
		This attribute is meaningful only in ITUT G.984.x systems. (R, W) (mandatory) (2 bytes)

		In ITU-T G.984 systems, the value set by the OLT is used by all TCONTs on this ANI. Upon ME
		instantiation, the ONU sets this attribute to 48. See [ITUT G.984.3] for further details.

		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
		This attribute indicates the ONU's piggyback DBA reporting format capabilities. [ITUT G.984.3]
		defines two possible piggyback reporting modes. For reporting mode 0, the single field is the
		entire report. For reporting mode 1, the DBA report is two fields long. Mode 0 is mandatory for
		ITU-T G.984 ONUs that support piggyback DBA reporting; mode 1 is optional. Subsequent PON
		specifications allows only one mode, which should be reported in this attribute as code point 0.

		The following coding indicates the ONU's piggyback DBA reporting mode capabilities:

		0	Mode 0 only

		1	Modes 0 and 1

		2	Deprecated

		3	Deprecated

		4	Piggyback DBA reporting not supported

		(R) (mandatory) (1-byte)

	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
		See clause A.1.4.3. (R,-W) (optional) (1-byte)

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

	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
		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
		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
		This attribute indicates the ONU's actual response time. This attribute is in the range
		34..36-us. Although this attribute is expressed in nanoseconds, its accuracy is likely to be
		more coarse. Furthermore, the value may change from one activation cycle to the next. Valid
		values are:

		0 (Null, function not supported)

		34000 to 36000 (response time in nanoseconds)

		All other values reserved

		(R) (optional) (2-bytes)

	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
		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
		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..16) as the key

type AttributeErrorType ¶

type AttributeErrorType int

AttributeErrorType is used to specify what specific relaxed decode error occured for an attribute

const (
	UnknownAttribute AttributeErrorType = iota
	InvalidTableAttribute
)

func (errType AttributeErrorType) String() string

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 ¶

type AttributeMe struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

AttributeMe (Class ID: #289 / 0x0121)

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
		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
		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
		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
		This attribute represents the OMCI access characteristics of the attribute. The following code
		points are defined.

		1	Read

		2	Write

		3	Read, write

		5	Read, setbycreate

		6	Write, setbycreate

		7	Read, write, setbycreate

		(R) (mandatory) (1-byte)

	Format
		This attribute represents the format of the attribute. The following code points are defined.

		1	Pointer

		2	Bit field

		3	Signed integer

		4	Unsigned integer

		5	String

		6	Enumeration (that is, a set of defined code points)

		7	Table

		(R) (mandatory) (1-byte)

	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
		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
		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
		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
		This attribute represents the level of support of the attribute (same notation as the attribute
		of the same name in the ME). The following code points are defined.

		1	Fully supported (supported as defined in this object)

		2	Unsupported (OMCI returns an error code if accessed)

		3	Partially supported (some aspects of attribute supported)

		4	Ignored (OMCI supported, but underlying function is not)

		(R) (mandatory) (1-byte)

type AttributeType ¶

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 / 0x0094)

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
		This attribute uniquely identifies each instance of this ME. The value 0xFFFF is reserved. (R,
		setbycreate) (mandatory) (2-bytes)

	Validation Scheme
		This attribute specifies the validation scheme used when the ONU validates a challenge.
		Validation schemes are defined as follows.

		0	Validation disabled

		1	Validate using MD5 digest authentication as defined in [IETF-RFC-2617] (recommended)

		3	Validate using basic authentication as defined in [IETF RFC 2617]

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

	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
		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
		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
		This string attribute allows for continuation of the user name beyond 25-characters (Note). Its
		default value is a null string. (R,-W) (optional) (25-bytes)

		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 / 0x0154)

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
		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
		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
		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
		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 BitmapConstraint ¶

type BitmapConstraint struct {
	Bitmask uint64
}

BitmapConstraint are bitmasks that only specific bits set or cleared

func NewBitFieldConstraint(input string) *BitmapConstraint

<bitmask>  is a numerical (often hexadecimal) value that specifies the valid bits
           allowed for the bitmask

func (c *BitmapConstraint) Valid(value interface{}) bool

type CallControlPerformanceMonitoringHistoryData ¶

type CallControlPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

CallControlPerformanceMonitoringHistoryData (Class ID: #140 / 0x008c)

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
		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
		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
		This attribute counts call set-up failures. (R) (mandatory) (4-bytes)

	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
		This attribute counts the number of calls that were terminated with cause. (R) (mandatory)
		(4-bytes)

	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 / 0x0005)

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.

		This attribute uniquely identifies each instance of this ME. The ONU sets the first byte of this
		2-byte identifier to:

		0	if the ONU contains pluggable equipment modules

		1	if the ONU is a single piece of integrated equipment.

		The second byte of this identifier is the slot number. In integrated ONUs, this byte may be used
		as a virtual slot or set to 0 to indicate a universal pseudoslot.

		Slot numbering schemes differ among vendors. It is only required that slot numbers be unique
		across the ONU. Up to 254 equipment slots are supported in the range 1..254 (Note 1). The value
		0 is reserved for possible use in an integrated ONU to indicate a universal pseudo-slot. The
		value 255 is also reserved. (R) (mandatory) (2-bytes)

	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)

		The three following attributes permit the OLT to specify its intentions for any future equipped
		configuration of a slot. Once some or all of these are set, the ONU can proceed to instantiate
		circuit pack and PPTP MEs, along with other predeterminable MEs, and allow the OLT to create
		related discretionary MEs, thereby supporting service pre-provisioning.

	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
		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
		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
		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
		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
		The OLT may use this attribute to control equipment protection switching. Code points have the
		following meaning when set by the OLT:

		0	Release protection switch

		1	Operate protection switch, protect cardholder unspecified

		2	Operate protection switch, use first protect cardholder

		3	Operate protection switch, use second protect cardholder

		The ONU should deny attempts to switch to an unequipped, defective or already active protection
		cardholder.

		Upon the get action from the OLT, this attribute should return the current value of the actual
		protection configuration. Code points are as defined above; the value 1 is never returned.

		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
		See clause A.1.4.3. (R,-W) (optional) (1-byte)

type CesServiceProfile ¶

type CesServiceProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

CesServiceProfile (Class ID: #21 / 0x0015)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory)
		(2-bytes)

	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
		Channel associated signalling (CAS): This attribute selects the signalling format. It applies to
		structured interfaces only. For unstructured interfaces, this value, if present, must be set to
		the default 0. Valid values are as follows.

		0	Basic

		1	E1 CAS

		2	SF CAS

		3	DS1 ESF CAS

		4	J2 CAS

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

type CircuitPack ¶

type CircuitPack struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

CircuitPack (Class ID: #6 / 0x0006)

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
		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
		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
		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
		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
		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
		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
		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
		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
		This attribute specifies whether an Ethernet interface is bridged or derived from an IP router
		function.

		0	Bridged

		1	IP router

		2	Both bridged and IP router functions

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

	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
		This attribute selects the appropriate configuration of configurable circuit packs. Table
		9.1.5-1 specifies two configurable card types: C-DS1/E1 (code 16), and C-DS1/E1/J1 (code 17).
		Values are indicated below for the allowed card types and configurations.

		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
		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
		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
		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 ¶

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 ¶

type ClassID uint16

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

func GetSupportedClassIDs() []ClassID

func (cid ClassID) String() string

type ClassSupport ¶

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 / 0x0131)

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
		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
		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
		This attribute is a list of entries, each entry reporting one aspect of the maintenance status
		of one port. If a port is associated with more than one CFM maintenance entity, each is
		represented as a separate item in this table attribute; a port that has no current maintenance
		functions is not represented in the table (so the table may be empty). Each entry is defined as
		follows.

		Port ID: The ME ID of the MAC bridge port config data whose information is reported in this
		entry. If the layer 2 parent is an IEEE 802.1p mapper, a null pointer. (2-bytes)

		Level: The level at which the reported maintenance function exists, 0..7. (1-byte)

		Direction: The value 1 (down) or 2 (up). (1-byte)

		VLAN ID: If this table entry reports a maintenance function associated with a VLAN, this field
		contains the value of the primary VLAN ID. If no VLAN is associated with this entry, this field
		contains the value 0. (2-bytes)

		MD: A pointer to the associated dot1ag maintenance domain ME. If no MD is associated with this
		entry, a null pointer. (2-bytes)

		MA: A pointer to the associated dot1ag maintenance association ME. If no MA is associated with
		this entry, a null pointer. (2-bytes)

		MEP ID: If this table entry reports an MEP, this field contains the value of its MEP ID (range
		1..8191). If this table entry reports an MHF, this field contains the value 0. (2-bytes)

		MAC address: The MAC address of the MP. (6-bytes)

		(R) (mandatory) (18N bytes)

	Configuration Error List Table
		This attribute is based on the [IEEE 802.1ag] configuration error list. It is a list of entries,
		each entry reporting a VLAN and a bridge port against which a configuration error has been
		detected. The table may be empty at any given time. Entries are defined as follows:

		VLAN ID: If this table entry reports a maintenance function associated with a VLAN, this field
		contains the value of the VLAN ID in error. If no VLAN is associated with this entry, this field
		contains the value 0. (2-bytes)

		Port ID: A pointer to the MAC bridge port config data whose information is reported in this
		entry. If the layer 2 parent is an IEEE 802.1p mapper, a null pointer. (2-bytes)

		Detected configuration error: A bit mask with the following meanings. A list entry exists if and
		only if at least one of these bits is set. Definitions appear in clause 22.2.4 of [IEEE
		802.1ag]: (1-byte)

		0x01	CFM leak. MA x is associated with a specific VID list, one or more of the VIDs in MA x can
		pass through the bridge port, no up MEP is configured for MA x on the bridge port, no down MEP
		is configured on any bridge port for MA x, and another MA y, at a higher MD level than MA x, and
		associated with at least one of the VID(s) also in MA x, does have an MEP configured on the
		bridge port.

		0x02	Conflicting VIDs. MA x is associated with a specific VID list, an up MEP is configured on
		MA x on the bridge port, and another MA y, associated with at least one of the VID(s) also in MA
		x, and at the same MD level as MA x, also has an up MEP configured on some bridge port.

		0x04	Excessive levels. The number of different MD levels at which maintenance domain
		intermediate points (MIPs) are to be created on this port exceeds the bridge's capabilities.

		0x08	Overlapped levels. An MEP is created for one VID at one MD level, but an MEP is also
		configured on another VID at that MD level or higher, exceeding the bridge's capabilities.

		(R) (mandatory) (5N bytes)

type Dot1AgChassisManagementInfo ¶

type Dot1AgChassisManagementInfo struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1AgChassisManagementInfo (Class ID: #306 / 0x0132)

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
		This attribute uniquely identifies this ME. There is at most one instance, whose value is 0. (R)
		(mandatory) (2-bytes)

	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
		The format of the chassis ID attribute, default value 7, as defined in [IEEE 802.1AB]:

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

	Chassis ID Part 1
		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)

	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
		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
		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 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
		The length of the management address attribute, default value 0. (R,-W) (mandatory) (1-byte)

	Management Address 1
		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)

	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 / 0x012d)

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
		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
		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
		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
		This attribute determines whether, when no more specific match is found, the bridge creates an
		MHF or not. This attribute is an enumeration with the following values:

		1	None. The bridge does not create any MHFs. This is the default value.

		2	Default. The bridge can create MHFs on this VID on any port through which the VID can pass.

		3	Explicit. The bridge can create MHFs on this VID on any port through which the VID can pass,
		but only if an MEP exists at some lower maintenance level.

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

	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
		Each entry is a vector of fields, indexed by primary VLAN ID.

		Primary VLAN ID (2-bytes)

		Table control: This field controls the meaning of a set operation. The 1-byte size of this field
		is included in get/get-next operations, but its value is undefined under get-next and should be
		ignored by the OLT. (1-byte)

		1	Add record to table; overwrite existing record, if any.

		2	Delete record from table.

		3	Clear all entries from table. This action may affect service and should be used judiciously.

		Other values are reserved.

		Status: This Boolean field indicates whether this table entry is in effect (true) or whether
		(false) it has been overridden by the existence of an MA for the same VID and MD level as this
		table's entry, and on which an up MEP is defined. This attribute is read-only. Space should be
		allocated for it during set operations, but the value is not used. (1-byte)

		Level: This field ranges from 0..7 and specifies the MD level of MHFs under the control of this
		instance of the dot1ag default MD level. The additional value 0xFF instructs the bridge to use
		the value in the catch-all level attribute. (1-byte)

		MHF creation: This attribute determines whether the bridge creates an MHF or not, under
		circumstances defined in clause 22.2.3 of [IEEE 802.1ag]. This attribute is an enumeration with
		the following values. (1-byte)

		1	None. No MHFs are created on this bridge for this MA.

		2	Default. The bridge can create MHFs on this VID on any port through which the VID can pass.

		3	Explicit. The bridge can create MHFs on this VID on any port through which the VID can pass,
		but only if an MEP exists at some lower maintenance level.

		4	Defer. This value causes the ONU to use the setting of the catch-all MHF creation attribute.
		This is recommended to be the default value.

		Sender ID permission: This attribute determines the contents of the sender ID TLV included in
		CFM messages transmitted by MPs controlled by this MA. (1-byte)

		1	None: the sender ID TLV is not to be sent, default.

		2	Chassis: the chassis ID length, chassis ID subtype, and chassis ID fields of the sender ID TLV
		are to be sent, but not the management address fields.

		3	Manage: the management address fields of the sender ID TLV are to be sent, but the chassis ID
		length is to be transmitted with a 0 value, and the chassis ID subtype, and chassis ID fields
		are not to be sent.

		4	ChassisManage: all chassis ID and management address fields are to be sent.

		5	Defer: the contents of the sender ID TLV is determined by the catch-all sender ID permission
		attribute.

		Associated VLANs list: This field comprises a list of up to 11 additional VLAN IDs associated
		with the primary VLAN, 2-bytes each. Unused placeholders, possibly including the entire field,
		are set to 0. (22-bytes)

		(R,-W) (mandatory) (29-bytes * N entries)

type Dot1AgMaintenanceAssociation ¶

type Dot1AgMaintenanceAssociation struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1AgMaintenanceAssociation (Class ID: #300 / 0x012c)

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
		This attribute uniquely identifies an instance of this ME. The values 0 and 0xFFFF are reserved.
		(R, setbycreate) (mandatory) (2-bytes)

	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
		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
		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)

	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
		3:	100 ms

		4:	1 s

		5:	10 s

		6:	1 min

		7:	10 min

		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)

		Continuity check message (CCM) interval: If CCMs are enabled on an MEP, the CCM interval
		attribute specifies the rate at which they are generated. The MEP also expects to receive CCMs
		from each of the other MEPs in its CC database at this rate.

		0:	CCM transmission disabled

		1:	3.33 ms

		2:	10 ms

	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
		This attribute determines whether the bridge creates an MHF, under circumstances defined in
		clause 22.2.3 of [IEEE 802.1ag]. This attribute is an enumeration with the following values:

		1	None. No MHFs are created on this bridge for this MA.

		2	Default (IEEE 802.1ag term). The bridge can create MHFs on this VID on any port through which
		the VID can pass.

		3	Explicit. The bridge can create MHFs on this VID on any port through which the VID can pass,
		but only if an MEP exists at some lower maintenance level.

		4	Defer. This value causes the ONU to use the setting of the parent MD. This is recommended to
		be the default value.

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

type Dot1AgMaintenanceDomain ¶

type Dot1AgMaintenanceDomain struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1AgMaintenanceDomain (Class ID: #299 / 0x012b)

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
		This attribute uniquely identifies an instance of this ME. The values 0 and 0xFFFF are reserved.
		(R, setbycreate) (mandatory) (2-bytes)

	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
		This attribute specifies one of several possible formats for the MD name attribute. (R,-W,
		setbycreate) (mandatory) (1-byte)

	MD Name 1
		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)

	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
		Maintenance domain intermediate point half function (MHF) creation: This attribute determines
		whether an associated bridge creates an MHF for this MD, under circumstances defined in
		clause-22.2.3 of [IEEE 802.1ag]. This attribute is an enumeration with the following values.

		1	None

		2	Default (IEEE 802.1ag term). The bridge can create MHFs on an associated VID on any port
		through which the VID can pass, where: i) there are no lower active MD levels or ii) there is a
		maintenance association end point (MEP) at the next lower active MD level on the port.

		3	Explicit. The bridge can create MHFs on an associated VID on any port through which the VID
		can pass, but only if an MEP exists at some lower maintenance level.

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

	Sender Id Permission
		This attribute determines the contents of the sender ID type-length-value (TLV) included in CFM
		messages transmitted by maintenance points (MPs) controlled by this MD. Chassis ID and
		management address information is available from the dot1ag chassismanagement info ME. The
		attribute is an enumeration with the following values.

		1	None: the sender ID TLV is not to be sent.

		2	Chassis: the chassis ID length, chassis ID subtype, and chassis ID fields of the sender ID TLV
		are to be sent, but not the management address fields.

		3	Manage: the management address fields of the sender ID TLV are to be sent, but the chassis ID
		length is to be transmitted with the value 0, and the chassis ID subtype, and chassis ID fields
		are not to be sent.

		4	ChassisManage: all chassis ID and management address fields are to be sent.

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

type Dot1AgMep ¶

type Dot1AgMep struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1AgMep (Class ID: #302 / 0x012e)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory)
		(2-bytes)

	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
		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
		This pointer specifies the maintenance association with which this MEP is associated. (R,-W,
		setbycreate) (mandatory) (2-bytes)

	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
		This attribute specifies some of the overall behavioural aspects of the MEP. It is interpreted
		as follows.

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

	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
		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
		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
		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
		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
		This attribute controls the generation of Ethernet alarm indication signal (AIS) frames when
		they are enabled through the MEP control attribute. It is interpreted as follows:

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

	Fault Alarm Threshold
		This attribute specifies the lowest priority alarm that is allowed to generate a fault alarm.
		The value 0 specifies that the ONU uses its internal default. It is defined as follows.

		1	All defects generate alarms after suitable soaking, including AIS and RDICCM.

		2	Alarm generated only by one of: MACstatus, RemoteCCM, ErrorCCM, XconCCM. This value is
		recommended as the default in [IEEE 802.1ag].

		3	Alarm generated only by one of: RemoteCCM, ErrorCCM, XconCCM.

		4	Alarm generated only by one of: ErrorCCM, XconCCM.

		5	Alarm generated only by: XconCCM.

		6	No alarms are to be reported. This setting may be useful during configuration of services
		across the network when spurious alarms could otherwise be generated.

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

	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
		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 / 0x012a)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory)
		(2-bytes)

	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)

		This attribute identifies the type of TP associated with this dot1 rate limiter. Valid values
		are:

		1	MAC bridge service profile

		2	IEEE 802.1p mapper service profile

	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
		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
		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 / 0x0123)

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
		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
		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
		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
		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
		This attribute is the shared secret for the first radius authentication server. It is a null-
		terminated character string. (R,-W) (mandatory) (25-bytes)

		The following two pairs of attributes are defined in the same way:

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

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

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

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

	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
		Radius messages initiated by the ONU contain a calling-station-ID field that is specified to be
		the supplicant's MAC address in upper-case ASCII form, with bytes separated by a delimiter. This
		attribute permits specification of the delimiter. (R,-W) (optional) (2-bytes)

		Value	Meaning

		0	ONU's internal default

		1	Hyphen (-) delimiter

		2	Colon (:) delimiter

		3	No delimiter

		0x20 - 0x7E	Use this value as the delimiter

		0xF0 - 0xFE	Vendor-specific use

		Other values are reserved.

type Dot1XPerformanceMonitoringHistoryData ¶

type Dot1XPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Dot1XPerformanceMonitoringHistoryData (Class ID: #292 / 0x0124)

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
		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
		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
		This attribute counts received valid EAPOL frames of any type. (R) (mandatory) (4-bytes)

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

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

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

	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
		This attribute counts received EAP response frames, other than resp/id frames. (R) (mandatory)
		(4-bytes)

	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
		This attribute counts transmitted request frames, other than request/id frames. (R) (mandatory)
		(4-bytes)

	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
		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
		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 / 0x0122)

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
		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
		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
		This attribute defines a set of actions that can be performed on the associated port. The act of
		writing to the register causes the specified action.

		1	Force re-authentication - this opcode initiates an IEEE-802.1X reauthentication conversation
		with the associated port. The port remains in its current authorization state until the
		conversation concludes.

		2	Force unauthenticated - this opcode initiates an IEEE-802.1X authentication conversation whose
		outcome is predestined to fail, thereby disabling normal Ethernet service on the port. The
		port's provisioning is not changed, such that upon re-initialization, a new IEEE-802.1X
		conversation may restore service without prejudice.

		3	Force authenticated - this opcode initiates an IEEE-802.1X authentication conversation whose
		outcome is predestined to succeed, thereby unconditionally enabling normal Ethernet service on
		the port. The port's provisioning is not changed, such that upon re-initialization, a new
		IEEE-802.1X conversation is required.

		(W) (mandatory) (1-byte)

	Authenticator Pae State
		4	Authenticated

		5	Aborting

		6	Held

		7	Force auth

		8	Force unauth

		9	Restart

		(R) (optional) (1-byte)

		This attribute returns the value of the port's PAE state. States are further described in [IEEE
		802.1X]. Values are coded as follows.

		0	Initialize

		1	Disconnected

		2	Connecting

		3	Authenticating

	Backend Authentication State
		This attribute returns the value of the port's back-end authentication state. States are further
		described in [IEEE 802.1X]. Values are coded as follows.

		0	Request

		1	Response

		2	Success

		3	Fail

		4	Timeout

		5	Idle

		6	Initialize

		7	Ignore

		(R) (optional) (1-byte)

	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
		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
		This attribute indicates whether the controlled port is currently authorized (1) or unauthorized
		(2). (R) (optional) (1-byte)

	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
		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
		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 ¶

type EfmBondingGroup struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EfmBondingGroup (Class ID: #418 / 0x01a2)

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
		This attribute uniquely identifies each instance of this ME. The value 0 is reserved. (R,
		setbycreate) (mandatory) (2-bytes)

	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
		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
		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
		This bit mapped attribute enables the various group alarms. A bit value of 1 means "enable".

		Bit	Meaning

		1 (LSB)	Group down

		2	Group partial

		3	Group US rate low

		4	Group DS rate low

		5	4x rate ratio

		6-8	Reserved

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

type EfmBondingGroupPerformanceMonitoringHistoryData ¶

type EfmBondingGroupPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EfmBondingGroupPerformanceMonitoringHistoryData (Class ID: #420 / 0x01a4)

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
		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
		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
		Clause 45.2.3.33 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

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

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

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

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

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

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

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

	Tx Discarded Frames
		Number of Ethernet frames discarded by the group transmit function. (R) (mandatory) (4-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: #421 / 0x01a5)

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
		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
		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
		Number of unicast Ethernet frames received over this group. (R) (mandatory) (4-bytes)

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

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

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

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

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

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

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

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

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

	Rx Multicast Bytes
		Number of bytes contained in the multicast Ethernet frames received over this group. (R)
		(mandatory) (8-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: #419 / 0x01a3)

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
		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.

		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
		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
		This bit mapped attribute enables the group down and group partial alarms. A bit value of 1
		means "enable".

		Bit	Meaning

		1 (LSB)	Link down

		2-8	Reserved

		(R,-W, setbycreate) (mandatory) (1-bytes)

type EfmBondingLinkPerformanceMonitoringHistoryData ¶

type EfmBondingLinkPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EfmBondingLinkPerformanceMonitoringHistoryData (Class ID: #422 / 0x01a6)

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
		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
		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
		Clause 45.2.3.29 of [IEEE 802.3]. (R) (mandatory) (4-bytes)

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

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

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

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

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

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

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

type EfmBondingPortPerformanceMonitoringHistoryData ¶

type EfmBondingPortPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EfmBondingPortPerformanceMonitoringHistoryData (Class ID: #423 / 0x01a7)

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
		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
		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
		Number of Ethernet frames received over this port. (R) (mandatory) (4-bytes)

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

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

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

	Tx Discarded Frames
		Number of Ethernet frames discarded by the port transmit function. (R) (mandatory) (4-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: #424 / 0x01a8)

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
		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
		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
		Number of unicast Ethernet frames received over this port. (R) (mandatory) (4-bytes)

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

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

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

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

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

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

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

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

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

	Rx Multicast Bytes
		Number of bytes contained in the multicast Ethernet frames received over this port. (R)
		(mandatory) (4-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 / 0x0157)

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
		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
		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
		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
		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
		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
		This attribute records the energy consumed by the ONU, measured in millijoules. (R) (optional)
		(4-bytes)

type EnhancedFecPerformanceMonitoringHistoryData ¶

type EnhancedFecPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EnhancedFecPerformanceMonitoringHistoryData (Class ID: #453 / 0x01c5)

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
		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
		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
		This attribute counts the number of bytes that were corrected by the FEC function. (R)
		(mandatory) (8-bytes)

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

	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
		This attribute counts the total received code words. (R) (mandatory) (8-bytes)

	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 / 0x014c)

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
		This attribute uniquely identifies each instance of this ME. There is only one instance, number
		0. (R) (mandatory) (2 bytes)

	Olt Crypto Capabilities
		This attribute specifies the cryptographic mechanisms available at the OLT. It is written by the
		OLT during authentication step 1. It is formatted as a bit map, where a 1 bit indicates that the
		particular algorithm is supported, and a 0 bit indicates it is not supported.

		Bit position	Algorithm

		1 (LSB)	AES-CMAC-128 (support is mandatory)

		2 	HMAC-SHA-256

		3 	HMAC-SHA-512

		4-128 	Reserved

		(W) (mandatory) (16 bytes)

	Olt Random Challenge Table
		This attribute specifies the random challenge OLT_challenge issued by the OLT during
		authentication step 1. It is structured as a table, with each entry being 17 bytes. The first
		byte is the table row number, starting at 1, and the remaining 16 bytes are the contents of the
		entry. OLT_challenge is the concatenation of all 16-byte content fields. In normal use, the OLT
		will write all the entries in the table, and then trigger the ONU's processing of the entire
		table using the OLT challenge status attribute. The table size is known by the maximum index set
		by the OLT. The OLT can clear the table with a set operation to row 0. (R, W) (mandatory) (17 *
		N-bytes)

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

	Olt Challenge Status
		This Boolean attribute controls the completion of authentication step 1. This attribute behaves
		as follows.

		When the OLT performs the first of possibly several set operations to the OLT crypto
		capabilities or the OLT random challenge table attributes, a side effect of the set operation is
		that the ONU sets the OLT challenge status attribute to false.

		When the OLT completes the set operation(s) to the OLT crypto capabilities and the OLT random
		challenge table attributes, then it sets the OLT challenge status attribute to true. This
		triggers the ONU to process the OLT random challenge table, using its choice of the OLT's
		candidate cryptographic hash algorithms.

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

	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
		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
		(authentication step 2). This attribute contains the result of the authentication computation
		from the ONU (ONU_result), according to the ONU's selected crypto capabilities attribute.

		ONU_result-= SelectedHashFunction (PSK, (ONU_selected_crypto capabilities | OLT_challenge |
		ONU_challenge | 0x0000 0000 0000 0000)),

		where "|" denotes concatenation.

		This attribute is structured as a table, with each entry being 16 bytes of content. The number
		of rows Q is implicit in the choice of hash algorithm.

		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)

		This attribute is used in authentication step 3. It contains OLT_result, the result of the
		authentication computation from the OLT.

		OLT_result-= SelectedHashFunction (PSK, (ONU_selected_crypto capabilities | ONU_challenge |
		OLT_challenge | ONU_serial_number)).

		The ONU_serial_number is the serial number attribute of the ONU-G ME, 8 bytes.

	Olt Result Status
		(authentication step 3). This Boolean attribute controls and reports the status of the OLT
		authentication result table attribute. This attribute behaves as follows.

		When the OLT performs the first of possibly several set operations to the OLT authentication
		result table attribute, a side effect of the set operation is that the ONU sets the OLT result
		status attribute to false.

		When the OLT completes the set operation(s) to the OLT authentication result table, then it sets
		the OLT result status attribute to true. This triggers the ONU to process the OLT authentication
		result table.

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

	Onu Authentication Status
		This attribute indicates the status of the authentication relationship from the perspective of
		the ONU. It has the following values.

		0	Indeterminate. This initial value indicates that the OMCI authentication process has not yet
		completed, and may not even have been started.

		1	Reserved.

		2	Reserved.

		3	Authentication success: the procedure has completed at least once since the latest ONU
		activation and in its most recent execution, the ONU has authenticated the OLT.

		4	Authentication failure: the procedure has completed at least once since the latest ONU
		activation, and either its most recent execution resulted in an error or the ONU has failed to
		authenticate the OLT.

		5	Reserved.

		Upon ONU activation, the ONU sets the attribute to the initial value. When the ONU
		authentication status has the value 3, encryption keys exchanged in the TC layer will be
		encrypted using the master session key (ITUT G.984 systems) or the key encryption key (KEK,
		ITU-T G.987 systems). The OLT should check the value of this attribute before initiating a key
		switch.

		(R) (mandatory) (1 byte)

	Master Session Key Name
		Following successful authentication, this register contains the "name," or the hash signature,
		of the current master session key. The master session key is defined as:

		MSK-= SelectedHashFunction (PSK, (OLT_challenge | ONU_challenge)).

		The master session key name is defined as:

		MSKname-= SelectedHashFunction (PSK, (ONU_challenge | OLT_challenge | 0x 3141 5926 5358 9793
		3141 5926 5358 9793)).

		If the selected hash function generates more than 128 bits, the result is truncated to the
		leftmost (most significant) 128 bits.

		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
		10	Clear the entire table.

		11	Reserved.

		The four MSBs specify the length of the fragment, which is left-justified in the key fragment
		field. The value 0 indicates 16-bytes of key fragment.

		The other two bits are reserved.

		Row identifier (1 byte): The two MSBs of this field are the key index, which appears in the
		header of encrypted multicast GEM frames. Key index 0 always indicates cleartext, and should
		therefore not appear in the identifier. The four LSBs identify the key fragment number, starting
		with 0. The other two bits are reserved.

		Key fragment (16 bytes): This field contains the specified fragment of the key (encrypted with
		AES-ECB using the KEK).

		(R, W) (optional) (18N bytes)

		This attribute is defined only in ITU-T G.987 systems. It contains the broadcast key generated
		by the OLT. It is a table, each of whose rows is structured as follows.

		Row control (1 byte): The two LSBs of this byte determine the attribute's behaviour under the
		set action. They always read back as 0 under the get next action.

		00	Set the specified row.

		01	Clear the specified row.

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

type EnhancedTcPerformanceMonitoringHistoryData ¶

type EnhancedTcPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EnhancedTcPerformanceMonitoringHistoryData (Class ID: #454 / 0x01c6)

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
		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
		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
		This attribute counts HEC errors in any of the fields of the downstream physical sync block. (R)
		(optional) (4-bytes)

	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
		This attribute counts the number of grants received whose specified profile was not known to the
		ONU. (R) (optional) (4-bytes)

	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
		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
		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
		This attribute counts the number of downstream XGEM frames received with an invalid key
		specification. The key may be invalid for several reasons, among which are:

		a)	GEM port provisioned for clear text and key index not equal to 00;

		b)	no multicast key of the specified key index has been provided via the OMCI for a multicast
		GEM port;

		c)	no unicast key of the specified key index has been successfully negotiated (see clause 15.5
		of [ITU-T G.987.3] or clause C.15.5 of [ITU-T G.9807.1] for key negotiation state machine);

		d)	GEM port specified to be encrypted and key index = 00;

		e)	key index = 11, a reserved value.

		(R) (mandatory) (8 bytes)

	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
		This attribute counts the number of state transitions from O5.1 to O6. (R) (optional) (4-bytes)

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

	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 EponDownstreamPerformanceMonitoringConfiguration ¶

type EponDownstreamPerformanceMonitoringConfiguration struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EponDownstreamPerformanceMonitoringConfiguration (Class ID: #406 / 0x0196)

This ME represents window sizes and threshold values for EPON downstream PM operations which are
defined in [IEEE 802.3] as: errored symbol period, errored frame, errored frame period and
errored frame seconds summary.

The EPON ONU automatically instantiates an instance of this ME for each ANI-E.

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

Attributes
	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-E. (R, set-by-create) (mandatory) (2-bytes)

	Errored Symbol Period Window
		This attribute specifies the number of symbols in the measurement period, as defined in clause
		57.5.3.1 of [IEEE 802.3]. (R, W) (optional) (8-bytes)

	Errored Symbol Period Threshold
		This attribute specifies the threshold of errored symbols for generating an event report, as
		defined in clause 57.5.3.1 of [IEEE 802.3]. (R, W) (optional) (8-bytes)

	Errored Frame Window
		This attribute specifies the duration in units of 100-ms of the measurement period, as defined
		in clause 57.5.3.2 of [IEEE 802.3]. (R, W) (optional) (2-bytes)

	Errored Frame Threshold
		This attribute specifies the threshold of errored frames for generating an event report, as
		defined in clause 57.5.3.2 of [IEEE 802.3]. (R, W) (optional) (4-bytes)

	Errored Frame Period Window
		This attribute specifies the duration in terms of frames of the measurement period, as defined
		in clause 57.5.3.3 of [IEEE 802.3]. (R, W) (optional) (4-bytes)

	Errored Frame Period Threshold
		This attribute specifies the threshold of errored frames for generating an event report, as
		defined in clause 57.5.3.3 of [IEEE 802.3]. (R, W) (optional) (4-bytes)

	Errored Frame Seconds Summary Window
		This attribute specifies the duration in units of 100ms of the measurement period, as defined in
		clause-57.5.3.4 of [IEEE-802.3]. (R, W) (optional) (2-bytes)

	Errored Frame Seconds Summary Threshold
		This attribute specifies the threshold of errored frame seconds for generating an event report,
		as defined in clause 57.5.3.4 of [IEEE 802.3]. (R, W) (optional) (2-bytes)

type EquipmentExtensionPackage ¶

type EquipmentExtensionPackage struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EquipmentExtensionPackage (Class ID: #160 / 0x00a0)

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
		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
		This attribute provisions an ONU that supports external sense points, e.g., physical security
		detectors at an enclosure. Each pair of bits is defined as follows.

		00	Sense point disabled (default)

		01	Report contact closure

		10	Report contact open

		11	Sense point disabled (same as 00)

		If the byte is represented in binary as 0B hhgg ffee ddcc bbaa, bits hh correspond to sense
		point 1, while bits aa correspond to sense point 8. (R,-W) (optional) (2-bytes)

		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
		This attribute provisions an ONU that supports external contact closure outputs, e.g., sump pump
		or air conditioner activation at an ONU enclosure. A contact point is said to be released when
		it is not energized. Whether this corresponds to an open or a closed electrical circuit depends
		on the ONU's wiring options. Upon ONU initialization, all contact points should go to the
		released state.

		If the byte is represented in binary as 0B hhgg ffee ddcc bbaa, bits hh correspond to contact
		output point 1, while bits aa correspond to contact output point 8.

		On write, the bits of this attribute have the following meaning.

		0x	No change to contact output point state

		10	Release contact output point

		11	Operate contact output point

		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 / 0x011e)

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
		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
		This attribute specifies the destination MAC address of upstream Ethernet frames. (R,-W,
		setbycreate) (mandatory) (6-bytes)

	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
		0	untagged frame

		1	tagged frame

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

		This attribute specifies the tagging policy to be applied to upstream Ethernet frames.

	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
		This attribute sets the loopback configuration as follows.

		0	No loopback

		1	Loopback of downstream traffic at MAC client

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

type EthernetFrameExtendedPm ¶

type EthernetFrameExtendedPm struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetFrameExtendedPm (Class ID: #334 / 0x014e)

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
		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
		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
		This attribute contains fields defined as follows.+

		Threshold data 1/2 ID: (2 bytes) 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. When PM is collected on a continuously running basis, rather
		than in 15-min intervals, counter thresholds should not be established. There is no mechanism to
		clear a TCA, and any counter parameter may eventually be expected to cross any given threshold
		value.

		Parent ME class: (2 bytes) This field contains the enumerated value of the ME class of the PM
		ME's parent. Together with the parent ME instance field, this permits a given PM ME to be
		associated with any OMCI ME. The supported ME classes are as follows.

		46	MAC bridge configuration data

		47	MAC bridge port configuration data

		11	Physical path termination point Ethernet UNI

		98	Physical path termination point xDSL UNI part 1

		266	GEM IW termination point

		281	Multicast GEM IW termination point

		329	Virtual Ethernet interface point

		162	Physical path termination point MoCA UNI

		Parent ME instance: (2 bytes) This field identifies the specific parent ME instance to which the
		PM ME is attached.

		Accumulation disable: (2 bytes) This bit field allows PM accumulation to be disabled; refer to
		Table 9.3.32-1. The default value 0 enables PM collection. If bit 15 is set to 1, no PM is
		collected by this ME instance. If bit 15-=-0 and any of bits 14..1 are set to 1, PM collection
		is inhibited for the attributes indicated by the 1 bits. Inhibiting PM collection does not
		change the value of a PM attribute, but if PM is accumulated in 15-min intervals, the value is
		lost at the next 15-min interval boundary.

		Bit 16 is an action bit that always reads back as 0. When written to 1, it resets all PM
		attributes in the ME, and clears any TCAs that may be outstanding.

		TCA disable: (2 bytes). Also clarified in Table 9.3.32-1, this field permits TCAs to be
		inhibited, either individually or for the complete ME instance. As with the accumulation disable
		field, the default value 0 enables TCAs, and setting the global disable bit overrides the
		settings of the individual thresholds. Unlike the accumulation disable field, the bits are
		mapped to the thresholds defined in the associated threshold data 1 and 2 ME instances. When the
		global or attribute-specific value changes from 0 to 1, outstanding TCAs are cleared, either for
		the ME instance globally or for the individual disabled threshold. These bits affect only
		notifications, not the underlying parameter accumulation or storage.

		If the threshold data 1/2 ID attribute does not contain a valid pointer, this field is not
		meaningful.

		Thresholds should be used with caution if PM attributes are accumulated continuously.

		Control fields: (2 bytes). This field is a bit map whose values govern the behaviour of the PM
		ME. Bits are assigned as follows.

		Bit 1 (LSB)	The value 1 specifies continuous accumulation, regardless of 15-min intervals. There
		is no concept of current and historical accumulators; get and get current data (if supported)
		both return current values. The value 0 specifies 15-min accumulators exactly like those of
		classical PM.

		Bit 2	This bit indicates directionality for the collection of data. The value 0 indicates that
		data are to be collected for upstream traffic. The value 1 indicates that data are to be
		collected for downstream traffic.

		Bits 3..14	Reserved, should be set to 0 by the OLT and ignored by the ONU.

		Bit 15	When this bit is 1, the P bits of the TCI field are used to filter the PM data collected.
		The value 0 indicates that PM is collected without regard to P bits.

		Bit 16	When this bit is 1, the VID bits of the TCI field are used to filter the PM data
		collected. The value 0 indicates that PM is collected without regard to VID.

		TCI: (2 bytes). This field contains the value optionally used as a filter for the PM data
		collected, under the control of bits 15..16 of the control fields. This value is matched to the
		outer tag of a frame. Untagged frames are not counted when this field is used.

		Reserved: (2 bytes). Not used; should be set to 0 by the OLT and ignored by the ONU.

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

	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
		The total number of octets received, including those in bad frames, excluding framing bits, but
		including FCS. (R) (mandatory) (4 bytes)

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

	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
		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
		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
		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
		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
		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
		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
		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
		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
		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 ¶

type EthernetFrameExtendedPm64Bit struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetFrameExtendedPm64Bit (Class ID: #425 / 0x01a9)

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.

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
		This attribute uniquely identifies each instance of this ME. To facilitate discovery, it is
		encouraged to identify instances sequentially starting with 1. (R, set-by-create) (mandatory) (2
		bytes)

	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
		This attribute contains fields defined as follows.

		Threshold data 64-bit ID: (2 bytes). This attribute points to an instance of the threshold data
		64-bit ME that contains PM threshold values. When PM is collected on a continuously running
		basis, rather than in 15-min intervals, counter thresholds should not be established. There is
		no mechanism to clear a TCA, and any counter parameter may eventually be expected to cross any
		given threshold value.

		Parent ME class: (2 bytes). This field contains the enumerated value of the ME class of the PM
		ME's parent. Together with the parent ME instance field, this permits a given PM ME to be
		associated with any OMCI ME. The supported ME classes are as follows.

		46	MAC bridge configuration data

		47	MAC bridge port configuration data

		11	Physical path termination point Ethernet UNI

		98	Physical path termination point xDSL UNI part 1

		266	GEM IW termination point

		281	Multicast GEM IW termination point

		329	Virtual Ethernet interface point

		162	Physical path termination point MoCA UNI

		Parent ME instance: (2 bytes). This field identifies the specific parent ME instance to which
		the PM ME is attached.

		Accumulation disable: (2 bytes). This bit field allows PM accumulation to be disabled; refer to
		Table 9.3.32-1. The default value 0 enables PM collection. If bit 15 is set to 1, no PM is
		collected by this ME instance. If bit 15 = 0 and any of bits 14..1 are set to 1, PM collection
		is inhibited for the attributes indicated by the 1 bits. Inhibiting PM collection does not
		change the value of a PM attribute, but if PM is accumulated in 15-min intervals, the value is
		lost at the next 15-min interval boundary.

		Bit 16 is an action bit that always reads back as 0. When written to 1, it resets all PM
		attributes in the ME, and clears any TCAs that may be outstanding.

		TCA disable: (2 bytes). Also clarified in Table 9.3.32-1, this field permits TCAs to be
		inhibited, either individually or for the complete ME instance. As with the accumulation disable
		field, the default value 0 enables TCAs, and setting the global disable bit overrides the
		settings of the individual thresholds. Unlike the accumulation disable field, the bits are
		mapped to the thresholds defined in the associated threshold data 1 and 2 ME instances. When the
		global or attribute-specific value changes from 0 to 1, outstanding TCAs are cleared, either for
		the ME instance globally or for the individual disabled threshold. These bits affect only
		notifications, not the underlying parameter accumulation or storage.

		If the threshold data 1/2 ID attribute does not contain a valid pointer, this field is not
		meaningful.

		Thresholds should be used with caution if PM attributes are accumulated continuously.

		Control fields: (2 bytes). This field is a bit map whose values govern the behaviour of the PM
		ME. Bits are assigned as follows:

		Bit 1 (LSB)	The value 1 specifies continuous accumulation, regardless of 15-min intervals. There
		is no concept of current and historic accumulators; get and get current data (if supported) both
		return current values. The value 0 specifies 15-min accumulators exactly like those of classical
		PM.

		Bit 2	This bit indicates directionality for the collection of data. The value 0 indicates that
		data are to be collected for upstream traffic. The value 1 indicates that data are to be
		collected for downstream traffic.

		Bits 3..14	Reserved, should be set to 0 by the OLT and ignored by the ONU.

		Bit 15	When this bit is 1, the P bits of the TCI field are used to filter the PM data collected.
		The value 0 indicates that PM is collected without regard to P bits.

		Bit 16	When this bit is 1, the VID bits of the TCI field are used to filter the PM data
		collected. The value 0 indicates that PM is collected without regard to VID.

		TCI: (2 bytes). This field contains the value optionally used as a filter for the PM data
		collected, under the control of bits 15..16 of the control fields. This value is matched to the
		outer tag of a frame. Untagged frames are not counted when this field is used.

		Reserved: (2 bytes). Not used; should be set to 0 by the OLT and ignored by the ONU.

		(R, W, set-by-create) (mandatory) (16 bytes)

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

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

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

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

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

	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) (8 bytes)

	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) (8 bytes)

	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) (8 bytes)

	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) (8-bytes)

	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) (8 bytes)

	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) (8 bytes)

	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) (8 bytes)

	Frames 512 To 1023 Octets
		The total number of frames (including bad frames) received that were 512..1023 octets long,
		excluding framing bits but including FCS. (R) (mandatory) (8 bytes)

	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) (8 bytes)

type EthernetFramePerformanceMonitoringHistoryDataDownstream ¶

type EthernetFramePerformanceMonitoringHistoryDataDownstream struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

EthernetFramePerformanceMonitoringHistoryDataDownstream (Class ID: #321 / 0x0141)

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
		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
		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
		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
		The total number of upstream octets received, including those in bad packets, excluding framing
		bits, but including FCS. (R) (mandatory) (4-bytes)

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

	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
		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
		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
		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.

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

	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
		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
		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
		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
		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
		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 / 0x0142)

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
		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
		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
		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
		The total number of upstream octets received, including those in bad packets, excluding framing
		bits, but including FCS. (R) (mandatory) (4-bytes)

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

	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
		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
		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
		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.

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

	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
		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
		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
		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
		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
		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 / 0x0018)

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
		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
		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
		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
		This attribute counts frames whose transmission failed due to excessive collisions.-(R)
		(mandatory) (4-bytes)

	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
		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
		This attribute counts the number of times that the receive buffer overflowed. (R) (mandatory)
		(4-bytes)

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

	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
		This attribute counts successfully transmitted frames whose transmission was delayed by more
		than one collision. (R) (mandatory) (4-bytes)

	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
		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
		This attribute counts frames whose transmission failed due to an internal MAC sublayer transmit
		error. (R) (mandatory) (4-bytes)

	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
		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
		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 / 0x0059)

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
		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
		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
		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 / 0x0128)

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
		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
		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
		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
		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
		The total number of packets received, including bad packets, broadcast packets and multicast
		packets. (R) (mandatory) (4-bytes)

	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
		The total number of received good packets directed to a multicast address. This does not include
		broadcast packets. (R) (mandatory) (4-bytes)

	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
		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
		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
		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
		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
		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
		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
		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
		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 / 0x0190)

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
		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
		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 / 0x00ab)

This ME organizes data associated with VLAN classification and tagging operations. 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.

Through separate attributes, this ME supports either a Received frame VLAN tagging operation
table attribute in its backward compatible form, or an enhanced frame classification and
processing capability. The OLT can determine whether the ONU supports the enhanced capability
through the Enhanced mode attribute of the ONU3-G ME.

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
		This attribute provides a unique number for each instance of this ME. (R, setbycreate)
		(mandatory) (2-bytes)

	Association Type
		This attribute identifies the type of the ME associated with this extended VLAN tagging ME.
		Values are assigned as follows.

		0	MAC bridge port configuration data

		1	IEEE 802.1p mapper service profile

		2	Physical path termination point Ethernet UNI

		3	IP host config data or IPv6 host config data

		4	Physical path termination point xDSL UNI

		5	GEM IW termination point

		6	Multicast GEM IW termination point

		7	Physical path termination point MoCA UNI

		8	Reserved

		9	Ethernet flow termination point

		10	Virtual Ethernet interface point

		11	MPLS pseudowire termination point

		12	EFM bonding group

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

		NOTE 1 - If a MAC bridge is configured, code points 1, 5, 6 and 11 are associated with the ANI
		side of the MAC bridge. Code point 0 is associated with the ANI or UNI side, depending on the
		location of the MAC bridge port. The other code points are associated with the UNI side.

		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
		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
		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
		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
		Regardless of its association, the rules of the received frame VLAN tagging operation table
		attribute pertain to upstream traffic. The downstream mode attribute defines the tagging action
		to be applied to downstream frames.

		The received frame VLAN tagging operation table installs defaults upstream rules. In the
		downstream direction, the upstream default rules with the default treatment do not apply. It
		should be noted that downstream frame treatment is defined by the downstream mode attribute and
		is not affected by the upstream default rules.

		The received frame VLAN tagging operation table can result in two types of rule mappings:

		o	One to one mapping: A table contains one or more rules that result in unique mappings between
		the ingress and egress flows.

		o	Many to one mapping: A table contains more than one rule that results in the same ANI-side tag
		configuration.

		For one-to-one  mappings, the inverse operation to apply in the downstream direction (in the
		case of bidirectional flows) is the inverse operation of the upstream rule.

		Many-to-one mappings are possible however, and these are treated as follows.

		o	If an upstream many-to-one mapping results from multiple operation rules producing the same
		ANI-side tag configuration, then the first matching rule in the list defines the inverse
		operation. The meaning of match depends on the value of the downstream mode attribute.

		o	If the many-to-one mapping results from "don't care" fields in the filter being replaced with
		provisioned fields in the ANI side tags, then the inverse is defined to set the corresponding
		fields on the ANI side to their lowest legal value.

		If the upstream rule merely copies (i.e., no explicit value is specified in the filter field) an
		inbound tag value to an outbound tag value, the comparison in the downstream direction applies
		to all tag values. This applies separately to the VID and P-bit fields. For example, with a
		downstream mode of 2 and an upstream rule that translates the VID while carrying forward the
		P-bit value, downstream frames that match the specified WAN-side VID will match any P-bit value
		and will translate the VID.

		0	The operation performed in the downstream direction is the inverse of that performed in the
		upstream direction. Which treatment and filter fields are used for downstream filtering and the
		handling of unmatched frames are left to the implementation of the ONU.

		1	Regardless of the filter rules, no operation is performed in the downstream direction. All
		downstream frames are forwarded unmodified.

		2	Filter on VID and P-bit value. On a match, perform the inverse operation on both the VID and
		P-bit value. If no match is found, forward the frame unmodified.

		3	Filter on VID only. On a match, perform the inverse VID operation only; pass the P bits
		through. If no match is found, forward the frame unmodified.

		4	Filter on P-bit only. On a match, perform the inverse P-bit operation only; pass the VID
		through. If no match is found, forward the frame unmodified.

		5	Filter on VID and P-bit value. On a match, perform the inverse operation on both the VID and
		P-bit value. If no match is found, discard the frame.

		6	Filter on VID. On a match, perform the inverse operation on the VID only; pass the P bits
		through. If no match is found, discard the frame.

		7	Filter on P-bit only. On a match, perform the inverse P-bit operation only; pass the VID
		through. If no match is found, discard the frame.

		8	Regardless of the filter rules, discard all downstream traffic.

		Please refer to Table 9.3.13-2 for example downstream mode use cases.

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

	Received Frame Vlan Tagging Operation Table
		Padding: (8 bits)

		Filter Ethertype: (4 bits) the Ethertype value on which to filter received frames, as follows.

		NOTE 3 - This filter is recommended for use on untagged frames or frames with priority tags
		only.

		0	Do not filter on Ethertype.

		1	Ethertype = 0x0800 (filter IPoE frames)

		2	Ethertype = 0x8863 or 0x8864 (filter PPPoE frames)

		3	Ethertype = 0x0806 (filter ARP frames)

		4	Ethertype = 0x86DD (filter IPv6 IpoE frames)

		5	Ethertype = 0x888E (filter EAPOL frames)

		Other values: reserved.

		Filter on extended criteria: (8 bits) filter on key upper level protocols:

		0	Do not filter on extended criteria

		1	DHCPv4 - frames matching the well-known DHCPv4 UDP ports (67, 68) will be filtered by this
		criteria code point.

		2	DHCPv6 - frames matching the well-known DHCPv6 UDP ports (546, 547) will be filtered by this
		criteria code point.

		NOTE 4 - This filter is recommended for use on untagged frames or priority framed tags only.

		Treatment tags to remove: (2 bits) Defines the tag treatment. The following values are
		supported:

		0..2	Remove 0, 1 or 2 tags, respectively. If one tag is specified, then the outer tag is
		stripped from double-tagged frames.

		3	Discard the frame. No symmetric downstream operation exists; i.e., this rule is ignored in the
		downstream direction.

		Padding: (10 bits)

		Treatment outer priority: (4 bits): Defines the outer VLAN priority treatment. The following
		values are supported:

		0..7	Add an outer tag, and insert this value as the priority in the outer VLAN tag.

		8	Add an outer tag, and copy the outer priority from the inner priority of the received frame.

		9	Add an outer tag, and copy the outer priority from the outer priority of the received frame.

		10	Add an outer tag, and derive P bits from the DSCP field of the incoming frame according to
		the Extended VLAN tagging operation configuration data ME DSCP to P-bit mapping attribute.

		15	Do not add an outer tag.

		Other values: reserved.

		Treatment outer VID: (13 bits). Defines the outer VID treatment. The following values are
		supported:

		0..4094	Use this value as the VID in the outer VLAN tag.

		4096	Copy the outer VID from the inner VID of the received frame.

		4097	Copy the outer VID from the outer VID of the received frame.

		Other values: reserved.

		Treatment outer TPID/DEI: (3 bits). Defines the outer VLAN TPID/DEI treatment. The following
		values are supported:

		000	Copy TPID (and DEI, if present) from the inner tag of the received frame.

		001	Copy TPID (and DEI, if present) from the outer tag of the received frame.

		010	Set TPID = output TPID attribute value of the Extended VLAN tagging operation configuration
		data ME and copy DEI bit from the inner tag of the received frame

		011	Set TPID = output TPID attribute value of the Extended VLAN tagging operation configuration
		data ME and copy DEI from the outer tag of the received frame

		100	Set TPID = 0x8100

		101	Reserved

		110	Set TPID = output TPID attribute value of the Extended VLAN tagging operation configuration
		data ME and set DEI = 0

		111	Set TPID = output TPID attribute value of the Extended VLAN tagging operation configuration
		data ME and set DEI = 1

		Padding: (12 bits)

		Treatment inner priority: (4 bits). Defines the inner VLAN priority treatment. The following
		values are supported:

		0..7	Add an inner tag, and insert this value as the priority to insert in the inner VLAN tag.

		8	Add an inner tag, and copy the inner priority from the inner priority of the received frame.

		9	Add an inner tag, and copy the inner priority from the outer priority of the received frame.

		10	Add an inner tag, and derive P bits from the DSCP field of the incoming frame according to
		the Extended VLAN tagging operation configuration data ME DSCP to P-bit mapping attribute.

		15	Do not add an inner tag.

		Other values: reserved.

		Treatment inner VID: (13 bits): Defines the inner VLAN VID treatment.  The following values are
		supported:

		0..4094	Use this value as the VID in the inner VLAN tag.

		4096	Copy the inner VID from the inner VID of the received frame.

		4097	Copy the inner VID from the outer VID of the received frame.

		Other values: reserved.

		Treatment inner TPID/DEI: (3 bits). Defines the inner VLAN TPID/DEI treatment. The following
		values are supported:

		000	Copy TPID (and DEI, if present) from the inner tag of the received frame.

		001	Copy TPID (and DEI, if present) from the outer tag of the received frame.

		010	Set TPID = output TPID attribute value of the Extended VLAN tagging operation configuration
		data ME and copy the DEI bit from the inner tag of the received frame.

		011	Set TPID = output TPID attribute value of the Extended VLAN tagging operation configuration
		data ME and, copy the DEI from the outer tag of the received frame.

		100	Set TPID = 0x8100

		101	Reserved

		110	Set TPID = output TPID attribute value of the Extended VLAN tagging operation configuration
		data ME and set DEI = 0

		111	Set TPID = output TPID attribute value of the Extended VLAN tagging operation configuration
		data ME and set DEI = 1

		This attribute is a table that filters and tags upstream frames. Each entry represents a tagging
		rule, comprising a filtering part (the first eight fields) and a treatment part (the last seven
		fields). Each incoming upstream packet is matched against each rule in list order. The first
		rule that matches the packet is selected as the active rule, and the packet is then treated
		according to that rule.

		There are three categories of rules: zero-tag, single-tag, and double-tag rules. Logically,
		these categories are separate, and apply to their respective incoming frame types. In other
		words, a single-tag rule should not apply to a double-tagged frame, even though the single-tag
		rule might match the outer tag of the double-tagged frame.

		Single-tag rules have a filter outer priority field-= 15 (indicating no external tag), zero-tag
		rules have both filter priority fields-= 15 (indicating no tags), and double-tag rules have both
		filter priority fields set to a value that differs from 15 (indicating two tags).

		Each tagging rule is based on a remove or an add operation, where up to two tags can be removed
		or added. A modify operation is applied by the combination of remove and add.

		By convention, when a single tag is added, the treatments use the inner tag data fields. This is
		true even for treatments where a single tag is added to a frame that already has a tag, i.e.,
		added as a second tag. The outer tag data fields are used only when two tags are added by the
		same rule.

		The terms inner and outer only have meaning with respect to the tags that are being filtered or
		added.

		The first 8-bytes of each entry are guaranteed to be unique, and are used to identify table
		entries (list order, above, refers to a sort on the first 8-bytes). The OLT deletes a table
		entry by setting all of its last 8-bytes to 0xFF.

		When the table is created, the ONU should autonomously predefine three entries that list the
		default treatment (normal forwarding without filtering or modification) for untagged, single
		tagged, and double tagged frames. As an exception to the rule on ordered processing, these
		default rules are always considered as a last resort for frames that do not match any other
		rule. Best practice dictates that these entries not be deleted by the OLT; however, they can be
		modified to produce the desired default behaviour.

		It should be noted that downstream frame treatment is defined by the downstream mode attribute
		and is not affected by the upstream default rules.

		15, 4096, x, 15, 4096, x, 0, (0, 15, x, x, 15, x, x) - no tags

		15, 4096, x, 14, 4096, x, 0, (0, 15, x, x, 15, x, x) - 1 tag

		14, 4096, x, 14, 4096, x, 0, (0, 15, x, x, 15, x, x) - 2 tags

		NOTE 2 - x is a "don't care" field and should be set to zero.

		See Figure 9.3.13-1.

		(R,-W) (mandatory) (16N bytes, where N is the number of VLAN tagging rules)

		Filter outer priority: (4 bits) Defines the outer VLAN priority filtering operation. The
		following values are supported:

		0..7	Filter received frames on this outer priority (P bit) value.

		8	Do not filter on outer priority.

		14	This is the default filter when no other two-tag rule applies.

		15	This entry is not a double-tag rule; ignore all other outer tag filter fields.

		Other values: reserved.

		Filter outer VID: (13 bits) Defines the outer VLAN VID filtering operation.  The following
		values are supported:

		0..4094	Filter received frames on this outer VID value.

		4096	Do not filter on the outer VID.

		Other values: reserved.

		Filter outer TPID/DEI: (3 bits) Defines the outer VLAN TPID/DEI filtering operation. The
		following values are supported:

		000	Do not filter on outer TPID field.

		100	Outer TPID = 0x8100. Filter on frames with the outer TPID set to 0x8100.

		101	Outer TPID = input TPID attribute value, don't care about DEI bit. Filter on frames with the
		outer TPID set to match the Extended VLAN tagging operation configuration data Input TPID
		attribute value and ignore the DEI bit.

		110	Outer TPID = input TPID, DEI = 0. Filter on frames with the outer TPID set to match the
		Extended VLAN tagging operation configuration data Input TPID attribute value and DEI set to the
		value 0.

		111	Outer TPID = input TPID, DEI = 1. Filter on frames with the outer TPID set to match the
		Extended VLAN tagging operation configuration data Input TPID attribute value and DEI set to the
		value 1

		Padding: (12 bits)

		Filter inner priority: (4 bits) Defines the inner VLAN priority filtering operation.  The
		following values are supported:

		0..7	Filter received frames on this inner priority value.

		8	Do not filter on inner priority.

		14	This is the default filter when no other one-tag rule applies.

		15	This entry is a no-tag rule; ignore all other VLAN tag filter fields.

		Other values: reserved.

		Filter inner VID: (13 bits) Defines the inner VLAN VID filtering operation.  The following
		values are supported:

		0..4094	Filter received frames on this inner VID value.

		4096	Do not filter on the inner VID.

		Other values: reserved.

		Filter inner TPID/DEI: (3 bits) Defines the inner VLAN TPID/DEI filtering operation. The
		following values are supported:

		000	Do not filter on inner TPID field.

		100	Inner TPID = 0x8100. Filter on frames with the inner TPID set to 0x8100.

		101	Inner TPID = input TPID attribute value, don't care about DEI bit. Filter on frames with the
		inner TPID set to match the Extended VLAN tagging operation configuration data Input TPID
		attribute value and ignore the DEI bit.

		110	Inner TPID = input TPID, DEI = 0. Filter on frames with the inner TPID set to match the
		Extended VLAN tagging operation configuration data Input TPID attribute value and DEI set to the
		value 0.

		111	Inner TPID = input TPID, DEI = 1. Filter on frames with the inner TPID set to match the
		Extended VLAN tagging operation configuration data Input TPID attribute value and DEI set to the
		value 1.

	Associated Me Pointer
		This attribute points to the ME with which this extended VLAN tagging operation configuration
		data ME is associated. (R,-W, setbycreate) (mandatory) (2-bytes)

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

	Dscp To P Bit Mapping
		DSCP to P-bit mapping: This attribute specifies mapping from DSCP to P bits. The attribute can
		be considered a bit string sequence of 64 3-bit groups. The 64 sequence entries represent the
		possible values of the 6-bit DSCP field. Each 3-bit group specifies the P-bit value to which the
		associated DSCP value should be mapped. (R,-W) (optional) (24-bytes)

		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.

	Enhanced Mode
		The Boolean value true specifies that the Enhanced received frame classification and processing
		table is used, and the Received frame VLAN tagging operation table is ignored. The value false
		indicates the Enhanced received frame classification and processing table is not used. It is
		strongly recommended that the OLT uses the same value for all Extended VLAN tagging operation
		configuration data instances created on an ONU. (R, Setbycreate) (optional) (1-byte)

	Enhanced Received Frame Classification And Processing Table
		This attribute is a table that provides enhanced capability for frame classification and
		processing. It extends the Received frame VLAN tagging operation table attribute with a set
		control field, a row key and direction. Each incoming packet is matched against each rule in row
		key order (smaller value row key has higher precedence) and direction. The first rule that
		matches the packet is selected as the active rule, and the packet is then treated according to
		that rule.

		When the table is empty, the ONU discards all received frames. The OLT may choose to create
		three entries that list the default treatment (normal forwarding without filtering or
		modification) for untagged, single tagged, and double tagged frames, with the direction field
		set to 0.

		NOTE 7 - Where no change is noted, the definitions in the Received frame VLAN tagging operation
		table attribute remain applicable.

		(R,-W) (optional) (28N bytes, where N is the number of entries in the table).

		Set ctrl: (2 bits)

		This field determines the meaning of a set operation. These bits are returned as 00 during get
		next operations.

		1	Write this entry into the table. Overwrite any existing entry with the same row key.

		2	Delete this entry from the table. The remaining fields are not meaningful.

		NOTE 8 - unlike the delete operation in the Received frame VLAN tagging operation table, the OLT
		does not need to set all eight bytes in Word 4 and Word 5 to 0xFF.

		3	Clear all entries from the table. The remaining fields are not meaningful.

		Other values: reserved.

		Dir: (2 bits)

		This field determines the direction of the classification and processing rule.

		0	This is an upstream rule. In the downstream direction, the inverse classification and
		operation is defined based on the downstream mode code point. All downstream mode codepoints are
		considered valid to be used when dir=0 is used (including downstream  mode 8).

		1	This is an upstream-only rule. This rule is ignored in the downstream direction.

		2	This is a downstream-only rule. This rule is ignored in the upstream direction.

		Other values: reserved.

		Row key: (16 bits)

		The row key distinguishes rows in the table. It is the responsibility of the OLT to assign and
		track row keys and content, and to ensure the classification rules are not duplicated and in the
		correct ordering.

		For Filter outer priority, Filter outer VID, Filter outer TPID/DEI, Filter inner priority,
		Filter inner VID, Filter inner TPID/DEI, Filter on Extended Criteria, Filter Ethertype,
		Treatment outer priority, Treatment outer VID, Treatment outer TPID/DEI, Treatment inner
		priority, Treatment inner VID, and Treatment inner TPID/DEI values please refer to Received
		frame VLAN tagging operation table in this ME.

type FastChannelConfigurationProfile ¶

type FastChannelConfigurationProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

FastChannelConfigurationProfile (Class ID: #432 / 0x01b0)

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
		REIN Inter-arrival time (IAT_REIN): This attribute specifies the REIN IAT. See clause 9.8 of
		[ITU-T G.9701]. The ITU-T G.9701 control parameter iat_rein_flag is set to the same value as the
		REIN IAT. See clause 11.4.2.7 of [ITU-T G.9701].

		The REIN IAT is specified via the following values:

		1	100 Hz;

		2	120 Hz;

		3	360 Hz.

		See clause 7.2.2.5 of [ITU-T G.997.2].

		(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 / 0x01b1)

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
		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 / 0x01b4)

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
		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
		Date/time-stamping of last successful downstream FRA operation (STAMP-FRAds): This attribute
		reports the date/time of the last successful FTU-R initiated FRA execution that has modified the
		bits allocation. See clause 7.10.14.5 of [ITUT-G.997.2]. The format of this parameter is as
		follows:

		(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 / 0x01b2)

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
		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 / 0x01b5)

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
		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
		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
		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
		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
		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 / 0x01b6)

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
		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
		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
		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
		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 FecPerformanceMonitoringHistoryData ¶

type FecPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

FecPerformanceMonitoringHistoryData (Class ID: #312 / 0x0138)

This ME collects PM data associated with PON downstream forward error correction (FEC) counters.
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 time
	and wavelength division multiplexing (TWDM) channel ME.

Attributes
	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
		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)

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

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

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

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

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

type GalEthernetPerformanceMonitoringHistoryData ¶

type GalEthernetPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

GalEthernetPerformanceMonitoringHistoryData (Class ID: #276 / 0x0114)

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
		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
		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
		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 / 0x0110)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory)
		(2-bytes)

	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 / 0x010a)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory)
		(2-bytes)

	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
		This attribute identifies the type of non-GEM function that is being interworked. The options
		are as follows.

		0	Circuit-emulated TDM

		1	MAC bridged LAN

		2	Reserved

		3	Reserved

		4	Video return path

		5	IEEE 802.1p mapper

		6	Downstream broadcast

		7	MPLS PW TDM service

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

	Service Profile Pointer
		This attribute points to an instance of a service profile:

		CES service profile	if IW option-=-0

		MAC bridge service profile	if IW option-=-1

		Video return path service profile	if IW option-=-4

		IEEE 802.1p mapper service profile	if IW option-=-5

		Null pointer	if IW option-=-6

		CES service profile	if IW option-=-7

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

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

	Interworking Termination Point Pointer
		This attribute is used for the CES and IEEE 802.1p mapper service without a MAC bridge.
		Depending on the service provided, it points to the associated instance of the following MEs:

		PPTP CES UNI

		Logical N * 64 kbit/s sub-port CTP

		PPTP Ethernet UNI

		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
		This value reports the number of PPTP ME instances associated with this GEM IW TP. (R)
		(optional) (1-byte)

	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
		5	GAL Ethernet profile for IEEE 802.1p mapper

		6	Null pointer

		7	Null pointer

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

		This attribute points to an instance of the GAL profile. The relationship between the IW option
		and the related GAL profile is as follows.

		Interworking option	GAL profile type

		0	Null pointer

		1	GAL Ethernet profile

		3	GAL Ethernet profile for data service

		4	GAL Ethernet profile for video return path

	Gal Loopback Configuration
		This attribute sets the loopback configuration when using GEM mode:

		0	No loopback

		1	Loopback of downstream traffic after GAL

		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 / 0x010c)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory)
		(2-bytes)

	Port_Id
		Port-ID:	This attribute is the port-ID of the GEM port associated with this CTP. (RWSC)
		(mandatory) (2-bytes)

		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
		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
		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.

		This attribute points to the instance of the traffic descriptor ME that contains the upstream
		traffic parameters for this GEM port network CTP. This attribute is used when the traffic
		management option attribute in the ONU-G ME is 1 (rate controlled), specifying the PIR/PBS to
		which the upstream traffic is shaped. This attribute is also used when the traffic management
		option attribute in the ONU-G ME is 2 (priority and rate controlled), specifying the
		CIR/CBS/PIR/PBS to which the upstream traffic is policed. (R,-W, setbycreate) (optional)
		(2-bytes)

	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
		Priority queue pointer for downstream: This attribute points to the instance of the priority
		queue used for this GEM port network CTP in the downstream direction. It is the responsibility
		of the OLT to provision the downstream pointer in a way that is consistent with the bridge and
		mapper connectivity. If the pointer is null, downstream queueing is determined by other
		mechanisms in the ONU. (R,-W, setbycreate) (mandatory) (2-bytes)

		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
		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
		This attribute points to the instance of the traffic descriptor ME that contains the downstream
		traffic parameters for this GEM port network CTP. This attribute is used when the traffic
		management option attribute in the ONU-G ME is 1 (rate controlled), specifying the PIR/PBS to
		which the downstream traffic is shaped. This attribute is also used when the traffic management
		option attribute in the ONU-G ME is 2 (priority and rate controlled), specifying the
		CIR/CBS/PIR/PBS to which the downstream traffic is policed. (R,-W, setbycreate) (optional)
		(2-bytes)

		See also Appendix II.

	Encryption Key Ring
		This attribute is defined in ITU-T G.987 systems only. It specifies whether the associated GEM
		port is encrypted, and if so, which key ring it uses. (R, W, setbycreate) (optional) (1 byte)

		0	(default) No encryption. The downstream key index is ignored, and upstream traffic is
		transmitted with key index 0.

		1	Unicast payload encryption in both directions. Keys are generated by the ONU and transmitted
		to the OLT via the PLOAM channel.

		2	Broadcast (multicast) encryption. Keys are generated by the OLT and distributed via the OMCI.

		3	Unicast encryption, downstream only. Keys are generated by the ONU and transmitted to the OLT
		via the PLOAM channel.

		Other values are reserved.

type GemPortNetworkCtpPerformanceMonitoringHistoryData ¶

type GemPortNetworkCtpPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

GemPortNetworkCtpPerformanceMonitoringHistoryData (Class ID: #341 / 0x0155)

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
		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
		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
		This attribute counts GEM frames transmitted on the monitored GEM port. (R) (mandatory)
		(4-bytes)

	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
		This attribute counts user payload bytes received on the monitored GEM port. (R) (mandatory)
		(8-bytes)

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

	Encryption Key Errors
		NOTE 3 - GEM PM ignores idle GEM frames.

		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.

		This attribute is defined in ITU-T G.987 systems only. It counts GEM frames with erroneous
		encryption key indexes. If the GEM port is not encrypted, this attribute counts any frame with a
		key index not equal to 0. If the GEM port is encrypted, this attribute counts any frame whose
		key index specifies a key that is not known to the ONU. (R) (optional) (4-bytes)

type GeneralPurposeBuffer ¶

type GeneralPurposeBuffer struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

GeneralPurposeBuffer (Class ID: #308 / 0x0134)

This ME is created by the OLT when needed to store the results of an operation, such as a test
command, that needs to return a block of data of indeterminate size. The buffer is retrieved
with get next operations, since its size is not known a priori. An instance of this ME is
created and deleted by the OLT, and typically made known to an ONU ME or to an action through a
pointer.

The ME is defined as generically as possible, such that it can be used for other applications
that may not initially be apparent, such as logging. The format of its content is specific to
each application, and is documented there.

The general purpose buffer is neither captured in an MIB upload, nor retained in a non-volatile
ONU memory.

Relationships
	Through a pointer, the OLT may associate a general purpose buffer with an ME or an operation
	that has a need to create large or indeterminate blocks of data for subsequent upload.

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

	Maximum Size
		The ONU determines the actual size of the buffer table in the process of capturing the data
		directed to it. The maximum size attribute permits the OLT to restrict the maximum size of the
		buffer table. The value 0 indicates that the OLT imposes no limit on the size; it is recognized
		that ONU implementations will impose their own limits. The ONU will not create a buffer table
		larger than the value of this attribute. If the ONU cannot allocate enough memory to accommodate
		this size, it should deny the ME create action or a write operation that attempts to expand an
		existing ME. (R,-W, setbycreate) (optional) (4-bytes)

	Buffer Table
		This attribute is an octet string that contains the result of some operation performed on the
		ONU. The exact content depends on the operation, and is documented with the definition of each
		operation. (R) (mandatory) (N bytes)

type IConstraint ¶

type IConstraint interface {
	// valid returns true if a value matches the defined constraint
	Valid(value interface{}) bool
}

IConstraint is an interface for attribute value comparison

func NewConstraint(input string, attrType AttributeType) IConstraint

func NewIntegerConstraint(input string) IConstraint

<input>
  where <input> is one of the following:
    <value>                   a single numerical value
    <min-value>..<max-value>  a range of values with the min/max specified

func NewIntegerConstraintList(input string) []IConstraint

<values>
  where <values> is a pattern of one or more numbers as indicated below.
    <value>                   a single numerical value
    <min-value>..<max-value>  a range of values with the min/max specified

  Multiple value fields can be specified and are separated by commas
  such as:      2, 4..16, 255

func NewOctetsConstraint(input string) IConstraint

[len(<values>)][,regex(<allowed-pattern>)][,fill(<value>)]
  where:
    len()    is a function that checks a string/octets for a specific length and the
             result should match one of the <values>.  For tables, this is the length
             of a row entry.  If not specified, the octet/string/table row can be any
             length.

    regex()  is an optional regular expression that will check the values of
             the collection of octets. Any pattern is provided

    fill())  is an optional fill value to add to the end of a supplied string so that
             the entire string length is set to the maximum allowed. Typically this is
             either an ASCII space (0x20) or a null (0x00).

type IManagedEntity ¶

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
	GetAlarmMap() AlarmMap

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

type IOctetStream ¶

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 IRelaxedDecodeError ¶

type IRelaxedDecodeError interface {
	// Error interface, so if relaxed decode is not supported, this behaves as
	// a normal error
	Error() string
	GetError() error

	// GetContents returns the octet payload specific to the error if it can be
	// determined. Derived relaxed decode errors may provide more specific control
	// and information
	GetContents() []byte
}

IRelaxedDecodeError provides a base interface that can be used to derive other decode specific errors that can be relaxed at the application's discretion

type Ieee8021PMapperServiceProfile ¶

type Ieee8021PMapperServiceProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

Ieee8021PMapperServiceProfile (Class ID: #130 / 0x0082)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory)
		(2-bytes)

	Tp Pointer
		This attribute points to an instance of the associated TP.

		If the optional TP type attribute is not supported, the TP pointer indicates bridging mapping
		with the value 0xFFFF; the TP pointer may also point to a PPTP Ethernet UNI.

		The TP type value 0 also indicates bridging mapping, and the TP pointer should be set to 0xFFFF.

		In all other cases, the TP type is determined by the TP type attribute.

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

		Each of the following eight attributes points to the GEM IW TP associated with the stated P-bit
		value. The null pointer 0xFFFF specifies that frames with the associated priority are to be
		discarded.

	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
		This attribute specifies how the ONU should handle untagged Ethernet frames received across the
		associated interface. Although it does not alter the frame in any way, the ONU routes the frame
		as if it were tagged with P bits (PCP field) according to the following code points.

		0	Derive implied PCP field from DSCP bits of received frame

		1	Set implied PCP field to a fixed value specified by the default P-bit assumption attribute

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

		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.

		DSCP to P-bit mapping: This attribute is valid when the unmarked frame option attribute is set
		to 0. The DSCP to P-bit attribute can be considered a bit string sequence of 64 3-bit groupings.
		The 64 sequence entries represent the possible values of the 6-bit DSCP field. Each 3-bit
		grouping specifies the P-bit value to which the associated DSCP value should be mapped. The
		unmarked frame is then directed to the GEM IW TP indicated by the interwork TP pointer mappings.
		(R,-W) (mandatory) (24-bytes)

	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
		This attribute identifies the type of TP associated with the mapper.

		0	Mapper used for bridging-mapping

		1	Mapper directly associated with a PPTP Ethernet UNI

		2	Mapper directly associated with an IP host config data or IPv6 host config data ME

		3	Mapper directly associated with an Ethernet flow termination point

		4	Mapper directly associated with a PPTP xDSL UNI

		5	Reserved

		6	Mapper directly associated with a PPTP MoCA UNI

		7	Mapper directly associated with a virtual Ethernet interface point

		8	Mapper directly associated with an IW VCC termination point

		9	Mapper directly associated with an EFM bonding group

		(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 / 0x000e)

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
		This attribute uniquely identifies each instance of this ME. (R,-setbycreate) (mandatory)
		(2-bytes)

	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
		This attribute points to the VP network CTP associated with this IW VCC TP. (R,-W, setbycreate)
		(mandatory) (2-bytes)

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

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

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

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

	Aal Loopback Configuration
		This attribute sets the ATM loopback configuration. All code points are retained for backward
		compatibility, but some are not expected to be needed in current and future applications.

		0	No loopback

		1	Loopback 1, loopback of downstream traffic before FEC of AAL1

		2	Loopback 2, loopback of downstream traffic after FEC of AAL1

		3	Loopback after AAL, loopback of downstream traffic after any AAL. Loopback after AAL is
		depicted in Figure 9.13.4-1.

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

	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
		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 / 0x0086)

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
		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
		This attribute is a bit map that enables or disables IP-related options. The value 1 enables the
		option while 0 disables it. The default value of this attribute is 0.

		0x01	Enable DHCP

		0x02	Respond to pings

		0x04	Respond to traceroute messages

		0x08	Enable IP stack

		0x10..0x80	Reserved

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

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

	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)

		Several attributes of this ME may be paired together into two categories, manual settings and
		current values.

		While the IP stack is disabled, there is no IP connectivity to the external world from this ME
		instance.

		While DHCP is disabled, the current values are always the same as the manual settings. While
		DHCP is enabled, the current values are those assigned by DHCP, or undefined (0) if DHCP has
		never assigned values.

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

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

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

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

	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 of the IP host service. (R) (optional) (4-bytes)

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

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

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

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

	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
		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
		This attribute is a pointer to a large string ME whose content specifies one or more DHCP relay
		agent options. (R, W) (optional) (2-bytes)

		The contents of the large string are parsed by the ONU and converted into text strings. Variable
		substitution is based on defined three-character groups, each of which begins with the '%'
		character. The string '%%' is an escape mechanism whose output is a single '%' character. When
		the ONU cannot perform variable substitution on a substring of the large string, it generates
		the specified option as an exact quotation of the provisioned substring value.

		Provisioning of the large string is separate from the operation of setting the pointer in this
		attribute. It is the responsibility of the OLT to ensure that the large string contents are
		correct and meaningful.

		Three-character variable definitions are as follows. The first variable in the large string must
		specify one of the option types. Both options for a given IP version may be present if desired,
		each introduced by its option identifier. Terminology is taken from clause 3.9.3 of [b-BBF
		TR-101].

		%01, %18 Specifies that the following string is for option 82 sub-option 1, agent circuit-ID
		(IPv4) or option 18, interface-ID (IPv6). The equivalence permits the same large string to be
		used in both IP environments.

		%02, %37 Specifies that the following string is for option 82 sub-option 2, relay agent remote-
		ID (IPv4) or option 37, relay agent remote-ID (IPv6). The equivalence permits the same large
		string to be used in both IP environments.

		%SL	In [b-BBF TR-101], this is called a slot. In an ONU, this variable refers to a shelf. It
		would be meaningful if the ONU has multiple shelves internally or is daisy-chained to multiple
		equipment modules. The range of this variable is "0".. "99"

		%SU	In TR-101, this is called a sub-slot. In fact, it represents a cardholder. The range of this
		variable is "0".. "99"

		%PO	UNI port number. The range of this variable is "0".. "999"

		%AE	ATM or Ethernet. This variable can take on the values "atm" or "eth".

		%SV	S-VID for Ethernet UNI, or ATM virtual path identifier (VPI) for ATM UNI, as it exists on
		the DHCP request received upstream across the UNI. Range "0".. "4096" for S-VID; range "0"..
		"255" for VPI. The value "4096" indicates no S-VID tag.

		%CV	C-VID (Q-VID) for Ethernet UNI, or ATM virtual circuit identifier (VCI) for ATM UNI, as it
		exists on the DHCP request received upstream across the UNI. Range "0".. "4096" for C-VID; range
		"0".."65535" for VCI. The value "4096" indicates no C-VID tag.

		Spaces in the provisioned string are significant.

		Example: if the large string were provisioned with the value

		%01%SL/%SU/%PO:%AE/%SV.%CV<null>,

		then the ONU would generate the following DHCP option 82 agent circuit-ID string for an Ethernet
		UNI that sent a DHCP request with no S tag and C tag = 3210 on shelf 2, slot 3, port 4.

		2/3/4:eth/4096.3210

		With the same provisioning, the ONU would generate the following DHCP option 82 agent circuit-ID
		string for an ATM UNI that sent a DHCP request on VPI = 123 and VCI = 4567 on shelf 2, slot 3,
		port 4.

		2/3/4:atm/123.4567

type IpHostPerformanceMonitoringHistoryData ¶

type IpHostPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

IpHostPerformanceMonitoringHistoryData (Class ID: #135 / 0x0087)

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
		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
		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
		This attribute counts ICMP errors received. (R) (mandatory) (4-bytes)

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

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

	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
		This attribute is incremented whenever the ONU encounters an out of memory condition in the IP
		stack. (R) (optional) (2 bytes)

	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 LargeString ¶

type LargeString struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

LargeString (Class ID: #157 / 0x009d)

The large string ME holds character strings longer than 25-bytes, up to 375-bytes. It is
maintained in up to 15 parts, each part containing 25-bytes. If the final part contains fewer
than 25-bytes, it is terminated by at least one null byte. For example:

Or

Instances of this ME are created and deleted by the OLT. Under some circumstances, they may also
be created by the ONU. To use this ME, the OLT or ONU instantiates the large string ME and then
points to the created ME from other ME instances. Systems that maintain the large string should
ensure that the large string ME is not deleted while it is still linked.

Relationships
	An instance of this ME may be cited by any ME that requires a text string longer than 25-bytes.

Attributes
	Managed Entity Id
		This attribute uniquely identifies each instance of this ME. The value 0xFFFF is reserved. When
		the large string is to be used as an IPv6 address, the value 0 is also reserved. The OLT should
		create large string MEs starting at 1 (or 0), and numbering upwards. The ONU should create large
		string MEs starting at 65534 (0xFFFE) and numbering downwards. (R,-setbycreate) (mandatory)
		(2-bytes)

	Number Of Parts
		This attribute specifies the number of non-empty parts that form the large string. This
		attribute defaults to 0 to indicate no large string content is defined.(R,-W) (mandatory)
		(1-byte)

		Fifteen additional attributes are defined in the following; they are identical. The large string
		is simply divided into as many parts as necessary, starting at part 1. If the end of the string
		does not lie at a part boundary, it is marked with a null byte.

	Part 1
		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) (mandatory) (25-bytes * 15 attributes)

	Part 2
		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) (mandatory) (25-bytes * 15 attributes)

	Part 3
		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) (mandatory) (25-bytes * 15 attributes)

	Part 4
		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) (mandatory) (25-bytes * 15 attributes)

	Part 5
		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) (mandatory) (25-bytes * 15 attributes)

	Part 6
		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) (mandatory) (25-bytes * 15 attributes)

	Part 7
		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) (mandatory) (25-bytes * 15 attributes)

	Part 8
		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) (mandatory) (25-bytes * 15 attributes)

	Part 9
		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) (mandatory) (25-bytes * 15 attributes)

	Part 10
		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) (mandatory) (25-bytes * 15 attributes)

	Part 11
		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) (mandatory) (25-bytes * 15 attributes)

	Part 12
		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) (mandatory) (25-bytes * 15 attributes)

	Part 13
		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) (mandatory) (25-bytes * 15 attributes)

	Part 14
		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) (mandatory) (25-bytes * 15 attributes)

	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) (mandatory) (25-bytes * 15 attributes)

type MacBridgeConfigurationData ¶

type MacBridgeConfigurationData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgeConfigurationData (Class ID: #46 / 0x002e)

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
		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
		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
		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
		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
		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
		This attribute records the number of ports linked to this bridge. (R) (mandatory) (1-byte)

	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.

		This attribute is the hello time received from the designated root, the interval (in 256ths of a
		second) between HELLO packets. Its range is 0x0100 to 0x0A00 (1..10-s). (R) (optional) (2-bytes)

	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 / 0x0033)

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
		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
		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
		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 ¶

type MacBridgePortBridgeTableData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePortBridgeTableData (Class ID: #50 / 0x0032)

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
		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
		This attribute lists known MAC DAs, whether they are learned or statically assigned, whether
		packets that have them as DAs are filtered or forwarded, and their ages. Each entry contains:

		-	Information (2-bytes);

		-	MAC address (6-bytes).

		The information bits are assigned as described as follows.

		Bit	Name	Setting

		1 (LSB)	Filter/forward	0: forward

		1: filter

		2	Reserved	0

		3	Dynamic/static	0: this entry is statically assigned

		1: this entry is dynamically learned

		4	Reserved	0

		16..5	Age	Age in seconds (1..4095)

		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 / 0x002f)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory)
		(2-bytes)

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

	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
		This attribute identifies the type of TP associated with this MAC bridge port. Valid values are
		as follows.

		1	Physical path termination point Ethernet UNI

		2	Interworking virtual circuit connection (VCC) termination point

		3	IEEE 802.1p mapper service profile

		4	IP host config data or IPv6 host config data

		5	GEM interworking termination point

		6	Multicast GEM interworking termination point

		7	Physical path termination point xDSL UNI part 1

		8	Physical path termination point VDSL UNI

		9	Ethernet flow termination point

		10	Reserved

		11	Virtual Ethernet interface point

		12	Physical path termination point MoCA UNI

		13	Ethernet in the first mile (EFM) bonding group

		(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.

		This attribute points to the TP associated with this MAC bridge port. The TP type attribute
		indicates the type of the TP; this attribute contains its instance identifier (ME ID). (R,-W,
		setbycreate) (mandatory) (2-bytes)

	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
		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
		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
		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
		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
		If the TP associated with this port has a MAC address, this attribute specifies it. (R)
		(optional) (6-bytes)

	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
		This attribute points to a traffic descriptor that limits the traffic rate entering the MAC
		bridge. (R,-W) (optional) (2-byte)

	Mac Learning Depth
		This attribute specifies the maximum number of MAC addresses to be learned by this MAC bridge
		port. The default value 0 specifies that there is no administratively imposed limit. (R,-W,
		setbycreate) (optional) (1-byte)

		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.

	Lasp Id Pointer
		This attribute points to an instance of the LASP ME. (R,W, setbycreate) (optional) (2 bytes)

type MacBridgePortDesignationData ¶

type MacBridgePortDesignationData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePortDesignationData (Class ID: #48 / 0x0030)

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
		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
		This attribute contains the designated root, designated cost, designated bridge and designated
		port, which are some of the outputs of the read port parameters operation defined in clause
		14.8.2.1 of [IEEE-802.1D]:

		o	identifier of the designated bridge for the port's segment (8-bytes);

		o	bridge identifier of the root transmitted by the designated bridge for the segment (8-bytes);

		o	port number of the designated port on the designated bridge considered to be part of this
		port's segment (4-bytes);

		o	path cost contribution of the designated port to this port's segment (4-bytes).

		Upon ME instantiation, the ONU sets this attribute to 0. (R) (mandatory) (24-bytes)

	Port State
		This attribute provides status information on the port. Valid values include the following.

		0	Disabled

		1	Listening

		2	Learning

		3	Forwarding

		4	Blocking

		5	Linkdown

		6	(R)Stp_off

		in accordance with [IEEE 802.1D]. (R) (mandatory) (1-byte)

		NOTE - The value linkdown is introduced to denote the port status when the Ethernet link state
		is down. This value distinguishes the case where Ethernet is physically down from the case where
		Ethernet is administratively locked, the latter being denoted by disabled. Be aware that this
		terminology violates the ITUT convention that disabled is an operational state, not
		administrative.

		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 / 0x004f)

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
		The following 10 attributes have similar definitions. Each permits the OLT to specify whether
		MAC DAs or Ethertypes of the named type are forwarded (0) or filtered (1). In each case, the
		initial value of the attribute is 0.

		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
		(R,-W) (mandatory) (1-byte)

	Ipv6 Multicast Filtering
		(R,-W) (mandatory) (1-byte)

	Ipv4 Broadcast Filtering
		(R,-W) (mandatory) (1-byte)

	Rarp Filtering
		(R,-W) (mandatory) (1-byte)

	Ipx Filtering
			(R,-W) (mandatory) (1-byte)

	Netbeui Filtering
		(R,-W) (mandatory) (1-byte)

	Appletalk Filtering
		(R,-W) (mandatory) (1-byte)

	Bridge Management Information Filtering
		(R,-W) (mandatory) (1-byte)

		Note that some destination MAC addresses should never be forwarded, considering the following
		rules of [IEEE 802.1D].

		1	Addresses from 01.80.C2.00.00.00 to 01.80.C2.00.00.0F are reserved.

		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
		(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 ¶

type MacBridgePortFilterTableData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePortFilterTableData (Class ID: #49 / 0x0031)

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
		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
		This attribute lists MAC addresses associated with the bridge port, each with an allow/disallow
		forwarding indicator for traffic flowing out of the bridge port. Additionally, the forwarding
		action may be based on a MAC source or DA. In this way, upstream traffic is filtered on ANI-side
		bridge ports, and downstream traffic is filtered on UNI-side bridge ports. The setting of an
		entry with a forward action implies that all other addresses are filtered. Conversely, the
		setting of an entry with a filter action implies that all other addresses are forwarded. The
		behaviour is unspecified if forward and filter actions are mixed.

		Each entry contains:

		-	the entry number, an index into this attribute list (1-byte);

		-	filter byte (1-byte);

		-	MAC address (6-bytes).

		The bits of the filter byte are assigned as follows.

		Bit	Name	Setting

		1 (LSB)	Filter/forward	0: forward

		1: filter

		2		0: MAC DAs

		1: MAC source addresses

		3..6	Reserved	0

		7..8	Add/remove	10: Clear entire table (set operation)

		00: Remove this entry (set operation)

		01: Add this entry

		Upon ME instantiation, the ONU sets this attribute to an empty 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 / 0x015c)

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
		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)

		The following nine attributes have similar definitions. Each permits the OLT to specify ICMPv6
		as the next header in the IPv6 header and various types in the ICMPv6 header, and whether
		traffic of the specified type is forwarded, discarded or snooped, in upstream and downstream
		directions separately. The bits of each attribute are assigned as follows.

		The initial value of each attribute is given in the last column of the table.

	Icmpv6 Error Messages Processing
		(R,-W) (mandatory) (1-byte)

	Icmpv6 Informational Messages Processing
		(R,-W) (mandatory) (1-byte)

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

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

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

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

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

	Multicast Listener Query Processing
		(R,-W) (mandatory) (1-byte)

		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
		(R,-W) (mandatory) (1-byte)

type MacBridgePortPerformanceMonitoringHistoryData ¶

type MacBridgePortPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MacBridgePortPerformanceMonitoringHistoryData (Class ID: #52 / 0x0034)

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
		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
		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
		This attribute counts frames transmitted successfully on this port. (R) (mandatory) (4-bytes)

	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
		This attribute counts frames received on this port. (R) (mandatory) (4-bytes)

	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 / 0x002d)

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
		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
		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
		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
		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
		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
		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
		This attribute specifies how often (in 256ths of a second) the bridge advertises its presence
		via hello packets, while acting as a root or attempting to become a root. The range is 0x0100 to
		0x0A00 (1..10-s). (R,-W, setbycreate) (mandatory) (2-bytes)

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

	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
		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
		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
		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 ¶

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) GetAlarmMap() AlarmMap

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) GetClassSupport() ClassSupport

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) SetClassID(classID ClassID)

func (entity *ManagedEntity) SetEntityID(eid uint16) error

func (entity *ManagedEntity) SetRequestedAttributeMask(mask uint16)

func (entity *ManagedEntity) String() string

type ManagedEntityDefinition ¶

type ManagedEntityDefinition struct {
	Name                 string
	ClassID              ClassID
	MessageTypes         mapset.Set // Mandatory
	AllowedAttributeMask uint16
	AttributeDefinitions AttributeDefinitionMap
	Access               ClassAccess
	Support              ClassSupport
	Alarms               AlarmMap // AlarmBit -> AlarmName
}

ManagedEntityDefinition defines a Manage Entity

func (bme ManagedEntityDefinition) DecodeAttributes(mask uint16, data []byte, p gopacket.PacketBuilder, msgType byte) (AttributeValueMap, error)

func (bme ManagedEntityDefinition) GetAlarmMap() AlarmMap

func (bme ManagedEntityDefinition) GetAllowedAttributeMask() uint16

func (bme ManagedEntityDefinition) GetAttributeDefinitions() AttributeDefinitionMap

func (bme ManagedEntityDefinition) GetClassID() ClassID

func (bme ManagedEntityDefinition) GetClassSupport() ClassSupport

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) SetClassID(classID ClassID)

func (bme *ManagedEntityDefinition) String() string

type ManagedEntityInfo ¶

type ManagedEntityInfo struct {
	New func(params ...ParamData) (*ManagedEntity, error)
}

ManagedEntityInfo provides ManagedEntity information

type ManagedEntityMe ¶

type ManagedEntityMe struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

ManagedEntityMe (Class ID: #288 / 0x0120)

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
		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
		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
		This table contains pointers to the attribute MEs that describe each of this ME's attributes.
		(R) (mandatory) (2 * X bytes, where X is the number of entries in the table.)

		NOTE - The ME ID attribute is not included in the list, since the type of this attribute is
		fixed.

	Access
		This attribute represents who creates this ME. The following code points are defined.

		1	Created by the ONU

		2	Created by the OLT

		3	Created by both the ONU and OLT

		(R) (mandatory) (1-byte)

	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
		This attribute lists the AVCs that are supported. (R) (mandatory) (Z bytes, where Z is the
		number of entries in the table.)

	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
		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
		This attribute represents the support capability of this ME in the ONU's implementation. This
		attribute does not declare whether the OMCI implementation complies with the Recommendations,
		but whether it complies with the OMCI declaration itself. The following code points are defined.

		1	Supported (supported as defined in this object)

		2	Unsupported (OMCI returns error code if accessed)

		3	Partially supported (some aspects of ME supported)

		4	Ignored (OMCI supported, but underlying function is not)

		(R) (mandatory) (1-byte)

type MessageTruncatedError ¶

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 / 0x009b)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory)
		(2-bytes)

	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
		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
		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
		This attribute defines the message format. Valid values are as follows.

		0	Text long

		1	Text short

		2	Binary

		The default value is recommended to be 0. (R,-W, setbycreate) (mandatory) (1-byte)

	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
		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
		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
		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
		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
		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 MgcConfigPortal ¶

type MgcConfigPortal struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MgcConfigPortal (Class ID: #154 / 0x009a)

The MGC config portal ME provides a way for the OLT to discover the configuration text delivered
to an ONU by a non-OMCI ITU-T H.248 VoIP configuration method. Text retrieved from this ME is
not required to be understood by the OLT or EMS, but it may be useful for human or vendor-
specific analysis tools. See also the SIP config portal ME.

An instance of this ME may be created by an ONU that supports non-OMCI ITUT-H.248 configuration.
It is not reported during an MIB upload.

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

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

	Configuration Text Table
		This attribute is used to pass a textual representation of the VoIP configuration back to the
		OLT. The contents are vendor-specific. The get, get next sequence must be used with this
		attribute since its size is unspecified. Upon ME instantiation, the ONU sets this attribute to
		0. (R) (mandatory) (x bytes)

type MgcPerformanceMonitoringHistoryData ¶

type MgcPerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MgcPerformanceMonitoringHistoryData (Class ID: #156 / 0x009c)

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
		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
		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
		This attribute counts the number of received Megaco messages on this association, as defined by
		[ITUT H.341]. (R) (mandatory) (4-bytes)

	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
		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
		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
		This attribute counts the total number of errors detected on this association, as defined by
		[ITU-T H.341]. This includes:

		o	syntax errors detected in a given received message;

		o	outgoing transactions that failed for protocol reasons.

		(R) (mandatory) (4-bytes)

	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
		This attribute reports the last event detected on this association. This includes events such as
		the link failing or being set up. Under normal circumstances, a get action on this attribute
		would return 0 to indicate no abnormal activity. This field is an enumeration as follows.

		0	No event - No event has yet been detected during this PM interval.

		1	Link up - The transport link underpinning the association came up.

		2	Link down - The transport link underpinning the association went down.

		3	Persistent error - A persistent error was detected on the link (such as the socket/TCP
		connection to the remote node could not be set up).

		4	Local shutdown - The association was brought down intentionally by the local application.

		5	Failover down - The association was brought down as part of failover processing.

		255	Other event - The latest event does not match any in the list.

		(R) (mandatory) (1-byte)

	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
		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 / 0x00a3)

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
		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
		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 PM refers to upstream traffic received on the UNI; outgoing PM refers to downstream
		traffic transmitted on the UNI.

	Incoming Unicast Packets
		(R) (optional) (4-bytes)

	Incoming Discarded Packets
		(R) (optional) (4-bytes)

	Incoming Errored Packets
		(R) (optional) (4-bytes)

	Incoming Unknown Packets
		(R) (optional) (4-bytes)

	Incoming Multicast Packets
		(R) (optional) (4-bytes)

	Incoming Broadcast Packets
		(R) (optional) (4-bytes)

	Incoming Octets
		(R) (optional) (4-bytes)

	Outgoing Unicast Packets
		(R) (optional) (4-bytes)

	Outgoing Discarded Packets
		(R) (optional) (4-bytes)

	Outgoing Errored Packets
		(R) (optional) (4-bytes)

	Outgoing Unknown Packets
		(R) (optional) (4-bytes)

	Outgoing Multicast Packets
		(R) (optional) (4-bytes)

	Outgoing Broadcast Packets
		(R) (optional) (4-bytes)

	Outgoing Octets
		(R) (optional) (4-bytes)

type MocaInterfacePerformanceMonitoringHistoryData ¶

type MocaInterfacePerformanceMonitoringHistoryData struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MocaInterfacePerformanceMonitoringHistoryData (Class ID: #164 / 0x00a4)

This ME collects PM data for an MoCA interface. Instances of this ME are created and deleted by
the OLT.

NOTE - The structure of this ME is an exception to the normal definition of PM MEs and normal PM
behaviour (clause I.4). It should not be used as a guide for the definition of future MEs. Among
other exceptions, this ME contains only current values, which are retrievable by get and get
next operations; no history is retained.

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

Attributes
	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
		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)

	Phy T X Broadcast Rate
		PHY Tx broadcast rate: This attribute indicates the MoCA PHY broadcast transmit rate from the
		ONU MoCA interface to all the nodes in bits per second. (R) (optional) (4-bytes)

	Node Table
		Rx packet: Number of packets received from the node. (4-bytes)

		Rx errored and missed: Number of errored and missed packets received from the node. The sum of
		this field across all entries in the node table contributes to the Rx errored and missed TCA.
		This field is reset to 0 on 15-min boundaries. (4-bytes)

		Rx errored: Number of errored packets received from the node. The sum of this field across all
		entries in the node table contributes to the Rx errored TCA. This field is reset to 0 on 15-min
		boundaries. (optional) (4-bytes)

		(R) (mandatory) (37 * N bytes, where N is the number of nodes in the node table)

		This attribute lists current nodes in the node table. The table contains MAC addresses and
		statistics for those nodes. These table attributes are further described in the following. Space
		for nonsupported optional fields must be allocated in table records, and filled with zero bytes.

		MAC address: A unique identifier of a node within the table. (6-bytes)

		PHY Tx rate: MoCA PHY unicast transmit rate from the ONU MoCA interface to the node identified
		by the MAC address, in bits per second. (4-bytes)

		Tx power control reduction: The reduction in transmitter level due to power control, in
		decibels. Valid values range from 0 (full power) to 60. (1-byte)

		PHY Rx rate: MoCA PHY unicast receive rate to the ONU MoCA interface from the node identified by
		the MAC address, in bits per second. (optional) (4-bytes)

		Rx power level: The power level received at the ONU MoCA interface from the node identified by
		the MAC address, in decibel-milliwatts, represented as a 2s complement integer. Valid values
		range from +10 (0x0A) to -80 (0xB0). (1-byte)

		PHY Rx broadcast rate: MoCA PHY broadcast receive rate to the ONU MoCA interface from the node
		identified by MAC address, in bits per second. (optional) (4-bytes)

		Rx broadcast power level: The power level received at the ONU MoCA interface from the node
		identified by the MAC address, in decibel-milliwatts, represented as a 2s complement integer.
		Valid values range from +10-(0x0A) to -80 (0xB0). (1-byte)

		Tx packet: Number of packets transmitted to the node. (4-bytes)

type MplsPseudowireTerminationPoint ¶

type MplsPseudowireTerminationPoint struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MplsPseudowireTerminationPoint (Class ID: #333 / 0x014d)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate)-(mandatory) (2
		bytes)

	Tp Type
		This attribute specifies the type of ANI-side TP associated with this-ME.

		1	Ethernet flow termination point

		2	GEM IW TP

		3	TCP/UDP config data

		4	MPLS pseudowire termination point

		NOTE - If this instance of the MPLS PW TP is pointed to by another instance of the MPLS PW TP
		(i.e., whose TP type-= 4), this instance represents a tunnelled MPLS flow, and the following
		attributes are not meaningful: MPLS PW direction; MPLS PW uplink label; MPLS PW downlink label;
		and MPLS PW TC. These attributes should be set to the proper number of 0x00 bytes by the OLT and
		ignored by the ONU.

		(R, W, setbycreate) (mandatory) (1 byte)

	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
		This attribute specifies the MPLS label stacking situation.

		0	Single MPLS labelled

		1	Double MPLS labelled

		(R, W, setbycreate) (mandatory) (1 byte)

	Mpls Pw Direction
		This attribute specifies the inner MPLS direction.

		0	Upstream only

		1	Downstream only

		2	Bidirectional

		(R, W, setbycreate) (mandatory) (1 byte)

	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
		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].

		This attribute specifies the inner MPLS TC value in the upstream direction. The attribute is not
		meaningful for unidirectional downstream PWs. (R, W, setbycreate) (mandatory) (1 byte)

	Mpls Tunnel Direction
		This attribute specifies the direction of the (outer) MPLS tunnel.

		0	Upstream only

		1	Downstream only

		2	Bidirectional

		(R, W, setbycreate) (mandatory for double-labelled case) (1 byte)

	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
		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
		This attribute specifies the TC value of the upstream MPLS tunnel. If the MPLS tunnel is
		downstream only, this attribute should be set to 0. (R, W, setbycreate) (mandatory for double
		MPLS labelled case) (1 byte)

		NOTE 2 - The TC field was previously known as EXP. Refer to [bIETF-RFC-5462].

	Pseudowire Type
		This attribute specifies the emulated service to be carried over this PW. The values are from
		[IETF RFC 4446].

		2	ATM AAL5 SDU VCC transport

		3	ATM transparent cell transport

		5	Ethernet

		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

		All other values are reserved.

		(R, W, setbycreate) (mandatory) (2 bytes)

	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
		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
		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
	ExtendedOffset        MsgType = 0x80
)

func (mt MsgType) String() string

type MulticastGemInterworkingTerminationPoint ¶

type MulticastGemInterworkingTerminationPoint struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MulticastGemInterworkingTerminationPoint (Class ID: #281 / 0x0119)

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
		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
		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
		3	Reserved

		5	IEEE 802.1p mapper

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

		This attribute identifies the type of non-GEM function that is being interworked. The option can
		be as follows.

		0	This value is a "no-op" or "don't care". It should be used when the multicast GEM IW TP is
		associated with several functions of different types. It can optionally be used in all cases,
		since the necessary information is available elsewhere. The previous code points are retained
		for backward compatibility:

		1	MAC bridged LAN

	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
		This attribute is set to 0 and not used. (R,-W, setbycreate) (mandatory) (2-bytes)

	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
		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
		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
		This attribute is set to 0 and not used. (R,-W, setbycreate) (mandatory) (1-byte)

	Ipv4 Multicast Address Table
		This attribute maps IP multicast addresses to PON layer addresses. Each entry contains the
		following.

		GEM port-ID		2-bytes

		Secondary key		2-bytes

		IP multicast DA range start		4-bytes

		IP multicast DA range stop		4-bytes

		The first four bytes of each entry are treated as a key into the list. The secondary key allows
		the table to contain more than a single range for a given GEM port.

		A set action to a particular value overwrites any existing entry with the same first four bytes.
		If the last eight bytes of a set command are all zero, that entry is deleted from the list, as
		the IP address 0.0.0.0 is not valid.

		(R,-W) (mandatory) (12N bytes, where N is the number of entries in the list.)

	Ipv6 Multicast Address Table
		This attribute maps IPv6 multicast DAs to PON layer addresses. Each entry contains:

		GEM port-ID	2-bytes

		Secondary key	2-bytes

		Least significant bytes,

		IP multicast DA range start	4-bytes

		Least significant bytes,

		IP multicast DA range stop	4-bytes

		Most significant bytes, IP DA	12-bytes

		The first four bytes of each entry are treated as a key into the list. The secondary key allows
		the table to contain more than a single range for a given GEM port.

		A set action to a particular value overwrites any existing entry with the same first four bytes.
		If the last 20 bytes of a set command are all zero, that entry is deleted from the list.

		(R,-W) (optional) (24N bytes, where N is the number of entries in the list.)

type MulticastOperationsProfile ¶

type MulticastOperationsProfile struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MulticastOperationsProfile (Class ID: #309 / 0x0135)

This ME expresses multicast policy. A multi-dwelling unit ONU may have several such policies,
which are linked to subscribers as required. Some of the attributes configure IGMP snooping and
proxy parameters if the defaults do not suffice, as described in [IETF-RFC-2236], [IETF-RFC
3376], [IETF RFC 3810] and [IETF RFC 5519]. 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 the multicast subscriber
	config info ME.

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

	Igmp Version
		This attribute specifies the version of IGMP to be supported. Support of a given version implies
		compatible support of previous versions. If the ONU cannot support the version requested, it
		should deny an attempt to set the attribute. (R,W, set-by-create) (mandatory) (1 byte)

		1	IGMP version 1 (deprecated)

		2	IGMP version 2

		3	IGMP version 3

		16	MLD version 1

		17	MLD version 2

		Other values are reserved.

	Igmp Function
		This attribute enables an IGMP function. The value 0 specifies transparent IGMP snooping only.
		The value 1 specifies snooping with proxy reporting (SPR); the value 2 specifies IGMP proxy. The
		function must be consistent with the capabilities specified by the other IGMP configuration
		attributes. (R,W, setbycreate) (mandatory) (1-byte)

	Immediate Leave
		This Boolean attribute controls the immediate leave function. The value false disables immediate
		leave; true enables immediate leave. (R,W, setbycreate) (mandatory) (1-byte)

	Upstream Igmp Tci
		Under control of the upstream IGMP tag control attribute, the upstream IGMP TCI attribute
		defines a VLAN ID and P-bits to add to upstream IGMP messages. (R,-W, setbycreate) (optional)
		(2-bytes)

	Upstream Igmp Tag Control
		2	Replace the entire TCI (VLAN ID plus P bits) on upstream IGMP/MLD traffic. The new tag is
		specified by the upstream IGMP/MLD TCI attribute. If the received IGMP/MLD traffic is untagged,
		an add operation is performed.

		3	Replace only the VLAN ID on upstream IGMP/MLD traffic, retaining the original DEI and P bits.
		The new VLAN ID is specified by the VLAN ID field of the upstream IGMP TCI attribute. If the
		received IGMP/MLD traffic is untagged, an add operation is performed, with DEI and P bits also
		taken from the upstream IGMP TCI attribute.

		Other values are reserved.

		This attribute controls the upstream IGMP TCI attribute. If this attribute is non-zero, a
		possible extended VLAN tagging operation ME is ignored for upstream frames containing IGMP/MLD
		packets. (R,-W, setbycreate) (optional) (1-byte)

		Value	Meaning

		0	Pass upstream IGMP/MLD traffic transparently, neither adding, stripping nor modifying tags
		that may be present.

		1	Add a VLAN tag (including P bits) to upstream IGMP/MLD traffic. The tag is specified by the
		upstream IGMP TCI attribute.

	Upstream Igmp Rate
		This attribute limits the maximum rate of upstream IGMP traffic. Traffic in excess of this limit
		is silently discarded. The attribute value is specified in messages/second. The recommended
		default value 0 imposes no rate limit on this traffic. (R,-W, setbycreate) (optional) (4-bytes)

	Dynamic Access Control List Table
		This attribute is a list that specifies one or more multicast group address ranges. Each row in
		the list comprises up to three row parts, where each row part is 24-bytes long. Each entry must
		include row part 0. The ONU may also support row parts 1-2, thus allowing the table to contain
		logical rows that exceed the 24-byte definition of row part 0.

	Static Access Control List Table
		This attribute is a list that specifies one or more multicast group address ranges. Groups
		defined in this list are multicast on the associated UNI(s) unconditionally, i.e., without the
		need for an IGMP join. The bandwidth of static multicast groups is not included in the current
		multicast bandwidth measurement maintained by the multicast subscriber monitor ME. If a join
		message is always expected, this table may be empty. Table entries have the same format as those
		in the dynamic access control list table. The preview fields are not meaningful. (R,-W)
		(mandatory) (each row part: 24 bytes)

	Lost Groups List Table
		This attribute is a list of groups from the dynamic access control list table for which there is
		an active join, but no downstream flow is present, possibly because of source failure, but also
		possibly because of misconfiguration somewhere upstream. Be aware of possible ambiguity between
		overlapping service providers and IPv4/IPv6 addresses. After a join, the ONU should wait a
		reasonable time for upstream processing before declaring a group to be lost. Each entry is a
		vector of the following components:

		-	VLAN ID, 0 if not used (2-bytes)

		-	Source IP address, 0.0.0.0 if not used. In IPv6, this field captures only the four least
		significant bytes. (4-bytes)

		-	Multicast destination IP address. In IPv6, this field captures only the four least significant
		bytes. (4-bytes)

		(R) (optional) (10N bytes)

	Robustness
		This attribute allows tuning for possible packet loss in the network. The recommended default
		value 0 causes the ONU to follow [IETF RFC 3376] to copy the robustness value from query
		messages originating further upstream. (R,-W, setbycreate) (optional) (1-byte)

	Querier Ip Address
		This attribute specifies the IP address to be used by a proxy querier. Although it is not a
		legitimate IP address, the recommended default value 0.0.0.0 is legal in this case (see [b-IETF
		RFC 4541]). (R,-W, setbycreate) (optional) (4-bytes)

	Query Interval
		This attribute specifies the interval between general queries in seconds. The value 0 specifies
		that the ONU uses its own default, which may or may not be the same as the recommended default
		of 125-s. (R,-W, set-by-create) (optional) (4-bytes)

	Query Max Response Time
		This attribute is the max response time added by the proxy into general query messages directed
		to UNIs. It is expressed in units of 0.1-s. The value 0 specifies that the ONU uses its own
		default, which may or may not be the same as the recommended default of 100 (10-s). (R,-W,
		setby-create) (optional) (4-bytes)

	Last Member Query Interval
		This attribute specifies the maximum response time inserted into group-specific queries sent to
		UNIs in response to group leave messages. It is also the repetition rate of [robustness]
		transmissions of the query. It is specified in units of 0.1-s, with a default of 10 (1-s).
		(R,-W) (optional) (4-bytes)

	Unauthorized Join Request Behaviour
		This Boolean attribute specifies the ONU's behaviour when it receives an IGMP join request for a
		group that is not authorized in the dynamic address control list table, or an IGMPv3 membership
		report for groups, none of which are authorized in the dynamic ACL. The default value false
		specifies that the ONU silently discard the IGMP request; the value true specifies that the ONU
		forwards the request upstream. The ONU does not attempt to honour the request for the
		unauthorized group(s) in either case. (R,-W) (optional) (1-byte)

	Downstream IGMP and multicast TCI
		This attribute controls the downstream tagging of both the IGMP/MLD and multicast frames. If the
		first byte of this attribute is non-zero, a possible extended VLAN tagging operation ME is
		ignored for downstream IGMP/MLD and multicast frames. (R,-W, set-by-create) (optional) (3-bytes)

		The first byte defines the control type:

		Value	Meaning

		0	Pass the downstream IGMP/MLD and multicast traffic transparently, neither stripping nor
		modifying tags that may be present.

		1	Strip the outer VLAN tag (including P bits) from the downstream IGMP/MLD and multicast
		traffic.

		2	Add a tag on to the downstream IGMP/MLD and multicast traffic. The new tag is specified by the
		second and third bytes of this attribute.

		3	Replace the tag on the downstream IGMP/MLD and multicast traffic. The new tag is specified by
		the second and third bytes of this attribute.

		4	Replace only the VLAN ID on the downstream IGMP/MLD and multicast traffic, retaining the
		original DEI and P bits. The new VLAN ID is specified by the VLAN ID field of the second and
		third bytes of this attribute.

		5	Add a tag on to the downstream IGMP/MLD and multicast traffic. The new tag is specified by the
		VID (UNI) field of the multicast service package table row of the multicast subscriber config
		info ME that is associated with this profile. If the VID (UNI) field is unspecified (0xFFFF) or
		specifies untagged traffic, the new tag is specified by the second and third bytes of this
		attribute.

		6	Replace the tag on the downstream IGMP/MLD and multicast traffic. The new tag is specified by
		the VID (UNI) field of the multicast service package table row of the multicast subscriber
		config info ME that is associated with this profile. If the VID (UNI) field specifies untagged
		traffic, the outer VLAN tag (including P bits) is stripped from the downstream IGMP/MLD and
		multicast traffic. If the value of the VID (UNI) is unspecified (0xFFFF), the new tag is
		specified by the second and third bytes of this attribute.

		7	Replace only the VID on the downstream IGMP/MLD and multicast traffic, retaining the original
		DEI and P bits. The new VLAN ID is specified by the VID (UNI) field of the multicast service
		package table row of the multicast subscriber config info ME that is associated with this
		profile. If the VID (UNI) field specifies untagged traffic, the outer VLAN tag (including P
		bits) is stripped from the downstream IGMP/MLD and multicast traffic. If the value of the VID
		(UNI) is unspecified (0xFFFF), the new tag is specified by the second and third bytes of this
		attribute.

		Other values are reserved.

		The second and third bytes define the TCI (VLAN ID and P bits) to be applied on the downstream
		IGMP/MLD and multicast streams in case the replace or add option is selected.

type MulticastSubscriberConfigInfo ¶

type MulticastSubscriberConfigInfo struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MulticastSubscriberConfigInfo (Class ID: #310 / 0x0136)

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
		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)

		This attribute indicates the type of the ME implicitly linked by the ME ID attribute.

		0	MAC bridge port config data

		1	IEEE-802.1p mapper service profile

	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
		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
		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
		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
		This attribute is a list that specifies one or more multicast service packages. When the ONU
		receives an IGMP/MLD join request, it searches the multicast service package table in row key
		order, matching the VID (UNI) field (several rows can share the same VID). For each VID (UNI)
		match, the multicast operations profile pointer is used to access the ME that contains the
		attributes associated with the service package. The search stops when all requested multicast
		groups have been found and dealt with.

		Each list entry is a vector of six components as follow.

		-	Table control (2-bytes)

		The first 2-bytes of each entry contain a key into the table. It is the responsibility of the
		OLT to assign and track table keys and content. Since row keys are created by the OLT, they may
		be densely or sparsely packed.

		The two MSBs of this field determine the meaning of a set operation. These bits are returned as
		00 during get next operations.

		Bits 14..11 are reserved. Bits 10..1 are the row key itself.

		-	VID (UNI). The value in this field is compared with the VID of upstream IGMP/MLD messages, and
		is used to decide whether to honour a join request. (2 bytes)

		Values:

		0..4095 - Matched against the VID of the IGMP/MLD message. 0 indicates a priority-tagged
		message, whose P bits are ignored.

		4096 - Matches untagged IGMP/MLD messages only.

		4097 - Matches tagged messages only, but ignores the value of the VID.

		0xFFFF - Unspecified.

		The VID (UNI) comparison occurs prior to any action defined by the upstream IGMP tag control
		attribute in an associated multicast operations profile (or alternatively, before any
		modification by a possible (extended) VLAN tagging operation configuration data ME).

		-	Max simultaneous groups. This field specifies the maximum number of dynamic multicast groups
		that may be replicated to the client port at any one time, for the multicast service package
		that is associated with this row. The value 0 specifies that no administrative limit is to be
		imposed. (2-bytes)

		-	Max multicast bandwidth. This field specifies the maximum imputed dynamic bandwidth, in bytes
		per second, that may be delivered to the client port at any one time, for the multicast service
		package that is associated with this row. The value 0 specifies that no administrative limit is
		to be imposed. (4-bytes)

		NOTE - The port is also constrained by the global max simultaneous groups and max multicast
		bandwidth attributes of the multicast subscriber config info ME.

		-	Multicast operations profile pointer. This field contains the ME ID of the multicast
		operations profile ME associated with this service package. (2 bytes)

		-	Reserved (8 bytes)

		(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:

		This attribute is a list that specifies the preview groups that are currently allowed for the
		UNI associated with this ME. It is intended to support paid viewing of a multicast group that
		may or may not have been previewed.

		When an IGMP/MLD join request is received, the order of search precedence is as follows.

		1. Multicast operations profile(s), fully authorized groups

		2. This attribute, the allowed preview groups table

		3. Multicast operations profile(s), preview-only groups

		If the first match is a group listed in this attribute, the ONU forwards the group to the UNI
		until the group is removed from this list or until the subscriber leaves the group.

type MulticastSubscriberMonitor ¶

type MulticastSubscriberMonitor struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

MulticastSubscriberMonitor (Class ID: #311 / 0x0137)

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
		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
		This attribute indicates the type of the ME implicitly linked by the ME ID attribute.

		0	MAC bridge port config data

		1	IEEE-802.1p mapper service profile

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

	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
		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
		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
		This attribute lists the groups from one of the related dynamic access control list tables or
		the allowed preview groups table that are currently being actively forwarded, along with the
		actual bandwidth of each. If a join has been recognized from more than one IPv4 source address
		for a given group on this UNI, there will be one table entry for each. Each table entry has the
		following form.

		-	VLAN ID, 0 if not used (2-bytes)

		-	Source IP address, 0.0.0.0 if not used (4-bytes)

		-	Multicast destination IP address (4-bytes)

		-	Best efforts actual bandwidth estimate, bytes per second (4-bytes)

		-	Client (set-top box) IP address, i.e., the IP address of the device currently joined (4-bytes)

		-	Time since the most recent join of this client to the IP channel, in seconds (4-bytes)

		-	Reserved (2-bytes)

		(R) (mandatory) (24N bytes)

	Ipv6 Active Group List Table
		-	Time since the most recent join of this client to the IP channel, in seconds (4-bytes)

		(R) (optional) (58N bytes)

		This attribute lists the groups from one of the related dynamic access control list tables or
		the allowed preview groups table that are currently being actively forwarded, along with the
		actual bandwidth of each. If a join has been recognized from more than one IPv6 source address
		for a given group on this UNI, there will be one table entry for each. In mixed IPv4-IPv6
		scenarios, it is possible that some fields might be IPv4, in which case their 12 most
		significant bytes of the given field are set to zero. Each table entry has the form:

		-	VLAN ID, 0 if not used (2-bytes)

		-	Source IP address, 0 if not used (16-bytes)

		-	Multicast destination IP address (16-bytes)

		-	Best efforts actual bandwidth estimate, bytes per second (4-bytes)

		-	Client (set-top box) IP address, i.e., the IP address of the device currently joined
		(16-bytes)

type NetworkAddress ¶

type NetworkAddress struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

NetworkAddress (Class ID: #137 / 0x0089)

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
		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
		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
		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 / 0x0091)

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
		This attribute uniquely identifies each instance of this ME. (R, setbycreate) (mandatory)
		(2-bytes)

	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
		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
		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
		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
		This attribute defines the dial plan format standard that is supported in the ONU for VoIP.
		Valid values include the following.

		0	Not defined

		1	ITU-T H.248 format with a specific plan (table entries define the dialling plan)

		2	NCS format [b-PKT-SP-NCS ]

		3	Vendor-specific format

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

	Dial Plan Table
		The table is the digit map that describes the dial plans used by the VoIP service, along with
		fields to manage the table. An example digit map is the string,

		(0T|00T|[1-7]xxx|8xxxxxxx|#xxxxxxx|*xx|91xxxxxxxxxx|9011x.T)

		Each row of the table comprises the following fields:

		Dial plan ID: The row number, a unique identifier of a dial plan within the dial plan table
		(1-byte).

		Action: Remove (0) or add (1) this plan (set action). When a dial plan is being removed, the
		dial plan token field is not used. (1-byte).

		Dial plan token: The definition of the dial plan itself. In the previous example, tokens include
		the strings "0T" and "*xx". Unused trailing bytes may be padded with nulls or ASCII spaces.
		(28-bytes)

		NOTE - Due to previously ambiguous documentation, implementations may vary. For
		interoperability, the OLT should write table entries as documented above, while it is encouraged
		for the ONU to accept any characters outside the formal grammar as delimiters and to accept the
		concatenation of rows as a single string that defines a digit map.

		(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 OctetConstraint ¶

type OctetConstraint struct {
	Length int            // Fixed length, if zero the length may vary or is not constrained/specified
	RegEx  *regexp.Regexp // Regular expression (optional)
	Fill   *byte          // Optional fill value. Not used in constraint checks at this time
}

OctetConstraint are octet/byte strings that have may have a fixed size and possibly a regular expression it must match. Table rows are also modeled by OctetConstraint

len(<values>)[,regex(<allowed-pattern>)][,fill(<value>)]

func (c *OctetConstraint) Valid(value interface{}) bool

type OctetString ¶

type OctetString struct {
	ManagedEntityDefinition
	Attributes AttributeValueMap
}

OctetString (Class ID: #307 / 0x0133)

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
		This attribute uniquely identifies each instance of this ME. The values 0 and 0xFFFF are
		reserved. (R, setbycreate) (mandatory) (2-bytes)

	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)

		In the following, 15 additional attributes are defined; they are identical. The octet string is
		simply divided into as many parts as necessary, starting at part 1 and left justified.

	Part 1
		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)

	Part 2
		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)

	Part 3
		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)

	Part 4
		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)

	Part 5
		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)

	Part 6
		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)

	Part 7
		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)

	Part 8
		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)

	Part 9
		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)

	Part 10
		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)

	Part 11
		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)

	Part 12
		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)

	Part 13
		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)

	Part 14
		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)

	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 / 0x0083)