tosca/pNF/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: required, structure: { key: { presence: required, value: measurementStatus, comment: "Contains the status of the measurement."}, value: { presence: required, value: [USED, DEPRECATED, OBSOLETE, PRELIMINARY] }}},
  28                       keyValuePair: { presence: required, structure: { key: { presence: required, value: initialValue, comment: "The initial value to which the Measurement Type is set at the beginning of a new granularity period."}, value: { presence: required }}},
  29                       keyValuePair: { presence: required, structure: { key: { presence: required, value: acmeParameter1, comment: "Extra vendor specific parameter 1."}, value: { presence: required }}},
  30                       keyValuePair: { presence: optional, structure: { key: { presence: required, value: acmeParameter2, comment: "Extra vendor specific parameter 2."}, value: { presence: required, value: [true, false] }}},
  31                       keyValuePair: { presence: optional, structure: { key: { presence: required, value: acmeParameter3, comment: "Extra vendor specific parameter 3."}, value: { presence: required }}}}
  32                   }
  33 ---
  34 pmDictionary:
  35     pmDictionaryHeader:
  36         pmDefVsn: AcmeNumber.1.0
  37         pmDefSchemaVsn: 1.0
  38         nfType: myPnf
  39         vendor: Acme
  40     pmDictionaryMeasurements:
  41
  42     -   measType: DRB.UEThpDl
  43         measDescription: Average DL UE throughput in gNB
  44         measCondition: See 3GPP TS 28.552
  45         measResultType: integer
  46         measResultRange: 0-4294967295
  47         measResultUnits: kbps
  48         measObjClass: NRCellDU
  49         measCollectionMethod: DER
  50         measLastChange: 1.0
  51         measChangeType: added
  52         measInfoId: "Data Radio Bearer"
  53         measFamily: DRB
  54         measAdditionalFields: {
  55             "measurementStatus": "USED",
  56             "initialValue": 0,
  57             "acmeParameter1": 0,
  58             "acmeParameter2": true,
  59             "acmeParameter3": "acmeParameterValue3"}
  60
  61     -   measType: VS.ifInDiscards
  62         measDescription: The number of inbound packets which were chosen to be discarded
  63         measCondition: The number of inbound packets which were chosen to be
  64             discarded even though no errors had been detected to prevent
  65             their being deliverable to a higher-layer protocol.  One
  66             possible reason for discarding such a packet could be to
  67             free up buffer space.
  68             Discontinuities in the value of this counter can occur at
  69             re-initialization of the management system, and at other
  70             times as indicated by the value of
  71             ifCounterDiscontinuityTime.
  72         measResultType: integer
  73         measResultRange: 0-4294967295
  74         measResultUnits: number
  75         measObjClass: EthernetPort
  76         measCollectionMethod: CC
  77         measLastChange: 1.0
  78         measChangeType: added
  79         measInfoId: "IP Management"
  80         measFamily: IP
  81         measAdditionalFields: {
  82             "measurementStatus": "USED",
  83             "initialValue": 0,
  84             "acmeParameter1": 0,
  85             "acmeParameter2": true,
  86             "acmeParameter3": "acmeParameterValue3"}
  87
  88     -   measType: VS.ifInErrors
  89         measDescription: Number of inbound packets that contained errors
  90         measCondition: For packet-oriented interfaces, the number of inbound
  91             packets that contained errors preventing them from being
  92             deliverable to a higher-layer protocol.  For character-
  93             oriented or fixed-length interfaces, the number of inbound
  94             transmission units that contained errors preventing them
  95             from being deliverable to a higher-layer protocol.
  96         measResultType: integer
  97         measResultRange: 0-4294967295
  98         measResultUnits: number
  99         measObjClass: EthernetPort
 100         measCollectionMethod: Gauge
 101         measLastChange: 1.0
 102         measChangeType: added
 103         measInfoId: "IP Management"
 104         measFamily: IP
 105         measAdditionalFields: {
 106             "measurementStatus": "USED",
 107             "initialValue": 0,
 108             "acmeParameter1": 0,
 109             "acmeParameter3": "acmeParameterValue3"}
 110
 111     -   measType: VS.ifInUnknownProtos
 112         measDescription: Number of inbound packets received via an unknown or usupported protocol
 113         measCondition: For packet-oriented interfaces, the number of packets
 114             received via the interface which were discarded because of
 115             an unknown or unsupported protocol.  For character-oriented
 116             or fixed-length interfaces that support protocol
 117             multiplexing the number of transmission units received via
 118             the interface which were discarded because of an unknown or
 119             unsupported protocol.  For any interface that does not
 120             support protocol multiplexing, this counter will always be
 121             0.
 122         measResultType: integer
 123         measResultRange: 0-4294967295
 124         measResultUnits: number
 125         measObjClass: EthernetPort
 126         measCollectionMethod: CC
 127         measLastChange: 1.0
 128         measChangeType: added
 129         measInfoId: "IP Management"
 130         measFamily: IP
 131         measAdditionalFields: {
 132             "measurementStatus": "USED",
 133             "initialValue": 0,
 134             "acmeParameter1": 0,
 135             "acmeParameter2": true}
 136
 137     -   measType: VS.ifHCInBroadcastPkts
 138         measDescription: Number of the broadcasted inbound packets delivered to the higher (sub-)layer
 139         measCondition: The number of packets, delivered by this sub-layer to a
 140             higher (sub-)layer, which were addressed to a broadcast
 141             address at this sub-layer. This object is a 64-bit version
 142             of ifInBroadcastPkts.
 143             Discontinuities in the value of this counter can occur at
 144             re-initialization of the management system, and at other
 145             times as indicated by the value of
 146             ifCounterDiscontinuityTime.
 147         measResultType: integer
 148         measResultRange: 0-4294967295
 149         measResultUnits: number
 150         measObjClass: EthernetPort
 151         measCollectionMethod: CC
 152         measLastChange: 1.0
 153         measChangeType: added
 154         measInfoId: "IP Management"
 155         measFamily: IP
 156         measAdditionalFields: {
 157             "measurementStatus": "USED",
 158             "initialValue": 0,
 159             "acmeParameter1": 0}
 160
 161     -   measType: VS.ifHCOutBroadcastPkts
 162         measDescription: Number of the broadcasted outsbound packets delivered to the higher (sub-)layer
 163         measCondition: The total number of packets that higher-level protocols
 164             requested be transmitted, and which were addressed to a
 165             broadcast address at this sub-layer, including those that
 166             were discarded or not sent.  This object is a 64-bit version
 167             of ifOutBroadcastPkts.
 168             Discontinuities in the value of this counter can occur at
 169             re-initialization of the management system, and at other
 170             times as indicated by the value of
 171             ifCounterDiscontinuityTime.
 172         measResultType: integer
 173         measResultRange: 0-4294967295
 174         measResultUnits: number
 175         measObjClass: EthernetPort
 176         measCollectionMethod: CC
 177         measLastChange: 1.0
 178         measChangeType: added
 179         measInfoId: "IP Management"
 180         measFamily: IP
 181         measAdditionalFields: {
 182             "measurementStatus": "USED",
 183             "initialValue": 0,
 184             "acmeParameter1": 0,
 185             "acmeParameter2": true,
 186             "acmeParameter3": "acmeParameterValue3"}