About this Resource

Modified: for 2.0.0

Defines a FXS Port resource which controls the FXS 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
RxGainYesYesint-6Possible values:
  • -11 - Minimum
  • 0 - Maximum
Specifies a relative gain adjustment in decibels based on the country profile selected.
TxGainYesYesint0Possible values:
  • -5 - Minimum
  • 5 - 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.
LocalLoopTypeYesYesEnum0Possible values:
  • 0 - llLengthStandard
  • 1 - llLengthLong
Specifies FXS local loop type. Supported loop types are Standard for cable length of up to 1000 meters and Long for cable length of up to 3000 meters.

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_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