FixedAccessInformationServiceAPI_TypesAndValues.ttcn 17.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
module FixedAccessInformationServiceAPI_TypesAndValues {
  
  // JSON
  import from JSON all;
  
  // LibCommon
  import from LibCommon_BasicTypesAndValues all;
  
  /**
   * @desc The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
   */
  type UInt32 Seconds;

  /**
   * @desc The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
   */
  type UInt32 NanoSeconds;

  /**
   * @desc
   * @member seconds The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
   * @member nanoSeconds The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
   */
  type record TimeStamp {
    Seconds seconds,
    NanoSeconds nanoSeconds
  }
  
  /**
   * @desc This type represents the fixed access information.
   * @member timeStamp Time stamp.
   * @member customerPremisesInfo The physical location of a customer site.
   * @member connectivityInfo The per connectivity domain fixed access information.
   */
  type record FaInfo {
    TimeStamp timeStamp optional,
    CpInfo customerPremisesInfo,
    ConnectivityInfo connectivityInfo optional
  }
  
  /**
   * @desc The per connectivity domain fixed access information.
   * @member LastMileTech An informative field identifying the last mile access technology used.
   * @member InterfaceType The physical interface used for the end customer site – as defined in IEEE802, ITU, Broadband Forum.
   * @member dsbw The bandwidth (in Mbps) from the network towards the customer site.
   * @member usbw The bandwidth (in Mbps) from the  customer site towards the network.
   * @member latency Maximum baseline latency (in ms) between customer site and service edge node.
   */
  type record ConnectivityInfo {
    LastMileTech lastMileTech optional,
    InterfaceType interfaceType,
    JSON.Number dsbw optional,
    JSON.Number usbw optional,
    JSON.Number latency optional
  }
  
  /**
   * @desc An informative field identifying the last mile access technology used.
   */
  type enumerated LastMileTech {
    ADSL,
    VDSL,
    GPON,
    XGPON,
    NGPON2,
    XGSPON,
    GFAST,
    P2PEthernet
  }

  /**
   * @desc The physical interface used for the end customer site – as defined in IEEE802, ITU, Broadband Forum.
   */
  type enumerated InterfaceType {
    e_100BASE_TX,
    e_1000BASE_TX,
    e_1000BASE_LX,
    e_1000BASELX10,
    e_1000BASEBX10,
    e_1000BASE_LH,
    e_1000Base_ZX,
    ADSL_RJ11,
    VDSL_RJ11,
    GPON
  }
  
  /**
   * @desc Latitude (DATUM=WGS84) -90 to 90 in decimal degree format DDD.ddd
   */
  type JSON.Number Latitude;
  
  /**
   * @desc Longitude (DATUM=WGS84) -180 to 180 in decimal degree format DDD.ddd
   */
  type JSON.Number Longitude;
  
  /**
   * @desc Postal code for the location
  */
  type JSON.String PostalCode;
  
  type record CpInfo_{
    Latitude latitude optional,
    Longitude longitude optional,
    PostalCode postalCode optional
  }
  type record of CpInfo_ CpInfo;
  
  /**
   * @desc This type represents the information of the device that is connected to a fixed access network.
   * @member timeStamp Time stamp.
   * @member gwId Information (typically the serial number) to identify an Internet Gateway Device through which the customer premises device is connected.
   * @member deviceId Typically, the serial number of the device.
   * @member deviceStatus Current operational status of the device.
   * @member upTime Time in seconds since the device was last restarted
   * @member iPConnectionUpTime The time in seconds that the IP interface has been connected.
   * @member totalBytesSent Total number of IP payload bytes sent since the device was last restarted
   * @member totalBytesReceived Total number of IP payload bytes received since the device was last restarted
   * @member totalPacketsSent Total number of packets sent since the device was last restarted
   * @member totalPacketsReceived Total number of packets received since the device was last restarted
   * @member iPPingDiagnostics The result of an IP-layer ping test 
   * @member traceRouteDiagnostics The result of an IP-layer trace-route test
   * @member downloadDiagnostics The result of a HTTP and FTP DownloadDiagnostics Test
   * @member uploadDiagnostics The result of a HTTP and FTP UploadDiagnostics Test
   */
  type record DeviceInfo {
    TimeStamp timeStamp optional,
    GatewayId gwId,
    DeviceId deviceId optional,
    DeviceStatus deviceStatus,
    JSON.Number upTime,
    JSON.Number iPConnectionUpTime,
    JSON.Number totalBytesSent,
    JSON.Number totalBytesReceived,
    JSON.Number totalPacketsSent,
    JSON.Number totalPacketsReceived,
    IPPingDiagnostics iPPingDiagnostics optional,
    TraceRouteDiagnostics traceRouteDiagnostics optional,
    DownloadDiagnostics downloadDiagnostics optional,
    UploadDiagnostics uploadDiagnostics optional
  }
  
