tosca/vnfsdk/test_SDC_and_VNFSDK_API_missing_entry_in_manifest/Files/Measurements/PM_Dictionary.yaml

   1 pmDictionary:
   2     presence: required
   3     structure:
   4         pmDictionaryHeader:
   5             presence: required
   6             structure:
   7                 pmDefVsn: { presence: required, comment: "Version of the PM Dictionary. Version is vendor defined."}
   8                 pmDefSchemaVsn: { presence: required, comment: "Version of the PM Dictionary Schema used for this PM Dictionary. Schema versions are specified in the VES Specifications."}
   9                 nfType: { presence: required, comment: "NF type to whom this PM Dictionary applies. nfType is vendor defined and should match the string used in eventName."}
  10                 vendor: { presence: required, value: Acme, comment: "Vendor of the NF type to whom this PM Dictionary applies."}
  11         pmDictionaryMeasurements:
  12             presence: required
  13             array:
  14                 - measType: { presence: required, comment: "Measurement name used in PM file, in 3GPP format where specified, else vendor defined. Names for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item e). Names for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item e). Vendor defined names are preceded with VS."}
  15                   measDescription: { presence: required, comment: "Text description of the purpose of the measurement, what information does the measurement provide. Descriptions for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item a). Descriptions for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item a). Vendors are free to augment or modify the 3GPP-provided descriptions to more accurately describe their measurements as needed."}
  16                   measCondition: { presence: required, comment: "Text description of the condition that causes the measurement to be updated. Conditions for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item c). Conditions for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item c). Vendors are free to augment or modify the 3GPP-provided conditions to more accurately describe their measurements as needed."}
  17                   measResultType: { presence: required, value: [integer], comment: "Data type of the measurement result. Result data types for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item d). Result data types for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item d). The measResultType values supported by a vendor are specified in the PM Dictionary YAML using the 'value' attribute and may include vendor-defined data types not specified by 3GPP; for example boolean."}
  18                   measResultRange: { presence: optional, comment: "Range for the measurement result. The range is specified as a comma separated list of discrete values or a range of values specified as minimum value-maximum value with no spaces. Result ranges for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item d) if applicable. Result ranges for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item d) if applicable. "}
  19                   measResultUnits: { presence: required, value: [seconds, minutes, nanoseconds, microseconds, kbps], comment: "Unit of measure for the result; e.g. milliseconds, bytes, kilobytes, packets, number. Unit of measure for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item d) if applicable. Unit of measure for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item d) if applicable. The measResultsUnits values supported by a vendor are specified in the PM Dictionary YAML using the 'value' attribute and may include vendor-defined units of measure not specified by 3GPP; for example ethernet frames."}
  20                   measObjClass: { presence: required, value: [NRCellCU, NRCellDU, NRBTS, IPNO, ETHIF], comment: "Measurement Object Class. Object classes for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item f). Object classes for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item f). The measObjClass values supported by a vendor are specified in the PM Dictionary YAML using the “value” attribute and may include vendor-defined objects not specified by 3GPP; for example IPSEC."}
  21                   measCollectionMethod: { presence: required, value: [CC, GUAGE, DER, SI], comment: "Collection Method for the measurement. 3GPP-defined collection methods are CC, SI, DER and Gauge. Collection Methods for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item b). Collection Methods for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item c). The measCollectionMethod values supported by a vendor are specified in the PM Dictionary YAML using the 'value' attribute and may include vendor-defined collection methods not specified by 3GPP; for example Average."}
  22                   measLastChange: { presence: required, comment: "PM Dictionary version the last time this measurement was changed, added or deleted."}
  23                   measChangeType: { presence: required, value: [added, modified, deleted], comment: "For the measLastChange, indicates the type of change made for this measurement. Valid values are added, modified or deleted. Deleted measurements may be kept in the PM Dictionary for one release or more or permanently for historical purposes, if desired."}
  24                   measInfoId: { presence: required, comment: "Name for a group of related measurements, in 3GPP format where specified, else vendor defined. Family names for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 Section 3.1. Family names for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 Section 3.4."}
  25                   measFamily: { presence: required, comment: "Abbreviation for a family of measurements, in 3GPP format where specified, else vendor defined. Family name abbreviations for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 Section 3.1. Family name abbreviations for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 Section 3.4. "}
  26                   measAdditionalFields: { presence: required, comment: "Hashmap of vendor specific PM Dictionary fields in key value pair format.", structure: {
  27                       keyValuePair: { presence: optional, structure: { key: { presence: required, value: acmeParameter3, comment: "Extra vendor specific parameter 3."}, value: { presence: required }}}}
  28                   }
  29 ---
  30 pmDictionary:
  31     pmDictionaryHeader:
  32         pmDefVsn: AcmeNumber.1.0
  33         pmDefSchemaVsn: 1.0
  34         nfType: myPnf
  35         vendor: Acme
  36     pmDictionaryMeasurements:
  37
  38     - measType: DRB.UEThpDl
  39       measDescription: Average DL UE throughput in gNB
  40       measCondition: See 3GPP TS 28.552
  41       measResultType: integer
  42       measResultRange: 0-4294967295
  43       measResultUnits: kbps
  44       measObjClass: NRCellDU
  45       measCollectionMethod: DER
  46       measLastChange: 1.0
  47       measChangeType: added
  48       measInfoId: "Data Radio Bearer"
  49       measFamily: DRB
  50       measAdditionalFields: {
  51           "measurementStatus": "USED",
  52           "initialValue": 0,
  53           "acmeParameter1": 0,
  54           "acmeParameter2": true,
  55           "acmeParameter3": "acmeParameterValue3"}
  56
  57     - measType: VS.ifInDiscards
  58       measDescription: The number of inbound packets which were chosen to be discarded
  59       measCondition: The number of inbound packets which were chosen to be
  60           discarded even though no errors had been detected to prevent
  61           their being deliverable to a higher-layer protocol.  One
  62           possible reason for discarding such a packet could be to
  63           free up buffer space.
  64           Discontinuities in the value of this counter can occur at
  65           re-initialization of the management system, and at other
  66           times as indicated by the value of
  67           ifCounterDiscontinuityTime.
  68       measResultType: integer
  69       measResultRange: 0-4294967295
  70       measResultUnits: number
  71       measObjClass: EthernetPort
  72       measCollectionMethod: CC
  73       measLastChange: 1.0
  74       measChangeType: added
  75       measInfoId: "IP Management"
  76       measFamily: IP
  77       measAdditionalFields: {
  78           "measurementStatus": "USED",
  79           "initialValue": 0,
  80           "acmeParameter1": 0,
  81           "acmeParameter2": true,
  82           "acmeParameter3": "acmeParameterValue3"}
  83
  84     - measType: VS.ifInErrors
  85       measDescription: Number of inbound packets that contained errors
  86       measCondition: For packet-oriented interfaces, the number of inbound
  87           packets that contained errors preventing them from being
  88           deliverable to a higher-layer protocol.  For character-
  89           oriented or fixed-length interfaces, the number of inbound
  90           transmission units that contained errors preventing them
  91           from being deliverable to a higher-layer protocol.
  92       measResultType: integer
  93       measResultRange: 0-4294967295
  94       measResultUnits: number
  95       measObjClass: EthernetPort
  96       measCollectionMethod: Gauge
  97       measLastChange: 1.0
  98       measChangeType: added
  99       measInfoId: "IP Management"
 100       measFamily: IP
 101       measAdditionalFields: {
 102           "measurementStatus": "USED",
 103           "initialValue": 0,
 104           "acmeParameter1": 0,
 105           "acmeParameter3": "acmeParameterValue3"}
 106
 107     - measType: VS.ifInUnknownProtos
 108       measDescription: Number of inbound packets received via an unknown or usupported protocol
 109       measCondition: For packet-oriented interfaces, the number of packets
 110           received via the interface which were discarded because of
 111           an unknown or unsupported protocol.  For character-oriented
 112           or fixed-length interfaces that support protocol
 113           multiplexing the number of transmission units received via
 114           the interface which were discarded because of an unknown or
 115           unsupported protocol.  For any interface that does not
 116           support protocol multiplexing, this counter will always be
 117           0.
 118       measResultType: integer
 119       measResultRange: 0-4294967295
 120       measResultUnits: number
 121       measObjClass: EthernetPort
 122       measCollectionMethod: CC
 123       measLastChange: 1.0
 124       measChangeType: added
 125       measInfoId: "IP Management"
 126       measFamily: IP
 127       measAdditionalFields: {
 128           "measurementStatus": "USED",
 129           "initialValue": 0,
 130           "acmeParameter1": 0,
 131           "acmeParameter2": true}
 132
 133     - measType: VS.ifHCInBroadcastPkts
 134       measDescription: Number of the broadcasted inbound packets delivered to the higher (sub-)layer
 135       measCondition: The number of packets, delivered by this sub-layer to a
 136           higher (sub-)layer, which were addressed to a broadcast
 137           address at this sub-layer. This object is a 64-bit version
 138           of ifInBroadcastPkts.
 139           Discontinuities in the value of this counter can occur at
 140           re-initialization of the management system, and at other
 141           times as indicated by the value of
 142           ifCounterDiscontinuityTime.
 143       measResultType: integer
 144       measResultRange: 0-4294967295
 145       measResultUnits: number
 146       measObjClass: EthernetPort
 147       measCollectionMethod: CC
 148       measLastChange: 1.0
 149       measChangeType: added
 150       measInfoId: "IP Management"
 151       measFamily: IP
 152       measAdditionalFields: {
 153           "measurementStatus": "USED",
 154           "initialValue": 0,
 155           "acmeParameter1": 0}
 156
 157     - measType: VS.ifHCOutBroadcastPkts
 158       measDescription: Number of the broadcasted outsbound packets delivered to the higher (sub-)layer
 159       measCondition: The total number of packets that higher-level protocols
 160           requested be transmitted, and which were addressed to a
 161           broadcast address at this sub-layer, including those that
 162           were discarded or not sent.  This object is a 64-bit version
 163           of ifOutBroadcastPkts.
 164           Discontinuities in the value of this counter can occur at
 165           re-initialization of the management system, and at other
 166           times as indicated by the value of
 167           ifCounterDiscontinuityTime.
 168       measResultType: integer
 169       measResultRange: 0-4294967295
 170       measResultUnits: number
 171       measObjClass: EthernetPort
 172       measCollectionMethod: CC
 173       measLastChange: 1.0
 174       measChangeType: added
 175       measInfoId: "IP Management"
 176       measFamily: IP
 177       measAdditionalFields: {
 178           "measurementStatus": "USED",
 179           "initialValue": 0,
 180           "acmeParameter1": 0,
 181           "acmeParameter2": true,
 182           "acmeParameter3": "acmeParameterValue3"}