1 module MicrowaveModel-ObjectClasses-AirInterface {
2 namespace "uri:onf:MicrowaveModel-ObjectClasses-AirInterface";
3 prefix MicrowaveModel-ObjectClasses-AirInterface;
5 import CoreModel-CoreNetworkModule-ObjectClasses {
6 prefix CoreModel-CoreNetworkModule-ObjectClasses;
8 import MicrowaveModel-TypeDefinitions {
9 prefix MicrowaveModel-TypeDefinitions;
11 import CoreModel-CoreFoundationModule-TypeDefinitions {
12 prefix CoreModel-CoreFoundationModule-TypeDefinitions;
14 import CoreModel-CoreFoundationModule-SuperClassesAndCommonPackages {
15 prefix CoreModel-CoreFoundationModule-SuperClassesAndCommonPackages;
19 'ONF (Open Networking Foundation) Open Transport Working Group - Wireless Transport Project';
22 'WG Web: <https://www.opennetworking.org/technical-communities/areas/specification/1931-optical-transport>
23 WG List: <mailto:wireless-transport@login.opennetworking.org >
25 <mailto:lyong@ciena.com>
26 WG Chair: Giorgio Cazzaniga
27 <mailto:giorgio.cazzaniga@sm-optics.com>';
30 'This module contains a collection of YANG definitions for
31 managing microwave transport networks.';
37 "ONF TR xyz: A YANG Data Model for Microwave Transport Networks.";
40 list MW_AirInterface_Pac {
41 description "LTP(MWPS-TTP)";
46 path '/CoreModel-CoreNetworkModule-ObjectClasses:NetworkElement/CoreModel-CoreNetworkModule-ObjectClasses:_ltpRefList/CoreModel-CoreNetworkModule-ObjectClasses:_lpList/CoreModel-CoreNetworkModule-ObjectClasses:uuid';
50 container airInterfaceCapability {
52 uses AirInterfaceCapability;
54 container airInterfaceConfiguration {
56 uses AirInterfaceConfiguration;
58 container airInterfaceStatus {
60 uses AirInterfaceStatus;
62 container airInterfaceCurrentProblems {
64 uses AirInterfaceCurrentProblems;
66 container airInterfaceCurrentPerformance {
68 uses AirInterfaceCurrentPerformance;
70 container airInterfaceHistoricalPerformances {
72 uses AirInterfaceHistoricalPerformances;
75 grouping AirInterfaceCapability {
76 description "Describes the 'analog' capabilities of modem and transmitter of the microwave device. Value ranges of attributes are not independently (e.g. min. and max. transmit power depends on modulation). Legal combinations of values are expressed in transmissionModeTypes.";
77 leaf typeOfEquipment {
80 description "This parameter indicates the equipment type. Instead of uploading the complete set of capabilities, capabilities of the same equipment type could be reused. Should be unique for a combination of modem, radio and their respective firmware.";
81 default "Type of equipment not yet defined.";
86 description "Value of the minimum transmit frequency tunable at the air interface.";
93 description "Value of the maximum transmit frequency tunable at the air interface.";
100 description "Value of the minimum receive frequency tunable at the air interface.";
104 leaf rxFrequencyMax {
107 description "Value of the maximum receive frequency tunable at the air interface.";
111 leaf adaptiveModulationIsAvail {
114 description "In case the device is capable of adaptive modulation, this field shall contain a 'true'.";
120 description "In case the device is capable of MIMO, this field shall contain a 'true'.";
126 description "Maximum number (n) of spatial multiplexing streams that can be conveyed by an n x n MIMO configuration.";
133 description "In case the microwave radio is capable of Adjacent Link Interference Cancelation (canceling of interference cause by transmitters located at the same site), this field shall contain a 'true'.";
139 description "In case the microwave radio is capable of ATPC, this field shall contain a 'true'.";
145 description "Extent of the ATPC range.";
149 leaf encryptionIsAvail {
152 description "Shall be marked 'true', if payload encryption is available.";
155 leaf loopBackIsAvail {
158 description "In case the radio is capable of looping back header information of the air interface, this field shall contain a 'true'.";
161 leaf maintenanceTimerRange {
164 description "Available time periods for maintenance configurations (e.g. the loop back of microwave header information) to be described. Concrete values shall be separated by commas (e.g. '10, 60, 360'). Ranges shall be expressed as two values separated by a minus (e.g. '10-360').";
166 default "Range of the maintenance timer not yet defined.";
168 leaf supportedAlarms {
171 description "Available alarms to be listed. Mandatory:'signalIsLost','rslIsExceeded','temperatureIsExceeded','modemIsFaulty','radioIsFaulty' and 'modulationIsDownShifted'. Further alarms might be added by the device. Names are to be separated by commas.";
172 default "Supported alarms not yet defined.";
174 list supportedChannelPlanList {
175 description "List of channel spacing that are supported by the device.";
176 key 'supportedChannelPlan';
178 uses MicrowaveModel-TypeDefinitions:channelPlanType;
182 grouping AirInterfaceConfiguration {
183 description "Configuration of the radio link.";
184 leaf airInterfaceName {
186 description "Operator specific microwave link ID (often used for coding area, type of element and sequential number).";
187 default "Air interface ID not yet defined.";
191 description "The radioSignalId is transmitted on the air interface so the remote site of the link synchronizes on the correct transmitter. The local radio MUST NOT synchronize on a radio signal with a different radioSignalId. The link ID is neither an ID necessary to span the model nor an ID referencing external data. It is just some sort of name of the link transmitted so the correct remote site can be identified in an interference situation.
192 The value zero might be used to make the microwave to disable the link ID check.";
193 default "Radio signal ID not yet defined.";
197 description "Center frequency of the transmit channel. The values to be configured have to exactly match the values listed in the international agreement referenced in channelPlanID. In case of automated selection of the transmit frequency this field shall describe the lowest center frequency selectable.";
203 description "Center frequency of the receive channel.";
207 leaf txChannelBandwidth {
209 description "Bandwidth of the transmit channel. The value shall be expressed explicitly (means in kHz) not as a reference to an international agreement. The values shall be chosen from the following _list: 3.500, 7.000, 14.000, 27.500, 28.000, 29.000, 29.650, 30.000, 40.000, 50.000, 55.000, 56.000, 59.300, 60.000, 80.000, 100.000, 112.000, 120.000, 150.000, 200.000, 250.000, 500.000, 750.000, 1.000.000, 1.250.000, 1.500.000, 1.750.000, 2.000.000;";
213 leaf rxChannelBandwidth {
215 description "Bandwidth of the receive channel. The value shall be expressed explicitly (means in kHz) not as a reference to an international agreement. The values shall be chosen from the following _list: 3.500, 7.000, 14.000, 27.500, 28.000, 29.000, 29.650, 30.000, 40.000, 50.000, 55.000, 56.000, 59.300, 60.000, 80.000, 100.000, 112.000, 120.000, 150.000, 200.000, 250.000, 500.000, 750.000, 1.000.000, 1.250.000, 1.500.000, 1.750.000, 2.000.000;";
220 type MicrowaveModel-TypeDefinitions:polarizationType;
221 description "Allows documenting the polarization of the air interface.";
222 default "not-specified";
226 description "Power ON. Activation of the entire radio in a split mount configuration shall be expressed as a 'true'.";
229 leaf transmitterIsOn {
231 description "Activation of the transmitter inside the radio shall be expressed as a 'true'.";
236 description "Activation of the receiver inside the radio shall be expressed as a 'true'. Attribute shall also be used for RX main and RX diversity squelches in case of diversity configurations.
237 Maintenance Feature";
242 description "Transmit power to be configured on the microwave link. Signed Byte is required. The actually operated transmit power might be lower depending on adaptive modulation and ATPC.";
246 leaf adaptiveModulationIsOn {
248 description "Adaptive Modulation. Activation of adaptive modulation shall be expressed as a 'true'.";
253 description "Minimum modulation to be configured (in case adaptive modulation is not used, this value represents also the fixed modulation). The modulation scheme shall be described by the number of symbols (e.g. BPSK->'2' or 256QAM->'256'). Allowed values are defined in TypeDefinitions::transmissionModeType::modulationScheme.";
259 description "Maximum modulation to be configured. The value of this field is only relevant, if Adaptive Modulation has been activated. The modulation scheme shall be described by the number of symbols (e.g. BPSK->'2' or 256QAM->'256'). Allowed values are defined in TypeDefinitions::transmissionModeType::modulationScheme.";
265 description "Activation of Cross Polarization Interference Cancelation shall be expressed as a 'true'. In case XPIC is not available for the current combination of channel bandwidth and modulation or the hardware in general, this parameter shall always be set to 'false'.";
270 description "Activation of Multiple Input Multiple Output (MIMO) shall be expressed as a 'true'.";
275 description "Activation of Adjacent Link Interference Cancelation (ALIC) shall be expressed as a 'true'.";
280 description "ATPC. Activation of Automated Transmit Power Control shall be expressed as a 'true'.";
283 leaf atpcThreshUpper {
285 description "If the receive level is higher than the upper threshold value, the transmitter is notified to decrease transmit power.";
289 leaf atpcThreshLower {
291 description "If the receive level is lower than the lower threshold value, the transmitter is notified to increase transmit power.";
295 leaf autoFreqSelectIsOn {
297 description "Activation of automatically selecting the transmit frequency in unlicensed bands shall be expressed as a 'true'.";
300 leaf autoFreqSelectRange {
302 description "Number of transmit channels (starting at the center frequency defined in txFrequency and with channel bandwidth according to txChannelBandwidth) that define the range within the transmit frequency can automatically been chosen. ";
306 leaf modulationIsOn {
308 description "De-activation of the modulation of the carrier signal for fault management shall be expressed as a 'false'.
309 Maintenance Feature";
312 leaf encryptionIsOn {
314 description "Activates encryption of the payload.";
317 leaf cryptographicKey {
319 description "Key for transforming plaintext into ciphertext data.";
320 default "Cryptographic key not yet defined.";
324 description "If this attribute is set to 'true', the received IF signal is transmitted back to the remote end.
325 Maintenance Feature";
328 leaf maintenanceTimer {
330 description "Time of existence of any maintenance configuration (e.g. the loop back of microwave header information). Valid values are defined in AirInterface::AirInterfaceCapability::maintenanceTimerRange.";
334 list problemKindSeverityList {
335 description "Severity of the problem to be configured.";
336 key 'problemKindName';
339 uses MicrowaveModel-TypeDefinitions:airInterfaceProblemSeverityType;
343 grouping AirInterfaceStatus {
344 description "Measurements of current values on the air interface and operational status of the device.";
345 leaf txFrequencyCur {
348 description "Center frequency of the currently operated transmit channel.";
352 leaf rxFrequencyCur {
355 description "Center frequency of the currently operated receive channel.";
362 description "Current transmit level.";
369 description "Current receive level.";
376 description "Currently operated modulation on transmit path. The modulation scheme shall be described by the number of symbols (e.g. BPSK->'2' or 256QAM->'256'). Allowed values are defined in TypeDefinitions::transmissionModeType::modulationScheme.";
380 leaf informationRateCur {
383 description "Information rate of the currently operated coding scheme.";
390 description "Currently measured signal to (noise+interference) ratio.";
397 description "Currently measured cross polarization discrimination.";
404 description "Current temperature (in degree Celsius) of the radio module inside the outdoor unit.";
408 leaf lastStatusChange {
409 type CoreModel-CoreFoundationModule-TypeDefinitions:DateAndTime;
411 description "Time the Air Interface entered its current operational status.
412 _format:yyyyMMddhhmmss.s[Z|{+|-}HHMm]; yyyy='0000'..'9999' year; MM='01'..'12' month; dd='01'..'31' day; hh='00'..'23' hour; mm='00'..'59' minute; ss='00'..'59' second; s='.0'..'.9'tenth of second (set to '.0' if EMS or NE cannot support this granularity); Z='Z' indicates UTC (rather than local time); {+|-}='+' or '-' delta from UTC; HH='00'..'23' time zone difference in hours; Mm='00'..'59' time zone difference in minutes.";
413 default "20101120140000.0Z+1";
415 leaf radioPowerIsUp {
418 description "If the radio unit has power and is switched on, this shall be expressed as a 'true'.";
424 description "If connection is established to the remote site with the same linkID, this shall be expressed as a 'true'.";
430 description "If XPIC is currently actually working (not just configured), this shall be expressed as a 'true'.";
436 description "If MIMO is currently actually working (not just configured), this shall be expressed as a 'true'.";
442 description "If Adjacent Link Interference Cancelation (ALIC) is currently actually working (not just configured), this shall be expressed as a 'true'.";
448 description "If ATPC is currently actually working (not just configured), this shall be expressed as a 'true'.";
451 leaf autoFreqSelectIsUp {
454 description "If automated frequency selection is currently actually working (not just configured), this shall be expressed as a 'true'.";
460 description "If loop back of the air interface header is currently active (not just configured), this shall be expressed as a 'true'.";
463 leaf localEndPointId {
466 description "The value of the localEndPointId is a vendor specific identifier of the air interface, used by the node to discover a microwave radio link.";
467 default "not-supported";
469 leaf remoteEndPointId {
472 description "The value of the remoteEndPointId is a vendor specific identifier or the airinterface at the remote side, used to by the node to discover a microwave radio link.";
473 default "not-supported";
476 grouping AirInterfaceCurrentProblems {
477 list currentProblemList {
478 key 'sequenceNumber';
480 uses MicrowaveModel-TypeDefinitions:airInterfaceCurrentProblemType;
483 grouping AirInterfaceCurrentPerformance {
484 description "Aggregated performance information of the air interface at a particular moment.";
485 list currentPerformanceDataList {
486 description "At least values of the counters, which are reset every 15 minutes, are to be provided. If available, the current values of the counters, which are reset every 24 hour, can be provided, too.";
489 uses MicrowaveModel-TypeDefinitions:airInterfaceCurrentPerformanceType;
494 grouping AirInterfaceHistoricalPerformances {
495 description "Aggregated performance information of the air interface for a pre-defined measurement interval.";
496 list historicalPerformanceDataList {
499 uses MicrowaveModel-TypeDefinitions:airInterfaceHistoricalPerformanceType;
502 list CoChannelGroup {
503 description "Required for configuring XPIC, MIMO and ALIC.";
504 key 'coChannelGroupId';
506 leaf coChannelGroupId {
507 type CoreModel-CoreFoundationModule-SuperClassesAndCommonPackages:UniversalId;
509 leaf-list airInterfaceList {
510 description "List of air interfaces, which are part of the co-channel (XPIC, MIMO, ALIC) group.";
513 path '/CoreModel-CoreNetworkModule-ObjectClasses:NetworkElement/CoreModel-CoreNetworkModule-ObjectClasses:_ltpRefList/CoreModel-CoreNetworkModule-ObjectClasses:uuid';
516 leaf sortOfCoChannelGroup {
518 description "Type of group of air interfaces with the same transmit and receive frequency. The values shall be chosen from the following _list:'XPIC', 'MIMO', 'ALIC';";