  /**
   * @desc Information (typically the serial number) to identify an Internet Gateway Device through which the customer premises device is connected.
   */
  type record of JSON.String GatewayId;
  
  /**
   * @desc Typically, the serial number of the device.
   */
  type record of JSON.String DeviceId;
  
  /**
   * @desc Current operational status of the device.
   */
  type enumerated DeviceStatus {
    Up,
    Initializing,
    Error,
    Disabled
  }
  
  type record IPPingDiagnostics {}
  type record TraceRouteDiagnostics {}
  type record DownloadDiagnostics{}
  type record UploadDiagnostics {}
  
  /**
   * @desc This type represents the information of the cable line of a fixed access network
   * @member timeStamp Time stamp.
   * @member customerPremisesInfo The physical location of a customer site.
   * 
   */
  type record CableLineInfo {
    TimeStamp timeStamp optional,
    CpInfo customerPremisesInfo,
    CmdInfo cmdInfo
  }
  
  /**
   * @desc 
   * @member cmdId 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.
   * @member cmStatus It provides CM connectivity status information of the CM.
   * @member cmDpvStats It represents the DOCSIS Path Verify Statistics collected in the cable modem device.
   * @member serviceFlowStats It describes statistics associated with the Service Flows in a managed device.
   */
  type record CmdInfo_ {
    CmdId cmdId,
    CmStatus cmStatus optional,
    CmDpvStats cmDpvStats optional,
    ServiceFlowStats serviceFlowStats optional
  }
  type record of CmdInfo_ CmdInfo;
  
  /**
   * @desc 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.
   */
  type JSON.String CmdId;
  
  /**
   * @desc It provides CM connectivity status information of the CM.
   * @member ifIndex It denotes the MAC Domain interface index of the CM.
   * @member It defines the CM connectivity state.
   * @member resets It denotes the number of times the CM reset or initialized this interface.
   * @member lostSyncs It denotes the number of times the CM lost synchronization with the downstream channel.
   * @member invalidRegRsps It denotes the number of times the CM received invalid registration response messages.
   * @member energyMgt1x1OperStatus It indicates whether the CM is currently operating in Energy Management 1x1 Mode
   * @member emDlsOperStatus It indicates whether the CM is currently operating in Energy Management DLS Mode
   */
  type record CmStatus_ {
    IfIndex ifIndex,
    CmRegState cmRegState,
    JSON.Number resets,
    JSON.Number lostSyncs,
    JSON.Number invalidRegRsps,
    JSON.Bool energyMgt1x1OperStatus,
    JSON.Bool emDlsOperStatus
  }
  type record of CmStatus_ CmStatus;
  
  /**
   * @desc It denotes the MAC Domain interface index of the CM.
   */
  type JSON.String IfIndex;
  
  /**
   * @desc It defines the CM connectivity state.
   */
  type enumerated CmRegState {
    other,
    notReady,
    notSynchronized,
    phySynchronized,
    usParametersAcquired,
    rangingComplete,
    dhcpV4Complete,
    todEstablished,
    securityEstablished,
    configFileDownloadComplete,
    registrationComplete,
    operational,
    accessDenied,
    eaeInProgress,
    dhcpv4InProgress,
    dhcpv6InProgress,
    dhcpV6Complete,
    registrationInProgress,
    bpiInit,
    forwardingDisabled,
    dsTopologyResolutionInProgress,
    rangingInProgress,
    rfMuteAll
  }
  
