3 namespace "urn:rdns:com:kumunetworks:yang:fd-relay";
6 import "ietf-inet-types" {
10 import ietf-yang-types {
14 import "ietf-interfaces" {
18 organization "Kumu Networks";
21 description "Full-duplex relay data model";
23 /* ***********************************************
25 *********************************************** */
27 revision "2020-10-13" {
28 description "Replace custom relay-interfaces with standard ietf-interfaces";
29 reference "redmine 34169";
31 revision "2020-10-01" {
32 description "Change SINR to type dB to include fractional portion, and PLMN_ID to string";
33 reference "redmine 32899";
35 revision "2020-09-14" {
36 description "Add additional parameters reboot, state_machine_state, alarm details and convert pci-lock and pci-blacklist to lists";
37 reference "redmine 34005, 33787, 32899";
39 revision "2019-09-09" {
40 description "Updated to resolve bugs";
41 reference "Relay SoW";
43 revision "2019-09-02" {
44 description "Initial revision.";
48 /* ***********************************************
50 *********************************************** */
56 description "LTE Physical Cell ID";
61 range "2 | 4 | 12 | 13 | 17";
63 description "LTE Band";
68 range "5 | 10 | 15 | 20";
70 description "LTE Bandwidth";
77 description "decibels mW";
84 description "decibels";
87 /* ***********************************************
89 *********************************************** */
91 grouping canx-module {
92 description 'cancellation module config and state';
95 description 'cancellation module state information';
98 description 'cancellation module calibration state';
101 container mimo_mode {
102 description 'mimo configuration';
107 description 'configured number of transmitters';
113 description 'configured number of receivers';
117 leaf num_active_alarms {
119 description 'number of active alarms on module';
124 description 'list of active alarms on module';
128 description "name of alarm";
133 description "true if alarm is currently active";
138 description 'description of module alarm';
143 description 'module alarm severity';
148 description 'current power readings';
151 description 'tx0 path power (module-referred)';
155 description 'tx1 path power (module-referred)';
159 description 'rx0 path power (module-input referred)';
163 description 'rx1 path power (module-input referred)';
167 leaf-list installed-versions {
169 description "list of installed software and versioning";
172 leaf center-frequency {
176 description 'cancellation module configured center frequency';
180 range "5 | 10 | 15 | 20";
182 description 'cancellation module configured bandwidth';
184 leaf tx_sample_power {
188 description 'cancellation module configured input-referred tx power';
192 description 'cancellation module configured rx gain';
196 type inet:ip-address;
197 description 'cancellation module local configuration IP addr';
200 } // grouping canx-module
203 description "The current state within one band";
206 description "active primary band";
211 description "DL EARFCN";
216 description "LTE Channel bandwidth in MHz";
221 description 'TX Output power in PUSCH';
226 description 'Connected PCI';
231 description "Backhaul link RSSI in dBm";
241 description "per-antenna RSRP";
246 description "per-antenna SINR";
249 list neighboring-cell-measurements {
259 description "DLEARFCN for neighboring cell";
266 description "neighboring cell measurements list";
267 } // list neighboring-cell-measurements
268 } // grouping band-info
271 description "Top level grouping for relay data (configuration & state)";
274 container networking {
275 description "networking state & config data";
277 description "networking configuration data";
279 container force-mtu {
280 description 'MTU Forced on system for all UE and ethernet interfaces, to avoid fragmentation';
283 description 'is force MTU enabled for all interfaces (eth and ue)';
287 description 'MTU to force on all interfaces';
293 description "networking state data";
295 leaf-list interfaces {
296 type if:interface-ref;
297 description 'list of all system network interfaces,
298 including traffic counters, etc.';
304 container dhcp-server {
305 description 'container for dhcp-server';
308 description 'DHCP server state';
312 unique "mac-address";
315 type inet:ip-address;
316 description "IP Address";
320 type yang:phys-address;
321 description "Lease MAC Address";
323 description "DHCP lease information";
330 description "Software information";
333 description "Relay software version";
337 container cancellation {
338 description "container for cancellation modules' state and config data";
339 container ul-module {
340 description 'uplink module state and config';
343 container dl-module {
344 description 'downlink module state and config';
349 container sys-health {
350 description 'relay system health status';
353 description 'relay system health status';
357 description "time since system reboot in seconds";
362 description "temperature in deg C";
365 leaf num_active_alarms {
367 description 'number of active alarms on relay';
372 description 'list of active alarms on relay';
376 description "name of alarm";
381 description "true if alarm is currently active";
386 description 'description of relay alarm';
391 description 'relay alarm severity';
395 leaf state_machine_state {
397 description "Current state of the state machine";
401 description 'relay remote control';
404 description "Reboot relay";
410 description 'cellular modem status & configuration';
413 description 'cellular modem configuration';
416 description 'pci lock configuration';
420 description 'pci lock enabled/disabled';
424 description 'pci to lock';
428 description 'earfcn to lock';
433 description 'List of PCIs that will never be attached too';
437 description 'PCI which will never be attached too';
440 container sim-config {
441 description 'SIM Card configuration';
444 description "SIM Card PIN";
448 container heartbeat {
449 description 'heartbeat ip configuration';
452 description "Enable/disable heartbeat functionality";
455 leaf heartbeat-server-ip {
456 type inet:ip-address;
457 description "Heartbeat server IP to check latency";
460 leaf heartbeat-interval {
462 description "Interval at which to check heartbeat";
466 container rf-config {
467 description 'rf configuration for ue';
470 description "enable band 2";
474 description "enable band 4";
476 leaf enable-band-12 {
478 description "enable band 12";
480 leaf enable-band-13 {
482 description "enable band 13";
484 leaf enable-band-17 {
486 description "enable band 17";
488 leaf disable-carrier-aggregration {
490 description "Enable/disable carrier aggregation";
497 description 'cellular modem state';
504 description 'APN associated with IP address';
508 type inet:ip-address;
509 description "IP Address";
513 type inet:ip-address;
514 description "Subnet Address";
516 description "ip address and apn information";
521 description "UE firmware version";
526 description "last reported heartbeat latency";
531 description "true if ue is attached to network";
535 description "connection uptime in seconds";
545 description "PLMN ID";
550 description "Current DL Data Rate in bits/second";
555 description "Current UL Data Rate in bits/second";
560 description "DL MCS Index";
564 description 'SIM Card and subscription related information';
565 leaf sim-card-present {
567 description "SIM Card present in unit";
572 description "IMEI Number as ASCII string base 10";
577 description "ISMI Number as ASCII string base 10";
581 container heartbeat-status {
582 description 'heartbeat status';
585 description "True if heartbeat IP is reachable";
588 container primary-band-info {
589 description 'LTE primary carrier information';
593 container ca-band-info {
594 description 'Secondary CA band information';
599 type yang:phys-address;
600 description 'MAC address for UE LAN port';
605 description "UE serial number";
612 description 'eNB Information - Config & State';
614 description "Relevant eNB Information for relay small cell";
618 description 'eNB Bandwidth in active bands';
620 leaf tx-power-per-antenna_0 {
622 description 'TX Output power per antenna 0';
624 leaf tx-power-per-antenna_1 {
626 description 'TX Output power per antenna 1';
630 description 'eNB DLEARFCN';
634 description 'eNB ULEARFCN';
640 description 'firmware upgrade';
642 description "Configuration for pushing firmware upgrade";
646 description 'URL to find the firmware ugprade';
650 description 'username for the file server';
654 description 'password for the file server';
658 description 'if true, trigger upgrade';
665 /* ***********************************************
667 *********************************************** */