blob: 39601799109f3cb3b48e8f91883d08737987ceff [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
Chip Boling8cdd6392022-01-27 08:43:37 -06004 *
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
Chip Boling8cdd6392022-01-27 08:43:37 -06008 *
Chip Boling6e27b352020-02-14 09:10:01 -06009 * http://www.apache.org/licenses/LICENSE-2.0
Chip Boling8cdd6392022-01-27 08:43:37 -060010 *
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 */
Chip Boling34ebcb62021-02-02 12:13:58 -060017/*
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// SipAgentPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity SIP agent performance monitoring history data
Chip Boling610117d2021-09-09 11:24:34 -050030const SipAgentPerformanceMonitoringHistoryDataClassID = ClassID(151) // 0x0097
Chip Boling6e27b352020-02-14 09:10:01 -060031
32var sipagentperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
Chip Boling610117d2021-09-09 11:24:34 -050034// SipAgentPerformanceMonitoringHistoryData (Class ID: #151 / 0x0097)
Chip Boling6e27b352020-02-14 09:10:01 -060035// This ME collects PM data for the associated VoIP SIP agent. Instances of this ME are created and
36// deleted by the OLT.
37//
38// For a complete discussion of generic PM architecture, refer to clause I.4.
39//
40// Relationships
41// An instance of this ME is associated with a SIP agent config data or SIP config portal object.
42//
43// Attributes
44// Managed Entity Id
Chip Boling610117d2021-09-09 11:24:34 -050045// This attribute uniquely identifies each instance of this ME. Through an identical ID, this ME is
46// implicitly linked to an instance of the corresponding SIP agent config data or to the SIP config
47// portal. If a non-OMCI configuration method is used for VoIP, there can be only one live ME
48// instance, associated with the SIP config portal, and with ME ID 0. (R, setbycreate) (mandatory)
49// (2-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060050//
51// Interval End Time
Chip Boling610117d2021-09-09 11:24:34 -050052// This attribute identifies the most recently finished 15-min interval. (R) (mandatory) (1-byte)
Chip Boling6e27b352020-02-14 09:10:01 -060053//
54// Threshold Data 1_2 Id
55// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
56// contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
57// data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)
58//
59// Transactions
Chip Boling610117d2021-09-09 11:24:34 -050060// This attribute counts the number of new transactions that were initiated. (R) (optional)
Chip Boling6e27b352020-02-14 09:10:01 -060061// (4-bytes)
62//
Chip Boling610117d2021-09-09 11:24:34 -050063// Rx Invite Reqs
64// This attribute counts received invite messages, including retransmissions. (R) (optional)
65// (4-bytes)
66//
67// Rx Invite Retrans
68// This attribute counts received invite retransmission messages. (R) (optional) (4-bytes)
69//
Chip Boling6e27b352020-02-14 09:10:01 -060070// Rx Noninvite Reqs
Chip Boling610117d2021-09-09 11:24:34 -050071// This attribute counts received non-invite messages, including retransmissions. (R) (optional)
72// (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060073//
74// Rx Noninvite Retrans
Chip Boling610117d2021-09-09 11:24:34 -050075// This attribute counts received non-invite retransmission messages. (R) (optional) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060076//
77// Rx Response
Chip Boling610117d2021-09-09 11:24:34 -050078// This attribute counts total responses received. (R) (optional) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060079//
80// Rx Response Retransmissions
Chip Boling610117d2021-09-09 11:24:34 -050081// This attribute counts total response retransmissions received. (R) (optional) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060082//
83// Tx Invite Reqs
Chip Boling610117d2021-09-09 11:24:34 -050084// This attribute counts transmitted invite messages, including retransmissions. (R) (optional)
85// (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060086//
87// Tx Invite Retrans
Chip Boling610117d2021-09-09 11:24:34 -050088// This attribute counts transmitted invite retransmission messages. (R) (optional) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060089//
90// Tx Noninvite Reqs
Chip Boling610117d2021-09-09 11:24:34 -050091// This attribute counts transmitted non-invite messages, including retransmissions. (R) (optional)
92// (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060093//
94// Tx Noninvite Retrans
Chip Boling610117d2021-09-09 11:24:34 -050095// This attribute counts transmitted non-invite retransmission messages. (R) (optional) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060096//
97// Tx Response
Chip Boling610117d2021-09-09 11:24:34 -050098// This attribute counts the total responses sent. (R) (optional) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -060099//
100// Tx Response Retransmissions
Chip Boling610117d2021-09-09 11:24:34 -0500101// This attribute counts total response retransmissions sent. (R) (optional) (4-bytes)
Chip Boling6e27b352020-02-14 09:10:01 -0600102//
103type SipAgentPerformanceMonitoringHistoryData struct {
104 ManagedEntityDefinition
105 Attributes AttributeValueMap
106}
107
Chip Boling8cdd6392022-01-27 08:43:37 -0600108// Attribute name constants
109
110const SipAgentPerformanceMonitoringHistoryData_IntervalEndTime = "IntervalEndTime"
111const SipAgentPerformanceMonitoringHistoryData_ThresholdData12Id = "ThresholdData12Id"
112const SipAgentPerformanceMonitoringHistoryData_Transactions = "Transactions"
113const SipAgentPerformanceMonitoringHistoryData_RxInviteReqs = "RxInviteReqs"
114const SipAgentPerformanceMonitoringHistoryData_RxInviteRetrans = "RxInviteRetrans"
115const SipAgentPerformanceMonitoringHistoryData_RxNoninviteReqs = "RxNoninviteReqs"
116const SipAgentPerformanceMonitoringHistoryData_RxNoninviteRetrans = "RxNoninviteRetrans"
117const SipAgentPerformanceMonitoringHistoryData_RxResponse = "RxResponse"
118const SipAgentPerformanceMonitoringHistoryData_RxResponseRetransmissions = "RxResponseRetransmissions"
119const SipAgentPerformanceMonitoringHistoryData_TxInviteReqs = "TxInviteReqs"
120const SipAgentPerformanceMonitoringHistoryData_TxInviteRetrans = "TxInviteRetrans"
121const SipAgentPerformanceMonitoringHistoryData_TxNoninviteReqs = "TxNoninviteReqs"
122const SipAgentPerformanceMonitoringHistoryData_TxNoninviteRetrans = "TxNoninviteRetrans"
123const SipAgentPerformanceMonitoringHistoryData_TxResponse = "TxResponse"
124const SipAgentPerformanceMonitoringHistoryData_TxResponseRetransmissions = "TxResponseRetransmissions"
125
Chip Boling6e27b352020-02-14 09:10:01 -0600126func init() {
127 sipagentperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
128 Name: "SipAgentPerformanceMonitoringHistoryData",
Chip Boling8cdd6392022-01-27 08:43:37 -0600129 ClassID: SipAgentPerformanceMonitoringHistoryDataClassID,
Chip Boling6e27b352020-02-14 09:10:01 -0600130 MessageTypes: mapset.NewSetWith(
131 Create,
132 Delete,
133 Get,
134 Set,
Chip Boling2d51f052021-02-09 09:04:15 -0600135 GetCurrentData,
Chip Boling6e27b352020-02-14 09:10:01 -0600136 ),
137 AllowedAttributeMask: 0xfffe,
138 AttributeDefinitions: AttributeDefinitionMap{
Chip Boling8cdd6392022-01-27 08:43:37 -0600139 0: Uint16Field(ManagedEntityID, PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
140 1: ByteField(SipAgentPerformanceMonitoringHistoryData_IntervalEndTime, UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
141 2: Uint16Field(SipAgentPerformanceMonitoringHistoryData_ThresholdData12Id, UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
142 3: Uint32Field(SipAgentPerformanceMonitoringHistoryData_Transactions, CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, true, false, 3),
143 4: Uint32Field(SipAgentPerformanceMonitoringHistoryData_RxInviteReqs, CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, true, false, 4),
144 5: Uint32Field(SipAgentPerformanceMonitoringHistoryData_RxInviteRetrans, CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, true, false, 5),
145 6: Uint32Field(SipAgentPerformanceMonitoringHistoryData_RxNoninviteReqs, CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, true, false, 6),
146 7: Uint32Field(SipAgentPerformanceMonitoringHistoryData_RxNoninviteRetrans, CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, true, false, 7),
147 8: Uint32Field(SipAgentPerformanceMonitoringHistoryData_RxResponse, CounterAttributeType, 0x0100, 0, mapset.NewSetWith(Read), false, true, false, 8),
148 9: Uint32Field(SipAgentPerformanceMonitoringHistoryData_RxResponseRetransmissions, CounterAttributeType, 0x0080, 0, mapset.NewSetWith(Read), false, true, false, 9),
149 10: Uint32Field(SipAgentPerformanceMonitoringHistoryData_TxInviteReqs, CounterAttributeType, 0x0040, 0, mapset.NewSetWith(Read), false, true, false, 10),
150 11: Uint32Field(SipAgentPerformanceMonitoringHistoryData_TxInviteRetrans, CounterAttributeType, 0x0020, 0, mapset.NewSetWith(Read), false, true, false, 11),
151 12: Uint32Field(SipAgentPerformanceMonitoringHistoryData_TxNoninviteReqs, CounterAttributeType, 0x0010, 0, mapset.NewSetWith(Read), false, true, false, 12),
152 13: Uint32Field(SipAgentPerformanceMonitoringHistoryData_TxNoninviteRetrans, CounterAttributeType, 0x0008, 0, mapset.NewSetWith(Read), false, true, false, 13),
153 14: Uint32Field(SipAgentPerformanceMonitoringHistoryData_TxResponse, CounterAttributeType, 0x0004, 0, mapset.NewSetWith(Read), false, true, false, 14),
154 15: Uint32Field(SipAgentPerformanceMonitoringHistoryData_TxResponseRetransmissions, CounterAttributeType, 0x0002, 0, mapset.NewSetWith(Read), false, true, false, 15),
Chip Boling6e27b352020-02-14 09:10:01 -0600155 },
156 Access: CreatedByOlt,
157 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600158 Alarms: AlarmMap{
159 0: "SIPAMD Rx invite req",
160 1: "SIPAMD Rx invite req retransmission",
161 2: "SIPAMD Rx noninvite req",
162 3: "SIPAMD Rx noninvite req retransmission",
163 4: "SIPAMD Rx response",
164 5: "SIPAMD Rx response retransmission",
165 },
Chip Boling6e27b352020-02-14 09:10:01 -0600166 }
167}
168
169// NewSipAgentPerformanceMonitoringHistoryData (class ID 151) creates the basic
170// Managed Entity definition that is used to validate an ME of this type that
171// is received from or transmitted to the OMCC.
172func NewSipAgentPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
173 return NewManagedEntity(*sipagentperformancemonitoringhistorydataBME, params...)
174}