Northbound interface:Enum Values

Sylvain Fontaine (Talk | contribs)
(Created page with " ==Enums values== ===validation_statuses=== {| border="1" |- ! Value ! Description |- | 'None' | |- | 'Successful' | |- | 'Unknown failure' | |- | 'Timeout occured' ...")
Newer edit →

---

Enums values

validation_statuses

Value	Description
'None'
'Successful'
'Unknown failure'
'Timeout occured'

sig_memory_schemes

Value	Description
'Base'	'Base signaling memory scheme: 8 MTP2, 8 M2PA, 4 M2UA, 8 ISUP, 8 SIP, 8 SCTP. These limits are set initially.'
'MTP2 modifier'	'Overwrite these limits in the base memory scheme: 16 MTP2, 2 M2PA, 2 M2UA. The other limits remain unchanged.'
'SIP modifier'	'Overwrite these limits in the base memory scheme: 16 SIP, 4 SCTP. The other limits remain unchanged.'

virtual_adapter_types

Value	Description
'TDM/IP Gateway'	'TDM/IP Gateway Units'
'TMS'	'TMS Units'
'N+1 Patch Panel'	'N+1 Patch Panel'

line_interface_physical_types

Value	Description
'UNKNOWN'	'Unknown physical Line Interface type'
'OC3_STM1'	'OC3 or STM1 physical Line Interface (optical connector)'
'DS3'	'DS3 physical Line Interface'
'E1_T1_J1'	'E1, T1 or J1 physical Line Interface (either with RJ48 or SCSI connectors)'
'NONE'	'Unit without any TDM Line Interface'

vad_noise_floor_levels

Value	Description
'Auto'
'-96'
'-90'
'-85'
'-80'
'-75'
'-70'
'-65'
'-60'
'-55'
'-50'
'-45'
'-40'
'-35'
'-30'
'-25'
'-20'
'-15'
'-10'
'-5'
'0'

echo_canceller_gain_power_levels

Value	Description
'-140'
'-130'
'-120'
'-110'
'-100'
'-90'
'-80'
'-70'
'-60'
'-50'
'-40'
'-30'
'-20'
'-10'
'0'
'10'
'20'
'30'
'40'
'50'
'60'

volume_control_gain_levels

Value	Description
'-18'
'-14'
'-10'
'-6'
'-5'
'-3'
'0'
'3'
'6'
'10'
'14'
'18'

tone_levels

Value	Description
'-19'
'-15'
'-10'
'-5'
'0'

t38_max_bitrates

Value	Description
'NONE'
'2400'
'4800'
'7200'
'9600'
'12000'
'14400'
'NONE'
'2400'
'4800'
'7200'
'9600'
'12000'
'14400'
'16800'
'19200'
'21600'
'24000'
'26400'
'28800'
'31200'
'33600'

t38_tcf_transfer_modes

Value	Description
'Local'
'Transferred'

voip_passthrough_detect_types

Value	Description
'NONE'	'Fax passthrough will not be detected'
'Silence suppression off'	'The SDP parameter \'a=silenceSupp:off\' will be used to detect fax passthrough'
'G711 only'	'The SDP parameter containing only one G711 codec will be used to detect fax passthrough'

voip_passthrough_codecs

Value	Description
'PCMU'
'PCMA'

fax_relay_detection_modes

Value	Description
'Standard'	'Fax tones and T.38 re-invites will trigger fax relay mode. Modem tones and passthrough re-invites will trigger passthrough mode, though fax detection will still continue.'
'Use relay mode on any tone'	'Both fax and modem tones will immediately cause switch to the chosen relay mode (without going to passthrough first for modem tones).'
'Always relay'	'Calls are directly invited using the specified relay mode, without waiting for any fax/modem tone. This improves performance when the calls are know to always be fax or modem (e.g. when connecting with a fax server).'

fax_relay_modes

Value	Description
'T.38'	'For FAX: Use T.38 but fallback to passthrough if T.38 is refused. For Modem: Use passthrough.'
'Passthrough'	'Use passthrough to relay FAX or Modem.'

adapter_oam_target_states

Value	Description
'Disabled'	'Unit is disabled (not used, and backup unit shall not takeover this unit)'
'Maintenance'	'Unit is in maintenance (not used, but backup unit can takeover this unit)'
'Enabled'	'Unit is enabled'
'Fault'	'Fault detected, the unit has been marked as unusable by Toolpack'

adapter_oam_current_states

