blob: e7485fec19068e39c4eb43d8af6f0027d9995246 [file] [log] [blame]
/*
* Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
* Copyright 2020-present Open Networking Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* NOTE: This file was generated, manual edits will be overwritten!
*
* Generated by 'goCodeGenerator.py':
* https://github.com/cboling/OMCI-parser/README.md
*/
package generated
import "github.com/deckarep/golang-set"
// UniGClassID is the 16-bit ID for the OMCI
// Managed entity UNI-G
const UniGClassID = ClassID(264) // 0x0108
var unigBME *ManagedEntityDefinition
// UniG (Class ID: #264 / 0x0108)
// This ME organizes data associated with UNIs supported by GEM. One instance of the UNI-G ME
// exists for each UNI supported by the ONU.
//
// The ONU automatically creates or deletes instances of this ME upon the creation or deletion of a
// real or virtual circuit pack ME, one per port.
//
// Relationships
// An instance of the UNI-G ME exists for each instance of a PPTP 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 a PPTP. (R) (mandatory) (2-bytes)
//
// Deprecated
// This attribute is not used. It should be set to 0 by the OLT and ignored by the ONU. (R,-W)
// (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) (mandatory) (1-byte)
//
// NOTE - PPTP MEs also have an administrative state attribute. The user port is unlocked only if
// both administrative state attributes are set to unlocked. It is recommended that this attribute
// not be used: that the OLT set it to 0 and that the ONU ignore it.
//
// Management Capability
// An ONU may support the ability for some or all of its PPTPs to be managed either directly by the
// OMCI or from a non-OMCI management environment such as [BBF TR-069]. This attribute advertises
// the ONU's capabilities for each PPTP.
//
// This attribute is an enumeration with the following code points:
//
// 0 OMCI only
//
// 1 Non-OMCI only. In this case, the PPTP may be visible to the OMCI, but only in a read-only
// sense, e.g., for PM collection.
//
// 2 Both OMCI and non-OMCI
//
// (R) (optional) (1-byte)
//
// Non_Omci Management Identifier
// Non-OMCI management identifier: If a PPTP can be managed either directly by the OMCI or a non-
// OMCI management environment, this attribute specifies how it is in fact to be managed. This
// attribute is either 0 (default-=-OMCI management), or it is a pointer to a VEIP, which in turn
// links to a non-OMCI management environment. (R,-W) (optional) (2-bytes)
//
// Relay Agent Options
// %SL In TR-101, this is called a slot. In an ONU, this variable refers to a shelf. It is
// 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 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 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 circuitID 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
//
// 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 remoteID (IPv6). The equivalence permits the same large
// string to be used in both IP environments.
//
type UniG struct {
ManagedEntityDefinition
Attributes AttributeValueMap
}
func init() {
unigBME = &ManagedEntityDefinition{
Name: "UniG",
ClassID: 264,
MessageTypes: mapset.NewSetWith(
Get,
Set,
),
AllowedAttributeMask: 0xf800,
AttributeDefinitions: AttributeDefinitionMap{
0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
1: Uint16Field("Deprecated", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, true, 1),
2: ByteField("AdministrativeState", EnumerationAttributeType, 0x4000, 0, mapset.NewSetWith(Read, Write), false, false, false, 2),
3: ByteField("ManagementCapability", EnumerationAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, true, false, 3),
4: Uint16Field("NonOmciManagementIdentifier", PointerAttributeType, 0x1000, 0, mapset.NewSetWith(Read, Write), false, true, false, 4),
5: Uint16Field("RelayAgentOptions", PointerAttributeType, 0x0800, 0, mapset.NewSetWith(Read, Write), false, true, false, 5),
},
Access: CreatedByOnu,
Support: UnknownSupport,
}
}
// NewUniG (class ID 264) creates the basic
// Managed Entity definition that is used to validate an ME of this type that
// is received from or transmitted to the OMCC.
func NewUniG(params ...ParamData) (*ManagedEntity, OmciErrors) {
return NewManagedEntity(*unigBME, params...)
}