Added analog and ysigchan configuration file samples.

git-svn-id: http://yate.null.ro/svn/yate/trunk@1549 acf43c95-373e-0410-b603-e72c3f656dc1
This commit is contained in:
marian 2007-12-14 16:14:12 +00:00
parent 41042be60e
commit 95bed0c982
2 changed files with 423 additions and 0 deletions

204
conf.d/analog.conf.sample Normal file
View File

@ -0,0 +1,204 @@
; This file keep the analog channel configuration
; Each section except for 'general' configures a group of lines or an individual line
; Each section named 'line group-name/circuit-code' or
; 'line group-name/fxo/circuit-code' configure a line belonging to group
; <group-name> or <group-name/fxo> and using the circuit with code
; <circuit-code> in that group. The 'fxo' part means that the line is the FXO
; listening the FXS end of a monitored line (<group-name>'s type must be monitor)
; For each [group-name] section the configuration file is searched for
; [line group-name/circuit-code] or [line group-name/fxo/circuit-code] sections
;
; NOTES:
;
; - Avoid use of the slash ('/') character in group names
; - Lines belonging to the same group always have the same type
; - For recorders (monitor groups), 2 lines must be configured: an FXO line listening
; the FXS end of monitored line and an FXS one listening the FXO end of the
; monitored line.
; - When recording, the first channel is the caller and the second one is the called
;
; ROUTING:
;
; Calls can be routed by setting the group name or line address as destination
; ^123$=analog/office-fxs/3
; ^012$=analog/office-fxs
; ^13\(*.)$=analog/office-fxo/\1
; ^013$=analog/office-fxo;
; When routing, the recorders will set the type, format and callsource parameters
; The 'type' parameter will have the value 'record', the 'format' parameter is the
; format of the data source (usually alaw or mulaw) and 'callsource' parameter
; will have the value 'fxs' or 'fxo' which indicates the call initiator (this is
; the end of the monitored line, not he recorder's one)
;
; [default]
; ${type}^record$=goto record
;
; [record]
; .*=wave/record//tmp/${caller}_${called}_$(++$recidx).${format}
;
; [$once]
; recidx=0
;
; In this example, a recorder is routed to wavefile to be recorded in a file name given
; by caller, called, incremented value of the 'recidx' variable and the data format
[general]
; This section keep general settings for the analog module
; echocancel: boolean: Automatically enable or disable individual line echo
; canceller on call begin/end
; If missing or invalid, no automatic echo canceller operation will be done
; This parameter can be overridden in group and line sections
; The hardware driver must support this feature
;echocancel=
; call-ended-target: string: Target to play when an FXS line is disconnected and
; the FXO is still off hook
; This option is used to set an announcement to the FXO to tell it that the call
; was ended by its peer
; This parameter is applied on reload and can be overridden in group sections
; Defaults to tone/busy
;call-ended-target=tone/busy
; outoforder-target: string: Target to play when an FXS line is disconnected and
; the FXO is off hook for a long period of time
; This tone is played after the call ended tone
; This parameter is applied on reload and can be overridden in group sections
; Defaults to tone/outoforder
;outoforder-target=tone/outoforder
; call-ended-playtime: integer: The time to play the call-ended-target prompt on an FXS line
; After that, the outoforder-target will be played until the user closes (set on hook) the line
; This parameter can be overridden in group sections
; Defaults to 2000
;call-ended-playtime=
; ring-timeout: integer: The time allowed to ellapse between rings on incoming calls on FXO lines
; This timer can be used when there is no way to know when the remote FXS closes an unaswered
; call (no line polarity changes)
; This timer can also be used to configure the FXO lines belonging to recorder (monitor) groups
; If used, incoming unaswered calls or recorders will be terminated when this time ellapsed
; This parameter can be overridden in group and line sections
; Set to 0 to disable this timer. Defaults to 10000
;ring-timeout=
; alarm-timeout: integer: The time allowed for an active call to remain alive with its line
; in alarm (out of order)
; A T1 line can detect link failures and notify the upper layer
; When notified on line failure, active unanswered calls are terminated immediately.
; Answered calls are allowed to persist for the given period
; Set to 0 to disable this timer. Defaults to 30000
;alarm-timeout=30000
;[group-name]
; This section is used to configure a group of analog lines
; enable: boolean: This option is used to create or remove a group of analog lines
; Applied on reload
; Defaults to yes
;enable=yes
; type: string: Group type. This is the type of the local end of all analog lines
; belonging to this group
; Allowed values:
; FXO: The line is a telephone set linked to a telephone exchange
; FXS: The line is a telephone exchange linked to a telephone set
; monitor: This group contains line monitors (recorders)
; This option is required on creation
;type=
; spans: string: Specify the span(s) containing the analog channel(s)
; The value of this option must be a section name specified in a telephony module
; Multiple spans may be specified by simply separating them with a comma (',') character
; This option is required on creation if group's type is not monitor
;spans=
; fxs,fxo: string: Specify the span(s) containing the analog channel(s) used by
; the FXS and FXO lines belonging to monitors
; The value of this option must be a section name specified in a telephony module
; Multiple spans may be specified by simply separating them with a comma (',') character
; This option is required on creation if group's type is monitor
;fxs=
;fxo=
; useallcircuits: boolean: Create lines for all circuits belonging to this group
; This parameter is processed only when creating lines
; If disabled, only lines declared in existing sections with will be created
; Use line sections to override group parameters
; Defaults to enable
;useallcircuits=enable
; delaydial: integer: Delay sending number on FXO lines
; This option is used to delay sending the called number (if any)
; Defaults to 2000 if missing or invalid
; Set to 0 to send number just after receiving the confirmation of hook off
; operation completion
; This parameter can be overridden in line sections and in the routing process
; Ignored if type is not FXO
;delaydial=2000
; dtmfinband: boolean: Enable to send the DTMF data in band on analog lines belonging
; to this group
; If disabled, the DTMF will be sent through the line's hardware if possible
; This parameter just set the order to try sending the DTMFs: if disabled and the line
; fails to send the DTMF through the hardware, it will send it in band
; This parameter can be overridden in line sections
; Defaults to disable
;dtmfinband=disable
; answer-on-polarity: boolean: This parameter is used by an FXO line to wait for line
; polarity change as a signal that an outgoing call was answered by the remote end
; If disabled, the call will be considerred answered as soon as the destination
; number is sent (even if the number is empty)
; Care must be taken when setting this option to yes: the telephone exchange (FXS) might
; not be able to change line polarity on answer or the hardware might not be able to
; detect such an event: the outgoing calls will never be answered
; This parameter can be overridden in line sections
; Defaults to no
;answer-on-polarity=no
; hangup-on-polarity: boolean: This parameter is used by an FXO line to handle line
; polarity change as a signal that a call was terminated by the remote end (on hook)
; For outgoing calls on lines with answer-on-polarity enabled the first polarity change
; will be treated as an off hook (answer) event and a second one will be considerred
; an on hook (hang up) event
; For outgoing calls on lines with answer-on-polarity disabled or for incoming calls,
; if this parameter is enabled the line polarity change will be treated as an
; on hook (hang up) event
; This parameter can be overridden in line sections
; Defaults to no
;hangup-on-polarity=no
; callsetup: string: This parameter is used to detect (FXO) or send (FXS) line
; setup data (such as caller id)
; Allowed values:
; after: send/detect call setup after the first ring and before the second one
; before: send/detect call setup before the first ring
; none: No call setup detect or send
; This parameter can be overridden in line sections
; Defaults to after if missing or invalid
;callsetup=after
; debuglevel: integer: The debug level of this group
; Applied on reload
; Defaults to the current debug level if missing or invalid
; NOTE: If 0, no debug messages will be printed out from this group or lines belonging to it
;debuglevel=
;[line group-name/circuit-code] or
;[line group-name/fxo/circuit-code]
; This section is used to configure an analog line belonging to a group of lines
; The line address (group-name/circuit-code) will be used to route a call to it
; enable: boolean: This option is used to create or remove an analog line
; When removed, any active call on this line will remain (the line will be destroyed on termination)
; Applied on reload
; Defaults to yes
;enable=yes
; out-of-service: boolean: This option is used to put a line in out of service or in service state
; When out of service, no calls can be done through the line and any active call
; on this line will be terminated
; Applied on reload
; Defaults to no
;out-of-service=no

219
conf.d/ysigchan.conf.sample Normal file
View File

@ -0,0 +1,219 @@
; This file keep signalling channel configuration
; Each section (except for 'general' section) configure a link
; For call controllers, the name of the section will be used to route outgoing calls
[general]
; This section keep general settings for the signalling module:
; - Default values for missing or invalid parameters in link sections
; debuglevel: string: Comma separated list of debug levels for module and SS7 components
; Set to 0 to disable any debug message or -1 (or void) to left it unchanged
; Keep in mind that all objects are chained in module, so any subsequent changes in
; module's debug level is propagated to the SS7 objects
; The order is: Module, Signalling engine, SS7 router, SS7 management, SS7 maintenance
; This parameter is applied on reload
;debuglevel=
;Example of an 'isdn-pri-net' link
;[link1]
; type: string: Specify the link type
; Allowed values:
; ss7-isup: SS7 ISDN User Part over synchronous (HDLC) interface(s)
; isdn-pri-net: ISDN network side of a data link over one or more primary HDLC interface(s)
; isdn-pri-cpe: ISDN CPE (user) side of a data link over one or more primary HDLC interface(s)
; isdn-pri-mon: ISDN monitor of one or more primary HDLC interface(s)
; NOTE: isdn-pri-net and isdn-pri-cpe are identical, except for the side of the link
;type=isdn-pri-net
; enable: boolean: Enable or disable this call controller
; yes: Create this call controller. If already exists, apply settings (the settings
; that can be changed on reload are explicitely specified in place)
; no: Remove call controller if already created
; Defaults to yes
;enable=yes
; sig: string: Specify the span(s) containing the signalling channel(s)
; For example wanpipe1 or any other section specified in any of the telephony
; modules like wpcard or zapcard
; Ignored if type is not isdn-pri-net or isdn-pri-cpe
;sig=wanpipe1
; voice: string: Specify the span(s) containing the voice channel(s)
; Multiple cards may be specified by simply separating them with a comma (',') character
; Defaults to the span specified in the sig parameter
; Ignored if type is not isdn-pri-net or isdn-pri-cpe
;voice=
; dtmfinband: boolean: Enable to try to send the DTMF data in band when an audio channel is available
; If disabled or no audio channel available, the DTMF will be sent through the signalling channel if any
; Defaults to disable
;dtmfinband = disable
; strategy: string: The strategy used to allocate voice channels for outgoing calls
; Allowed values:
; - increment Do an incremental search for an idle channel starting with the last allocated channel
; - decrement Do an decremental search for an idle channel starting with the last allocated channel
; - lowest Do an incremental search for an idle channel starting with the first channel in group
; - highest Do an decremental search for an idle channel starting with the last channel in group
; - random Randomly choose an idle channel
; Defaults to increment
;strategy=increment
; strategy-restrict: string: Define channel allocation restrictions and behaviour
; This option is ignored when strategy is random
; Allowed values:
; even Allocate only even channels
; odd Allocate only odd channels
; even-fallback Allocate even channels. Fallback to odd channels when no more even channels
; odd-fallback Allocate odd channels. Fallback to even channels when no more odd channels
;strategy-restrict=
; channelsync: integer: The interval (in seconds) at which the call controller
; will try to re-sync idle channels
; The call controller will notify the other side of the link of idle channels
; Set to 0 to disable
; Defaults to minimum value if missing or invalid
;channelsync=1000
; numplan: string: Default numbering plan for outgoing calls
; Values: unknown, isdn, data, telex, national, private
; Defaults to unknown if missing or incorrect
; This parameter refers only to ISDN
;numplan=unknown
; numtype: string: Default number type for outgoing calls
; Values: unknown,international,national,net-specific,subscriber,abbreviated,reserved
; Defaults to unknown if missing or incorrect
;numtype=unknown
; presentation: string: Default number presentation for outgoing calls
; Values: allowed, restricted, unavailable
; Defaults to allowed if missing or incorrect
;presentation=allowed
; screening: string: Default number screening for outgoing calls
; Values: user-provided, user-provided-passed, user-provided-failed, network-provided
; Defaults to user-provided if missing or incorrect
;screening=user-provided
; format: string: Default data format for outgoing calls. Values: alaw, mulaw, g721
; Defaults to alaw if missing or incorrect
; alaw is used commonly in Europe while mulaw is used commonly in US and Japan.
;format=alaw
; display-charset: integer: Charset value to send with display (callername) data. Interval 0..127
; Set to an invalid value to disable. This will also disable charset reading for incoming display data
; Defaults to 255 (disabled)
; This parameter refers only to ISDN
;display-charset=255
; print-layer2PDU: boolean: Print layer 2 (Q.921) protocol data units to output
; For ISDN this option is applied on reload
; Defaults to no
;print-layer2PDU=no
; print-layer3PDU: boolean: Print layer 3 (Q.931) protocol data units to output
; For ISDN this option is applied on reload
; Defaults to no
;print-layer3PDU=no
; extended-debug: boolean: Print extented debug data (such as raw hex data) to output
; For ISDN this parameter is used in conjuction with print-layer2PDU and print-layer3PDU and
; is ignored if it's pair is not enabled
; For ISDN this option is applied on reload
; Defaults to no
;extended-debug=no
; sig-net: string: Specify the span(s) containing the signalling channel(s) for the network side of the monitored link
; For example wanpipe1 or any other section specified in any of the telephony
; modules like wpcard or zapcard
; Ignored if type is not isdn-pri-mon
;sig-net=
; sig-cpe: string: Specify the span(s) containing the signalling channel(s) for the user side of the monitored link
; For example wanpipe1 or any other section specified in any of the telephony
; modules like wpcard or zapcard
; Ignored if type is not isdn-pri-mon
;sig-cpe=
; voice-net: string: Specify the span(s) containing the voice channel(s) for the network side of the monitored link
; Multiple cards may be specified by simply separating them with a comma (',') character
; Defaults to the span specified in the sig-net parameter
; Ignored if type is not isdn-pri-mon
;voice-net=
; voice-cpe: string: Specify the span(s) containing the voice channel(s) for the user side of the monitored link
; Multiple cards may be specified by simply separating them with a comma (',') character
; Defaults to the span specified in the sig-cpe parameter
; Ignored if type is not isdn-pri-mon
;voice-cpe=
; detect: boolean: Change the side of the link on each captured request for watched signalling span(s)
; If disabled and the side of the link is not correct, the monitor will not be notified on
; data link state change. This may lead to malfunction
; Defaults to enable
; Ignored if type is not isdn-pri-mon
;detect=enable
; muxchanbuffer: integer: The buffer size for one channel of the audio multiplexer
; Defaults to 160 if 0 or missing
; Ignored if type is not isdn-pri-mon
;muxchanbuffer=160
; idlevalue: integer: The value used by the audio multiplexer to fill missing data
; This value is used to fill the free space when the multiplexer has to forward the received
; data but one channel buffer is not full
; Interval: 0..255. Defaults to 255 if missing or invalid
; Ignored if type is not isdn-pri-mon
;idlevalue=255
; idletimeout: integer: HDLC data link idle timeout
; The minimum allowed value is 4000. Defaults to 30000 if missing or invalid
; Ignored if type is not isdn-pri-mon
;idletimeout=30000
; emergency: boolean: Emergency align SS7 MTP2 layer at startup
; Defaults to no
;emergency=yes
; rxunderruninterval: integer: The interval (in miliseconds) allowed between 2 packets received
; on the signalling channel (required)
; Minimum value is 5 for SS7 links and 3000 for ISDN links
;rxunderruninterval=10
; pointcodetype: string: SS7 link point code type (required)
; Allowed values:
; ITU ITU-T Q.704
; ANSI ANSI T1.111.4
; ANSI8 8-bit SLS
; China GF 001-9001
; Japan T-Q704, NTT-Q704
; Japan5 5-bit SLS
;pointcodetype=
; pointcode: string: Point code serviced by this link
; defaultpointcode: string: Default point code for outgoing calls
; If missing or invalid, the default point code is set to the first point code added
; If no point codes are added no calls can be made (incoming or outgoing) through this link
; The format is network-cluster-member
; Parameter pointcode may be repeated
;pointcode=
;defaultpointcode=
; remotepointcode: string: Default destination point code used for outgoing calls and maintenance messages
; If missing or invalid, no maintenance message will be sent
; The format is network-cluster-member
;remotepointcode=
; debuglevel: string: Comma separated list of debug levels for link layers
; Set to 0 to disable any debug message or -1 (or void) to left it unchanged
; ss7-isup: Interface,Circuit group, MTP2, MTP3, ISUP
; isdn-pri-net,isdn-pri-cpe: Interface,Circuit group, Q921, Q931
;debuglevel=