Value	Description
'Unknown'	'Current state is unknown (not been updated in the database by responsible application yet)'
'Not present'	'The unit is not present (not connected yet)'
'Configuring'	'The unit is being configured'
'Ready'	'The unit is present and ready'
'Ready (backup)'	'The unit is present and ready as the standby unit of a redundant group'
'Management'	'The unit is present, but in management state (will not be used for any call)'
'Going management'	'The unit is present, but going management (waiting until there is no more calls on this unit)'
'Management idle'	'The unit is present, no more calls on it, and is waiting to be cleared'
'Fault'	'Failure state, the unit is not working properly after excessive retry'

adapter_statuses

Value	Description
'Up'
'Down'

tdm_compandings

Value	Description
'uLaw'	'uLaw format is used on the TDM bus'
'aLaw'	'aLaw format is used on the TDM bus'

voip_codec_assignation_modes

Value	Description
'Mixed Mode'	'Mixed mode codec assignation algorithm type'
'Fixed Mode'	'Fixed mode codec assignation algorithm type (amount of each codec specified)'

np1_group_functional_states

Value	Description
'Fault'	'Group has a \'Fault\' (some Units down and not replaced by the backup Unit)'
'Unprotected'	'Group is unprotected (backup Unit missing, or patch panel not ready to handle a switch)'
'Unprotected (switched to backup)'	'Group is unprotected and switched (backup Unit is replacing a primary Unit which is not actually ready to be re-activated)'
'Healthy'	'Group is healthy, using primary Unit (all primary Units are active, backup Unit is ready to take over)'
'Healthy (backup active)'	'Group is healthy, using backup Unit (backup Unit is active, replaced primary Unit is ready to take over)'

ip_interface_presences

Value	Description
'Unknown'
'Present'
'Not present'

ip_interface_service_types

Value	Description
'RTP'	'RTP'
'SIP'	'SIP'
'SIGTRAN'	'SIGTRAN'
'MANAGEMENT'	'MANAGEMENT'
'H248/RADIUS'	'H248'
'TUNNEL'	'TUNNEL'

ip_interface_port_statuses

Value	Description
'Up'
'Down'

ip_interface_port_rates

Value	Description
'1Gbps'
'100Mbps'
'10Mbps'

ip_interface_port_duplexes

Value	Description
'Full-duplex'
'Half-duplex'

tunnel_types

Value	Description
'PPPoE'	'PPPoE'

sdp_gen_options

Value	Description
'No session level connection'	'Session level connection line (\'c=IN IP4 ...\') will be omitted'
'Omit carriage return (OBSOLETE)'	'Endlines in the generated SDP will not contain the carriage return character'
'Generate all SDP parameters'	'All parameters in the SDP will be generated, even when default value is used (makes SDP much longer, may cause problem over UDP)'
'Use NSE instead of X-NSE in the NSE MIME'	'Use NSE instead of X-NSE in the NSE MIME'

sdp_combine_options

Value	Description
'Use sender\'s codec order'	'Sender\'s codec order will be used in the local/remote SDP combine result'
'Ignore incompatible codec parameters'	'The local/remote SDP combine result will also keep codecs with codec-specific options that don\'t match)'
'Overlook transport directions'	'The local/remote SDP combine will ignore sendonly or recvonly indications'

call_supp_info_types

Value	Description
'Don\'t forward'	'Don\'t forward to the SS7 network'
'SS7 Suspend/Resume'	'Suspend/Resume ISUP messages on the SS7 network'
'SS7 Remote Hold/Retrieval'	'Call progress (CPG) with generic notification indicator indicating remote hold/retrieval (Q.763 section 3.25)'

hop_counter_handlings

Value	Description
'Don\'t forward'	'Don\'t forward the incoming leg\'s hop counter (max fowards) to this outgoing leg'
'Forward'	'Forward the incoming leg\'s hop counter (max fowards) to the outgoing this (without decrementing)'
'Decrement and forward'	'Decrement and forward the incoming leg\'s hop counter (max fowards) to this outgoing leg. Drop the call if value reached 1'

outgoing_early_media_modes

Value	Description
'Automatic early media detection'	'Rely on indications in outgoing call\'s signaling to determine if early media is present or not.'
'Always assume early media is present'	'Consider early media always present on outgoing calls using this profile, no matter what\'s indicated by the signaling.'
'Always ignore early media'	'Always ignore any early media present on outgoing calls using this profile, no matter what\'s indicated by the signaling.'

incoming_early_media_modes

