Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
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
"description": "The last latency measurement",
"type": "integer"
},
"lastMeasTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"minLatency": {
"description": "The minimum latency measurement.",
"type": "integer"
},
"maxLatency": {
"description": "The maximum latency measurement.",
"type": "integer"
},
"avgLatency": {
"description": "The average latency measurement.",
"type": "integer"
},
"numMeas": {
"description": "The number of latency measurements made.",
"type": "integer"
}
}
},
"CableLineInfo.serviceFlowStats.serviceFlowInfo": {
"type": "object",
"required": [
"serviceFlowId",
"description",
"timeCreated",
"timeActive",
"policedDropPkts",
"policedDelayPkts",
"aqmDroppedPkts"
],
"properties": {
"serviceFlowId": {
"description": "It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.",
"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"
},
"timeCreated": {
"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.",
"$ref": "#/components/schemas/TimeStamp"
},
"timeActive": {
"description": "FIt indicates the number of seconds that the service flow has been active",
"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 1) exceeding the selected Buffer Size for the service flow; or 2) UGS packets dropped due to exceeding the Unsolicited Grant Size with a Request/Transmission policy that requires such packets to be dropped.",
"type": "integer"
},
"policedDelayPkts": {
"description": "It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate.",
"type": "integer"
},
"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"
}
}
},
"CableLineInfo.serviceFlowStats": {
"type": "object",
"required": [
"ifIndex",
"serviceFlowInfo"
],
"ifIndex": {
"description": "It represents the interface index of the MAC Domain of the Service Flow.",
"type": "string"
"serviceFlowInfo": {
"description": "It represents the information of a Service Flow.",
"type": "array",
"$ref": "#/components/schemas/CableLineInfo.serviceFlowStats.serviceFlowInfo"
}
}
},
"CableLineInfo": {
"type": "object",
"required": [
"customerPremisesInfo",
"cmId"
],
"properties": {
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
"customerPremisesInfo": {
"$ref": "#/components/schemas/CpInfo"
"cmId": {
"type": "string",
"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 the device, including across firmware updates."
"cmStatus": {
"$ref": "#/components/schemas/CableLineInfo.cmStatus"
"cmDpvStats": {
"$ref": "#/components/schemas/CableLineInfo.cmDpvStats"
},
"serviceFlowStats": {
"$ref": "#/components/schemas/CableLineInfo.serviceFlowStats"
}
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
"x-etsi-ref": "6.2.4"
},
"CmConnNotification.cmIf.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. 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
],
"type": "integer"
},
"CmConnNotification.cmIf": {
"description": "",
"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/CmConnNotification.cmIf.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": {
"$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": {
"$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": {
"$ref": "#/components/schemas/LinkType"
}
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
"required": [
"self"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1"
},
"CmConnSubscription.filterCriteriaCmConn.cmIf.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"
},
"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/CmConnSubscription.filterCriteriaCmConn.cmIf.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": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CmConnSubscription.filterCriteriaCmConn.cmIf"
"customerPremisesInfo": {
"$ref": "#/components/schemas/CpInfo"
}
"type": "object",
"x-etsi-mec-cardinality": "1"
},
"CmConnSubscription": {
"properties": {
"_links": {
"$ref": "#/components/schemas/CmConnSubscription.links"
},
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
"requestTestNotification": {
"description": "Shall be set to TRUE by the service consumer to request",
"type": "boolean"
},
"websockNotifConfig": {
"description": "Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"$ref": "#/components/schemas/WebsockNotifConfig"
},
"expiryDeadline": {
"$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"
}
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
"required": [
"subscriptionType",
"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"
},
"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": {
"$ref": "#/components/schemas/TimeStamp"
}
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
"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": {
"$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"
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Enum"
},
"deviceId": {
"description": "The device identifier.",
"items": {
"type": "string"
"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"
},
"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"
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
"callbackReference": {
"description": "URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
},
"requestTestNotification": {
"description": "Shall be set to TRUE by the service consumer to request",
"type": "boolean"
},
"websockNotifConfig": {
"description": "Provides details to negotiate and signal the use of a Websocket connection between FAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to FAIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009, clause 6.12a.",
"$ref": "#/components/schemas/WebsockNotifConfig"
},
"expiryDeadline": {
"$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"
}
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
"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": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"deviceStatus": {
"$ref": "#/components/schemas/DeviceInfo.deviceStatus"
},
"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"
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
1556
1557
1558
1559
"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": {
"$ref": "#/components/schemas/IPPingDiagnostics"
},
"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": {
"$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": {
"$ref": "#/components/schemas/UploadDiagnostics"
}
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
"required": [
"gwId",
"deviceId",
"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": {
"$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": "uri",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "URI"
},
"eOMTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"rOMTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"tCPOpenReponseTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"tCPOpenRequestTime": {
"$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": "uri",
"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": {
"$ref": "#/components/schemas/TimeStamp"
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
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
"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": {
"$ref": "#/components/schemas/TimeStamp"
}
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
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
"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.\n\nIf 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"
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
"maximumResponseTime": {
"description": "Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test.\n\nIf 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.\n\nIf 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\npings (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"
}
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
"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": [
0,
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"
"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": {
"$ref": "#/components/schemas/TimeStamp"
}
1916
1917
1918
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
"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": {
"$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"
},
"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"
"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"
},
"WebsockNotifConfig": {
"type": "object",
"properties": {
"subscriptionType": {