  /**
   * @desc It represents the DOCSIS Path Verify Statistics collected in the cable modem device.
   * @member ifIndex It denotes the MAC Domain interface index of the CM.
   * @member lastMeasLatency The last latency measurement.
   * @member lastMeasTime the last measurement time of the last latency measurement.
   * @member minLatency  the minimum latency measurement.
   * @member maxLatency  the maximum latency measurement.
   * @member avgLatency  the average latency measurement.
   * @member numMeas The number of latency measurements made.
   */
  type record CmDpvStats_ {
    IfIndex ifIndex,
    JSON.Number lastMeasLatency,
    TimeStamp lastMeasTime,
    JSON.Number minLatency,
    JSON.Number maxLatency,
    JSON.Number avgLatency,
    JSON.Number numMeas
  }
  type record of CmDpvStats_ CmDpvStats;
  
  /**
   * @desc It describes statistics associated with the Service Flows in a managed device.
   * @member ifIndex It denotes the MAC Domain interface index of the CM.
   * @member serviceFlowInfo It represents the information of a Service Flow.
   */
  type record ServiceFlowStats_ {
    IfIndex ifIndex,
    ServiceFlowInfo serviceFlowInfo
  }
  type record of ServiceFlowStats_ ServiceFlowStats;
  
  /**
   * @desc It represents the information of a Service Flow.
   * @member ifIndex It denotes the MAC Domain interface index of the CM.
   * @member serviceFlowId It represents an identifier assigned to a Service Flow by CMTS within a MAC Domain.
   * @member pkts 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.
   * @member timeCreated It indicates the time when the service flow was created.
   * @member timeActiveIt Indicates the number of seconds that the service flow has been active.
   * @member policedDropPkts 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.
   * @member policedDelayPkts It counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate.
   * @member aqmDroppedPkts 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 record ServiceFlowInfo_ {
    JSON.Number serviceFlowId,
    JSON.Number pkts,
    TimeStamp timeCreated,
    JSON.Number timeActive,
    JSON.Number policedDropPkts,
    JSON.Number policedDelayPkts,
    JSON.Number aqmDroppedPkts
  }
  type record of ServiceFlowInfo_ ServiceFlowInfo;
  
  /**
   * @desc This type represents the information of the of an optical network (e.g., G-PON, XG-PON, NG-PON2, XGS-PON).
   * @member timeStamp Time stamp.
   * @member customerPremisesInfo The physical location of a customer site.
   * @member ponSYS_ID The 20-bit identity of the optical system within a certain domain.
   * @member opticalNetworkInfo 
   */
  type record PonInfo {
    TimeStamp timeStamp optional,
    CpInfo customerPremisesInfo,
    PonSYS_ID ponSYS_ID,
    OpticalNetworkInfo opticalNetworkInfo
  }
  
  type JSON.String PonSYS_ID;
  
  /**
   * @desc This type represents the information of the of an optical network (e.g., G-PON, XG-PON, NG-PON2, XGS-PON).
   * @member onuId Information to identify an Optical Network Unit.
   * @member ponTech An informative field identifying the optical technology used.
   * @member operationalState It reports whether the ONU is currently capable of performing its function.
   * @member dsRate Downstream line rate
   * @member usRate Upstream line rate
   */
  type record OpticalNetworkInfo_ {
    OnuId onuId,
    PonTech ponTech,
    OperationalState operationalState,
    DsRate dsRate,
    UsRate usRate
  }
  type record of OpticalNetworkInfo_ OpticalNetworkInfo;
  
  /**
   * @desc Information to identify an Optical Network Unit.
   */
  type JSON.String OnuId;
  type record of OnuId OnuIds;
  
  /**
   * @desc An informative field identifying the optical technology used.
   */
  type enumerated PonTech {
    GPON,
    XGPON,
    NGPON2,
    XGSPON
  }
  
  /**
   * @desc It reports whether the ONU is currently capable of performing its function.
   */
  type enumerated OperationalState {
    enabled,
    disabled
  }
  
  /**
   * @desc Upstream line rate
   */
  type enumerated DsRate {
    e_ds_one, // 1 = 2.48832 Gbit/s: G-PON [i.9] or NG-PON2 option 2 [i.8]
    e_ds_two  // 9.95328 Gbit/s:  XG-PON [i.10] or XGS-PON [i.11] or NG-PON2 option 1 [i.8]
  }
  