Value	Description
'Forward from outgoing to incoming call'	'Forward early media indication from outgoing call to corresponding incoming call, if present.'
'Forward if present, otherwise play ring tone'	'Forward early media indication from outgoing call to corresponding incoming call, if present. Play ring tone to incoming call if corresponding outgoing call does not have early media.'
'Always play ring tone'	'Always play a ring tone on the incoming call, no matter if there is early media indication on the corresponding outgoing call.'
'Never forward early media'	'Disable early media on incoming call no matter if there is early media on corresponding outgoing call.'

ring_tone_start_states

Value	Description
'Immediately'	'Ring tone starts (on incoming call) immediately'
'Call Accepted'	'Ring tone starts (on incoming call) once outgoing call is accepted'
'Call Progress Received'	'Ring tone starts (on incoming call) once \'Call Progress\' is received on the outgoing call'
'Call Alerted'	'Ring tone starts (on incoming call) once outgoing call is alerted'

outgoing_lnp_modes

Value	Description
'No LNP insertion'	'No LNP field is inserted in the outgoing leg. (Default)'
'Relay LNP information'	'LNP fields are inserted in the outgoing leg only if they were received in the incoming leg.'
'Always insert LNP information'	'LNP fields are inserted in the outgoing leg regardless of their presence in the incoming.'

incoming_lnp_modes

Value	Description
'Terminate LNP'	'Routing is done using the real called party number (not the LRN). LNP fields are ignored for the outgoing leg. (Default)'
'Forward LNP from incoming to outgoing call'	'Routing is done using the LRN when available otherwise the called party number. LNP fields are kept for possible relay on outgoing leg.'
'Ignore LNP information'	'Routing is done using the called party number. LNP fields are ignored for the outgoing leg.'

mlpp_sip_outgoing_modes

Value	Description
'No MLPP insertion'	'No MLPP field is inserted in the SIP outgoing leg. (Default)'
'Relay MLPP information'	'MLPP fields are inserted in the SIP outgoing leg only if they were received in the incoming leg.'
'Always insert MLPP information'	'MLPP fields are inserted in the SIP outgoing leg regardless of their values in the incoming.'

mlpp_ss7_outgoing_modes

Value	Description
'No MLPP insertion'	'No MLPP field is inserted in the outgoing leg. (Default)'
'Relay MLPP information'	'MLPP fields are inserted in the outgoing leg only if they were received in the incoming leg. The missing received parameters will be completed by the default values of this profile.'
'Always insert MLPP information'	'MLPP fields are inserted in the outgoing leg. MLPP fields from the incoming leg will be used if available. The missing received parameters will be completed by the default values of this profile.'
'Forced MLPP information'	'MLPP profile fields are inserted in the outgoing leg. MLPP fields from the incoming leg will be NOT used.'

mlpp_sip_resource_priority_namespaces

Value	Description
'q735'	'Q.735.3 was created to be a commercial version of the operationally equivalent DSN specification for Multi-Level Precedence and Preemption (MLPP)'

mlpp_lfb_modes

Value	Description
'LFB allowed'	'Indicates that the LFB option is allowed.'
'LFB path reserved'	'Indicates that the path for the call is reserved (national use).'
'LFB not allowed'	'Indicates that the LFB option is not allowed.'

mlpp_pl_modes

Value	Description
'PL flash override'	'Indicates that precedence level is flash override (highest).'
'PL flash'	'Indicates that precedence level is flash.'
'PL immediate'	'Indicates that precedence level is immediate.'
'PL priority'	'Indicates that precedence level is priority.'
'PL routine'	'Indicates that precedence level is routine (lowest).'

call_transfer_modes

Value	Description
'Relay'	'Relay call transfer requests from outgoing call leg to incoming call leg (don\'t process locally)'
'Process'	'Process call transfer (un-join outgoing call leg, route and join a new outgoing call leg...)'

info_transfer_caps

Value	Description
'Speech'	'Speech (val=0x00)'
'Digital'	'Unrestricted digital information (val=0x08)'
'Restricted digital'	'Restricted digital information (val=0x09)'
'3.1 kHz audio'	'3.1 kHz audio (val=0x10)'
'Digital with tones'	'Unrestricted digital information with tones/announcements (val=0x11)'
'Video'	'Video (val=0x18)'
'Relay'	'Relay information transfer capability from other leg'

dtmf_types

Value	Description
'Relay DTMF according to RFC2833'
'Relay DTMF in band'
'Relay DTMF using SIP INFO messages'

ring_tone_types

Value	Description
'Don\'t play any tone'	'No call progress tone played'
'Play ring tone'	'Standard ring tone configured in profile'
'Play busy tone'	'Standard busy tone configured in profile'
'Play fast busy (congestion) tone'	'Standard congestion tone configured in profile'
'Play a specific audio file'	'Audio file or audio file list (example: @{PROMPT_PATH}/reason_404.wav:0:0:0)'

