blob: 5a46091765ae069e9103ccd9441650bc2825015c [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 */
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// SipCallInitiationPerformanceMonitoringHistoryDataClassID is the 16-bit ID for the OMCI
29// Managed entity SIP call initiation performance monitoring history data
30const SipCallInitiationPerformanceMonitoringHistoryDataClassID ClassID = ClassID(152)
31
32var sipcallinitiationperformancemonitoringhistorydataBME *ManagedEntityDefinition
33
34// SipCallInitiationPerformanceMonitoringHistoryData (class ID #152)
35// This ME collects PM data related to call initiations of a VoIP SIP agent. Instances of this ME
36// are created and 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 an instance of the SIP agent config data or SIP config
42// portal ME.
43//
44// Attributes
45// Managed Entity Id
46// Managed entity ID: This attribute uniquely identifies each instance of this ME. Through an
47// identical ID, this ME is implicitly linked to an instance of the SIP agent config data or the
48// SIP config portal ME. If a nonOMCI configuration method is used for VoIP, there can be only one
49// live ME instance, associated with the SIP config portal, and with ME ID 0. (R, setbycreate)
50// (mandatory) (2-bytes)
51//
52// Interval End Time
53// Interval end time: This attribute identifies the most recently finished 15-min interval. (R)
54// (mandatory) (1-byte)
55//
56// Threshold Data 1_2 Id
57// Threshold data 1/2 ID: This attribute points to an instance of the threshold data 1 ME that
58// contains PM threshold values. Since no threshold value attribute number exceeds 7, a threshold
59// data 2 ME is optional. (R,-W, setbycreate) (mandatory) (2-bytes)
60//
61// Failed To Connect Counter
62// Failed to connect counter: This attribute counts the number of times that the SIP UA failed to
63// reach/connect its TCP/UDP peer during SIP call initiations. (R) (mandatory) (4-bytes)
64//
65// Failed To Validate Counter
66// Failed to validate counter: This attribute counts the number of times that the SIP UA failed to
67// validate its peer during SIP call initiations. (R) (mandatory) (4-bytes)
68//
69// Timeout Counter
70// Timeout counter: This attribute counts the number of times that the SIP UA timed out during SIP
71// call initiations. (R) (mandatory) (4-bytes)
72//
73// Failure Received Counter
74// Failure received counter: This attribute counts the number of times that the SIP UA received a
75// failure error code during SIP call initiations. (R) (mandatory) (4-bytes)
76//
77// Failed To Authenticate Counter
78// Failed to authenticate counter: This attribute counts the number of times that the SIP UA failed
79// to authenticate itself during SIP call initiations. (R) (mandatory) (4-bytes)
80//
81type SipCallInitiationPerformanceMonitoringHistoryData struct {
82 ManagedEntityDefinition
83 Attributes AttributeValueMap
84}
85
86func init() {
87 sipcallinitiationperformancemonitoringhistorydataBME = &ManagedEntityDefinition{
88 Name: "SipCallInitiationPerformanceMonitoringHistoryData",
89 ClassID: 152,
90 MessageTypes: mapset.NewSetWith(
91 Create,
92 Delete,
93 Get,
94 Set,
Chip Boling2d51f052021-02-09 09:04:15 -060095 GetCurrentData,
Chip Boling6e27b352020-02-14 09:10:01 -060096 ),
97 AllowedAttributeMask: 0xfe00,
98 AttributeDefinitions: AttributeDefinitionMap{
99 0: Uint16Field("ManagedEntityId", PointerAttributeType, 0x0000, 0, mapset.NewSetWith(Read, SetByCreate), false, false, false, 0),
100 1: ByteField("IntervalEndTime", UnsignedIntegerAttributeType, 0x8000, 0, mapset.NewSetWith(Read), false, false, false, 1),
101 2: Uint16Field("ThresholdData12Id", UnsignedIntegerAttributeType, 0x4000, 0, mapset.NewSetWith(Read, SetByCreate, Write), false, false, false, 2),
102 3: Uint32Field("FailedToConnectCounter", CounterAttributeType, 0x2000, 0, mapset.NewSetWith(Read), false, false, false, 3),
103 4: Uint32Field("FailedToValidateCounter", CounterAttributeType, 0x1000, 0, mapset.NewSetWith(Read), false, false, false, 4),
104 5: Uint32Field("TimeoutCounter", CounterAttributeType, 0x0800, 0, mapset.NewSetWith(Read), false, false, false, 5),
105 6: Uint32Field("FailureReceivedCounter", CounterAttributeType, 0x0400, 0, mapset.NewSetWith(Read), false, false, false, 6),
106 7: Uint32Field("FailedToAuthenticateCounter", CounterAttributeType, 0x0200, 0, mapset.NewSetWith(Read), false, false, false, 7),
107 },
108 Access: CreatedByOlt,
109 Support: UnknownSupport,
Chip Boling34ebcb62021-02-02 12:13:58 -0600110 Alarms: AlarmMap{
111 0: "SIP call PM failed connect",
112 1: "SIP call PM failed to validate",
113 2: "SIP call PM timeout",
114 3: "SIP call PM failure error code received",
115 4: "SIP call PM failed to authenticate",
116 },
Chip Boling6e27b352020-02-14 09:10:01 -0600117 }
118}
119
120// NewSipCallInitiationPerformanceMonitoringHistoryData (class ID 152) creates the basic
121// Managed Entity definition that is used to validate an ME of this type that
122// is received from or transmitted to the OMCC.
123func NewSipCallInitiationPerformanceMonitoringHistoryData(params ...ParamData) (*ManagedEntity, OmciErrors) {
124 return NewManagedEntity(*sipcallinitiationperformancemonitoringhistorydataBME, params...)
125}