Newer
Older
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:
# 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"
$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-origin-type: URI
expiryDeadline:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: "#/components/schemas/CmConnSubscription.filterCriteriaCmConn"
subscriptionType:
description: Shall be set to "CmConnSubscription".
type: string
- 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:
-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:
-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-origin-type: String
notificationType:
description: Shall be set to "DevInfoNotification".
type: string
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
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
$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-origin-type: URI
expiryDeadline:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: "#/components/schemas/DevInfoSubscription.filterCriteriaDevInfo"
subscriptionType:
description: Shall be set to "DevInfoSubscription".
type: string
- subscriptionType
- callbackReference
- filterCriteriaDevInfo
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
description: "Typically, the serial number of the device.This value shall remain fixed over the lifetime of the device, including across firmware updates."
x-etsi-mec-cardinality: 0..1
$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"
description:
"Information (typically the serial number) to identify an Internet Gateway Device through which
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-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
totalBytesReceived:
description: Total number of IP payload bytes received since the device was last restarted.
type: integer
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-origin-type: Integer
totalPacketsReceived:
description: Total number of packets received since the device was last restarted.
type: integer
x-etsi-mec-origin-type: Integer
totalPacketsSent:
description: Total number of packets sent since the device was last restarted.
type: integer
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-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"
- 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/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
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
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
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
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:
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"
$ref: "#/components/schemas/ExpiryNotification.links"
expiryDeadline:
# description': Time stamp.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TimeStamp
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
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
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
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
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
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:
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:
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
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
$ref: "#/components/schemas/OnuAlarmNotification.alarm"
customerPremisesInfo:
description: The physical location of the related customer sites.
items:
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-origin-type: String
onuId:
description: The unique identifier for an optical network unit.
type: string
x-etsi-mec-origin-type: String
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
- notificationType
- onuId
- alarm
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
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- -1
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
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
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"
$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-origin-type: URI
expiryDeadline:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: "#/components/schemas/OnuAlarmSubscription.filterCriteriaOnuAlarm"
subscriptionType:
description: Shall be set to \"OnuAlarmSubscription\".
type: string
- subscriptionType
- callbackReference
- filterCriteriaOnuAlarm
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
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
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
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
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
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
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
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
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
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
description: List of hyperlinks related to the resource.
properties:
subscription:
type: array
items:
$ref: "#/components/schemas/SubscriptionLinkList.links.subscription"
$ref: "#/components/schemas/SubscriptionLinkList.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-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
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:
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/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
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
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
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
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
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:
LinkType:
description: >-
'This data type represents a type of link'
type: object
required:
- href
properties:
href:
Href:
description: >-
The URI referring to the subscription.
type: string
ProblemDetails:
properties:
detail:
description: A human-readable explanation specific to this occurrence of the problem
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
instance:
description: A URI reference that identifies the specific occurrence of the problem