cause_types

Value	Description
'Q850 unallocated number'
'Q850 no route to network'
'Q850 no route to destination'
'Q850 send special tone'
'Q850 misdialled trunk prefix'
'Q850 channel unacceptable'
'Q850 call awarded in established channel'
'Q850 preemption'
'Q850 reattempt'
'Q850 ported number'
'Q850 normal call clearing'
'Q850 user busy'
'Q850 no user responding'
'Q850 no answer from user'
'Q850 subscriber absent'
'Q850 call rejected'
'Q850 number changed'
'Q850 redirection'
'Q850 exchange routing error'
'Q850 non selected user clearing'
'Q850 destination out of order'
'Q850 address incomplete'
'Q850 facility rejected'
'Q850 response to status enquiry'
'Q850 normal unspecified'
'Q850 no circuit available'
'Q850 network out of order'
'Q850 frame mode out of service'
'Q850 frame mode connection operational'
'Q850 temporary failure'
'Q850 switching equipment congestion'
'Q850 access information discarded'
'Q850 circuit not available'
'Q850 precedence call blocked'
'Q850 resource unavailable'
'Q850 quality of service not available'
'Q850 requested facility not subscribed'
'Q850 outgoing calls barred'
'Q850 outgoing calls barred within CUG'
'Q850 incoming calls barred'
'Q850 incoming calls barred within CUG'
'Q850 bearer cap not authorized'
'Q850 bearer cap not available'
'Q850 inconsistency access info'
'Q850 service not available'
'Q850 bearer cap not implemented'
'Q850 channel type not implemented'
'Q850 requested facility not implemented'
'Q850 only restricted digital info'
'Q850 service not implemented'
'Q850 invalid call reference'
'Q850 channel does not exist'
'Q850 call identity does not exist'
'Q850 call identity in use'
'Q850 no call suspended'
'Q850 call has been cleared'
'Q850 user not member of CUG'
'Q850 incompatible destination'
'Q850 non existant CUG'
'Q850 invalid transit network'
'Q850 invalid message unspecified'
'Q850 mandatory IE missing'
'Q850 message type non existent'
'Q850 not compatible with call state'
'Q850 IE non existent'
'Q850 invalid IE content'
'Q850 message not compatible'
'Q850 recovery on timer expiry'
'Q850 parameter non existent passed on'
'Q850 msg with non recognized param discarded'
'Q850 protocol error'
'Q850 interworking unspecified'
'Toolpack normal'
'Toolpack resource error'
'Toolpack timeout'
'Toolpack no route'
'Toolpack call collision'
'Toolpack sync drop'
'Toolpack signaling error'
'Toolpack locally rejected'
'Toolpack interface not available'
'Toolpack reset in progress'
'Toolpack rejected by unit'
'Toolpack missing or invalid IE'
'Toolpack incoming only'
'Toolpack system configuration changed'
'Toolpack resource no more available'
'Toolpack incompatible media'
'Toolpack resource allocation failed'
'Toolpack data path not available'
'Toolpack local congestion'
'Toolpack authorization required'
'Toolpack call divert is not allowed'
'300 Multiple Choices'
'301 Moved Permanently'
'302 Moved Temporarily'
'305 Use Proxy'
'380 Alternative Service'
'400 Bad request'
'401 Unauthorized'
'402 Payment required'
'403 Forbidden'
'404 Not found'
'405 Method not allowed'
'406 Not acceptable'
'407 Proxy authentication required'
'408 Request timeout'
'409 Conflict'
'410 Gone'
'413 Request entity too large'
'414 Request URI too long'
'415 Unsupported media'
'416 Unsupported URI scheme'
'420 Bad extension'
'421 Extension required'
'422 Session timer too small'
'423 Interval too brief'
'429 Referrer identity error'
'480 Temporary unavailable'
'481 Call or transaction does not exist'
'482 Loop detected'
'483 Too many hops'
'484 Address incomplete'
'485 Ambiguous'
'486 Busy here'
'487 Request terminated'
'488 Not acceptable here'
'489 Bad event'
'491 Retry after'
'500 Server internal error'
'501 Not implemented'
'502 Bad gateway'
'503 Service unavailable'
'504 Server timeout'
'505 Version unsupported'
'513 Message too large'
'600 Busy everywhere'
'603 Decline'
'604 Not exist anywhere'
'606 Not acceptable'

reason_cause_actions

Value	Description
'Continue call'
'Stop call'
'Process call routing'

