Newer
Older
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:
type: array
items:
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
$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.'
type: array
items:
type: string
x-etsi-mec-cardinality: 0..1
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
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
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: URI
eOMTime:
# description': End of transmission 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'
rOMTime:
# description': Request 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'
tCPOpenReponseTime:
# description': Response 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'
tCPOpenRequestTime:
# description': Request 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'
testBytesReceived:
description: The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
totalBytesReceived:
description: The total number of bytes received on the Interface between bOMTime and eOMTime.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
required:
- diagnosticsState
type: object
x-etsi-ref: 6.5.6
ExpiryNotification.links:
description: List of hyperlinks related to the resource.
properties:
self:
description: Self referring URI. This shall be included in the response from the FAIS. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: URI
required:
- self
type: object
x-etsi-mec-cardinality: '1'
ExpiryNotification:
properties:
_links:
$ref: '#/components/schemas/ExpiryNotification.links'
expiryDeadline:
# description': Time stamp.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
required:
- _links
- expiryDeadline
type: object
x-etsi-ref: 6.4.5
FaInfo.connectivityInfo.interfaceType:
description: 'The physical interface used for the end customer site:1 = 100BASE-TX.2 = 1000BASE-TX.3 = 1000BASE-LX.4 = 1000BASELX10.5 = 1000BASEBX10. 6 = 1000BASE-LH.7 = 1000Base-ZX. 8 = ADSL-RJ11.9 = VDSL-RJ11.10 = GPON.'
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
FaInfo.connectivityInfo.lastMileTech:
description: 'An informative field identifying the last mile access technology used.The valid values are:1 = ADSL.2 = VDSL.3 = GPON. 4 = XGPON.5 = NGPON2. 6 = XGSPON. 7 = GFAST.8 = P2PEthernet.'
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
FaInfo.connectivityInfo:
description: The per connectivity domain FAI as defined below.
properties:
dsbw:
description: The bandwidth (in Mbps) from the network towards the customer site.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
interfaceType:
$ref: '#/components/schemas/FaInfo.connectivityInfo.interfaceType'
lastMileTech:
$ref: '#/components/schemas/FaInfo.connectivityInfo.lastMileTech'
latency:
description: Maximum baseline latency (in ms) between customer site and service edge node.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
usbw:
description: The bandwidth (in Mbps) from the customer site towards the network.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
required:
- lastMileTech
- interfaceType
FaInfo:
properties:
connectivityInfo:
type: array
items:
$ref: '#/components/schemas/FaInfo.connectivityInfo'
customerPremisesInfo:
description: The physical location of a customer site.
items:
$ref: '#/components/schemas/CpInfo'
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: 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
x-etsi-ref: 6.2.2
IPPingDiagnostics.diagnosticsState:
description: 'The state of the IP ping test. Enumeration of: 1 = None. 2 = Requested. 3 = Complete. 4 = Error_CannotResolveHostName. 5 = Error_Internal.6 = Error_Other.'
enum:
- 1
- 2
- 3
- 4
- 5
- 6
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
IPPingDiagnostics:
properties:
averageResponseTime:
description: 'Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test.
If there were no successful responses, this value shall be zero.'
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
dataBlockSize:
description: Size of the data block in bytes to be sent for each ping.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
diagnosticsState:
$ref: '#/components/schemas/IPPingDiagnostics.diagnosticsState'
failureCount:
description: Result parameter indicating the number of failed pings in the most recent ping test.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
host:
description: Host name or address of the host to ping.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
maximumResponseTime:
description: 'Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test.
If there were no successful responses, this value shall be zero.'
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
minimumResponseTime:
description: 'Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test.
If there were no successful responses, this value shall be zero.'
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
numberOfRepetitions:
description: Number of repetitions of the ping test to perform before reporting the results.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
successCount:
description: 'Result parameter indicating the number of successful
pings (those in which a successful response was received prior to the timeout) in the most recent ping test.'
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
timeout:
description: Timeout in milliseconds for the ping test.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
required:
- diagnosticsState
type: object
x-etsi-ref: 6.5.4
OnuAlarmNotification.alarm:
description: 'Indicates the alarm of the ONU:0 = EquipmentAlarm.1 = PoweringAlarm.2 = BatteryMissing.3 = BatteryFailure.4 = BatteryLow.5 = PhysicalIntrusion. 6 = OnuSelfTestFailure. 7 = DyingGasp. 8 = TemperatureYellow.9 = TemperatureRed.10 = VoltageYellow.11 = VoltageRed.12 = OnuManualPowerOff. 13 = InvImage.14 = PseOverloadYellow.15 = PseOverloadRed.'
enum:
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
OnuAlarmNotification:
properties:
alarm:
$ref: '#/components/schemas/OnuAlarmNotification.alarm'
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 "OnuAlarmNotification".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
onuId:
description: The unique identifier for an optical network unit.
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
- onuId
- alarm
type: object
x-etsi-ref: 6.4.2
OnuAlarmSubscription.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 =\tEquipmentAlarm.\n\t(Functional failure on an internal interface.)\n1 =\tPoweringAlarm.\n\t(Loss of external power to battery backup unit. This alarm is typically derived through an external interface to a battery backup unit, and indicates that AC is no longer available to maintain battery charge.)\n2 =\tBatteryMissing.\n\t(Battery is provisioned but missing.)\n3 =\tBatteryFailure.\n\t(Battery is provisioned and present but cannot recharge.)\n4 =\tBatteryLow.\n\t(Battery is provisioned and present but its voltage is too low.)\n5 =\tPhysicalIntrusion.\n\t(Applies if the ONU supports detection such as door or box open.)\n6 =\tOnuSelfTestFailure.\n\t(ONU has failed autonomous self-test.)\n7 =\tDyingGasp.\n\t(ONU is powering off imminently due to loss of power to the ONU itself.)\n8 =\tTemperatureYellow.\n\t(No service shutdown at present, but the circuit pack is operating beyond its recommended range.)\n9 =\tTemperatureRed.\n\t(Some services have been shut down to avoid equipment damage.)\n10 =\tVoltageYellow.\n\t(No service shutdown at present, but the line power voltage is below its recommended minimum.)\n11 =\tVoltageRed.\n\t(Some services have been shut down to avoid power collapse.)\n12 =\tOnuManualPowerOff.\n\t(The ONU is shutting down because the subscriber has turned off its power switch.)\n13 =\tInvImage.\n\t(Software image is invalid.)\n14 =\tPseOverloadYellow.\n\t(Indicates that the ONU is nearing its maximum ability to supply the known PoE demand of the attached PDs. The thresholds for declaring and clearing this alarm are vendor-specific.)\n15 =\tPseOverloadRed.\n\t(Indicates that the ONU is unable to supply all of the PoE demand of the attached PDs and has removed or reduced power to at least one PD.)\n-1 =\tAll."
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- -1
type: integer
OnuAlarmSubscription.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
OnuAlarmSubscription.filterCriteriaOnuAlarm:
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:
alarms:
items:
$ref: '#/components/schemas/OnuAlarmSubscription.alarms'
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Enum
customerPremisesInfo:
description: 0 to N physical locations of the customer sites.
items:
$ref: '#/components/schemas/CpInfo'
minItems: 0
type: array
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.'
items:
type: string
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: String
required:
- onuId
type: object
x-etsi-mec-cardinality: '1'
OnuAlarmSubscription:
properties:
_links:
$ref: '#/components/schemas/OnuAlarmSubscription.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'
filterCriteriaOnuAlarm:
$ref: '#/components/schemas/OnuAlarmSubscription.filterCriteriaOnuAlarm'
subscriptionType:
description: Shall be set to \"OnuAlarmSubscription\".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- subscriptionType
- callbackReference
- filterCriteriaOnuAlarm
type: object
x-etsi-ref: 6.3.2
PonInfo.opticalNetworkInfo.dsRate:
description: "Downstream line rate, valid values are:\n1 =\t2,48832 Gbit/s: G-PON [i.9]; or\nNG-PON2 option 2 [i.8].\n2 =\t9,95328 Gbit/s: XG-PON [i.10]; or\n XGS-PON [i.11]; or\nNG-PON2 option 1 [i.8]."
enum:
- 1
- 2
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
PonInfo.opticalNetworkInfo.operationalState:
description: 'It reports whether the ONU is currently capable of performing its function. Valid values are: 0 = enabled 1 = disabled'
enum:
- 0
- 1
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
PonInfo.opticalNetworkInfo.ponTech:
description: 'An informative field identifying the optical technology used. The valid values are: 1 = GPON. 2 = XGPON.3 = NGPON2. 4 = XGSPON.'
enum:
- 1
- 2
- 3
- 4
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
PonInfo.opticalNetworkInfo.usRate:
description: "Upstream line rate, valid values are:\n1 =\t1,24416 Gbit/s: G-PON option 1 [i.9].\n2 =\t2,48832 Gbit/s: G-PON option 2 [i.9]; or\nXG-PON [i.10]; or\nNG-PON2 option 2 [i.8].\n3 =\t9,95328 Gbit/s: XGS-PON [i.11]; or\nNG-PON2 option 1 [i.8]."
enum:
- 1
- 2
- 3
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
PonInfo.opticalNetworkInfo:
description: ''
items:
type: object
minItems: 1
properties:
dsRate:
$ref: '#/components/schemas/PonInfo.opticalNetworkInfo.dsRate'
onuId:
description: Information to identify an Optical Network Unit.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
operationalState:
$ref: '#/components/schemas/PonInfo.opticalNetworkInfo.operationalState'
ponTech:
$ref: '#/components/schemas/PonInfo.opticalNetworkInfo.ponTech'
usRate:
$ref: '#/components/schemas/PonInfo.opticalNetworkInfo.usRate'
required:
- onuId
- ponTech
- operationalState
- dsRate
- usRate
PonInfo:
properties:
customerPremisesInfo:
description: The physical location of a customer site.
items:
$ref: '#/components/schemas/CpInfo'
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: CpInfo
opticalNetworkInfo:
type: array
items:
$ref: '#/components/schemas/PonInfo.opticalNetworkInfo'
ponSYS_ID:
description: 'The 20-bit identity of the optical system within a certain domain.This is a reference value set by the OSS.'
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:
- customerPremisesInfo
- ponSYS_ID
- opticalNetworkInfo
type: object
x-etsi-ref: 6.2.5
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
SubscriptionLinkList.links.subscription.subscriptionType:
description: 'Numeric value (0 - 255) corresponding to specified type of subscription as following: 0 = RESERVED. 1 = ONU_ALARM. 2 = DEVICE_ABNORMAL_ALERT. 3 = CM_CONNECTIVITY_STATE.4 = ANI_ALARM.'
enum:
- 0
- 1
- 2
- 3
- 4
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
SubscriptionLinkList.links.subscription:
description: A link to a subscription.
properties:
href:
description: The URI referring to the subscription.
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: URI
subscriptionType:
$ref: '#/components/schemas/SubscriptionLinkList.links.subscription.subscriptionType'
required:
- href
- subscriptionType
SubscriptionLinkList.links:
description: List of hyperlinks related to the resource.
properties:
subscription:
type: array
items:
$ref: '#/components/schemas/SubscriptionLinkList.links.subscription'
SubscriptionLinkList:
properties:
_links:
$ref: '#/components/schemas/SubscriptionLinkList.links'
required:
- _links
type: object
x-etsi-ref: 6.3.5
TimeStamp:
properties:
nanoSeconds:
description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
format: Uint32
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uint32
seconds:
description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
format: Uint32
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Uint32
required:
- seconds
- nanoSeconds
type: object
x-etsi-ref: 6.5.2
TraceRouteDiagnostics.diagnosticsState:
description: 'The state of the IP trace-route test. Enumeration of: 1 = None. 2 = Requested. 3 = Complete. 4 = Error_CannotResolveHostName. 5 = Error_MaxHopCountExceeded. 6 = Error_Internal. 7 = Error_Other.'
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
type: integer
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: Enum
TraceRouteDiagnostics:
properties:
dataBlockSize:
description: Size of the data block in bytes to be sent for each trace route.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
diagnosticsState:
$ref: '#/components/schemas/TraceRouteDiagnostics.diagnosticsState'
host:
description: Host name or address of the host to find a route to.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
maxHopCount:
description: The maximum number of hop used in outgoing probe packets. The default is 30 hops.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
numberOfRouteHops:
description: 'Result parameter indicating the number of hops within the discovered route.
If a route could not be determined, this value shall be zero.'
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
responseTime:
description: 'Result parameter indicating the response time in milliseconds the most recent trace route test.
If a route could not be determined, this value shall be zero.'
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
timeout:
description: Timeout in milliseconds for the trace route test.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
required:
- diagnosticsState
type: object
x-etsi-ref: 6.5.5
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
UploadDiagnostics.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_PasswordRequestFailed. 7 = Error_LoginFailed. 8 = Error_NoTransferMode. 9 = Error_NoPASV. 10 = Error_NoCWD. 11 = Error_NoSTOR.12 = Error_NoTransferComplete.'
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
UploadDiagnostics:
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/UploadDiagnostics.diagnosticsState'
eOMTime:
# description': End of transmission 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'
rOMTime:
# description': Request 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'
tCPOpenReponseTime:
# description': Response 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'
tCPOpenRequestTime:
# description': Request 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'
testBytesSent:
description: The test traffic sent in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between bOMTime and eOMTime.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
testFileLength:
description: 'The size of the file (in bytes) to be uploaded to the
server.'
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
uploadURI:
description: The URI for the device to perform the upload to.
format: uri
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: URI
required:
- diagnosticsState
type: object
x-etsi-ref: 6.5.7