blob: b9bf56c4f335251338213b0476eda2947a20c5d9 [file] [log] [blame]
Chip Boling6e27b352020-02-14 09:10:01 -06001/*
2 * Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
Andrea Campanella7167ebb2020-02-24 09:56:38 +01003 * Copyright 2020-present Open Networking Foundation
4
Chip Boling6e27b352020-02-14 09:10:01 -06005 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
Andrea Campanella7167ebb2020-02-24 09:56:38 +01008
Chip Boling6e27b352020-02-14 09:10:01 -06009 * http://www.apache.org/licenses/LICENSE-2.0
Andrea Campanella7167ebb2020-02-24 09:56:38 +010010
Chip Boling6e27b352020-02-14 09:10:01 -060011 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
Andrea Campanella7167ebb2020-02-24 09:56:38 +010017 /*
Chip Boling6e27b352020-02-14 09:10:01 -060018 * NOTE: This file was generated, manual edits will be overwritten!
19 *
20 * Generated by 'goCodeGenerator.py':
21 * https://github.com/cboling/OMCI-parser/README.md
22 */
23
24package generated
25
26import "github.com/deckarep/golang-set"
27
28// BbfTr069ManagementServerClassID is the 16-bit ID for the OMCI
29// Managed entity BBF TR-069 management server
30const BbfTr069ManagementServerClassID ClassID = ClassID(340)
31
32var bbftr069managementserverBME *ManagedEntityDefinition
33
34// BbfTr069ManagementServer (class ID #340)
35// If functions within the ONU are managed by [BBF TR-069], this ME allows OMCI configuration of
36// the autoconfiguration server (ACS) URL and related authentication information for an ACS
37// connection initiated by the ONU. [BBF TR-069] supports other means to discover its ACS, so not
38// all BBF-TR069-compatible ONUs necessarily support this ME. Furthermore, even if the ONU does
39// support this ME, some operators may choose not to use it.
40//
41// An ONU that supports OMCI configuration of ACS information automatically creates instances of
42// this ME.
43//
44// Relationships
45// An instance of the BBF TR-069 management server ME exists for each instance of a BBF TR-069
46// management domain within the ONU.
47//
48// Attributes
49// Managed Entity Id
50// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
51// identical ID, this ME is implicitly linked to an instance of a VEIP that links to the BBF TR-069
52// management domain. (R) (mandatory) (2-bytes)
53//
54// Administrative State
55// Administrative state: This attribute locks (1) and unlocks (0) the functions performed by this
56// ME. When the administrative state is locked, the functions of this ME are disabled. BBF TR-069
57// connectivity to an ACS may be possible through means that do not depend on this ME. The default
58// value of this attribute is locked. (R,W) (mandatory) (1-byte)
59//
60// Acs Network Address
61// ACS network address: This attribute points to an instance of a network address ME that contains
62// URL and authentication information associated with the ACS URL. (R, W) (mandatory) (2 bytes)
63//
64// Associated Tag
65// Associated tag: This attribute is a TCI value for BBF TR-069 management traffic passing through
66// the VEIP. A TCI, comprising user priority, CFI and VID, is represented by 2-bytes. The value
67// 0xFFFF specifies that BBF TR-069 management traffic passes through the VEIP with neither a VLAN
68// nor a priority tag. (R, W) (mandatory) (2-bytes)
69//
70type BbfTr069ManagementServer struct {
71 ManagedEntityDefinition
72 Attributes AttributeValueMap
73}
74
75func init() {
76 bbftr069managementserverBME = &ManagedEntityDefinition{
77 Name: "BbfTr069ManagementServer",
78 ClassID: 340,
79 MessageTypes: mapset.NewSetWith(
80 Get,
81 Set,
82 ),
83 AllowedAttributeMask: 0xe000,
84 AttributeDefinitions: AttributeDefinitionMap{
85 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read), false, false, false, 0),
86 1: ByteField("AdministrativeState", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read, Write), false, false, false, 1),
87 2: Uint16Field("AcsNetworkAddress", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, Write), false, false, false, 2),
88 3: Uint16Field("AssociatedTag", UnsignedIntegerAttributeType, 0x2000, 0, mapset.NewSetWith(Read, Write), false, false, false, 3),
89 },
90 Access: CreatedByOnu,
91 Support: UnknownSupport,
92 }
93}
94
95// NewBbfTr069ManagementServer (class ID 340) creates the basic
96// Managed Entity definition that is used to validate an ME of this type that
97// is received from or transmitted to the OMCC.
98func NewBbfTr069ManagementServer(params ...ParamData) (*ManagedEntity, OmciErrors) {
99 return NewManagedEntity(*bbftr069managementserverBME, params...)
100}