channel_usages

Value	Description
'Round-Robin'
'Per-trunk lowest timeslot'
'Per-trunk highest timeslot'
'All-trunks lowest timeslot'
'All-trunks highest timeslot'
'Lowest CIC'
'Highest CIC'
'Odd lowest CIC'
'Odd highest CIC'
'Even lowest CIC'
'Even highest CIC'

nap_types

Value	Description
'NAP type ISDN'
'NAP type SS7'
'NAP type SIP'
'NAP type VOIP media only'
'NAP type TDM media only'
'NAP type CAS'

caf_timezones

Value	Description
'International Date Line West'
'Nome Time'
'Hawaii-Aleutian Standard Time'
'Hawaii-Aleutian Daylight Time'
'Pacific Standard Time'
'Pacific Daylight Time'
'Central Standard Time'
'Central Daylight Time'
'Atlantic Standard Time'
'Newfoundland Standard Time'
'Atlantic Daylight Time'
'Newfoundland Daylight Time'
'Azores Time'
'West Africa Time'
'Greenwich Mean Time'
'Central European Time'
'Eastern European Time'
'Moscow Standard Time'
'Moscow Daylight Time'
'Echo Time Zone'
'Foxtrot Time Zone'
'Christmas Island Time'
'Australian Western Standard Time'
'Australian Western Daylight Time'
'Australian Central Standard Time'
'Australian Eastern Standard Time'
'Australian Central Daylight Time'
'Australian Eastern Daylight Time'
'Norfolk (Island) Time'
'International Date Line East'
'Local timezone'

uui_encodings

Value	Description
'Hex'	'Use hexadecimal encoding'
'Text'	'Use text encoding if possible'
'Escaped text'	'Use text encoding, escape illegal characters'

system_physical_ports

Value	Description
'eth0'	'Port labeled eth0'
'eth1'	'Port labeled eth1'
'voip0'	'Port labeled voip0'
'voip1'	'Port labeled voip1'

adapter_physical_port_purposes

Value	Description
'HOST'	'HOST'
'CTRL0'	'CTRL0'
'CTRL1'	'CTRL1'
'OTHER'	'OTHER'

bonding_switchovers

Value	Description
'One'	'One IP address unreachable'
'Half + 1'	'Half + 1 IP addresses unreachable'
'All'	'All IP addresses unreachable'

gateway_test_call_modes

Value	Description
'Generate outgoing call'	'Generate an outgoing call that will not be subjected to the routing table.'
'Simulate incoming call'	'Will simulate an incoming call that will go through the routing table. This means that the call can be rejected or call parameters will be re-mapped according to the routing table before the outgoing call is made.'

local_nat_traversal_methods

Value	Description
'None'	'This is used when gateway is not NATted'
'Force Public IP'	'Forces the local public IP address in SIP and RTP packets.'
'Advertise Active Direction'	'Sends the \'a=direction:active\' in SDP attribute. Remote device must set itself in passive mode.'

remote_nat_traversal_methods

Value	Description
'None'	'Remote device is not behind a NAT or remote NAT device is SIP/RTP aware.'
'Parse Direction Attribute'	'Uses \'Passive Mode\' only when \'a=direction:active\' is received in the SDP.'
'Force Passive Mode'	'Use IP address and port from first received RTP packet to starts sending RTP packets.'

non_linear_processor_tune_options

Value	Description
'Normal'	'Default level of non-linear processing engagement of the echo cancellation module. This is the optimal setting for most call environment.'
'Increased'	'Increased level of non-linear processing engagement of the echo cancellation module. It may be required for some 2-to-4 wire hybrid or line conditions with large non-linear component in the echo.'
'Reduced'	'Reduced level of non-linear processing engagement of the echo cancellation module. It can avoid unpleasant voice artifact such as choppiness if there is heavy double-talk conditions while doing echo-tail characterization at the start of a call.'
'Disabled'	'Disable the non-linear processing of the echo cancellation module. It should always be activated unless while testing some G.168 scenarios.'

voip_packet_durations

Value	Description
'5 ms'	'Use packet duration of 5ms'
'10ms'	'Use packet duration of 10ms'
'20ms'	'Use packet duration of 20ms'
'30ms'	'Use packet duration of 30ms'
'40ms'	'Use packet duration of 40ms'
'50ms'	'Use packet duration of 50ms'
'60ms'	'Use packet duration of 60ms'
'70ms'	'Use packet duration of 70ms'
'80ms'	'Use packet duration of 80ms'
'90ms'	'Use packet duration of 90ms'
'160ms'	'Use packet duration of 160ms'