SIP configuration
SIP profiles configuration
sip profile
This command creates a SIP profile and switchs to configuration mode.
The use of a negative form (no) of the command removes a SIP profile.
Syntax
[np] sip profile <NUM>
Parameters
<NUM> – SIP profile number, set in the form of a digit from 1 to 5.
Default value
None.
Required privilege level
10
Command mode
CONFIG
Example
esr(config)# sip profile 1
codec-packettime g711
This command sets the packetization time for the G711 codec. Packetization time – the number of milliseconds of speech in one RTP packet.
The use of a negative form (no) of the command sets the default value.
Syntax
codec-packettime g711 <PTIME>
no codec-packettime g711
Parameters
<PTIME> – packetization time in milliseconds, takes values of [10, 20, 30, 40, 50, 60].
Default value
20
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# codec-packettime g711 50
codec-packettime g723
This command sets the packetization time for the G723 codec. Packetization time – the number of milliseconds of speech in one RTP packet.
The use of a negative form (no) of the command sets the default value.
Syntax
codec-packettime g723 <PTIME>
no codec-packettime g723
Parameters
<PTIME> – packetization time in milliseconds, takes values of [30, 60, 90].
Default value
30
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# codec-packettime g723 60
codec-packettime g729
This command sets the packetization time for the G729 codec. Packetization time – the number of milliseconds of speech in one RTP packet.
The use of a negative form (no) of the command sets the default value.
Syntax
codec-packettime g729 <PTIME>
no codec-packettime g729
Parameters
<PTIME> – packetization time in milliseconds, takes values of [10, 20, 30, 40, 50, 60, 70, 80].
Default value
20
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# codec-packettime g729 70
conference type
This command sets the operation mode of the three-way conference.
Using the no conf_mode command sets the conference mode to default.
Syntax
conference type <MODE>
no conf_mode
Parameters
<MODE> – VPN operation mode. Two modes are available:
local - conference is intended locally by the device after pressing 'flash+3' combination;
remote – conference is intended on remote server. Then, after pressing 'flash+3' combination Invite message sending on server to number, pointed in the 'Conference server' field. In this case conference processing by algorithm, described in RFC4579.
Default value
local
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# conference type remote
conference uri address
This command sets the address of the remote conference server in the SIP-URI scheme: user@address:port.
The use of a negative form (no) of the command removes the value.
Syntax
conference uri address <ADDR>
conference uri address
Parameters
<ADDR> – may take the value of ipv4 address or the domain name.
IP address, defined as AAA.BBB.CCC.DDD where each part takes values of [0..255]. Example of domain name – example.loc.
Default value
None.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# conference uri address sipnetwork.loc
conference uri port
This command sets the port of the remote conference server in the SIP-URI scheme: user@address:port.
The use of a negative form (no) of the command removes the value.
Syntax
conference uri port <PORT>
no conference uri port
Parameters
<PORT> – number of TCP/UDP port to exchange data with a remote server, takes values of [1..65535].
Default value
5060
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# conference uri port 5066
conference uri user
This command sets the user name of the remote conference server in the SIP-URI scheme: user@address:port.
The use of a negative form (no) of the command sets the default value.
Syntax
conference uri user <USER>
no conference uri user
Parameters
<USER> – server profile name, set by the string of up to 31 characters.
Default value
conf
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# conference uri user conference
description
The command is used to register on SIP server.
The use of a negative form (no) of the command removes a name of configurated SIP profile.
Syntax
description <DESCRIPTION>
no description
Parameters
<DESCRIPTION> – profile description, set by the string of up to 255 characters.
Default value
None
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# description “first sip profile”
dialplan pattern
This command assigns a dial plan to the current SIP profile.
The use of a negative form (no) of the command disables specified dial plan.
Syntax
dialplan pattern <DNAME>
no dialplan pattern
Parameters
<DNAME> – name of the dial plan, set by the string of up to 31 characters.
Default value
None
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# dialplan pattern dialplanName
echo-caceller
The command enables SIP proxy.
The use of a negative form (no) of the command removes the echocancelling.
Syntax
[no] echo-canceller
Parameters
The command does not contain parameters
Default value
Echo-canceller is enabled.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# echo-canceller
enable
The command enables SIP proxy.
The use of a negative form (no) of the command disables SIP profile.
Syntax
[no] enable
Parameters
The command does not contain parameters.
Default value
SIP profile is disabled.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# enable
fax protocol t38
This command allows the transition in T.38 - when an incoming re-invite to T.38 from the oncoming gateway.
The use of a negative form (no) of the command restricts transition to T.38.
Syntax
[no] fax protocol t38
Parameters
The command does not contain parameters.
Default value
Switch to t38 is disabled.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# fax protocol t38
fax protocol t38 redundant
This command adds the redundancy into T.38 packets; value is corresponding to amount of previous packets, which is doubling in every new T.38 packet. This redundancy method is useful for case when the packets are lost in the transfer.
The use of a negative form (no) of the command removes the redundancy from T.38 packets.
Syntax
fax protocol t38 redundant <SIZE>
no fax protocol t38 redundant
Parameters
<SIZE> – the number of previous packets, which are duplicated in each new T.38 packet, can be 0, 1, 2.
Default value
0
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# fax protocol t38 redundant 2
ims call-holding
This command assigns the name of the Call Hold service. The command changes XML element name in Notify message body, used for transmission of commands to activate/deactivate 'Call Hold' service. Example: if service name has 'call-hold' value, activation command will appear as:
<call-hold active="true"/>
and deactivation command:
<call-hold active="false"/>
The use of a negative form (no) of the command sets the default service name.
Syntax
ims call-holding <NAME>
no ims call-holding
Parameters
<NAME> – name of the 'call hold' service, set by the string of up to 31 characters.
Default value
call-hold
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# ims call-holding hold
ims call-transfer
This command assigns the name of the Call Transfer service. The command changes XML element name in Notify message body, used for transmission of commands to activate/deactivate '3-way-conference' service. Example: if service name has 'call-transfer' value, activation command will appear as:
< call-transfer active="true"/>
and deactivation command:
< call-transfer active="false"/>
The use of a negative form (no) of the command sets the default service name.
Syntax
ims call-transfer <NAME>
no ims call-transfer
Parameters
<NAME> – name of the 'Call Transfer' service, set by the string of up to 31 characters.
Default value
explicit-call-transfer
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# ims call-transfer transfer
ims call-waiting
This command assigns the name of the 'Call Waiting' service. The command changes the name of XML element in Notify message body used to pass enable/disable command of 'Call Waiting' service. Example: if service name has 'call-waiting' value, activation command will appear as:
<call-waiting active="true"/>
and deactivation command:
<call-waiting active="false"/>
The use of a negative form (no) of the command sets the default service name.
Syntax
ims call-waiting <NAME>
no ims call-waiting
Parameters
<NAME> – name of the 'Call Waiting' service, set by the string of up to 31 characters.
Default value
call-waiting
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# ims call-waiting wait
ims conference
This command assigns '3 Way Conference' service name – XML element name in Notify message body, used for transmission of commands to activate/deactivate '3-way Conference' service. Example: if service name has 'three-party-conference' value, activation command will appear as:
< three-party-conference active="true"/>
and deactivation command:
< three-party-conference active="false"/>
The use of a negative form (no) of the command sets the default service name.
Syntax
ims conference <NAME>
no ims conference
Parameters
<NAME> – name of the '3 Way Conference' service, set by the string of up to 31 characters.
Default value
three-party-conference
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# ims conference conf
ims hotline
This command assigns 'Hotline' service name – XML element name in Notify message body, used for transmission of commands to activate 'Hotline' service. Activation command sending Hotline phone number and call timeout. Example: if service name has 'hot-line-service' value and it is needed to perform a call to number 30001 after 6 seconds after onhook, activation command will appear as:
<hot-line-service>
<addr>30001</addr>
<timeout>6</timeout>
</hot-line-service>
The use of a negative form (no) of the command sets the default service name.
Syntax
ims hotline <NAME>
no ims hotline
Parameters
<NAME> – name of the 'Hotline' service, set by the string of up to 31 characters.
Default value
hot-line-service
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# ims hotline hot
ims type
The command assigns operation mode of VAS with IMS.
The use of a negative form (no) of the command disables the limitations.
Syntax
ims type <MODE>
no ims type
Parameters
<MODE> – Suppl with IMS operation mode, may take the following values:
- implicit - allows management of certain types of services by the IMS (IP Multimedia Subsystem) server. In this case enabling the '3-way Conference' (works only by the algorithm RFC4579), 'Call Hold', 'Call Waiting', 'Hot line' (regardless of whether they are enabled or not in the configuration) services is performed remotely by the IMS server by sending Notify messages, the body of which sends commands to activate/deactivate services in XCAP format (in fact, XML, RFC4825). In this subscription option, gateway will send SUBSCRIBE requests after subscriber registration, and upon successful subscription, will process NOTIFY requests received from IMS, which are used for service management. 'Call Hold' service name - XML element name in Notify message body, used for transmission of commands to activate/deactivate 'Call Hold' Example: if service name has 'call-hold' value, activation command will appear as:
<call-hold active="true"/>
deactivation command:
<call-hold active="false"/> - explicit - allows management of certain types of services by the IMS (IP Multimedia Subsystem) server. In this case enabling the '3-way Conference' (works only by the algorithm RFC4579), 'Call Hold', 'Call Waiting', 'Hot line' (regardless of whether they are enabled or not in the configuration) services is performed remotely by the IMS server by sending Notify messages, the body of which sends commands to activate/deactivate services in XCAP format (in fact, XML, RFC4825). In this subscription option, gateway will not send SUBSCRIBE requests after subscriber registration, and will only process NOTIFY requests received from IMS, which are used for service management.
Default value
VAS with IMS is disabled.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# ims type implicit
payload dtmf
This command assigns the type of load for transmitting packets over RFC2833.
The use of a negative form (no) of the command sets the default value.
Syntax
payload dtmf <TYPE>
no payload dtmf
Parameters
<TYPE> – type of load for transmitting packets over RFC2833, the allowed values for use are [96..127].
Default value
96
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# payload dtmf 101
rtcp
This command enables the RTCP protocol to control the conversational channel.
The use of a negative form (no) of the command restricts the use of RTCP.
Syntax
[no] rtcp
Parameters
The command does not contain parameters.
Default value
Deactivating/disabling the RTCP protocol.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# rtcp
rtcp extend-reports
This command enables the sending of RTCP Extended Reports packets in accordance with RFC 3611.
The use of a negative form (no) of the command restricts the use of RTCP Extended Reports.
Syntax
[no] rtcp extend-reports
Parameters
The command does not contain parameters.
Default value
RTCP Extended Reports packets sending disabled.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# rtcp extend-reports
rtcp keepalive
This command sets the receive period of the RTCP message, which is measured in units of the transmission interval. If at the end of the reception period no RTCP packet is received from the opposite side, ESR-12V/12VF/14VF disconnects.
The use of a negative form (no) of the command sets the default value.
Syntax
rtcp keepalive <TIME>
no rtcp keepalive
Parameters
<TIME> – RTCP message reception period in seconds, allowed to use the value [1..30].
Default value
5
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# rtcp keepalive 25
rtcp tx-period
This command sets the interval for transmitting RTCP packets.
The use of a negative form (no) of the command sets the default value.
Syntax
rtcp tx-period <TIME>
no rtcp tx-period
Parameters
<TIME> – RTCP packet transmission interval in seconds, the allowed values for use are [1..60].
Default value
5
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# rtcp tx-period 40
session expiries-timer
This command sets the minimum interval for checking the operability of a connection according to RFC2028 (from 90 to 1800 s, by default 120 s).
The use of a negative form (no) of the command sets the default value.
Syntax
session expiries-timer <TIME>
no session expiries-timer
Parameters
<TIME> – the minimum interval of checking the operability of the connection in seconds, can take values [90..1800].
Default value
120
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# session expiries-timer 180
session keepalive
This coomand sets the period of time in seconds that should pass before the forced session termination, if the session is not renewed in time.
The use of a negative form (no) of the command sets the default value.
Syntax
session keepalive <TIME>
no session keepalive
Parameters
<TIME> – the minimum interval of checking the operability of the connection, can take values [90..80000].
Default value
1800
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# session keepalive 900
session timer disable
his command disables support for the timer extension (RFC 4028).
The use of a negative form (no) of the command allows the use of the update session according to RFC4028.
Syntax
[no] session timer disable
Parameters
The command does not contain parameters.
Default value
Session control is enabled.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# session timer disable
silence-detect
This command enables the use of the silence detector.
The use of a negative form (no) of the command restricts the use of silence detector.
Syntax
[no] silence-detect
Parameters
The command does not contain parameters.
Default value
Silence detector is enabled.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# silence-detect
sip-domain address
This command specifies the SIP domain in which the device is located.
The use of a negative form (no) of the command removes the value of SIP domain.
Syntax
sip-domain address <ADDRESS>
no sip-domain address
Parameters
<ADDRESS> – SIP domain in which the device is located, set by ipv4 address or domain name.
Default value
None
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# sip-domain address sip.network.com
sip-domain registration enable
This command enables the use of the SIP Domain during registration (the SIP domain will be inserted into the Request-Line Register requests).
The use of a negative form (no) of the command cancels the use of SIP Domain when registering.
Syntax
[no] sip-domain registration enable
Parameters
The command does not contain parameters.
Default value
Do not use of SIP domain when registering.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# sip-domain registration enable
sip-domain registration retry
This command specifies the period of time during which registration of the subscriber port on the SIP server is valid. Average, port registration renewal is carried out after 2/3 of specified period.
The use of a negative form (no) of the command sets the default value.
Syntax
sip-domain registration retry <INTERVAL>
no sip-domain registration retry
Parameters
<INTERVAL> – period of time in seconds during which the registration of the subscriber port on the SIP server is valid. May take values in the range of [30..10000].
Default value
1800
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# sip-domain registration retry 900
source-address
source-address
This command specifies a public address – this parameter is used as external address of the device when operating behind NAT (behind gateway). The address of external (WAN) gateway interface (NAT), behind that ESR-12V/12VF/14VF is installed, is specified as the public address.
The use of a negative form (no) of the command removes the value.
Syntax
source-address <IPv4 address>
no source-address
Parameters
<IPv4 address> – адрес внешнего (WAN) интерфейса шлюза (NAT), за которым установлен ESR-12V/12VF/14VF.
Default value
None.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# source-address 232.104.45.12
transfer dtmf
The command is used to specify the method of DTMF signal transmission.
The use of a negative form (no) of the command sets the default value.
Syntax
transfer dtmf <MODE>
no transfer dtmf
Parameters
<MODE> – DTMF signals transmission mode, may take the following values:
info – передача сообщений по протоколу SIP в запросах INFO;
inband – внутриполосная передача;
rfc-2833 – согласно рекомендации RFC2833 в качестве выделенной нагрузки в речевых пакетах RTP.
Default value
rfc-2833
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# transfer dtmf inband
transfer flash
The command is used to specify the method of Flash signal transmission.
The use of a negative form (no) of the command sets the default value.
Syntax
transfer flash <MODE>
no transfer flash
Parameters
<MODE> – Flash signals transmission mode, may take the following values:
- sscc – message transmission to a cooperating party via SIP in INFO requests. Flash event is sent in Application/sscc extension as 'event flashhook'.
- dtmf – message transmission to a cooperating party via SIP in INFO requests. Flash event is sent in Application/dtmf-relay as 'signal=hf'.
- hook-flash – message transmission to a cooperating party via SIP in INFO requests. Flash event is sent in Application/Hook Flash extension as 'signal=hf'.
- broadsoft – message transmission to a cooperating party via SIP in INFO requests. Flash event is transmitted in Application/Broadsoft extension as event flashhook.
Default value
hook-flash
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# transfer flash dtmf
SIP PROXY configuration
proxy primary
The command is used to switch to the primary SIP proxy configuration mode. The use of a negative form (no) of the command removes all settings of primary SIP proxy.
Syntax
[no] proxy primary
Parameters
The command does not contain parameters.
Default value
None.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# proxy primary
proxy primary keepalive
The command specifies the primary server supervision period.
The use of a negative form (no) of the command sets the default value.
Syntax
proxy primary keepalive <PERIOD>
no proxy primary keepalive
Parameters
<PERIOD> – periodic messages sending interval in seconds to check the availability of a primary SIP server, may take the values of [10..3600].
Default value
30
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# proxy primary keepalive 60
proxy primary mode
The command specifies SIP proxy usage mode.
The use of a negative form (no) of the command sets the default value.
Syntax
proxy primary mode <MODE>
no proxy primary mode
Parameters
<MODE> – SIP proxy usage mode, may take the following values:
- parking – SIP proxy redundancy mode without control of primary SIP proxy;
- homing – SIP proxy redundancy mode with control of primary SIP proxy.
Default value
homing
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# proxy primary mode parking
proxy secondary
The command is used to switch to the redundant SIP proxy configuration mode.
The use of a negative form (no) of the command removes all settings of redundant SIP proxy.
Syntax
proxy secondary <NUM>
no proxy secondary
Parameters
<NUM> – redundant SIP proxy number, takes values of [1..4].
Default value
None.
Required privilege level
10
Command mode
CONFIG-SIP-PROFILE
Example
esr(config-sip-profile)# proxy secondary 2
enable
The command enables SIP proxy.
The use of a negative form (no) of the command disables SIP proxy.
Syntax
[no] enable
Parameters
The command does not contain parameters.
Default value
SIP proxy is disabled.
Required privilege level
10
Command mode
CONFIG-VOIP-SIP-PROXY
Example
esr(config-voip-sip-proxy)# enable
ip address proxy-server
The command specifies the IP address of a proxy server.
The use of a negative form (no) of the command removes the value.
Syntax
ip address proxy-server <ADDR>
no ip address proxy-server
Parameters
<ADDR> – proxy server address, set by ipv4 address or the domain name. May take the value of ipv4 address or the domain name.
IP address, defined as AAA.BBB.CCC.DDD where each part takes values of [0..255]. Example of domain name – example.loc.
Default value
None
Required privilege level
10
Command mode
CONFIG-VOIP-SIP-PROXY
Example
esr(config-voip-sip-proxy)# ip address proxy-server 10.245.56.12
ip address registration-server
The command specifies the log server address.
The use of a negative form (no) of the command removes the value.
Syntax
ip address registration-server <ADDR>
no ip address registration-server
Parameters
<ADDR> – log server address, set by ipv4 address or the domain name. May take the value of ipv4 address or the domain name.
IP address, defined as AAA.BBB.CCC.DDD where each part takes values of [0..255]. Example of domain name – example.loc.
Default value
None
Required privilege level
10
Command mode
CONFIG-VOIP-SIP-PROXY
Example
esr(config-voip-sip-proxy)# ip address registration-server 10.245.56.12
ip port proxy-server
The command specifies the number of proxy server UDP port.
The use of a negative form (no) of the command sets the default value.
Syntax
ip port proxy-server <PORT>
no ip port proxy-server
Parameters
<PORT> – number of proxy server UDP port, takes values of [1..65535].
Default value
5060
Required privilege level
10
Command mode
CONFIG-VOIP-SIP-PROXY
Example
esr(config-voip-sip-proxy)# ip port proxy-server 5080
ip port registration-server
The command specifies the number of log server UDP port.
The use of a negative form (no) of the command sets the default value.
Syntax
ip port registration-server <PORT>
no ip port registration-server
Parameters
<PORT> – number of registration server UDP port, takes values of [1..65535].
Default value
5060
Required privilege level
10
Command mode
CONFIG-VOIP-SIP-PROXY
Example
esr(config-voip-sip-proxy)# ip port registration-server 5080
registration
The command is used to register on SIP server.
The use of a negative form (no) of the command disables the registration on SIP server.
Syntax
[no] registration
Parameters
The command does not contain parameters.
Default value
Registration is not used.
Required privilege level
10
Command mode
CONFIG-VOIP-SIP-PROXY
Example
esr(config-voip-sip-proxy)# registration
SIP common parameters configuration
authentication mode
The command is used to assign authentication profile.
The use of a negative form (no) of the command sets the default value.
Syntax
authentication mode <MODE>
no authentication mode
Parameters
<MODE> – authentication profile, may take the following values:
- global – one user name/password pair is used for all ports;
- user-defined – each port has its own user name/password value.
Default value
user-defined
Required privilege level
10
Command mode
CONFIG-SIP
Example
esr(config-sip)# authentication mode global
authentication name
This command assigns a login in case when authentication mode has the 'global' value.
The use of a negative form (no) of the command removes the value.
Syntax
authentication name <LOGIN>
no authentication name
Parameters
<LOGIN> – login for authentication, set by the string of up to 31 characters.
Default value
None
Required privilege level
10
Command mode
CONFIG-SIP
Example
esr(config-sip)# authentication name esr12V
authentication password
This command assigns a password in case when authentication mode has 'global' value.
The use of a negative form (no) of the command removes the value.
Syntax
authentication password { <PASS> | encrypted <ENCRYPTED-PASS>}
no authentication password
Parameters
<PASS> – authentication password, set by the string of up to 16 characters.
<ENCRYPTED-PASS> – hash password via sha512 algorithm, set by the string of [2..32] characters.
Default value
None
Required privilege level
10
Command mode
CONFIG-SIP
Example
esr(config-sip)# authentication password superpass
sip service
The command allows to switch to the SIP common settings configuration mode.
The use of a negative form (no) of the command returns the default common settings.
Syntax
[no] sip services
Parameters
The command does not contain parameters.
Default value
None
Required privilege level
10
Command mode
CONFIG
Example
esr(config)# sip services esr(config-sip)#
Dial plan configuration
description
The command is used to change a dial plan description.
The use of a negative form (no) of the command disables a dial plan description.
Syntax
description <DESCRIPTION>
no description
Parameters
<DESCRIPTION> – dial plan description, set by the string of up to 255 characters.
Default value
None
Required privilege level
10
Command mode
CONFIG-DIAL-RULESET
Example
esr(config-dial-ruleset)# description first
dialplan pattern
This command creates a dial plan and to switch to the edit mode.
The use of a negative form (no) of the command removes the dial plan.
Syntax
dialplan pattern <NAME>
no dialplan pattern
Parameters
<NAME> – name of the dial plan, set by the string of up to 31 characters.
Default value
None
Required privilege level
10
Command mode
CONFIG
Example
esr(config)# dialplan pattern newplan
enable
The command enables a dial plan being configured.
The use of a negative form (no) of the command disables a dial plan being configured.
Syntax
[no] enable
Parameters
The command does not contain parameters.
Default value
The dial plan is not enabled.
Required privilege level
10
Command mode
CONFIG-DIAL-RULESET
Example
esr(config-dial-ruleset)# enable
pattern
This command adds the dial plan rules.
The use of a negative form (no) of the command sets the default value.
Syntax
pattern <REGEXP>
no pattern
Parameters
<REGEXP> - regular expression specifying the dial plan. Set by the string of up to 1024 characters. The rules for creating regular expressions are described in section Dial plan configuration example of user manual.
Default value
"S5, L5 ([xABCD*#].S)"
Required privilege level
10
Command mode
CONFIG-DIAL-RULESET
Example
esr(config-dial-ruleset)# pattern "S5, L5 (41xx@{local} | 7383xxxxxxx)"
VAS Configuration
prefix busy
This command specifies the code, dialed from a telephone, for activation, deactivation and 'Call forwarding on busy' services configuration.
The use of a negative form (no) of the command removes the value.
Syntax
prefix busy <CODE>
no prefix busy
Parameters
<CODE> – 'Call forwarding on busy' service configuration code dialed from a telephone, can take values of [10..99].
Default value
None
Required privilege level
10
Command mode
CONFIG-VOIP-SERVICES
Example
esr(config-voip-services)# prefix busy 99
prefix call-waiting
This command specifies the code, dialed from a telephone, for activation, deactivation and 'Call waiting' services configuration.
The use of a negative form (no) of the command removes the value.
Syntax
prefix call-waiting <CODE>
no prefix call-waiting
Parameters
<CODE> – code dialed from the telephone to control the 'Call Waiting' service can be [10..99].
Default value
None
Required privilege level
10
Command mode
CONFIG-VOIP-SERVICES
Example
esr(config-voip-services)# prefix call-waiting 89
prefix dnd
The command is used to specify the code, dialed from a telephone, for activation, deactivation and 'Do not disturb' service configuration.
The use of a negative form (no) of the command removes the value.
Syntax
prefix dnd <CODE>
no prefix dnd
Parameters
<CODE> – 'Do not disturb' service configuration code dialed from a telephone, can take values of [10..99].
Default value
None
Required privilege level
10
Command mode
CONFIG-VOIP-SERVICES
Example
esr(config-voip-services)# prefix dnd 79
prefix hotline
The command is used to specify the code, dialed from a telephone, for activation, deactivation and 'Hot/Warm line' service configuration.
The use of a negative form (no) of the command removes the value.
Syntax
prefix hotline <CODE>
no prefix hotline
Parameters
<CODE> – 'Hot/Warm line' service configuration code dialed from a telephone, can take values of [10..99].
Default value
None
Required privilege level
10
Command mode
CONFIG-VOIP-SERVICES
Example
esr(config-voip-services)# prefix hotline 69
prefix no-answer
This command specifies the code, dialed from a telephone, for activation, deactivation and 'Call forwarding - No Answer' services configuration.
The use of a negative form (no) of the command removes the value.
Syntax
prefix no-answer <CODE>
no prefix no-answer
Parameters
<CODE> – 'Call forwarding - No Answer' service configuration code dialed from a telephone, can take values of [10..99].
Default value
None
Required privilege level
10
Command mode
CONFIG-VOIP-SERVICES
Example
esr(config-voip-services)# prefix no-answer 59
prefix-pickup
The command is used to specify the code, dialed from a telephone, for activation, deactivation and 'Call pickup' services configuration.
The use of a negative form (no) of the command removes the value.
Syntax
prefix pickup <CODE>
no prefix pickup
Parameters
<CODE> – 'Call pickup' service configuration code dialed from a telephone, can take values of [10..99].
Default value
None
Required privilege level
10
Command mode
CONFIG-VOIP-SERVICES
Example
esr(config-voip-services)# prefix pickup 49
prefix uncoditional
This command specifies the code, dialed from a telephone, for activation, deactivation and 'Call Forward Unconditional' services configuration.
The use of a negative form (no) of the command removes the value.
Syntax
prefix uncoditional <CODE>
no prefix uncoditional
Parameters
<CODE> – 'Unconditional forwarding' service configuration code dialed from a telephone, can take values of [10..99].
Default value
None
Required privilege level
10
Command mode
CONFIG-VOIP-SERVICES
Example
esr(config-voip-services)# prefix uncoditional 39
voice services
The command is used to switch to the VAS configuration mode.
The use of a negative form (no) of the command returns the default configuration.
Syntax
[no] voice services
Parameters
The command does not contain parameters.
Default value
None
Required privilege level
10
Command mode
CONFIG
Example
esr(config)# voice services
SIP ALG feature activation
Service-voip routing
This command activates the feature of routing VoIP packets when the PBX server is disconnected.
The use of a negative form (no) of the command disables the feature.
Syntax
[no] service-voip routing
Parameters
The command does not contain parameters.
Required privilege level
10
Command mode
CONFIG-E1
CONFIG-IF-GI
CONFIG-MULTILINK
CONFIG-PORT-CHANNEL
CONFIG-GRE
CONFIG-IP4IP4
CONFIG-PPPOE
CONFIG-PPTP
CONFIG-VTI
CONFIG-BRIDGE
Example
esr(config-if-gi)# service-voip routing
PBX configuration
PBX server configuration
enable
This command activates the embedded PBX server.
The use of a negative form (no) of the command disables the embedded PBX server and erases settings.
Syntax
[no] enable
Parameters
The command does not contain parameters.
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# enable
expiry
This command controls the validity period of registration.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] expiry [min|max] <EMIN>
Parameters
Min – minimum registration duration;
Max – maximum registration duration;
<EMIN> – may take values of [60…64800] in seconds.
Default value
Min – 60 seconds;
Max – 3600 seconds.
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# expiry min 60
session-timer type
This command configures session timer start parameters.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] session-timer type <TTIME>
Parameters
<TTIME> – may take one of the values: [originate, accept, refuse];
originate – always start session timer;
accept – start the timer only at the request of the other side;
refuse – do not start session timer.
Default value
refuse
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# session-timer type accept
session-timer expiries
This command sets the maximum interval for updating a session.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] session-timer expiries <ETIME>
Parameters
<ETIME> – maximum interval for updating a session in seconds, may take values [90-80000].
Default value
1800 seconds.
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# session-timer expiries 600
session-timer min-se
This command sets the minimum interval for updating a session.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] session-timer min-se <MTIME>
Parameters
<MTIME> – minimum interval for updating a session in seconds, may take values [90-1800].
Default value
90 seconds.
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# session-timer min-se 100
session-timer refresher
This command sets the initiator for updating a session.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] session-timer refresher <RTIME>
Parameters
<RTIME> – session refresh initiator, may take value: (uac|uas);
uac – caller initiates a session update when possible;
uas – callee initiates a session update when possible.
Default value
uas
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# session-timer refresher uas
profile
This command is used to configure the SIP profile in PBX.
The use of a negative form (no) of the command removes the profile.
Syntax
[no] profile <PNAME>
Parameters
<PNAME> – profile name, specified by a word from 1 to 31 characters long.
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# profile sip_phones
register-server
This command configures registration server data in PBX.
The use of a negative form (no) of the command removes registration server information.
Syntax
[no] register-server <REGNAME>
Parameters
<REGNAME> – Registration server name, specified by a word from 1 to 31 characters long.
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# register-server ssw
ruleset
This command configures the routing context in PBX.
The use of a negative form (no) of the command removes routing context.
Syntax
[no] ruleset <RULNAME>
Parameters
<RULENAME> – routing context name, specified by a word from 1 to 31 characters long.
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# ruleset local
user
This command configures the subscribers in PBX.
The use of a negative form (no) of the command removes the subscriber.
Syntax
[no] user <UNAME>
Parameters
<UNAME> – subscriber name or number, specified by a word from 1 to 31 characters long.
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr(config-pbx)# user 1482
transport protocol
This command selects the transport protocol used by PBX.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] transport protocol <PROTO>
Parameters
<PROTO> – used transport protocol, may take the value { tcp | udp | both }.
Default value
udp
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# transport protocol udp
transport port
This command configures the transport port used by PBX.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] transport port <PORT>
Parameters
<PORT> – port number, takes values of [1..65535].
Default value
5060
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# transport port 5060
fax
This command configures the fax parameters in PBX.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] fax protocol t38 error-correction <FTYPE> datagram-size <SIZE>
Parameters
<FTYPE> – the choice of error correction method, may take the values {fec | redundancy};
<SIZE> – the choice of the datagram size in bytes, may take the value [272 ... 512].
Required privilege level
10
Command mode
CONFIG-PBX
Example
esr (config-pbx)# fax protocol t38 error-correction fec datagram-size 272
Configuring a subscriber on a PBX server
password
This command configures PBX subscriber authentication parameters.
The use of a negative form (no) of the command removes the value.
Syntax
password { <PASS> | encrypted <ENCRYPTED-PASS>}
no password
Parameters
<PASS> – authentication password, set by the string of up to 16 characters.
<ENCRYPTED-PASS> – hash password via sha512 algorithm, set by the string of [2..32] characters.
Required privilege level
10
Command mode
CONFIG-PBX-USER
Example
esr (config-pbx-user)# password 1234
profile
This command is used to assign the SIP profile to PBX subscriber.
The use of a negative form (no) of the command removes a current configuration.
Syntax
[no] profile <PNAME>
Parameters
<PNAME> – SIP profile name, specified by a word from 1 to 31 characters long.
Required privilege level
10
Command mode
CONFIG-PBX-USER
Example
esr (config-pbx-user)# profile sip_phones
Configuring the routing context on the PBX server
description
This command changes the description of the PBX routing context.
The use of a negative form (no) of the command removes description.
Syntax
[no] description <DESCR>
Parameters
<DESCR>– description of the routing context, specified by a string from 1 to 255 characters.
Required privilege level
10
Command mode
CONFIG-PBX-RULESET
Example
esr (config-pbx-ruleset)# description local_calls
rule
This command configures the routing rule in the current context.
The use of a negative form (no) of the command removes the rule.
Syntax
[no] rule <RIDX>
Parameters
<RIDX> – the index of the rule in the context of routing, specified by a number from 1 to 1000.
Required privilege level
10
Command mode
CONFIG-PBX-RULESET
Example
esr (config-pbx-ruleset)# rule 1
enable
This command activates the current routing rule.
The use of a negative form (no) of the command disables the rule.
Syntax
[no] enable
Parameters
The command does not contain parameters.
Required privilege level
10
Command mode
CONFIG-PBX-RULE
Example
esr (config-pbx-rule)# enable
pattern
This command creates a pattern in a routing rule.
The use of a negative form (no) of the command removes the pattern.
Syntax
[no] pattern <PSTR>
Parameters
<PSTR> – routing rule pattern, specified by a string from 1 to 256 characters.
Default value
(null)
Required privilege level
10
Command mode
CONFIG-PBX-RULE
Example
esr (config-pbx-rule)# pattern _XXX,1,Dial(SIP/${EXTEN})
description
This command configures the routing rule description in PBX.
The use of a negative form (no) of the command removes description.
Syntax
[no] description <DESCR>
Parameters
<DESCR>– rule description, specified by a string from 1 to 255 characters.
Required privilege level
10
Command mode
CONFIG-PBX-RULE
Example
esr (config-pbx-rule)# description local_calls
Configuring the registration server for PBX
protocol
This command is used to specify the protocol for communication with the registration server.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] protocol <PROTO>
Parameters
<PROTO> – the protocol used to communicate with the registration server, may be {tcp | udp}.
Default value
udp
Required privilege level
10
Command mode
CONFIG-PBX-REG-SERVER
Example
esr (config-pbx-reg-server)# protocol udp
authentication password
This command configures authentication on the registration server.
The use of a negative form (no) of the command removes the value.
Syntax
authentication password { <PASS> | encrypted <ENCRYPTED-PASS>}
no authentication password
Parameters
<PASS> – authentication password, set by the string of up to 16 characters.
<ENCRYPTED-PASS> – hash password via sha512 algorithm, set by the string of [2..32] characters.
Required privilege level
10
Command mode
CONFIG-PBX-REG-SERVER
Example
esr (config-pbx-reg-server)# authentication password 1234
username
This command specifies the username on the upstream registration server.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] username <UNAME>
Parameters
<UNAME> – authentication username on the registration server.
Required privilege level
10
Command mode
CONFIG-PBX-REG-SERVER
Example
esr (config-pbx-reg-server)# username esr
ip address
The command specifies the log server address.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] ip address <ADDR>
Parameters
<ADDR> – the registration server address, specified in A.B.C.D format, where it takes the value [0..255], or with a domain name from 1 to 31 characters long.
Required privilege level
10
Command mode
CONFIG-PBX-REG-SERVER
Example
esr (config-pbx-reg-server)# ip address eltex-co.ru
ip port
The command specifies the log server port.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] ip port <PORT>
Parameters
<PORT> – destination port on the registration server, may take the value [1 ... 65535].
Default value
5060
Required privilege level
10
Command mode
CONFIG-PBX-REG-SERVER
Example
esr (config-pbx-reg-server)# ip port 5060
domain
This command specifies the SIP domain on the registration server.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] domain <DSTR>
Parameters
<DSTR> – SIP domain on the registration server, specified by a word from 1 to 31 characters long.
Required privilege level
10
Command mode
CONFIG-PBX-REG-SERVER
Example
esr(config-pbx-reg-server)# ssw3.11
profile
This command specifies the SIP profile used when accessing the registration server.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] profile <PNAME>
Parameters
<PNAME> – SIP profile assigned to the registration server, specified by a word from 1 to 31 characters long.
Required privilege level
10
Command mode
CONFIG-PBX-REG-SERVER
Example
esr (config-pbx-reg-server)# profile sip_phones
enable
This command activates registration on a higher server.
The use of a negative form (no) of the command disables a current configuration.
Syntax
[no] enable
Parameters
The command does not contain parameters.
Required privilege level
10
Command mode
CONFIG-PBX-REG-SERVER
Example
esr (config-pbx-reg-server)# enable
Configuring the SIP profile on a PBX server
type
This command specifies the type created on the PBX SIP profile.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] type <TTYPE>
Parameters
<TTYPE> – type of the created SIP profile, may take the values {local | remote};
Local – profile is used to register on the local server;
Remote – profile is used to register on the remote server.
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# type local
client
This command specifies the type of clients using the SIP profile.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] client <CTYPE>
Parameters
<CTYPE> – type of the user connected to the profile can take one of the values {peer | friend | user}:
- peer – incoming and outgoing calls are allowed without authorisation;
- user – only incoming calls are allowed;
- friend – combines peer and user profile types.
Default value
peer
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# client friend
from-domain
This command assigns a SIP profile to a domain.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] from-domain <FDSTR>
Parameters
<FDSTR> – domain name, specified by a word from 1 to 31 characters long.
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# from-domain sip.domain
security level
This command defines how to handle connections with peers.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] security level <STYPE>
Parameters
<STYPE> – takes the value {port | invite | invire-port | address | support};
Port – allow checking peer compliance by ip-address without checking the port number;
Invite – do not require authentication of incoming INVITE messages;
Invite-port – combines port and invite;
Address – authentication only by IP authentication;
Support – allow calls without re-authentication.
Default value
None
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# security level address
nat
This command defines the interaction policy with NAT.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] nat <NTYPE>
Parameters
<NTYPE> – policy of interaction with NAT, may take values {comedia | force-port | both};
comedia – send media stream to PBX port, regardless of SDP instructions;
force-port – use rport even if it is not present;
Both – combines comedia and force-port.
Default value
None
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# nat comedia
codec allow
This command specifies the codecs used by the SIP profile.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] codec allow <ATYPE>
Parameters
<ATYPE> – type of codec allowed, may take values {G711A | G711U | G722 | G726}.
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# codec allow g722
qualify
This command configures client availability check.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] qualify <QTYPE>
Parameters
<QTYPE> – period of checking the availability of the client in milliseconds can take the value [100 ... 100000].
Default value
1000
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# qualify 100000
host-address
This command specifies the addresses of subscribers associated with this profile.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] host-address <ADDR>
Parameters
<ADDR> – subscriber address, specified in A.B.C.D format, where it takes the value [0..255], or with a domain name from 1 to 31 characters long.
Default value
dynamic
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# host-address 192.168.116.183
sip-port
This command specifies the port of subscribers associated with this profile.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] sip-port <PORT>
Parameters
<PORT> – port of subscribers is set by a number from 1 to 65535.
Default value
5060
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# sip-port 5062
authentication password
This command configures authentication of users with this profile.
The use of a negative form (no) of the command removes a current value.
Syntax
authentication password { <PASS> | encrypted <ENCRYPTED-PASS>}
no authentication password
Parameters
<PASS> – authentication password, set by the string of up to 16 characters.
<ENCRYPTED-PASS> – hash password via sha512 algorithm, set by the string of [2..32] characters.
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# authentication password 1234
username
This command configures username for subscribers with this profile.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] username <UNAME>
Parameters
<UNAME> – authentication name for users, specified by a word from 1 to 31 characters.
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# username user
protocol
This command specifies the transport protocol used by subscribers with this profile.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] protocol <PTYPE>
Parameters
<PTYPE> – used transport protocol, may take the value { tcp | udp | both }.
Default value
udp
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# protocol udp
ruleset
This command specifies the routing context to which this profile is bound.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] ruleset <RNAME>
Parameters
<RNAME> – routing context associated with this profile. Specified by a word from 1 to 31 characters.
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# ruleset local
in-band
This command configures the in-band signaling.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] in-band <ITYPE>
Parameters
<ITYPE> – may take values { always | not | never }:
- Always – always use in-band signaling;
- Not – do not use in-band signaling;
- Never – never use in-band signaling.
Default value
never
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# in-band not
rtp-media
This command enables the direction of RTP traffic directly between peers.
The use of a negative form (no) of the command removes a current value.
Syntax
[no] rtp-media
Parameters
The command does not contain parameters.
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# rtp-media
group pickup
This command assigns the SIP profile to the capture group.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] group pickup <GTYPE>
Parameters
<GTYPE> – pickup group, specified by the number from 1 to 31.
Default value
255
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# group pickup 16
group calling
This command assigns the SIP profile to the call group.
The use of a negative form (no) of the command sets the default value.
Syntax
[no] group calling <GTYPE>
Parameters
<GTYPE> – call group, specified by the number from 1 to 31.
Default value
255
Required privilege level
10
Command mode
CONFIG-PBX-PROFILE
Example
esr (config-pbx-profile)# group calling 16
Display PBX server information
show pbx peers
This command displays peers connected to PBX.
Syntax
show pbx peers
Parameters
The command does not contain parameters.
Required privilege level
1
Command mode
ROOT
Example
esr# show pbx peers
show pbx registrations
This command displays active registrations on the PBX server.
Syntax
show pbx registrations
Parameters
The command does not contain parameters.
Required privilege level
1
Command mode
ROOT
Example
esr# show pbx registrations