Enterprise services are SIP-enabled real-time communication systems and collaboration services. By configuring the ME to recognize a particular enterprise service, you are drawing that service under the security protection of the ME, preventing application-level attacks. These services allow an organization to support, among others:
IP PBX hosted VoIP services
Enterprise instant messaging systems
Mobile devices
Presence-based applications
Enterprise services work by establishing an application (directory) server, a SIP component in the enterprise. Client programs access the server to look up user entries, and the server expects a certain set of users to be using it. For example, a server might be an IBM/Lotus Sametime server. Using the ME, you would configure a link between that server and a directory containing the Sametime users.
Specifically, the ME supports the following enterprise servers:
IBM Lotus Sametime Server
Microsoft Live Communications Server (LCS) 2005
Nortel Multimedia Communications Server (MCS)
Avaya IP telephony PBX
A generic SIP source/destination
A generic SIP registration server
A DNS group
A SIP connection
An H.323 gateway
Note:
While you can configure directory services at any time, you must enable the master-services > directory object for the ME to use the service. See Configuring Master Services Objects for more information.For detailed information on the ME enterprise gateways, refer to the Oracle Communications OS-E Session Services Guide.
The server pool server-pool-admission-control objects provides inbound and outbound normalization settings to apply to calls going to or from the server. Use outbound-normalization for calls destined for a server; use inbound-normalization for calls received from the server. The objects properties are common for servers, gateway, and trunk groups, and are described in Configuring Normalization objects.
The following sections briefly describe each server type that is supported by the ME.
Note:
The ME may present server types other than those described here. Oracle does not recommend using these servers.Configures a generic SIP server. For example, it could be a SIP proxy, a SIP application server, or a PSTN gateway. By configuring the public switched telephone network (PSTN) gateway, you can configure the ME to allow enterprises to continue call operations even if their provider server is busy or down. The way that the ME handles unavailable servers and future call routing is controlled by the local-mode setting of the routing-settings property. See the routing-setting attribute descriptions for more information.
Specify the SIP URI for the gateway, in the form SIP:gatewayIdentity. For example, SIP:sip-server@broadsoft.com.
The SIP host is a generic server description that allows the ME configuration to include a server configuration for a non-explicit server type.
DNS-group is a server configuration template for servers that do not use a server pool configuration because they can be resolved by DNS. When the ME receives a REGISTER request, if the domain is the same as that configured for a dns-group, the ME clones the configuration of that dns-group for the server. The ME then does three DNS lookups: NAPTR, SRV, and A: to resolve the transport protocol, port, and address. (If multiple records are found, the ME uses the preference set in the DNS server to select the primary.) The ME then adds the server to the server pool. If the domain from the REGISTER is different from the dns-group, the ME creates a new server object and clones the configuration from the dns-group. Note that you must configure a dial plan and/or registration plan to point to the dns-group.
The SIP connection server type provides a client/server model between the ME and customer premise equipment. The ME fills the server role, while the connection (line) between the CPE and the ME acts as client. This connection may be a single line, a shared line, or a group of shared lines to the enterprise or a residence. The point of connection on a shared line (the CPE) represents one or multiple direct inward dial (DID) numbers. Behind the CPE, however, may be many more endpoints. In this configuration, the client initiates, or re-establishes in the event of failure, the connection with the ME.
Using this server type allows you to create a configuration specific to an AOR. For instance, it allows you to control the number of concurrent calls to (emission control) and from (admission control) the specific AOR. You can override the global location cache settings that set the number of concurrent calls, and allow more or fewer calls based on the connection.
Additionally, the ME can learn client transport information through dynamic registration. Within the registration-plan, you can reference a sip-connection type server. Then, when a REGISTER comes in from the CPE (sip-connection server) and matches a registration-plan, when the ME installs a location cache entry, it saves the sip-connection name and reference in the location entry. If the sip-connection has unknown transport information (host, port, transport, local port and so on), the ME can use the dynamic learn feature (if enabled), to derive the sip-connection transport information from the client registration.
Opens the server configuration object to allow setting the parameters for communication between the directory server and the ME, supporting the following enterprise services:
IBM Lotus Sametime Server (sametime)
Microsoft Live Communications Server 2005 (lcs)
Nortel Network Multimedia Communications Server (mcs)
Avaya IP telephony PBX (avaya)
A generic SIP source/destination (sip-host)
A PSTN gateway (sip-gateway)
DNS group
SIP connection
H.323 gateway
The ME uses strict, tight, or loose matching rules to map. A REGISTER request or INVITE must match according to what you have configured within this object. By default, the ME uses strict rules for mapping, meaning that it only maps to names that contain an exact match of the domain name you entered. If you have configured the domain-alias property, the ME uses tight rules, meaning it will map on either the name or alias. If you set the domain-subnet property, loose matching rules are in effect.
Note:
While you can configure directory services at any time, you must enable the master-services > directory object for the ME to use the service. See Configuring Master Services Objects for more information.Note:
When creating or editing a SIP gateway, specify the SIP URI for the gateway, in the form SIP:gatewayIdentity. For example, SIP:sip-server@broadsoft.com.The routing-setting property allows you to select one or more server attributes. The following table describes each of these attributes in detail.
| Attribute | Description |
|---|---|
|
normalization |
When the ME receives a request (e.g., an INVITE or REGISTER), it checks the host portion of the request. When normalization is enabled, if the host portion matches the domain name, domain name alias, the subnet, or a server-pool entry, the ME changes the host name to the server domain name. By making this change, the ME can then match the request on a configured dial or registration plan. |
|
auto-tag-match |
When enabled, if the server has a configured directory, the ME automatically creates a dial plan and registration plan for the server. |
|
auto-domain-match |
When enabled, the ME creates a domain-based dial and registration plan for the server. The plan uses the domain-exact request-uri-match type (matches any USER field and a HOST field containing the exact domain name specified). The ME uses the domain name configured for the server, and the resulting plans have no normalization or session configuration. The action associated with the plans is delegate. |
|
pstn-backup |
When a server is down (not reachable), if pstn-backup is not selected, the ME changes the state of the server to ”not available.” Any dial or registration plan with reference to that server is removed from the call routing or registration routing table. In its normal state, the ME operates in provider mode, forwarding calls to a provider application server. If the server fails, and the ME has location information for the provider, it forwards calls locally. Otherwise, the ME forwards calls to a PSTN gateway. You configure the gateway using the pstn-gateway server object. This is called local mode. When enabled, an unavailable server state changes to ”local mode.” Plan entries stay in the routing tables. |
|
outbound-association |
When enabled, the ME uses its management system to derive associations when originating a SIP message. When disabled, the ME sends the message straight through, which results in better performance. |
|
cxc-from |
When enabled, the ME changes the From header to the ME local identity when proxying registrations to an upstream server. When disabled the original URI remains in place, meaning that the REGISTER is derived directly from the sender. |
|
local-mode |
Sets the ME to always function in local mode. In provider mode, the normal state, the ME forwards calls to a provider application server. If the server has failed, and the ME has location information for the provider, it forwards calls locally. Otherwise, the ME forwards calls to a PSTN gateway. You configure the gateway using the sip-gateway server object. This is called local mode. The ME detects provider failure using the failover-detection property setting of the server-pool-admission-control object. When local mode is not selected, the system stays in local mode until the it determines that the server has resumed functionality. When the server again becomes available, the ME reverts the registrar peer back to provider mode and retries calling through the provider. If the call is successful, the ME stays in provider mode. |
The service-type property allows you to set the way the ME handles INVITE and REGISTER requests and database exchanges. The following table describes each of these settings in detail.
Table 36-2 Service-Type Definitions
| Attribute | Description |
|---|---|
|
provider |
Specifies the server as a provider peer, which means that the ME proxies INVITE and REGISTER requests. If a peer has proxy-registration configured, then the ME proxies the registration. In other words, the ME intercepts the REGISTER, stores the contact information in the location cache, and generates a new request with the ME as the contact. If the peer does not have proxy-registration configured, the ME does not proxy the registration. Instead, it checks the call routing table to see if the request URI matches a provider. If there is a match, the ME forwards the request to the peer listed in the table. If there is not a match, the ME walks the call routing table, entry by entry. If a match is found in the table, the INVITE is forwarded to the peer. Otherwise, the INVITE is forwarded to the default outbound proxy. |
|
internal |
Specifies the server as an internal peer (internal to the enterprise or subscriber community under a single service provider). If the internal peer is a SIP registrar, then the ME Engine does location database exchanges with it. When an INVITE matches a dial plan for an internal peer, the ME first looks up the location cache for forwarding information. If found, the INVITE is forwarded to the location binding. Otherwise, the INVITE is forwarded to the internal peer. |
|
external |
Specifies the server as an external peer (external to the enterprise or subscriber community under a single service provider). If the external peer is a SIP registrar, then the ME challenges the REGISTER request with RADIUS or DIAMETER, and if successful, then passes the request on to the external peer. The ME stores the location binding in the cache in case the external peer forwards future INVITEs. When an INVITE matches a dial plan for an external peer, the ME first looks up the location cache for forwarding information. If found, the INVITE is forwarded to the location binding. Otherwise, the INVITE is forwarded to the external peer. |
config vsp enterprise servers sametime string config vsp enterprise servers lcs string config vsp enterprise servers mcs string config vsp enterprise servers avaya string config vsp enterprise servers sip-gateway SIP:gatewayIdentity config vsp enterprise servers h323-server string config vsp enterprise servers sip-host string config vsp enterprise servers dns-group string config vsp enterprise servers sip-connection string
description: Associates a text string with a server configuration. The string displays in some event logs and status providers to help identify the target.
Default: There is no default setting
Example: set description E911server
admin: Specifies whether the system uses this server in the current session. If enabled, the system uses this server. If disabled, the system does not use this server.
Default: enabled Values: enabled | disabled
Example: set admin disabled
carrier: Associates a text string with a server. The string can later be used to group and categorize servers.
Default: There is no default setting
Example: set carrier server1
domain: Identifies a domain to be used by the system for server normalization. In cases where the server is associated with:
a single domain: Enter that domain.
multiple domains: Enter one of the domain names.
no domain: Enter another valid domain on the system. (This might be the case with a PSTN gateway for example.)
Also, you must set this property if you enable the settings > local-directory-based-user-services property without configuring the directory property (to assign a directory to a server). Set this domain name to match user SIP addresses to the appropriate server (by use of the domain).
Default: There is no default setting
Example: set domain voip.companyABC.com
routing-tag: Controls which outbound interface SIP traffic uses. The routing-tag indicates the interface on the server where a SIP message with a matching routing-tag would be forwarded. The SIP message derives its routing-tag from the session config or IP interface classification-tag, depending on the configuration scenario. This property sets the initial routing tag for a server. If there is a policy match that applies to the server, and that configuration sets a routing tag (with the routing-settings ingress- and egress-classification-tag), the policy setting takes precedence.
Default: There is no default setting
Example: set routing-tag lcs1
failover-detection: Determines the method to use to detect when an upstream server peer is unavailable (and has resumed availability).
Default: none
Values: none: The system does no checking, and the server peer always appears available, even when down.
auto: The system uses an internal algorithm to count transaction failures. If a message to the server fails, the system resends the message the number of times defined in the sip-settings > max-retransmissions property. When the system reaches the retransmission threshold, it increments the dead-threshold count and then starts the retransmission process again. When the server reaches the failure threshold (set with the dead-threshold property), the system changes the server state to DOWN and sends no further requests. The fallback timer (set with the dead-fallback-interval property) activates. When the timer expires, the system decrements the server dead count by one and can again send requests to the server. If it receives no response, the system again increments the count and reaches the threshold, restarting the process. If the server responds, the system decrements the dead count again, until the count reaches 0. Note that if there is a major transport error, such as ”no socket,” the system skips the retransmission step and increments the dead-threshold count. Use this setting in the case where a server does not respond to SIP OPTIONS messages. You must also enable the vsp > auto-server-fail-detection property (which acts like a master switch) when using this option.
ping: The system uses the sip-ping utility to check server availability. SIP ping sends SIP OPTIONS messages to a peer. When enabled, the system pings its peers at an interval defined in the ping-interval property. If the peer is not operational (determined by the dead-threshold property, the system switches to local mode if pstn-backup is checked (routing-setting property), or to unavailable mode if pstn-backup is not checked. When the system is again able to successfully ping the peer, it reverts to provider mode.
register: The system determines server availability by sending a REGISTER request to the server. If there is no response from the provider, the server is assumed down. Note that you must configure a user for the server, with the appropriate password. (See the user and password-tag properties).
Example: set failover-detection auto
failover-termination: Sets whether calls are disconnected if the ME detects server failure. If the failover-detection property is enabled (set to anything other than none), and a server fails, the ME terminates all calls going through that server when this property is enabled. When disabled, connections are unaffected.
Default: disabled
Values: enabled | disabled
Example: set failover-termination enabled
domain-alias: Sets the system to recognize an alias domain as the domain in which the server resides. You can enter as many aliases as you choose.
Default: There is no default setting
Example: set domain-alias eng.companyABC.com
domain-subnet: Sets the IP subnets serviced by this server.
Default: There is no default setting
Example: set domain-subnet 1.2.3.4/16
local: Sets the server local IP address.
Default: There is no default setting
Example: set local 192.168.1.4
ping-interval: Sets the number of seconds between ping packets sent between the system and the SIP registrar server.
Default: 10
Example: set ping-interval 30
dead-threshold: Specifies the number of transaction failures (and resulting retransmissions) a server can experience before the server state is changed to DOWN. This threshold is used in the auto and ping options of the failover-detection property.
Default: 4
Values: Min: 1 / Max: 255
Example: set dead-threshold 15
dead-fallback-interval: Sets the fallback timer for the server. During this period, the system does not send REGISTER or INVITES to the down server. After the timer expires, the system decrements the dead-threshold by 1. This timer is used in the auto and ping options of the failover-detection property.
Default: 300
Values: Min: 30 / Max: 65535
Example: set dead-fallback-interval 450
handle-3xx-locally-routing-lookup: Specifies whether the system should do a dial plan lookup on the REQUEST URI of a newly generated INVITE based on a 302 response received from this server. This property works in conjunction with the handle-3xx-locally property of the sip-settings session config object. If that property is enabled, the system generates a new INVITE when it receives a 3xx response. The system puts the contents of the CONTACT field in the REQUEST URI of the new INVITE. You should disable this feature if your server is configured to explicitly forward the message to a specified third sever. Set this to enabled if the message is coming from an endpoint with instructions to forward the message to a different AOR.
Default: enabled
Values: enabled | disabled
Example: set handle-3xx-locally-routing-lookup disabled
unregistered-sender-directive: Sets the action the system takes when it receives a packet with an unknown sender in the ”From” field of the INVITE packet. Use the registration-requirement-level setting in the route or source-route object to define what is considered unknown.
Default: allow; if you select refuse, the default result code is 400
Values: allow: The system permits the packet to proceed toward its destination.
discard: The system immediately discards the packet.
refuse [result-code][result-string]: The system discards the packet but sends a response to indicate having done so. The response includes an error code (default of 400 but you can enter any value between 400 and 699) and an optional description.
Example: set unregistered-sender directive refuse 404 ”unknown sender”
inbound-session-config-pool-entry: Specifies a session configuration entry to apply to all inbound traffic destined for this server.
Default: There is no default setting
Example: set inbound-session-config-pool-entry ”vsp session-config-pool entry inboundPolicy”
outbound-session-config-pool-entry: Specifies a session configuration entry to apply to all outbound traffic from or through this server.
Default: There is no default setting
Example: set outbound-session-config-pool-entry ”vsp session-config-pool entry outboundPolicy”
server-type: Sets the server version or function. The type that you select is dependent on the server type that you are configuring. See below for the options for each server.
sametime: Identifies the server as version 3.1, operating as either a direct or proxy server (SIP connector).
sametime-31
sametime-31-sip-connector
sametime-75
sametime-75-sip-connector
lcs: Identifies the LCS server version (2003 or 2005) and the function (server-only or access proxy).
lcs-2003
lcs-2003-access-proxy
lcs-2005
lcs-2005-access-proxy
ocs-2007
ocs-2007-edge-server
mcs: Identifies the server as Nortel Networks MCS.
nortel-mcs
avaya: Identifies the server as an Avaya PBX.
avaya
sip-host: When using the generic SIP server, identifies the function the server is fulfilling.
windows-messenger
sip-proxy
sipura
snom
polycom
office-communicator
nortel-mcp
sip-gateway: Identifies the server as a SIP gateway.
sip-proxy
sipx
dns-group: Identifies a DNS group.
dns-group
sip-connection: Identifies the connection type.
windows-messenger
sip-proxy
sipura
snom
polycom
office-communicator
nortel-mcp
h323-server: Identifies the server as an H.323 gateway.
h323-gw
h323-gatekeeper
peer-identity: Secondary property. Specifies a unique URI to identify a remote peer. The ME uses the peer identity (usually found in the FROM header) in peer-to-peer SIP messaging to identify where a SIP message is from. The system can use this information to identify a peer with which to swap location database records.
Default: There is no default setting
Example: set peer-identity sip:nnos-e@companyABC.com
directory: Secondary property. Creates the link between the server and the name directory it uses. Enter the full path name to a configured directory.
Also, if you enabled the settings > local-directory-based-user-services property, you must either set this property (to assign a directory to a server) or set the domain property to match user SIP addresses to the appropriate server (by use of the domain).
Default: There is no default setting
Example: set directory vsp\enterprise\directories\notes-directory ABCco
user: Secondary property. Assigns a user name that the system must supply when challenged by the server (the name of the person qualified to log into this directory server). Enter the name expected by the server, do not create it here. The user name and password-tag (below) are used for authentication between the system and server. This name must match the username configured on the server.
Default: There is no default setting
Example: set user admin
password-tag: Secondary property. Specifies the tag associated with the shared secret used to authenticate transactions between the system and this server. This is the tag associated with the password that the system must supply when challenged by the server. See Understanding Passwords and Tags for information on the ME two-part password mechanism.
This password associated with this tag must match the password configured on the server.
Default: There is no default setting
Example: set password-tag secure
routing-setting<attributes>: Secondary property. Sets attributes of the server. See Routing-Setting Definitions for a description of each option.
Default: normalization+outbound-association
Example: set routing-setting auto-tag-match+auto-domain-match
loop-detection: Secondary property. Sets the aggressiveness with which the system enforces call routing loop detection. (The most aggressive requires the fewest parameters to match for the system to drop the call.)
Default: tight
Values: strict: If the system receives a call from a SIP proxy, and a DNS or dial-plan lookup resolves that the source and destination address are the same, the system drops the call. This is the most aggressive.
tight: If the system finds the source and destination address, transport protocol, and port to be the same, it drops the call.
loose: The system uses standard SIP loop detection (based on the VIA header). When the system finds its own address in the list of SIP proxies traversed, it allows the packet through.
Example: set loop-detection strict
service-type: Secondary property. Specifies the way in which the system handles INVITE and REGISTER requests and database exchanges. See Service-Type Definitions for complete descriptions of each option.
Default: provider
Values: provider | internal | external
Example: set service-type internal
peer-max-interval: Secondary property. Specifies the value the system writes to the max-interval setting for a peer. When doing registration delegation, the system changes the expiration value in the REGISTER request to the specified max-interval when delegating it to the upstream server. The system saves the expiration value recorded in the 200OK from the upstream server to its location cache. If you enter 0, the peer value remains.
Default: 86400
Example: set peer-max-interval 0
peer-min-interval: Secondary property. Specifies the value the system writes to the min-interval setting for a peer. When doing registration delegation, the system changes the expiration value in the REGISTER request to the specified min-interval when delegating it to the upstream server. The system saves the expiration value recorded in the 200OK from the upstream server to its location cache. If you enter 0, the peer value remains.
Default: 3600
Example: set peer-min-interval 0
registration-request-timeout: Secondary property. Specifies the number of seconds the system waits for a response after sending a REGISTER request to this server. If the system does not receive a response within the configured time, it sends, to the endpoint, notification that service is not available.
Default: 10
Example: set registration-request-timeout 8
default-policy: Secondary property. Sets the name of the policy to apply if no more specific policy is in place. Enter a previously configured policy reference.
Default: There is no default setting
Example: set default-policy vsp\policies\session-policies\policy lcs
user-group-policy: Secondary property. Specifies the policy to apply to users of this server who are members of the specified group. The group can be either a user group from the directory service schema or a virtual group constructed in the configuration for policy application purposes.
Enter a group name, and the system applies the specified policy to any user belonging to that group. Also enter the complete path to a previously configured policy reference.
If this value is set both here and at the enterprise level, through the enterprise object, the system applies both settings.
Default: There is no default setting
Example: set user-group-policy lcsAdmin ”vsp policies session-policies policy noIM”
to-policy: Secondary property. References a policy to apply. If the SIP messages that start a session are directed to this server, the system applies and evaluates the referenced to-policy.
Default: There is no default setting
Example: set to-policy vsp\policies\session-policies\policy toPolicy
from-policy: Secondary property. References a policy to apply. If the SIP messages that start a session come from this server, the system applies and evaluates the referenced from-policy.
Default: There is no default setting
Example: set from-policy vsp\policies\session-policies\policy fromPolicy
fork-delay: Secondary property. Sets the period that the system waits before ”ringing” another SIP device registered with a user.
Default: 0 (all destinations ring simultaneously)
Example: set fork-delay 3
server-pool-flush: Secondary property. Activates the ability to flush the server pool and relearn the entries from its configuration and the DNS server. The frequency with which the system flushes the server pool is determined by the TTL on the DNS response.
Default: disabled
Values: enabled | disabled
Example: set
message-filtering: Secondary property. Specifies a message filter to apply to traffic passing through this server. Do not change this setting from the default, none, unless specified to do so by Technical Support personnel.
Default: none Values: none | st-AD local-domain federated-domain
Example: set message-filtering none
add-user-to-connect: Secondary property. When enabled, the ME puts the ”user” (defined in the same server configuration) into the contact during register fail-over detection. For example the contact looks like this:
”Contact: sip:user@1.2.3.4:5060; transport=udp;expires=3600”
By default this parameter is disabled and the contact looks like this:
”Contact: sip:user@1.2.3.4:5060; transport=udp;expires=3600”
Default: disabled
Values: enabled | disabled
Example: set add-user-to-connect enabled
ping-mode: Allows you to modify how the ME decides when to mark a server up or down when it receives a response from a remote server to an OPTIONS ping.
Default: promiscuous-mode
Values: promiscuous-mode: When an OPTIONS ping is sent to the server, if any response is received, the server is considered up. The only case where the server is marked down is a timeout from no response.
restricted-mode: When an OPTIONS ping is sent to the server, the server must respond with a 200OK or it will be considered down.
Example: set ping-mode restricted-mode
domain-port: (dns-group only) Provides local-port functionality for a server of type dns-group. See the server-pool-admission-control > local-port property description for details.
Default: There is no default setting
Values: Min: 1 / Max: 65535
host: (dns-group and sip-connection only) See the server-pool-admission-control > host property description for details.
transport: (dns-group and sip-connection only) See the server-pool-admission-control > transport property description for details.
port: (dns-group and sip-connection only) See the server-pool-admission-control > port property description for details.
local-port: (dns-group and sip-connection only) See the server-pool-admission-control > local-port property description for details.
connection-role: (sip-connection only) See the server-pool-admission-control > connection-role property description for details.
admission-control: (dns-group and sip-connection only) See the server-pool-admission-control > admission-control property description for details.
emission-control: (dns-group and sip-connection only) See the server-pool-admission-control > emission-control property description for details.
max-bandwidth: (dns-group and sip-connection only) See the server-pool-admission-control > max-bandwidth property description for details.
max-number-of-concurrent-calls: (dns-group and sip-connection only) See the server-pool-admission-control > max-number-of-concurrent-calls property description for details.
max-calls-in-setup: (dns-group and sip-connection only) See the server-pool-admission-control > max-calls-in-setup property description for details.
Secondary object. Configures SIP communications settings for calls destined for the server. These settings override SIP settings from the default session configuration. However, these settings are overridden from outside the session configuration by SIP settings contained in any matching policy rules.
Creates a configuration of servers that the ME uses to access enterprise information. A server pool is a logical construct used to group physical interfaces (hosts) into a shared resource for registration and INVITE requests. Add servers to the pool using the server-pool-admission-control subobject.
call-routing-on: Secondary property. Specifies whether the system does routing or location lookups based on the Request URI, the To URI, or an alternate setting. By default, the system performs lookups on the Request URI. Change this setting, for example, when routing information is not available in the Request URI but it is available in the To URI.
This setting applies to all servers in the pool. All calls from all servers in the pool are looked -up based on the URI set with this property.
This setting can also be configured in the arbiter object. If values are set in both this and the arbiter, the arbiter settings take precedence.
Default: request-uri
Values: request-URI: The Request URI, which contains the hop-by-hop destination for the call
to-uri: The To URI, which contains the final destination of the call
as-is: The Request URI (the default) or the value set for this property in the arbiter object
Example: set call-routing-on to-uri
handle-response: Specifies the action the system should take when it receives a specific response code from this server. Enter a code, and set a handling pattern.
Default: try-next-peer
Values: try-next-peer: The system forwards the message to the next server within this server pool
try-next-route: The system forwards the message to the route that is the next most-specific. Use this in conjunction with the arbiter-apply joined-matches option (in the arbiter object).
forward: The system returns the response to the originator of the message
Example: set handle-response 404 forward
dialog-failover: When enabled, the dialog-failover setting forces the ME to check the state of the destination SIP server before sending messages. If the destination server is down, the calls are routed to the next configured (and available) backup server.
For dialog-failover to work, the failure-detection property must be set to auto, ping, or register in the servers and/or exchange objects.
When dialog-failover is set to disabled, any calls in progress at the time of the failure will be retried at the original destination server until the configured timeout settings have expired.
Default: disabled
Values: enabled | disabled
Example: set dialog-failover enabled
server-gatekeeper-id: Secondary property. Specifies the way the ME reaches an H.323 Gatekeeper.
Default: dynamic
Values: dynamic: The ME learns the Gatekeeper ID via RAS messaging.
static: The GKId string must be configured. The ME uses this configured string to contact a remote H.323 Gatekeeper.
Example: set server-gatekeeper-id static
remote-web-services-fetch-timer: Configures the allowed interval to collect redirect statistics before the ME times out.
Default: 5000
Values: Min: 0 / Max: 4294967296
Example: set remote-web-services-fetch-timer 7000
Allows you to configure a server-pool CAC on any enterprise server that contains a pool.
max-bandwidth: Enter the maximum amount of bandwidth, in kbits per second, the ME allocates to the AOR. When the system reaches the maximum bandwidth limit for a server, it rejects calls until bandwidth use drops below the maximum.
Default: unlimited
Values: Min: 0 / Max: unlimited
Example: set max-bandwidth 1000
max-number-of-concurrent-calls: Specify the maximum number of active calls allowed for this AOR at one time. When this value is reached, the connection does not accept calls until the value drops below the threshold.
Default: 1000
Values: Min: 0 / Max: 1000000
Example: set max-number-of-concurrent-calls 5000
max-calls-in-setup: Sets the maximum number of simultaneous call legs in setup stage that are allowed for this AOR. A call leg in setup is much more compute-intensive than established call legs, so this value is more restrictive than the concurrent call leg value. A value of 0 causes the system to decline all calls and registrations.
Default: 30
Values: Min: 0 / Max: 10000
Example: set max-calls-in-setup 5000
call-rate-limiting: Limits the number of calls sent to an AOR within a certain interval in seconds. Once this interval is reached, the system rejects any calls to or from this AOR until the rate decreases, returning a response code and message. This feature sets the acceptable arrival rate for incoming calls when used with admission-control and the acceptable set-up rate when used with emission-control. When this feature is enabled, set the number of calls and the measurement interval. You can also enter a result code from 400 to 699 and a text string to accompany call rejection if no available server is found.
Default: disabled
Values: enabled | disabled
Example: set call-rate-limiting enabled
admission-control: Specifies whether the system considers AOR limitations when forwarding a call from the AOR. The system tracks the number of concurrent (both incoming and outgoing) active calls for this AOR.
Default: disabled
Values: enabled | disabled
Example: set admission-control enabled
emission-control: Specifies whether the system considers AOR limitations when forwarding a call to this AOR. The system tracks the number of concurrent (both incoming and outgoing) active calls for this AOR.
Default: disabled
Values: enabled | disabled
Example: set emission-control enabled
call-admission-control-error-code: Enter the call admission error code.
Default: 503
Values: Min: 400 / Max: 999
Example: set call-admission-control-error-code 550
call-admission-control-error-string: Enter the text string the user sees when a call admission control error occurs.
Default: There is no default setting
Example: set call-admission-control-error-string cac error
call-emission-control-error-code: Enter the call emission error code.
Default: 503
Values: Min: 400 / Max: 999
Example: set call-emission-control-error-code 550
call-emission-control-error-string: Enter the text string the user sees when a call emission control error occurs.
Default: There is no default setting
Example: set call-emission-control-error-string cac error
Adds server connections to the server pool. You must identify the server by host name or IP address. Optionally, you can set a preference, protocol, port, load-balancing, and other criteria, as well as limit connections.
Each server in a pool has an associated order of preference. The server with the lowest order is preferred, and becomes the primary. The other servers are backups. If the primary is up, as indicated by the ME monitoring process, then registrations and INVITE requests are sent there. If it is down (but the backup is up), then the ME sends requests to the backup. When the primary later becomes available again, the ME resumes sending registrations and INVITE to it.
If both the primary and backup are down, then the peer changes to local mode. In local mode, the ME does not proxy registrations to the failing peer. Instead, if the To header is addressed to a SIP phone directly connected to the ME (it has a location binding with the ME), INVITEs are switched locally. If the To header is addressed to a location out of reach of the ME, the INVITE is forwarded to the configured PSTN gateway: (The gateway is configured with the sip-gateway server object.)
If the primary or backup later becomes available, the peer reverts from local back to provider mode, and again forwards registrations and INVITE to the primary or backup server.
The server object allows you to configure normalization plans for outgoing and incoming calls. See Configuring Normalization objects, for a full description of the server object outbound-normalization and inbound-normalization subobjects.
host: Specifies the host name or IP address of an Internet endpoint. Enter a host name or IP address.
Default: There is no default setting
Example: set 192.168.10.10
endpoint: Associates a text string with a server-pool server. The string can later be used to group and categorize servers.
Default: There is no default setting
Example: set endpoint server1
transport: Specifies the protocol used by the connection.
Default: UDP
Values: any | UDP | TCP | TLS
Example: set transport any
port: Specifies the port used by the connection for SIP traffic.
Default: 5060
Example: set port 3333
local-port: Sets a port number for the system to use in the Contact header, Via header, and source port when it sends a Register request (and subsequent SIP messages) to an upstream server. The server caches the binding and includes the local-port when contacting the system. Additionally, the server can be configured to send SIP messages to this particular local-port without prior registration from the system.
With local-port configured, the system can tell:
To which connection in the server pool to forward a call
Which connection in the server pool it received the call from, when the connection sends SIP message to this local port
Using this property allows you to group traffic based on the local port number. For example, if there are multiple domains from a single physical server, the port will indicate which domain should receive the call. Or, if there is a distinct pair of physical servers to protect traffic for a domain, the Eclipse can fail over to the right backup server (in case of primary failure) for this particular domain.
Default: There is no default setting
Example: set local-port 5050
connection-role: Specifies the way the server behaves in establishing a TCP/TLS connection. If set to initiator, the server can open up a connection without any SIP traffic. If set to responder, the server will not open up a TCP/TLS connection until receiving SIP traffic.
Default: initiator for server-pool and responder for sip-connection
Values: initiator | responder
Example: set connection-role responder
connection-retry-interval: Specifies the number of seconds the system waits between attempts to open a TCP or TLS connection. This value is only meaningful if the connection-role property is set to initiator. If set to responder, the value is ignored.
Default: 5
Example: set connection-retry-interval 10
preference: Specifies the preference for the connection. The lower the value the higher the preference. If you use the value of none, the system uses the preference set in a different part of the configuration, such as the ordered set of arbitration rules in the dial-plan object.
Default: none Values: none | integer [0-65535]
Example: set preference 1
admission-control: Specifies whether the system considers downstream server capacity when forwarding a call from the server. The ME tracks the number of concurrent calls for each server. If this property is enabled, the system does not forward calls from the server if the server limit has been reached and instead sends a ”503 Service Unavailable” message. If disabled, the system does forward calls from the server. (Set the call limit with the max-number-of-concurrent-calls property.) See Admission Control for an AOR for specific information on CAC settings applicability for an AOR.
Default: disabled
Values: enabled | disabled
Example: set admission-control enabled
emission-control: Specifies whether the system considers upstream server capacity when forwarding a call to the server. The ME tracks the number of concurrent (both incoming and outgoing) active calls for the server. If this property is enabled, the system does not forward calls to the server if the limit, set with the max-number-of-concurrent-calls property, has been reached. Instead, the system sends one of the following messages and drops the call:
If there is one outbound server/UAC/UAS, the system sends a ”486 Busy” message, indicating that the route was resolved but that the AOR was unavailable.
If there are multiple outbound server/UAC/UASs and all have reached the maximum concurrent calls threshold, the system sends a ”486 Busy” message.
If there are multiple outbound server/UAC/UASs and at least one has not reached the maximum concurrent calls threshold, the return code is determined by the final server that the system attempted to reach. This could be, for example, ”486 busy” or a ”504 server timeout” if the last server was unresponsive and the transaction timed out.
If disabled, the system continues to forward calls to the server.
Default: disabled
Values: enabled | disabled
Example: set emission-control enabled
max-bandwidth: Specifies the amount of bandwidth the system allocates to a connection. For a SIP server, the default value is unlimited or the server uplink bandwidth. For example, if the uplink is GigE, then bandwidth is 1 million kbps. When the system reaches the maximum bandwidth limit for a server, it rejects calls until bandwidth use drops below the maximum.
Note that the bandwidth usage value is based not on the actual traffic on the wire, but on a calculation done by the system. The calculation uses the value associated with the first known CODEC identified in the SDP for a usage rate. If there is not a known CODEC, or the value has not yet been determined from the SDP, the system uses the default-session-bandwidth value from the session configuration media object.
Set a specific bandwidth if you are using, for example, a TDM trunk or PSTN gateway with limited bandwidth. For a PSTN trunk, the usual capacity is DS0 (64 kbps bandwidth). If a gateway has 8 trunks, then the gateway has 512 kbps bandwidth.
Default: unlimited Values: unlimited | kbps
Example: set max-bandwidth 512
max-number-of-concurrent-calls: Specifies the number of calls allowed on the connection at one time. When this value is reached, the connection will not accept calls until the value drops below the threshold.
Default: 1000
Values: Min: 0 / Max: 1000000
Example: set max-number-of-concurrent-calls 1500
max-calls-in-setup: Sets the maximum number of simultaneous inbound and outbound call legs in setup stage that are allowed for the connection. A call leg in setup is much more compute-intensive than established call legs, so this value is more restrictive than the concurrent call leg value. A value of 0 causes the system to decline all calls and registrations.
Default: 30
Values: Min: 0 / Max: 10000
Example: set max-calls-in-setup 5
call-rate-limiting: Secondary property. Limits the number of calls sent to a server within a certain interval. Once this interval is reached, the system hunts for the next available server. If there are no available servers, the system returns a response code and message. This feature sets the acceptable arrival rate for incoming calls when used with admission-control and the acceptable set-up rate when used with emission-control.
If enabled, set the number of calls allowed and the measurement interval (in seconds). You can also enter a result code from 400 to 699 and a text string to accompany call rejection if no available server is found.
Default: disabled; if set to enabled, the default calls-per-interval is 60, the default interval is 1 second, and the default result is 486, Busy Here. Values: enabled <calls-per-interval><interval><result-code><result-string> | disabled
Example: set call-rate-limiting enabled 50 1 480 ”Temporarily unavailable”
max-number-of-registrations: Secondary property. Specifies the maximum number of registrations that can be active with a server at any one time. This property is used in conjunction with the server-registration-balance property of the VSP settings object to implement registration load balancing.
Default: 1000
Values: Min: 0 (causes the WebRTC Session Controller Media Engine to decline all calls and registrations) / Max: 1000000
Example: set max-number-of-registrations 1500
max-registrations-in-progress: Secondary property. Specifies the number of registrations or authentication requests per second that the system forwards to the server. Use this property as a flow control mechanism to control the system, which can process registrations much more quickly than the server. To set this, you must know the capability of your server. You also must enable the server-registration-balance property of the VSP settings object.
When a register is delegated/forwarded/tunneled to the server, the system increments a cluster-wide server counter. When the counter reaches this threshold, the system handles subsequent registrations. It responds with ”200 OK,” but sets a brief expiration, causing the phone to reregister almost immediately.
Default: 300
Values: Min: 0 (causes the WebRTC Session Controller Media Engine to decline all calls and registrations) / Max: 100000
Example: set max-registrations-in-progress 600
external-outbound-normalization: Secondary property. Specifies whether the system should perform external normalization on outbound call legs. Enter the host name of your calling plan server.
Default: no Values: no | yes server
Example: set external-outbound-normalization yes ITALKBB-EGR5
external-inbound-normalization: Secondary property. Specifies whether the system should perform external normalization on inbound call legs. Enter the host name of your calling plan server.
Default: no Values: no | yes server
Example: set external-inbound-normalization yes PT1-INGRESS
handle-unregister-locally: Secondary property. Specifies under what circumstances the ME can process an UNREGISTER request. When enabled, the system processes the request even if the REGISTER was not sent by the same registration endpoint.
Default: disabled
Values: enabled | disabled
Example: set handle-unregister-locally enabled
Opens the error-response-codes configuration object where you can specify custom admission-control, emission-control, and server down error codes and text strings that will be returned in the SIP response and captured in the event log.
call-admission-control-error-code: Modifies the error code to be returned in the SIP response when a call-admission-control error occurs.
Default: 503
Values: Min: 400 / Max: 999
Example: set call-admission-control-error-code 550
call-admission-control-error-string: Creates a user-defined text string to be returned in the SIP response when a call-admission-control error occurs.
Default: There is no default setting
Example: set call-admission-control-error-string cac error
call-emission-control-error-code: Modifies the error code to be returned in the SIP response when a call-emission-control error occurs.
Default: 503
Values: Min: 400 / Max: 999
Example: set call-emission-control-error-code 550
call-emission-control-error-string: Creates a user-defined text string to be returned in the SIP response when a call-emission-control error occurs.
Default: There is no default setting
Example: set call-emission-control-error-string cac error
server-down-error-code: Modifies the error code to be returned in the SIP response when a destination SIP server is down.
Default: 503 (Bad Gateway)
Example: set server-down-error-code 403
server-down-error-string: Creates a user-defined text string to be returned in the SIP response when a destination SIP server is down.
Default: There is no default setting
Example: set server-down-error-string error
Sets the characteristics of the relationship between two peers that are both proxies. When the ME acts as a proxy, it is able to supply the credentials needed for authentication challenges. It maintains a location service database to store SIP caller location (address-of-record) information. This database can be updated via the ME registration service, static address-of-records (AORs), and/or configured the ME policies. To ensure that peer systems have and use the same database, set the properties of this object.
You can also set the registration-proxy property in the vsp object. In that instance, you are optimizing system performance by specifying whether the ME should walk the database.
admin: Enables or disables this proxy registration configuration. If enabled, the server applies these characteristics to sessions with its configured peers. If disabled, these characteristics are inactive.
Default: enabled
Values: enabled | disabled
Example: set admin disabled
request-download: Automates the download of the registration database from a peer. (Peers are identified in the server configuration.) If set to yes, the peer system downloads the database to this server with the frequency set in the request interval of this property. In addition, it copies the interval to the expiration time in the REGISTER requests forwarded to peers. If set to no, downloads do not occur automatically. The system only learns of new or changed AORs through REGISTER requests.
Default: no; if set to yes, the default interval is 1440 minutes Values: no | yes minutes
Example: set request-download yes 1080
Sets the properties specific to the server socket. To set general system network parameters, including other socket properties, use the services network object. This object is only applicable to sip-connection.
tcp-keepalive-time: Specifies the time, in seconds, that an established TCP connection can remain idle before the system sends a keepalive to the client. The idle time expiration initiates the keepalive process.
Default: 600
Values: Min: 10 / Max: 14400
Example: set tcp-keepalive-time 900
tcp-keepalive-probes: Specifies the number of unanswered TCP keepalive probes that are allowed before the system determines a session is idle and disconnects it.
Default: 5
Values: Min: 2 / Max: 16
Example: set tcp-keepalive-probes 10
tcp-keepalive-interval: Specifies the time, in seconds, that the system waits for a response from a keepalive probe before ending the next one. The ME continues to send probes until it has sent the number specified in the tcp-keepalive-probes property.
Default: 6
Values: Min: 1 / Max: 60
Example: set tcp-keepalive-interval 10
tcp-ephemeral-port-start: Secondary property. Configures the local TCP ephemeral port range start. Well-known ports or ports configured for use with SIP or H.323 should not be allocated in the local port pool range. Well-known ports or ports configured for use with SIP and H.323 should not be allocated in the local port pool range.
Default: 1024
Values: Min: 1024 / Max: 65535
Example: set tcp-ephemeral-port-start 2025
tcp-ephemeral-port-end: Secondary property. Configures the local TCP ephemeral port range end. Well-known ports or ports configured for use with SIP or H.323 should not be allocated in the local port pool range. Well-known ports or ports configured for use with SIP and H.323 should not be allocated in the local port pool range.
Default: 4999
Values: Min: 1024 / Max: 65535
Example: set tcp-ephemeral-port-end 3025
Configures the ME to recognize the Avaya Converged Communication Server (CCS), a SIP proxy server that connects to the company's proprietary IP telephony solution, the Avaya Call Manager (ACM). The CCS will add SIP-based voice, presence, and Instant Messaging (IM) services.
This feature is only applicable to Avaya.
server: Sets the IP address of the computer hosting the CCS service.
Default: There is no default setting
Example: set server 192.168.10.10
port: Sets the TCP port of the SIP proxy service on the computer hosting the CCS service.
Default: There is no default setting
Example: set port 2020
mode: Specifies the type of server this CCS server is functioning as.
Default: home-edge
Values: edge: An edge device, allowing domain routing
home: A home device with only one domain configured
home-edge: A combination device
Example: set mode edge
Sets the configuration for scenarios when the ME is communicating with an external H.323 GK. (This property is only applicable if the server-type property is set to h323-gatekeeper.) When the ME registers on behalf of a client, these settings allow the systems to exchange RAS messages.
registration-ttl: Sets the time to live (TTL), in seconds, for registration to the external GK.
Default: 3600
Values: Min: 0 / Max: 4294967295
Example: set registration-ttl 5000
registration-retries: Sets the number of RRQs or GRQs the ME resends to an external GK before abandoning the request. A value of 0 allows unlimited retries.
If multiple external GKs exist, this property is not used to control RRQ and GRQ retransmission.
Default: 5
Values: Min: 0 / Max: 4294967295
Example: set registration-retries 100
admission-retries: Sets the number of times the ME resends an ARQ to an external GK before refusing to admit the call.
Default: 3
Values: Min: 0 / Max: 4294967295
Example: set admission-retries 5
endpoint-alias: Assigns a string to the GRQ and RRQ to allow the external GK to identify the ME.
Default: EPAlias
Example: set endpoint-alias alias1
supported-prefix: Sets the value for GKs that need digits prepended to a number.
Default: +1
Example: set supported-prefix +4
prefix-type: Adds a voice capability supported prefix to the supported protocols identified in the ME-transmitted GRQ and RRQ.
Default: h323ID
Values: none
dialedDigits
h323ID
urlID
emailID
Example: set prefix-type none
reregister-on-urq: Specifies whether the ME tries to reregister a client after having received an UNREGISTER from the GK. When enabled, the ME tries to reregister the client up to the number of times specified in the registration-retries property.
Default: disabled
Values: enabled | disabled
Example: set reregister-on-urq enabled
calls-gk-routed: When true, T_H225CallModel_gatekeeperRouted is the call model in an ME-transmitted ARQ. When false, T_H225CallMode_direct is the call mode the ME uses.
Default: false
Values: true | false
Example: set calls-gk-routed true
use-alternate-gks: When true, supportsAltGKPresent is present in an ME-transmitted RRQ.
Default: false
Values: true | false
Example: set use-alternate-gks true
retries-before-alt-gk: Specifies how many times the ME resents an RRQ or GRQ to an external GK when multiple external GKs exist.
Default: 10
Values: Min: 0 / Max: 4294967296
Example: set retries-before-alt-gk 25
use-lightweight-rrq: When true, the ME reregisters with an external GK using a lightweight RRQ.
Default: false
Values: true | false
Example: set use-lightweight-rrq true
gk-round-robin: Specifies how the ME handles external GKs that have previously rejected the ME.
Default: PollRejected
Values: IgnoreRejected: The ME ignores rejected GKs.
PollRejected: The ME contacts external GKs that have previously sent GRJ or RRJ to the ME.
Example: set gk-round-robin IgnoreRejected
wait-for-gk-response: Determines the length of time, in seconds, the ME waits for a response to a GRQ or RRQ.
Default: 15
Values: Min: 1 / Max: 4294967296
Example: set wait-for-gk-response 44
wait-for-admit-response: Determines the length in time, in seconds, the ME waits for a response to an ARQ.
Default: 5
Values: Min: 1 / Max: 4294967296
Example: set wait-for-admit-response 10
wait-for-location-response: Determines the length of time, in seconds, that the ME has to process a received LRQ before timing out.
Default: There is no default setting
Example: set wait-for-location-response 15
delay-all-gks-rejected: Specifies the length of time, in seconds, the ME waits before attempting external GK discovery and registration when all external GKs have rejected all GRQs and RRQs from the ME.
Default: 15
Values: Min: 1 / Max: 4294967296
Example: set delay-all-gks-rejected 25
use-lrqsrc-endpoint-info: Determines if the H.323 process extracts sourceEndpointInfo from a received LRQ to pass to SIP for use in destination route lookup.
Default: false
Values: true | false
Example: set use-lrqsrc-endpoint-info true
create-gk-sessions: When true, the ME creates sessions for all RAS discovery and registration traffic sent by the ME to external GKs.
Default: false
Values: true | false
Example: set create-gk-sessions true
tos: Enables or disables packet marking. Marking (tagging) a packet provides a QoS indicator, which routers along the path may act on. The ME writes this value to the ToS field of the IP header. Enter this value in hexadecimal or decimal format.
Default: There is no default setting
Values: disabled | tos <0-255>
Example: set tos 128