About this Resource

Modified: for 2.1.0

Defines a FXO Port resource which controls the FXO Port

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ConfigIEStateNoYesEnum1Possible values:
  • 0 - esDISABLED
  • 1 - esENABLED
Specifies the Administrative State of the resource.
PortNameYesNostringnone128 - Max Length Specifies the string name of the Port.
PortAliasNoNostringnone20 - Max Length Specifies an alias name for the port for easy identification.
PortDescriptionNoNostringnone64 - Max Length Specifies a description for easy identification when being selected in Signaling Groups
RxGainYesYesint6Possible values:
  • -10 - Minimum
  • 10 - Maximum
Specifies a relative gain adjustment in decibels based on the country profile selected.
TxGainYesYesint0Possible values:
  • -10 - Minimum
  • 10 - Maximum
Specifies a relative gain adjustment in decibels based on the country profile selected.
CountryYesYesint33 Specifies the country profile to be used. One of the following: Australia (1), Austria (2), Belgium (3), Brazil (4), China (5), Czech Republic (6), Denmark (7), Finland (8), France (9), Germany (10), Switzerland (11), Greece (12), Hungary (13), India (14), Italy (15), Japan (16), Korea (17), Mexico (18), Netherlands (19), New Zealand (20), Nigeria (21), Norway (22), Portugal (23), Russia (24), Saudi Arabia (25), Slovakia (26), South Africa (27), Spain (28), Sweden (29), Taiwan (30), Turkey (31), United Kingdom (32), United States (33). Must be within the range of 1 to 33, 33 being the default.
RingValidationNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Specifies whether ring validation is to be enabled or disabled by the analog FXO port.
MaxRingFrequencyYesYesint50Possible values:
  • 7 - Minimum
  • 250 - Maximum
 Specifies the upper frequency limit used for ring validation by analog FXO port.
MinRingFrequencyYesYesint15Possible values:
  • 7 - Minimum
  • 250 - Maximum
 Specifies the lower frequency limit used for ring validation by analog FXO port.
RingDetectionThresholdYesYesEnum0Possible values:
  • 0 - prdt17dB
  • 1 - prdt24dB
  • 2 - prdt50dB
Specifies the ring detection threshold of analog FXO port.
ImpedanceYesYesint0Possible values:
  • 0 - Minimum
  • 15 - Maximum
 This parameter matches the impedance presented by local TELCO analog FXO line. The following are valid values: 0-600 ohms 1-900 ohms 2-270 ohms (750 ohms || 150 nF) and 275 ohms (780 ohms || 150 nF) 3-220 ohms (820 ohms || 120 nF) and 220 ohms (820 ohms || 115 nF) 4-370 ohms (620 ohms || 310 nF) 5-320 ohms (1050 ohms || 230 nF) 6-370 ohms (820 ohms || 110 nF) 7-275 ohms (780 ohms || 115 nF) 8-120 ohms (820 ohms || 110 nF) 9-350 ohms (1000 ohms || 210 nF) 10-200 ohms (680 ohms || 100 nF) 11-600 ohms 2.16 uF 12-900 ohms 1 uF 13-900 ohms 2.16 uF 14-600 ohms 1 uF 15- Global Impedance
LocalLoopTypeYesYesint0Possible values:
  • 0 - Minimum
  • 7 - Maximum
 Specifies the EIA line model used to match the local loop to which the FXO analog port connects. The value representations as follows: 0-EIA Type 0 1-EIA Type 1 2-EIA Type 2 3-EIA Type 3 4-EIA Type 4 5-EIA Type 5 6-EIA Type 6 7-EIA Type 7
FXOCalibrationTimeStampNoNoint0 Time stamp when last time the FXO line was calibrated to auto detect Impedence and Local loop type

Runtime

Parameter Name Description Data Type Possible Values
rt_PortOperatorStatus Indicates operational status of the port. EnumPossible values:
  • 0 - psUp
  • 1 - psDown
rt_PortAlarmStatus Displays the alarm status of this port. EnumPossible values:
  • 0 - pasNormal
  • 1 - pasYellow
  • 2 - pasBlue
  • 3 - pasRedLOS
  • 4 - pasRedLOF
  • 5 - pasRelayPassThrough
rt_PortAssertAlarmType Displays the assert alarm type of this port. EnumPossible values:
  • 0 - apatYellow
  • 1 - apatRed
  • 2 - apatNormal
rt_PortLoopbackType Displays the loop back status of the port. EnumPossible values:
  • 0 - pltLocal
  • 1 - pltRemote
  • 2 - pltLine
  • 3 - pltPayload
  • 4 - pltNone
rt_PortTimeatLastOperStatusChange Indicates the last time (in epoch) when the operational status of the port changed. int
rt_PortFXOCalibrationStatus Indicates status of FXO calibration. EnumPossible values:
  • 0 - fcsNone
  • 1 - fcsInProgress
  • 2 - fcsSuccess
  • 3 - fcsFailed
rt_PortLicenseStatus Indicates the license status of a port. EnumPossible values:
  • 0 - ptLicenseUnknown
  • 1 - ptNotLicensed
  • 2 - ptLicensed
  • 3 - ptLicensedDisabled

Statistics

Parameter Name Description Data Type Possible Values
rt_CasPortIncomingCallsAttempted Displays the number of incoming calls attempted. int
rt_CasPortOutgoingCallsAttempted Displays the number of outgoing calls attempted. int
rt_CasPortIncomingCallsConnected Displays the number of incoming calls actually connected. int
rt_CasPortOutgoingCallsConnected Displays the number of outgoing calls actually connected. int
rt_CasPortCountersLastResetTime Displays the time when the call counters were last reset. int
rt_CasBusyHourCallAttempts Displays the BHCA rate for this port. int
rt_CasBusyHourCallCompletions Displays the BHCC rate for this port. int
  • No labels