Newer
Older
info:
title: "ETSI GS MEC 029 Fixed Access Information API"
version: 2.1.1
description: "ETSI GS MEC 029 Fixed Access Information API described using OpenAPI."
license:
name: BSD-3-Clause
url: https://forge.etsi.org/rep/mec/gs029-fai-api
externalDocs:
description: "ETSI GS MEC 029 Fixed Access Information API, v2.1.1"
url: "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/029/02.01.01_60/gs_mec029v020101p.pdf"
/queries/fa_info:
get:
tags:
- "Queries"
summary: "Retrieve information on the available fixed access networks."
description: "Retrieve information on the available fixed access networks."
operationId: fa_infoGET
parameters:
type: array
items:
$ref: "#/components/schemas/CpInfo"
description: "Comma separated list of customer premises information"
- in: query
name: lastMileTech
schema:
type: array
items:
description: "Comma separated list of last mile technologies."
- in: query
name: interfaceType
schema:
type: array
items:
type: integer
description: "Comma separated list of interface types."
description: "Comma separated list of the bandwidth (in Mbps) from the network towards the customer site."
description: "Comma separated list of the bandwidth (in Mbps) from the customer site towards the network."
- in: query
name: latency
schema:
type: array
items:
description: "Comma separated list of the maximum baseline latency (in ms) between customer site and service edge node."
responses:
"200":
description: "A response body containing the FAI is returned. "
$ref: "#/components/schemas/FaInfo"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"406":
$ref: "#/components/responses/406"
"429":
$ref: "#/components/responses/429"
/queries/device_info:
get:
tags:
- "Queries"
summary: "retrieve information on the devices that are connected to a fixed access network."
description: "retrieve information on the devices that are connected to a fixed access network."
operationId: device_infoGET
parameters:
description: "Comma separated list of gateway identifier"
- in: query
name: deviceId
schema:
type: array
items:
description: "Comma separated list of device identifier."
- in: query
name: deviceStatus
schema:
type: array
items:
type: integer
description: "Comma separated list of device status."
responses:
"200":
description: "A response body containing the device information is returned"
$ref: "#/components/schemas/DeviceInfo"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"406":
$ref: "#/components/responses/406"
"429":
$ref: "#/components/responses/429"
/queries/cable_line_info:
get:
tags:
- "Cable line info"
summary: "It Queries information about the cable line of a fixed access network."
description: "It Queries information about the cable line of a fixed access network."
operationId: cable_line_infoGET
parameters:
- in: query
name: customerPremisesInfo
schema:
type: array
items:
$ref: "#/components/schemas/CpInfo"
description: "Comma separated list of customer premises information"
- in: query
name: cmId
schema:
type: array
items:
description: "Comma separated list of Cable Modem identifiers."
responses:
"200":
description: "A response body containing the cable line information is returned."
content:
application/json:
schema:
$ref: "#/components/schemas/CableLineInfo"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"406":
$ref: "#/components/responses/406"
"429":
$ref: "#/components/responses/429"
/queries/optical_network_info:
get:
tags:
- "Optical network info"
summary: "used to query information about the optical network."
description: "used to query information about the optical network."
operationId: optical_network_infoGET
parameters:
- in: query
name: customerPremisesInfo
schema:
type: array
items:
$ref: "#/components/schemas/CpInfo"
description: "Comma separated list of customer premises information"
- in: query
name: ponYS_ID
schema:
type: array
items:
description: "Comma separated list of optical system identifiers."
- in: query
name: onuId
schema:
type: array
items:
description: "Comma separated list of optical network unit identifiers."
responses:
"200":
description: "A response body containing the optical network information is returned."
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/PonInfo"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"406":
$ref: "#/components/responses/406"
"429":
$ref: "#/components/responses/429"
/subscriptions:
get:
tags:
- "Subscription"
summary: "request information about the subscriptions for this requestor."
description: "request information about the subscriptions for this requestor."
operationId: subGET
parameters:
- in: query
name: subscription_type
schema:
description: "Query parameter to filter on a specific subscription type. Permitted values: ONU_ALARM. DEVICE_ABNORMAL_ALERT. CM_CONNECTIVITY_STATE. ANI_ALARM."
responses:
"200":
description: "A response body containing the list of links to requestor subscriptions is returned."
content:
application/json:
schema:
$ref: "#/components/schemas/SubscriptionLinkList"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"406":
$ref: "#/components/responses/406"
"429":
$ref: "#/components/responses/429"
post:
tags:
- "Subscription"
summary: " create a new subscription to FAI notifications."
description: " create a new subscription to FAI notifications."
operationId: subPOST
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/OnuAlarmSubscription"
- $ref: "#/components/schemas/DevInfoSubscription"
- $ref: "#/components/schemas/CmConnSubscription"
- $ref: "#/components/schemas/AniAlarmSubscription"
responses:
"201":
description: "In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/OnuAlarmSubscription"
- $ref: "#/components/schemas/DevInfoSubscription"
- $ref: "#/components/schemas/CmConnSubscription"
- $ref: "#/components/schemas/AniAlarmSubscription"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"406":
$ref: "#/components/responses/406"
"415":
$ref: "#/components/responses/415"
"422":
$ref: "#/components/responses/422"
"429":
$ref: "#/components/responses/429"
callbacks:
notification:
"{$request.body#/callbackReference}":
summary: "Callback POST used to send a notification"
description: "A notification from FAIS."
operationId: notificationPOST
requestBody:
description: Subscription notification
required: true
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/OnuAlarmNotification"
- $ref: "#/components/schemas/DevInfoNotification"
- $ref: "#/components/schemas/CmConnNotification"
- $ref: "#/components/schemas/AniAlarmNotification"
"204":
$ref: "#/components/responses/204"
/subscriptions/{subscriptionId}:
parameters:
- in: path
name: subscriptionId
description: "Refers to created subscription, where the FAI API allocates a unique resource name for this subscription"
schema:
type: string
required: true
- "Subscription"
summary: "Retrieve information about this subscription."
description: "Retrieve information about this subscription."
operationId: individualSubscriptionGET
"200":
description: "A response body containing data type describing the specific FAI event subscription is returned"
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/OnuAlarmSubscription"
- $ref: "#/components/schemas/DevInfoSubscription"
- $ref: "#/components/schemas/CmConnSubscription"
- $ref: "#/components/schemas/AniAlarmSubscription"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"406":
$ref: "#/components/responses/406"
"429":
$ref: "#/components/responses/429"
- "Subscription"
summary: "Used to update the existing subscription."
description: "Used to update the existing subscription."
operationId: individualSubscriptionPUT
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/OnuAlarmSubscription"
- $ref: "#/components/schemas/DevInfoSubscription"
- $ref: "#/components/schemas/CmConnSubscription"
- $ref: "#/components/schemas/AniAlarmSubscription"
"200":
description: "A response body containing data type describing the updated subscription is returned"
content:
application/json:
schema:
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
oneOf:
- $ref: "#/components/schemas/OnuAlarmSubscription"
- $ref: "#/components/schemas/DevInfoSubscription"
- $ref: "#/components/schemas/CmConnSubscription"
- $ref: "#/components/schemas/AniAlarmSubscription"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"406":
$ref: "#/components/responses/406"
"412":
$ref: "#/components/responses/412"
"422":
$ref: "#/components/responses/422"
"429":
$ref: "#/components/responses/429"
- "Subscription"
summary: "Used to cancel the existing subscription."
description: "Used to cancel the existing subscription."
operationId: individualSubscriptionDELETE
responses:
"204":
$ref: "#/components/responses/204"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"429":
$ref: "#/components/responses/429"
description: "Indicates the alarm of the ANI: 0 = LowReceivedOpticalPower. 1 = HighReceivedOpticalPower. 2 = SignalFailure. 3 = SignalDegrade. 4 = LowTransmitOpticalPower.5 = HighTransmitOpticalPower.6 = LaserBiasCurrent."
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
type: integer
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Enum
description: The unique identifiers for the optical network unit.
type: string
description: The index of an access network interface supported by the optical network unit.
type: string
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: String
$ref: "#/components/schemas/AniAlarmNotification.alarm"
$ref: "#/components/schemas/AniAlarmNotification.aniId"
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 "AniAlarmNotification".
type: string
x-etsi-mec-origin-type: String
onuId:
type: string
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
- notificationType
- aniIndex
- 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 =\tLowReceivedOpticalPower.\n(Received downstream optical power below threshold.)\n1 =\tHighReceivedOpticalPower.\n\t(Received downstream optical power above threshold.)\n2 =\tSignalFalure.\n(Bit error-based signal fail.)\n3 =\tSignalDegrade.\n(Bit error-based signal degrade.)\n4 =\tLowTransmitOpticalPower.\n(Transmit optical power below lower threshold.)\n5 =\tHighTransmitOpticalPower.\n(Transmit optical power above upper threshold.)\n6 =\tLaserBiasCurrent.\n(Laser bias current above threshold determined by vendor.)\n-1 =\tAll."
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- -1
type: integer
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
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
description: "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response."
required:
- onuId
- aniId
properties:
customerPremisesInfo:
required:
- onuId
- aniId
description: 0 to N physical locations of the customer sites.
minItems: 0
type: array
items:
$ref: "#/components/schemas/CpInfo"
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: CpInfo
onuId:
description: "1 to N unique identifiers for the optical network units. Typical it is the unique serial number for each ONU, which contains the vendor ID and version number. The first four bytes are an ASCII-encoded four-letter vendor ID. The second four bytes are a binary encoded serial number, under the control of the ONU vendor."
type: array
items:
type: string
x-etsi-mec-cardinality: "1..N"
x-etsi-mec-origin-type: String
aniId:
description: ""
type: object
description: "The unique identifiers for the optical network unit"
type: string
aniIndex:
description: "The index of an access network interface supported by the optical network unit"
type: string
alarms:
type: array
items:
$ref: "#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm.alarms"
description: 'Shall be set to \"AniAlarmSubscription\"'
type: string
$ref: "#/components/schemas/AniAlarmSubscription.links"
aniIndex:
description: The index of an access network interface supported by the optical network unit.
type: string
x-etsi-mec-origin-type: String
callbackReference:
description: URI selected by the service consumer to receive notifications on the subscribed FAIS information. This shall be included both in the request and in response.
format: uri
type: string
x-etsi-mec-origin-type: URI
expiryDeadline:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: "#/components/schemas/AniAlarmSubscription.filterCriteriaAniAlarm"
- subscriptionType
- callbackReference
- filterCriteriaAniAlarm
- onuId
- aniIndex
description: "It describes statistics associated with the Service Flows in a managed device."
properties:
ifIndex:
description: "It represents the interface index of the MAC Domain of the Service Flow"
type: string
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: String
serviceFlowInfo:
type: array
items:
$ref: "#/components/schemas/CableLineInfo.cmInfo.serviceFlowStats.serviceFlowInfo"
type: object
required:
- ifIndex
- serviceFlowInfo
CableLineInfo.cmInfo.serviceFlowStats.serviceFlowInfo:
description: It represents the information of a Service Flow.
properties:
aqmDroppedPkts:
description: For upstream service flows on which AQM is enabled, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to Active Queue Management drop decisions.
type: integer
x-etsi-mec-origin-type: Integer
pkts:
description: For outgoing Service Flows, this attribute counts the number of Packet Data PDUs forwarded to this Service Flow. For incoming upstream CMTS service flows, this attribute counts the number of Packet Data PDUs actually received on the Service Flow identified by the SID for which the packet was scheduled.
type: integer
x-etsi-mec-origin-type: Integer
policedDelayPkts:
description: It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate.
type: integer
x-etsi-mec-origin-type: Integer
policedDropPkts:
description: "For upstream service flows, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to:\n1)\texceeding the selected Buffer Size for the service flow; or\n2)\tUGS packets dropped due to exceeding the Unsolicited Grant Size with a Request/Transmission policy that requires such packets to be dropped."
type: integer
x-etsi-mec-origin-type: Integer
serviceFlowId:
description: It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.
type: integer
x-etsi-mec-origin-type: Integer
timeActive:
description: It indicates the number of seconds that the service flow has been active.
type: integer
x-etsi-mec-origin-type: Integer
timeCreated:
# description': It indicates the time when the service flow was created.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TimeStamp
- serviceFlowId
- pkts
- timeCreated
- timeActive
- policedDropPkts
- policedDelayPkts
- aqmDroppedPkts
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
description: "It defines the CM connectivity state. Enumeration of: 1 = other. 2 = notReady. 3 = notSynchronized. 4 = phySynchronized. 5 = usParametersAcquired. 6 = rangingComplete. 7 = dhcpV4Complete. 8 = todEstablished. 9 = securityEstablished. 10 = configFileDownloadComplete. 11 = registrationComplete. 12 = operational. 13 = accessDenied. 14 = eaeInProgress. 15 = dhcpv4InProgress. 16 = dhcpv6InProgress. 17 = dhcpV6Complete. 18 = registrationInProgress. 19 = bpiInit. 20 = forwardingDisabled. 21 = dsTopologyResolutionInProgress. 22 = rangingInProgress. 23 = rfMuteAll."
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
type: integer
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Enum
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
description: It provides CM connectivity status information of the CM.
properties:
cmRegState:
$ref: "#/components/schemas/CableLineInfo.cmInfo.cmStatus.cmRegState"
emDlsOperStatus:
description: It indicates whether the CM is currently operating in Energy Management DLS Mode.
type: boolean
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Boolean
energyMgt1x1OperStatus:
description: It indicates whether the CM is currently operating in Energy Management 1x1 Mode.
type: boolean
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Boolean
ifIndex:
description: It denotes the MAC Domain interface index of the CM.
type: string
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: String
invalidRegRsps:
description: It denotes the number of times the CM received invalid registration response messages.
type: integer
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Integer
lostSyncs:
description: It denotes the number of times the CM lost synchronization with the downstream channel.
type: integer
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Integer
resets:
description: It denotes the number of times the CM reset or initialized this interface.
type: integer
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Integer
required:
- ifIndex
- cmRegState
- resets
- lostSyncs
- invalidRegRsps
- energyMgt1x1OperStatus
- emDlsOperStatus
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
description: It represents the DOCSIS Path Verify Statistics collected in the cable modem device.
properties:
avgLatency:
description: The average latency measurement.
type: integer
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Integer
ifIndex:
description: It represents the interface Index of the Downstream Interface where the measurements are taken.
type: string
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: String
lastMeasLatency:
description: The last latency measurement.
type: integer
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Integer
lastMeasTime:
# description': The last measurement time of the last latency measurement.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TimeStamp
$ref: "#/components/schemas/TimeStamp"
maxLatency:
description: The maximum latency measurement.
type: integer
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Integer
minLatency:
description: The minimum latency measurement.
type: integer
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Integer
numMeas:
description: The number of latency measurements made.
type: integer
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: Integer
required:
- ifIndex
- lastMeasLatency
- lastMeasTime
- minLatency
- maxLatency
- avgLatency
- numMeas
description: ""
properties:
cmDpvStats:
type: array
items:
$ref: "#/components/schemas/CableLineInfo.cmInfo.cmDpvStats"
cmId:
description: "Information (typically the serial number) to identify a Cable Modem at subscriber locations intended for use in conveying data communications on a cable data system.This value SHALL remain fixed over the lifetime of thedevice, including across firmware updates."
type: string
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: String
cmStatus:
$ref: "#/components/schemas/CableLineInfo.cmInfo.cmStatus"
serviceFlowStats:
type: array
items:
$ref: "#/components/schemas/CableLineInfo.cmInfo.serviceFlowStats"
required:
- cmId
properties:
cmInfo:
$ref: "#/components/schemas/CableLineInfo.cmInfo"
customerPremisesInfo:
# description': The physical location of a customer site.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': CpInfo
$ref: "#/components/schemas/CpInfo"
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: "#/components/schemas/TimeStamp"
type: object
required:
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."
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
description: ""
items:
type: object
properties:
cmId:
description: The Cable Modem identifier.
type: string
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: String
cmRegState:
items:
$ref: "#/components/schemas/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
properties:
cmIf:
type: array
items:
$ref: "#/components/schemas/CmConnNotification.cmIf"
customerPremisesInfo:
# description': The physical location of a customer site.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': CpInfo
$ref: "#/components/schemas/CpInfo"
notificationType:
description: 'Shall be set to \"CmconnNotification\".'
type: string
x-etsi-mec-cardinality: "1"
x-etsi-mec-origin-type: String
timeStamp:
# description': Time stamp.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': TimeStamp
$ref: "#/components/schemas/TimeStamp"
type: object
x-etsi-ref: 6.4.4
description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
properties:
self:
# description': Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LinkType
$ref: "#/components/schemas/LinkType"
required:
- self
type: object
x-etsi-mec-cardinality: 0..1
CmConnSubscription.filterCriteriaCmConn.cmIf.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
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
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:
# 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