Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
info:
title: "ETSI GS MEC 029 Fixed Access Information API"
version: 2.1.1
description: "ETSI GS MEC 029 Fixed Access Information API described using OpenAPI."
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
contact:
url: https://forge.etsi.org/rep/mec/gs029-fai-api
externalDocs:
description: "ETSI GS MEC 029 Fixed Access Information API, v2.1.1"
url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.01.01_60/gs_mec029v020101p.pdf'
openapi: 3.0.0
servers:
- url: 'https://localhost/fai/v1'
tags:
- name: queries
description: Queries
- name: subscription
description: Subscription
paths:
/queries/fa_info:
get:
tags:
- 'queries'
summary: 'Retrieve information on the available fixed access networks.'
description: 'Retrieve information on the available fixed access networks.'
operationId: fa_infoGET
parameters:
- in: query
name: customerPremisesInfo
schema:
type: array
items:
$ref: '#/components/schemas/CpInfo'
required: false
description: 'Comma separated list of customer premises information'
- in: query
name: lastMileTech
schema:
type: array
items:
type: integer
required: false
description: 'Comma separated list of last mile technologies.'
- in: query
name: interfaceType
schema:
type: array
items:
type: integer
description: 'Comma separated list of interface types.'
- in: query
name: dsbw
schema:
type: array
items:
type: integer
required: false
description: 'Comma separated list of the bandwidth (in Mbps) from the network towards the customer site.'
- in: query
name: usbw
schema:
type: array
items:
type: integer
required: false
description: 'Comma separated list of the bandwidth (in Mbps) from the customer site towards the network.'
- in: query
name: latency
schema:
type: array
items:
type: integer
required: false
description: 'Comma separated list of the maximum baseline latency (in ms) between customer site and service edge node.'
responses:
'200':
description: 'A response body containing the FAI is returned. '
content:
application/json:
schema:
$ref: '#/components/schemas/FaInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
/queries/device_info:
get:
tags:
- 'queries'
summary: 'retrieve information on the devices that are connected to a fixed access network.'
description: 'retrieve information on the devices that are connected to a fixed access network.'
operationId: device_infoGET
parameters:
- in: query
name: gwId
schema:
type: array
items:
type: string
required: false
description: 'Comma separated list of gateway identifier'
- in: query
name: deviceId
schema:
type: array
items:
type: string
required: false
description: 'Comma separated list of device identifier.'
- in: query
name: deviceStatus
schema:
type: array
items:
type: integer
description: 'Comma separated list of device status.'
responses:
'200':
description: 'A response body containing the device information is returned'
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
#/queries/cable_line_info:
#get:
#/queries/optical_network_info:
#get:
#/subscriptions:
#get:
#post:
#/subscriptions/{subscriptionId}:
#get:
#put:
#delete:
# /notifitication_end_point_provided_by_client
#post:
components:
schemas:
AniAlarmNotification.alarm:
description: 'Indicates the alarm of the ANI: 0 = LowReceivedOpticalPower. 1 = HighReceivedOpticalPower. 2 = SignalFailure. 3 = SignalDegrade. 4 = LowTransmitOpticalPower.5 = HighTransmitOpticalPower.6 = LaserBiasCurrent.'
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
AniAlarmNotification.aniId:
properties:
onuId:
description: The unique identifiers for the optical network unit.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
aniIndex:
description: The index of an access network interface supported by the optical network unit.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- onuId
- aniIndex
AniAlarmNotification:
properties:
alarm:
$ref: '#/components/schemas/AniAlarmNotification.alarm'
aniId:
$ref: '#/components/schemas/AniAlarmNotification.aniId'
customerPremisesInfo:
description: The physical location of the related customer sites.
items:
$ref: '#/components/schemas/CpInfo'
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: CpInfo
notificationType:
description: Shall be set to "AniAlarmNotification".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
onuId:
type: string
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
required:
- notificationType
- onuId
- aniIndex
- alarm
type: object
x-etsi-ref: 6.4.6
AniAlarmSubscription.filterCriteriaAniAlarm.alarms:
description: "In case alarms is not included in the subscription request, the default value -1 = All shall be used and included in the response:\n0 =\tLowReceivedOpticalPower.\n(Received downstream optical power below threshold.)\n1 =\tHighReceivedOpticalPower.\n\t(Received downstream optical power above threshold.)\n2 =\tSignalFalure.\n(Bit error-based signal fail.)\n3 =\tSignalDegrade.\n(Bit error-based signal degrade.)\n4 =\tLowTransmitOpticalPower.\n(Transmit optical power below lower threshold.)\n5 =\tHighTransmitOpticalPower.\n(Transmit optical power above upper threshold.)\n6 =\tLaserBiasCurrent.\n(Laser bias current above threshold determined by vendor.)\n-1 =\tAll."
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- -1
type: integer
AniAlarmSubscription.links:
properties:
self:
# description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LinkType
$ref: '#/components/schemas/LinkType'
required:
- self
AniAlarmSubscription.filterCriteriaAniAlarm:
description: 'List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.'
required:
- onuId
- aniId
properties:
customerPremisesInfo:
required:
- onuId
- aniId
description: 0 to N physical locations of the customer sites.
minItems: 0
type: array
items:
$ref: '#/components/schemas/CpInfo'
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: CpInfo
onuId:
description: '1 to N unique identifiers for the optical network units. Typical it is the unique serial number for each ONU, which contains the vendor ID and version number. The first four bytes are an ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number, under the control of the ONU vendor.'
type: array
items:
type: string
x-etsi-mec-cardinality: '1..N'
x-etsi-mec-origin-type: String
aniId:
description: ''
type: object
required:
- onuId
- aniIndex
properties:
onuId:
description: 'The unique identifiers for the optical network unit'
type: string
aniIndex:
description: 'The index of an access network interface supported by the optical network unit'
type: string
alarms:
type: array
items:
$ref: '#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm.alarms'
AniAlarmSubscription:
properties:
subscriptionType:
description: 'Shall be set to \"AniAlarmSubscription\"'
type: string
_links:
$ref: '#/components/schemas/AniAlarmSubscription.links'
aniIndex:
description: The index of an access network interface supported by the optical network unit.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
callbackReference:
description: URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response.
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: URI
expiryDeadline:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
filterCriteriaAniAlarm:
$ref: '#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm'
required:
- subscriptionType
- callbackReference
- filterCriteriaAniAlarm
- onuId
- aniIndex
type: object
x-etsi-ref: 6.3.6
CableLineInfo.cmInfo.serviceFlowStats:
description: It describes statistics associated with the Service Flows in a managed device.
properties:
ifIndex:
description: It represents the interface index of the MAC Domain of the Service Flow.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
serviceFlowInfo:
type: array
items:
$ref: '#/components/schemas/CableLineInfo.cmInfo.serviceFlowStats.serviceFlowInfo'
type: object
required:
- ifIndex
- serviceFlowInfo
CableLineInfo.cmInfo.serviceFlowStats.serviceFlowInfo:
description: It represents the information of a Service Flow.
properties:
aqmDroppedPkts:
description: For upstream service flows on which AQM is enabled, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to Active Queue Management drop decisions.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
pkts:
description: For outgoing Service Flows, this attribute counts the number of Packet Data PDUs forwarded to this Service Flow. For incoming upstream CMTS service flows, this attribute counts the number of Packet Data PDUs actually received on the Service Flow identified by the SID for which the packet was scheduled.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
policedDelayPkts:
description: It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
policedDropPkts:
description: "For upstream service flows, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to:\n1)\texceeding the selected Buffer Size for the service flow; or\n2)\tUGS packets dropped due to exceeding the Unsolicited Grant Size with a Request/Transmission policy that requires such packets to be dropped."
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
serviceFlowId:
description: It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
timeActive:
description: It indicates the number of seconds that the service flow has been active.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
timeCreated:
# description': It indicates the time when the service flow was created.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
required:
- serviceFlowId
- pkts
- timeCreated
- timeActive
- policedDropPkts
- policedDelayPkts
- aqmDroppedPkts
CableLineInfo.cmInfo.cmStatus.cmRegState:
description: 'It defines the CM connectivity state. Enumeration of: 1 = other. 2 = notReady. 3 = notSynchronized. 4 = phySynchronized. 5 = usParametersAcquired. 6 = rangingComplete. 7 = dhcpV4Complete. 8 = todEstablished. 9 = securityEstablished. 10 = configFileDownloadComplete. 11 = registrationComplete. 12 = operational. 13 = accessDenied. 14 = eaeInProgress. 15 = dhcpv4InProgress. 16 = dhcpv6InProgress. 17 = dhcpV6Complete. 18 = registrationInProgress. 19 = bpiInit. 20 = forwardingDisabled. 21 = dsTopologyResolutionInProgress. 22 = rangingInProgress. 23 = rfMuteAll.'
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
CableLineInfo.cmInfo.cmStatus:
description: It provides CM connectivity status information of the CM.
properties:
cmRegState:
$ref: '#/components/schemas/CableLineInfo.cmInfo.cmStatus.cmRegState'
emDlsOperStatus:
description: It indicates whether the CM is currently operating in Energy Management DLS Mode.
type: boolean
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Boolean
energyMgt1x1OperStatus:
description: It indicates whether the CM is currently operating in Energy Management 1x1 Mode.
type: boolean
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Boolean
ifIndex:
description: It denotes the MAC Domain interface index of the CM.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
invalidRegRsps:
description: It denotes the number of times the CM received invalid registration response messages.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
lostSyncs:
description: It denotes the number of times the CM lost synchronization with the downstream channel.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
resets:
description: It denotes the number of times the CM reset or initialized this interface.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
required:
- ifIndex
- cmRegState
- resets
- lostSyncs
- invalidRegRsps
- energyMgt1x1OperStatus
- emDlsOperStatus
CableLineInfo.cmInfo.cmDpvStats:
description: It represents the DOCSIS Path Verify Statistics collected in the cable modem device.
properties:
avgLatency:
description: The average latency measurement.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
ifIndex:
description: It represents the interface Index of the Downstream Interface where the measurements are taken.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
lastMeasLatency:
description: The last latency measurement.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
lastMeasTime:
# description': The last measurement time of the last latency measurement.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
maxLatency:
description: The maximum latency measurement.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
minLatency:
description: The minimum latency measurement.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
numMeas:
description: The number of latency measurements made.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
required:
- ifIndex
- lastMeasLatency
- lastMeasTime
- minLatency
- maxLatency
- avgLatency
- numMeas
CableLineInfo.cmInfo:
description: ''
properties:
cmDpvStats:
type: array
items:
$ref: '#/components/schemas/CableLineInfo.cmInfo.cmDpvStats'
cmId:
description: 'Information (typically the serial number) to identify a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.This value SHALL remain fixed over the lifetime of thedevice, including across firmware updates.'
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
cmStatus:
$ref: '#/components/schemas/CableLineInfo.cmInfo.cmStatus'
serviceFlowStats:
type: array
items:
$ref: '#/components/schemas/CableLineInfo.cmInfo.serviceFlowStats'
required:
- cmId
CableLineInfo:
properties:
cmInfo:
$ref: '#/components/schemas/CableLineInfo.cmInfo'
customerPremisesInfo:
# description': The physical location of a customer site.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': CpInfo
$ref: '#/components/schemas/CpInfo'
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
type: object
required:
- customerPremisesInfo
- cmInfo
x-etsi-ref: 6.2.4
cmRegState:
description: 'It indicates the CM connectivity state. Enumeration of: 1 = notReady. 2 = notSynchronized. 3 = phySynchronized. 4 = dsTopologyResolutionInProgress.5 = usParametersAcquired. 6 = rangingInProgress.7 = rangingComplete. 8 = eaeInProgress.9 = dhcpv4InProgress. 10 = dhcpv6InProgress.11 = dhcpV4Complete.12 = dhcpV6Complete.13 = todEstablished.14 = securityEstablished.15 = configFileDownloadComplete.16 = registrationInProgress.17 = registrationComplete. 18 = accessDenied. 19 =operational. 20 = bpiInit.21 =forwardingDisabled.'
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
type: integer
CmConnNotification.cmIf:
description: ''
items:
type: object
properties:
cmId:
description: The Cable Modem identifier.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
cmRegState:
items:
$ref: '#/components/schemas/cmRegState'
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Enum
ifIndex:
description: The MAC Domain interface index of the CM.
items:
type: string
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: String
required:
- cmId
- ifIndex
- cmRegState
CmConnNotification:
required:
- notificationType
- cmIf
properties:
cmIf:
type: array
items:
$ref: '#/components/schemas/CmConnNotification.cmIf'
customerPremisesInfo:
# description': The physical location of a customer site.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': CpInfo
$ref: '#/components/schemas/CpInfo'
notificationType:
description: 'Shall be set to \"CmconnNotification\".'
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
type: object
x-etsi-ref: 6.4.4
CmConnSubscription.links:
description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
properties:
self:
# description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LinkType
$ref: '#/components/schemas/LinkType'
required:
- self
type: object
x-etsi-mec-cardinality: 0..1
CmConnSubscription.filterCriteriaCmConn.cmIf:
description: ''
properties:
cmId:
description: The identifier of a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
cmRegState:
items:
$ref: '#/components/schemas/cmRegState'
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Enum
ifIndex:
description: The MAC Domain interface index of the CM.
items:
type: string
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: String
required:
- cmId
- ifIndex
- cmRegState
CmConnSubscription.filterCriteriaCmConn:
description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
properties:
cmIf:
$ref: '#/components/schemas/CmConnSubscription.filterCriteriaCmConn.cmIf'
customerPremisesInfo:
# description': The physical location of a customer site.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': CpInfo
$ref: '#/components/schemas/CpInfo'
type: object
x-etsi-mec-cardinality: '1'
CmConnSubscription:
properties:
_links:
$ref: '#/components/schemas/CmConnSubscription.links'
callbackReference:
description: URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response.
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: URI
expiryDeadline:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
filterCriteriaCmConn:
$ref: '#/components/schemas/CmConnSubscription.filterCriteriaCmConn'
subscriptionType:
description: Shall be set to "CmConnSubscription".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- subscriptionType
- callbackReference
- filterCriteriaCmConn
type: object
x-etsi-notes: "NOTE:\t'notReady' indicates that the CM has not started the registration process yet.\n\t'notSynchronized' indicates that the CM has not initiated or completed the synchronization of the downstream physical layer.\n\t'phySynchronized' indicates that the CM has completed the synchronization of the downstream physical layer.\n\t'dsTopologyResolutionInProgress' indicates that the CM is attempting to determine its MD-DS-SG.\n\t'usParametersAcquired' indicates that the CM has completed the upstream parameters acquisition or have completed the downstream and upstream service groups resolution.\n\t'rangingInProgress' indicates that the CM has initiated the initial ranging process.\n\t'rangingComplete' indicates that the CM has completed initial ranging and received a Ranging Status of success from the CMTS in the RNG-RSP message.\n\t'eaeInProgress' indicates that the CM has sent an Auth Info message for EAE.\n\t'dhcpv4InProgress' indicates that the CM has sent a DHCPv4 DISCOVER to gain IP connectivity.\n\t'dhcpv6InProgress' indicates that the CM has sent a DHCPv6 Solicit message.\n\t'dhcpv4Complete' indicates that the CM has received a DHCPv4 ACK message from the CMTS.\n\t'dhcpv6Complete' indicates that the CM has received a DHCPv6 Reply message from the CMTS.\n\t'todEstablished' indicates that the CM has successfully acquired time of day.\n\t'securityEstablished' indicates that the CM has successfully completed the BPI initialization process.\n\t'configFileDownloadComplete' indicates that the CM has completed the config file download process.\n\t'registrationInProgress' indicates that the CM has sent a Registration Request.\n\t'registrationComplete' indicates that the CM has successfully completed the Registration process with the CMTS.\n\t'accessDenied' indicates that the CM has received a registration aborted notification from the CMTS.\n\t'operational' indicates that the CM has completed all necessary initialization steps and is operational.\n\t'bpiInit' indicates that the CM has started the BPI initialization process as indicated in the CM config file.\n\t'forwardingDisabled' indicates that the registration process was completed, but the network access option in the received configuration file prohibits forwarding."
x-etsi-ref: 6.3.4
CpInfo:
properties:
latitude:
description: 'Latitude (DATUM=WGS84)
-90 to 90 in decimal degree format DDD.ddd'
format: Float
type: number
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Float
longitude:
description: 'Longitude (DATUM=WGS84)
-180 to 180 in decimal degree format DDD.ddd'
format: Float
type: number
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Float
postalCode:
description: Postal code for the location
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
type: object
x-etsi-ref: 6.5.3
DevInfoNotification:
properties:
deviceErrStatus:
$ref: '#/components/schemas/deviceErrStatus'
# x-etsi-mec-cardinality: '1'
# x-etsi-mec-origin-type: Enum
deviceId:
description: The identifier for a device.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
notificationType:
description: Shall be set to "DevInfoNotification".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
required:
- notificationType
- deviceId
- deviceErrStatus
type: object
x-etsi-ref: 6.4.3
deviceErrStatus:
description: 'The abnormal operational status of the device. Enumeration of: 1 = Error. 2 = Disabled.'
enum:
- 1
- 2
type: integer
DevInfoSubscription.links:
description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
properties:
self:
# description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LinkType
$ref: '#/components/schemas/LinkType'
required:
- self
type: object
x-etsi-mec-cardinality: 0..1
DevInfoSubscription.filterCriteriaDevInfo:
description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
properties:
deviceErrStatus:
items:
$ref: '#/components/schemas/deviceErrStatus'
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Enum
deviceId:
description: The device identifier.
items:
type: string
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: String
gwId:
description: The identifier of an Internet Gateway Device through which the customer premises device is connected.
items:
type: string
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: String
type: object
x-etsi-mec-cardinality: '1'
DevInfoSubscription:
properties:
_links:
$ref: '#/components/schemas/DevInfoSubscription.links'
callbackReference:
description: URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response.
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: URI
expiryDeadline:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
filterCriteriaDevInfo:
$ref: '#/components/schemas/DevInfoSubscription.filterCriteriaDevInfo'
subscriptionType:
description: Shall be set to "DevInfoSubscription".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- subscriptionType
- callbackReference
- filterCriteriaDevInfo
type: object
x-etsi-ref: 6.3.3
DeviceInfo.deviceStatus:
description: 'Current operational status of the device. Enumeration of: 1 = Up. 2 = Initializing. 3 = Error. 4 = Disabled.'
enum:
- 1
- 2
- 3
- 4
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
DeviceInfo:
properties:
deviceId:
description: 'Typically, the serial number of the device.
This value shall remain fixed over the lifetime of the device, including across firmware updates.'
items:
type: string
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: String
deviceStatus:
$ref: '#/components/schemas/DeviceInfo.deviceStatus'
downloadDiagnostics:
# description': The result of a HTTP and FTP DownloadDiagnostics Test.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': DownloadDiagnostics
$ref: '#/components/schemas/DownloadDiagnostics'
gwId:
description: 'Information (typically the serial number) to identify an Internet Gateway Device through which
the customer premises device is connected.
This value shall remain fixed over the lifetime of the device, including across firmware updates.'
items:
type: string
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: String
iPConnectionUpTime:
description: The time in seconds that the IP interface has been connected.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
iPPingDiagnostics:
# description': The result of an IP-layer ping test.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': IPPingDiagnostics
$ref: '#/components/schemas/IPPingDiagnostics'
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
totalBytesReceived:
description: Total number of IP payload bytes received since the device was last restarted.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
totalBytesSent:
description: Total number of IP payload bytes sent since the device was last restarted.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
totalPacketsReceived:
description: Total number of packets received since the device was last restarted.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
totalPacketsSent:
description: Total number of packets sent since the device was last restarted.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
traceRouteDiagnostics:
# description': The result of an IP-layer trace-route test.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TraceRouteDiagnostics
$ref: '#/components/schemas/TraceRouteDiagnostics'
upTime:
description: Time in seconds since the device was last restarted.
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Integer
uploadDiagnostics:
# description': The result of a HTTP and FTP UploadDiagnostics Test.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': UploadDiagnostics
$ref: '#/components/schemas/UploadDiagnostics'
required:
- gwId
- deviceStatus
- upTime
- iPConnectionUpTime
- totalBytesSent
- totalBytesReceived
- totalPacketsSent
- totalPacketsReceived
type: object
x-etsi-ref: 6.2.3
DownloadDiagnostics.diagnosticsState:
description: 'The state of the HTTP and FTP download test. Enumeration of:1 = None.2 = Requested.3 = Completed.4 = Error_InitConnectionFailed.5 = Error_NoResponse.6 = Error_TransferFailed. 7 = Error_PasswordRequestFailed.8 = Error_LoginFailed.9 = Error_NoTransferMode.10 = Error_NoPASV.11 = Error_IncorrectSize.12 = Error_Timeout.'
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
DownloadDiagnostics:
properties:
bOMTime:
# description': Begin of transmission time in UTC, which shall be specified to microsecond precision.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
diagnosticsState:
$ref: '#/components/schemas/DownloadDiagnostics.diagnosticsState'
downloadURI:
description: The URI for the device to perform the download on.
format: uri
type: string