  /**
   * @desc Upstream line rate
   */
  type enumerated UsRate {
    e_us_one, // 1 = 1.24416 Gbit/s: G-PON option 1 [i.9]
    e_us_two, // 2 = 2.48832 Gbit/s: G-PON option 2 [i.9] or XG-PON [i.10] or NG-PON2 option 2 [i.8]
    e_us_three // 9.95328 Gbit/s: XGS-PON [i.11]
  }
  
  /**
   * @desc Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
   * @member self_ Self referring URI. The URI shall be unique within the FAI API as it acts as an ID for the subscription.
   */
  type record Links {
    LinkType self_
  } with {
    variant (self_) "name as 'self'";
  }
  
  /**
   * @desc This type represents a type of link and may be referenced from data structures.
   */
  type record LinkType {
    Href href
  }
  
  /**
   * @desc URI referring to a resource.
   */
  type JSON.String Href;

  /**
   * @desc This type represents a list of links related to currently existing subscriptions for the service consumer.
   * @member links List of hyperlinks related to the resource.
   * @member subscription A link to a subscription.
   */
  type record SubscriptionLinkList {
    Links links,
    Subscriptions subscription optional
  } with {
    variant (links) "name as '_links'";
  }
  
  /**
   * @desc A link to a subscription
   * @member href The URI referring to the subscription.
   * @member subscriptionType Type of subscription
   */
  type record Subscription_ {
    JSON.AnyURI href,
    SubscriptionType subscriptionType
  }
  type record of Subscription_ Subscriptions;
  
  /**
   * @desc Type of subscription
   */
  type enumerated SubscriptionType {
     RESERVED,
     ONU_ALARM,
     DEVICE_ABNORMAL_ALERT,
     CM_CONNECTIVITY_STATE,
     ANI_ALARM
  }
  
  /**
   * @desc This type represents a subscription to ONU alarm notifications from FAIS.
   */
  type record OnuAlarmSubscription {
    JSON.String subscriptionType,
    JSON.AnyURI callbackReference,
    Links links optional,
    FilterCriteriaOnuAlarm filterCriteriaOnuAlarm,
    TimeStamp expiryDeadline optional
  } with {
    variant (links) "name as '_links'";
  }
  
  /**
   * @desc 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
   * @member customerPremisesInfo Physical locations of the customer sites
   * @member onuId Unique identifiers for the optical network units.
   * @member In case alarms is not included in the subscription request, the default value -1 = All shall be used and included in the response.
   */
  type record FilterCriteriaOnuAlarm {
    CpInfo customerPremisesInfo optional,
    OnuIds onuId,
    Alarms alarms optional
  }
  
  /**
   * @desc 
   */
  type enumerated Alarm {
    EquipmentAlarm, // (Functional failure on an internal interface)
    PoweringAlarm, // (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.)
    BatteryMissing, // (Battery is provisioned but missing)
    BatteryFailure, // (Battery is provisioned and present but cannot recharge)
    BatteryLow, // (Battery is provisioned and present but its voltage is too low)
    PhysicalIntrusion, // (Applies if the ONU supports detection such as door or box open)
    OnuSelfTestFailure, // (ONU has failed autonomous self-test)
    DyingGasp, // ()ONU is powering off imminently due to loss of power to the ONU itself.)
    TemperatureYellow, // (No service shutdown at present, but the circuit pack is operating beyond its recommended range.)
    TemperatureRed, // ()Some services have been shut down to avoid equipment damage.)
    VoltageYellow, // (No service shutdown at present, but the line power voltage is below its recommended minimum.)
    VoltageRed, // (Some services have been shut down to avoid power collapse.)
    OnuManualPowerOff, // (The ONU is shutting down because the subscriber has turned off its power switch.)
    InvImage, // (Software image is invalid)
    PseOverloadYellow, // (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.)
    PseOverloadRed, //(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.)
    All
  }
  type record of Alarm Alarms;
  
} // End of module FixedAccessInformationServiceAPI_TypesAndValues