Table Of Contents
Configuring the Cisco Unified Application Server
Configuring Components
Applications
Partitions
Media Server Engines
Providers
Telephony Servers
Configuring SCCP Devices
Configuring System Parameters
Service Control
SSL Management
Redundancy Setup
Configuring Environment Parameters
User Management
Configuring Core Components
Log Server
Alarm Management
Configuring the Cisco Unified Application Server
This chapter describes how to use the Cisco Unified Application Environment management console to manage application servers and includes these sections:
•
Configuring Components
• Configuring System Parameters
• Configuring Environment Parameters
Configuring Components
The management console provides access to the system components used to manage IP telephony
applications. The Components group contains links to these configuration pages:
• Applications—Install and uninstall applications
• Partitions—Control configuration profiles for an application
• Media Server Engines—Enable the Cisco Unified Application Environment to act as a media endpoint
• Providers—Display the list of providers, which open network ports and allow the runtime environment to communicate with devices
• Telephony Servers—Configure interactions with IP telephony devices
Applications
You must open the Applications page ( Figure 3-1) to install and uninstall applications. When you open the Applications page, the page displays the application name (displayed as a link), status, and version number. An application typically includes configuration items that are unique to your deployment and which you must configure after the application is installed.
This section describes how to install, enable, disable, modify, and uninstall applications.
Note All application configuration occurs at the partition level. See the "Partitions" section for information about partitions.
Figure 3-1 Applications Page
To install an application, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Applications.
Step 2 Click Browse and highlight the file.
Step 3 Click Open.
Step 4 Click Upload File.
The Application Manager processes the file, installs the application, and updates the Applications page to list the application.
To enable an application, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Applications.
Step 2 Click the underlined application link.
Step 3 Click Enable Application.
The application begins running. If you return to the Applications page, the Status column shows that the application is enabled.
To disable an application, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Applications.
Step 2 Click the underlined application link.
Step 3 Click Disable Application.
The application stops running. If you return to the Applications page, the Status column shows that the application is Disabled.
To modify application settings, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Applications.
Step 2 Click the underlined application link.
Step 3 Make changes as needed.
Step 4 Click Apply.
To uninstall an application setting, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Applications.
Step 2 Click the underlined application link.
Step 3 If the application is enabled, click Disable Application.
Step 4 Click Uninstall Application.
Step 5 Click Yes to confirm.
The application is removed.
Partitions
All application configuration occurs at the partition level. A partition is a configuration profile for an application. Applications can support multiple partitions, enabling you to create and execute multiple versions of the same application on a single Cisco Unified Application server.
Partitions are flexible and can be useful in a variety of situations. For example, if an application is intended to serve end-users located on distinct Cisco Unified CallManager clusters, it is often desirable for all call control and media streams to terminate to the network and telephony resources contained within each cluster. At the same time, it may be desirable to have another configurable protocol on the application, such as LDAP, which makes reference to the same central location, regardless of the partition.
Each partition is associated with a call route group and media resource group. By defining unique call route groups and media resource groups, you can identify the partitions that use individual media servers. For each partition, you can also determine which Cisco Unified CallManager cluster is used for making calls by specifying a call route group that corresponds to the particular telephony protocol and group.
Each application is also associated with scripts, which are partitioned along with the application. Because multiple scripts can execute actions through the same protocol, you must specify the conditions under which a partitioned script should initiate action.
For example, assume that an application has one script and three partitions and activates on an IncomingCall trigger. The default partition has no triggering parameters and can act as a catch-all for events which do not match other partitions.
The application server determines the best match handler for a given event. Other partitions take effect if their trigger parameters are activated. For example, if Partition 2 specifies to=2000, then when a call comes in for extension 2000, partition 2 will activate. If no trigger matches, the default partition will be active.
A partition is similar to a configuration template for a script and follows these rules:
•The application developer sets the event that triggers a script. The event applies to all partitions and cannot be changed.
•All installed script partitions across all applications are treated as equal.
•If any two partitions have identical triggering criteria, either one may trigger; therefore, it is important that all partitions have unique triggering criteria.
•The router will match the handler that best fits the events. For example, if partition A specifies to=2000 and partition B specifies to=2000 and from=1000, then a call from 1000 to 2000 triggers B.
To create a new partition, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Applications.
Step 2 Click the underlined application name.
A page opens to display available settings ( Figure 3-2).
Figure 3-2 Application Manager Example Page
Step 3 Click Create Partition.
Step 4 Configure settings as described in Table 3-1.
Step 5 Click Create Partition.
Note Parameter values are inherited from the default partition, and all unchanged parameters in the new partition remain linked to parameters in the default partition. These parameter values will be updated in the new partition to match any changes made to them in the default partition.
Step 6 Scroll down to the Scripts section and click Edit Trigger Parameters.
Step 7 Enter at least one trigger parameter name and value. Trigger requirements are dictated by the needs of the application and are beyond the scope of this document.
Step 8 Click Done to return to the application page.
Table 3-1 Partition Parameters
Field
|
Description
|
Name
|
Name of partition.
|
Description
|
Information to identify the partition.
|
Enable
|
Indicates whether the partition is active.
|
Reserve Media Early
|
Indicates whether to reserve media ports early to reduce setup time.
|
Call Route Group
|
Used by an application only when making outbound calls.
The protocol of the inbound call is determined by a combination of the Cisco Unified CallManager configuration and triggering parameters on the partitioned script.
|
Media Resource Group
|
Media server group that closet to the IP endpoints that are using this application.
|
Preferred Codec
|
Preferred media resource codec.
|
Defining Trigger Parameters
You can define triggers in any of the following ways:
•Single value— Figure 3-3 shows an example trigger that activates when extension 2000 receives a call.
•List of values— Figure 3-4 shows an example trigger that activates when a call is received from extension 2000, 2001, or 2003.
•Single regular expression— Figure 3-5 shows an example trigger that activates when a call is received on any of the extensions 2000-2999 (regex:2[0-9][0-9][0-9]).
•Combination of methods— Figure 3-6 shows an example trigger that includes a single value trigger that activates when the extension 2000 is called and a regular expression trigger that activates when a call is received from any of the extensions 2000-2999 (regex:2[0-9][0-9][0-9]).
Note A regular expression is indicated by adding regex: before the expression. You cannot mix literal values and regular expressions in a list. Only a single regular expression can be used as a trigger parameter for a given partition. The syntax [0-9] in a regular expression is equivalent to the CallManager X notation used in route patterns and CTI Route point line numbers.
Figure 3-3 Example Single Value Trigger Parameter Configuration
Figure 3-4 Example Value List Trigger Parameter Configuration
Figure 3-5 Example Single Regular Expression Trigger Parameter Configuration
Figure 3-6 Example Combined Trigger Parameter Configuration
Event Types and Trigger Parameters
This section lists trigger parameters for the following event types:
•Metreos.CallControl.IncomingCall— Table 3-2
•Metreos.Providers.Http.GotRequest— Table 3-3
•Metreos.Providers.JTapi.JTapiIncomingCall— Table 3-4
•Metreos.Providers.JTapi.JTapiCallInitiated— Table 3-5
•Metreos.Providers.TimerFacility.TimerFire— Table 3-6
Table 3-2 Metreos.CallControl.IncomingCall
Trigger Parameter
|
Description
|
To
|
The called party, or last redirected number if redirected.
|
From
|
The number of the calling party.
|
OriginalTo
|
The original called party, even if redirected.
|
DisplayName
|
The textual display name associated with the calling party.
|
Table 3-3 Metreos.Providers.Http.GotRequest
Trigger Parameter
|
Description
|
URI
|
Path portion of the requested URI. This must always begin with a front slash (/).
|
Hostname
|
Host portion of the requested URI. This will not contain port information.
|
Host
|
Host portion of the requested URI, and may contain port information.
|
Port
|
Port portion of the requested URI.
|
Body
|
The content of the request.
|
Method
|
Request method. This will be either GET or POST.
|
Query
|
Query string portion of the requested URI.
|
RemoteHost
|
The IP address and port of the remote client.
|
RemoteIPAddress
|
The IP address of the remote client.
|
Table 3-4 Metreos.Providers.JTapi.JTapiIncomingCall
Trigger Parameter
|
Description
|
To
|
The called party, or last redirected number if redirected.
|
From
|
The number of the calling party.
|
OriginalTo
|
The original called party, even if redirected.
|
DeviceName
|
The name of the device that the call came in on.
|
Table 3-5 Metreos.Providers.JTapi.JTapiCallInitiated
Trigger Parameter
|
Description
|
To
|
The called party.
|
From
|
The number of the calling party.
|
DeviceName
|
The name of the device from which the call was initiated.
|
Table 3-6 Metreos.Providers.TimerFacility.TimerFire
Trigger Parameter
|
Description
|
TimerUserData
|
An opaque token used to allow distinguishable events to be raised. Inform the administrator of this value.
|
Media Server Engines
In order for the Cisco Unified Application Environment to act as a media endpoint, a Cisco Unified Media Engine must be present and the Cisco Unified Application Environment must be configured to use the server. The decision to use a media engine ultimately rests with the needs of the application. Applications that place or answer calls typically require a media engine.
Note Some applications do not require media engines; for example, telephony applications that use peer-to-peer media negotiation.
To be available for use by applications, each media engine must be placed in a media resource group, which is assigned within the application partition. All media engines are placed automatically into the Default media resource group, and all application partitions can use the default group. Creating custom media resource groups is recommended in the following cases:
•Diverse geography—If a single Cisco Unified Application Environment provides call control for calls that originate and terminate in different countries, it is desirable to use media servers that are physically located in each country to service the calls directed to that country. For example, a click-to-talk application may reside on the Cisco Unified Application Server in New York but be triggered by a user in India to call another phone number in India. If all media servers in India are assigned to a custom media resource group, the application can be instructed to use the servers in the Indian media resource group to process calls that originate and terminate in India.
•Resource guarantees—Some applications, such as scheduled conferencing, are sensitive to resource utilization and may not recover well from unexpected loss of media resources due to the demands of other applications. To reserve the needed resources, you can assign specific media servers to a custom media resource group. The application then reserves the resources of the custom media resource group.
Use the Media Servers page ( Figure 3-7) to create and configure media servers and media resource groups. A media resource group is a container for a collection of media servers. Each media server must be associated with one or more groups. It is also possible, but not necessary, to create media resource groups. The system provides a default media resource group for use if multiple groups are not needed.
Figure 3-7 Media Servers Page
To create and configure media servers, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Media Servers.
Step 2 Choose from these actions:
•Add a media server:
Click Add a Media Server, enter values as described in Table 3-7, and click Add.
•Edit parameters for an existing media server:
Click the Edit button to the right of the server entry, enter values as described in Table 3-7, and click Apply.
•Enable a media server:
Click the Enable button to the right of the server entry.
•Remove a media server.
Click the Enable button to the right of the server entry.
Table 3-7 Media Server Parameters
Field
|
Description
|
Name
|
Name of media server
|
IP Address
|
IP address of media server
|
Password
|
Password for access to media server
|
Connection Type
|
Method of connecting to media server (use IPC)
|
Add to Group
|
Group to which media server is assigned
|
To add a media resource group, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Media Servers.
Step 2 Click Create New Group.
Step 3 Enter values as described in Table 3-7, and click Add.
Step 4 Add or remove members:
•To add a member, select the member name, and click Add Member. Add additional members as needed.
•To remove a member, select the member name, and click Remove.
Step 5 Click Create Group.
To edit an existing media resource group, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Media Servers.
Step 2 In the Media Resource Groups area, click Edit New Group.
Step 3 Enter values as described in Table 3-7.
Step 4 Add or remove members:
•To add a member, select the member name, and click Add Member. Add additional members as needed.
•To remove a member, select the member name, and click Remove.
Step 5 Click Apply.
The system adds the server and displays it in the Media Servers list.
Step 6 To confirm that the Media Server was added to the correct group, select the group from the drop-down list at the bottom of the page and click Edit Group.
To remove a media server from the group without removing it from the system, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Media Servers.
Step 2 In the Media Resource Groups area, select the group from the pull-down list, and click Edit Group.
Step 3 Click Delete Group.
Step 4 Click OK to confirm.
The group is deleted and removed from the pull-down list on the Media Servers page.
Caution A media server cannot be used unless it is associated with a group. If removed from a group, it must be reassigned before an application can access it; if not explicitly added to a group, it will be inaccessible.
To remove a media server from the system, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Media Servers.
Step 2 Click Remove to the right of the Media Server you want to delete.
The media server is deleted and removed from the list on Media Servers page.
Providers
Providers are application server plug-in modules that open network ports and allow the runtime environment to communicate with devices on the network. Use the Providers page ( Figure 3-8) to display the list of providers shipped with the Cisco Unified Application Server, the status of each provider (Enabled, Running, or Disabled), and the version number. Clicking on the provider name launches the configuration page for that provider.
Figure 3-8 Providers Page
From the Main Control Panel, click Providers to display the list of providers.
Each provider configuration page includes following sections:
•Configuration—Configurable parameters for the provider.
•Extensions—Special actions exposed by the provider and invoked only through the management console rather than by a script (not all providers have extensions).
To invoke the extension, click Invoke Extension.
Note Disabling the provider allows for its subsequent uninstallation, which resets the provider back to its default configuration settings and makes it unavailable. Restarting the application server will automatically restart the provider.
Click an underlined link to select one of the following providers:
• CiscoDeviceListX Provider
• H.323 Provider
• HTTP Provider
• JTAPI Provider
• Media Control Provider
• SCCP Provider
• SIP Provider
• Timer Provider
To modify provider settings, make changes as needed, and click Update. Click Done to return to the Providers page.
CiscoDeviceListX Provider
The CiscoDeviceListX provider communicates with Cisco Unified CallManager to retrieve and cache real-time device information for application use. The CiscoDeviceListX (3.X, 4.X) and SNMP (5.X) protocols are used to gather this information. The Cisco Unified CallManagers with which the Cisco Unified Application Server communicates are specified in the Telephony Servers pages.
The CiscoDeviceListX provider supports the following extensions, which you can invoke on the CiscoDeviceListX Provider page:
•Metreos.Providers.CiscoDeviceListX.Refresh—Forces the application server to reinitialize the real-time cache. This is recommended if phone device IP addresses have been changed during high usage of an application that uses the CiscoDeviceListX provider.
Figure 3-9 shows the Cisco DeviceListX Provider page, and Table 3-8 lists the provider parameters.
Figure 3-9 Cisco DeviceListX Provider Page
Table 3-8 Cisco DeviceListX Provider Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
Poll Interval
|
Interval in minutes between requests sent to Cisco Unified CallManager to refresh device information (cache refresh)
|
H.323 Provider
The H.323 provider uses the H.323 protocol to create, receive, and control IP telephony calls between Cisco Unified CallManager nodes. The H.323 provider has an H.323 gateway device appearance in Cisco Unified CallManager.
Figure 3-10 shows the H.323 Provider page, and Table 3-9 lists the provider parameters.
Figure 3-10 H.323 Provider Page
Table 3-9 H.323 Provider Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
Listen Port
|
Number of the port on which H.323 listens
|
Max Pending Calls
|
Maximum number of pending calls that are allowed before the stack starts auto-rejecting calls
Valid Range: 100 - 1000
|
H.245 Range (min)
|
Minimum port number for H.245
Valid Range: 1024 - 32767
|
H.245 Range (max)
|
Maximum port number for H.245
Valid Range: 1024 - 32767
|
Enable Stack Debugging
|
Field in which to enable StackDebugger, a tool that writes logs to a file for H.323 diagnostics
|
Stack Debugging Log Level
|
Log level specifying detail of logs written by the StackDebugger (valid values are 0 - 5, where 0 disables debugging, and 5 maximizes debugging)
|
Stack Debugging Log File
|
Name of log file for the Stack Debugging Log function
|
TCP Connect Timeout
|
Number of seconds that an attempt is made to contact a gateway before giving up. A lower number ensures faster failover
Valid Range: 1 - 10
|
H323 Service Log Level
|
Detail level of service log messages. 0=Off, 1=Error, 2=Warning, 3=Info, 4=Verbose
|
HTTP Provider
The HTTP provider receives HTTP requests over port 8000. These requests are then routed to the appropriate application for processing.
Figure 3-11 shows the HTTP Provider page, and Table 3-10 lists the provider parameters.
Figure 3-11 HTTP Provider Page
Table 3-10 HTTP Provider Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
Port
|
Number of the port on which the provider listens
|
Session Expiration Minutes
|
Number of minutes before HTTP sessions expire
Valid Range: 1 - 3600
|
JTAPI Provider
The JTAPI provider uses the CTI protocol to create, receive, and control IP telephony calls. The JTAPI provider registers as a CTI route point and CTI port in Cisco Unified CallManager and can use JTAPI to monitor phone devices.
Figure 3-12 shows the JTapi Provider page, and Table 3-11 lists the provider parameters.
Figure 3-12 JTapi Provider Page
Table 3-11 JTAPI Provider Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
Monitor Devices
|
Devices to monitor
|
Username
|
User with permission to monitor specified devices
|
Password
|
Password for user with permission to monitor the specified devices
|
CTI Manager
|
IP address of CTI manager
|
Backup CTI Manager
|
IP address of backup CTI manager
|
Max Calls per Device
|
Maximum number of calls allowed on any first-party CTI Port device (this value must match the equivalent value in Cisco Unified CallManager)
|
Server Version
|
Cisco Unified CallManager release
|
Advertise Low-bitrate Codecs
|
Indication of whether devices should be registered with G.723.1 and G.729a support
|
Perform these actions on the JTapi Provider page:
•Click View and Edit Values to create a list of devices to monitor in third party mode. Enter the device name, and click Add.
•Click Change Password to assign a new password. Enter the new password, reenter it in the Verify Password field, and click Apply.
•Click Done to return to the Providers page.
Media Control Provider
The Media Control provider manages media engines to provide media capabilities to applications. The Media Control provider supports the following extensions, which you should invoke only under the direction of a Cisco technical support engineer:
•Metreos.MediaControl.RefreshMediaServers—Forces the application server to reinitialize control of the media engines.
•Metreos.MediaControl.ClearMRGCache—Forces the application server to reinitialize the media engine's internal storage.
•Metreos.MediaControl.PrintServerTable—Forces the application server to write a summary of all configured media engines to the application server log.
•Metreos.MediaControl.PrintDiags—Forces the application server to write diagnostic information about currently connected media engines to the application server log.
Figure 3-13 shows an excerpt of the Media Control Provider page, and Table 3-12 lists the provider parameters.
Figure 3-13 Media Control Provider Page
Table 3-12 Media Control Provider Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component.
|
Connect Timeout
|
Interval in milliseconds before a connection is deemed unsuccessful and the system attempts to retry.
|
Heartbeat Interval
|
Interval, in seconds, between heartbeat signals to a media server.
|
Heartbeat Skew
|
Interval, in seconds, that the Media Control provider waits for a response to the heartbeat signal.
|
Log Inbound Connect Messages
|
All inbound connect messages written to the Log Server.
|
Log Outbound Connect Messages
|
All outbound connect messages written to the Log Server.
|
Log Outbound Disconnect Messages
|
All outbound disconnect messages written to the Log Server.
|
Log Outbound Command Messages
|
All outbound command messages written to the Log Server.
|
Log Inbound Response Messages
|
All inbound responses written to the Log Server.
|
Log Real-time Resource Info
|
Heartbeat signal information written to the Log Server.
|
Log Media Server Selection
|
All selection process details written to the Log Server.
|
Log Transaction Metrics
|
All log transaction metrics written to the Log Server.
|
SCCP Provider
The SCCP provider uses the SCCP protocol to create, receive, and control IP telephony calls. The SCCP provider registers as an SCCP 7960 device in Cisco Unified CallManager.
Figure 3-14 shows an excerpt of the SCCP Provider page. Table 3-13 lists the basic SCCP parameters; the screen also includes an extensive set of advanced parameters, which should not require modification.
Figure 3-14 SCCP Provider Page
Table 3-13 SCCP Provider Parameters
Field
|
Description
|
Log Level
|
Filter for all debug output (below the specified level)
|
MaxBurst
|
Maximum registration messages per burst (5)
Valid range: 1 - 2147483647
|
InterBurstDelayMs
|
Milliseconds between bursts (1000)
Valid range: 0 - 2147483647
|
CallManagerPort
|
Port on which Cisco Unified CallManagers listen for registrations (2000)
Valid range: 1024 - 32767
|
AdvertiseLowBitRateCodecs
|
Devices registered with G.729a support (No)
|
MusicOnHoldOption
|
Music-On-Hold enabled (Yes)
|
LogCallVerbose
|
Verbose logging for call enabled (Yes)
|
LogCallManagerVerbose
|
Verbose logging for CallManager (No)
|
LogConnectionVerbose
|
Verbose logging for connection (No)
|
LogDiscoveryVerbose
|
Verbose logging for discovery (No)
|
LogRegistrationVerbose
|
Verbose logging for registration (Yes)
|
LogSystemVerbose
|
Verbose logging for system (No)
|
SIP Provider
The SIP provider uses the SIP protocol to create, receive, and control IP telephony calls between Cisco Unified CallManager nodes. The SIP provider either behaves as a SIP trunk or registers as SIP 7961G-GE devices in Cisco Unified CallManager.
Figure 3-15 shows the SIP Provider page, and Table 3-14 lists the provider parameters.
Figure 3-15 SIP Provider Page
Table 3-14 SIP Provider Parameters
Field
|
Description
|
Log Level
|
Filter for all debug output (below the specified level)
|
DefaultOutboundFromNumber
|
Default From number for outbound call
|
SIPTrunkIP
|
SIP Trunk IP address for outbound call (should match the IP used for SIP Trunk in CallManager)
|
SIPTrunkPort
|
SIP Trunk port for outbound call (should match the port used for SIP Trunk in CallManager)
|
MinRegistrationPort
|
Minimum TCP port number to use for registration with SIP server (valid range: 1024 - 65535)
|
MaxRegistrationPort
|
Maximum TCP port number to use for registration with SIP server (valid range: 1024 - 65535)
|
ServiceLogLevel
|
SIP service log level (0=Off, 1=Error, 2=Warning, 3=Info, 4=Verbose, valid range: 0 - 4)
|
LogTimingStat
|
Timing statistics (enabled when set to true)
|
Timer Provider
The Timer provider makes timers available for use by applications. It does not communicate with any other system.
Click the Timer provider link to configure the Timer provider. Figure 3-16 shows the Timer Provider page, and Table 3-15 lists the provider parameters.
Figure 3-16 Timer Provider Page
Table 3-15 Timer Provider Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
Enable Minute Events
|
Field in which to enable minute by minute timer events (enabled when set to true)
|
Enable Hourly Events
|
Field in which to enable hourly timer events (enabled when set to true)
|
Enable Daily Events
|
Field in which to enable daily timer events will be generated (enabled when set to true)
|
Telephony Servers
Every IP telephony system must contain at least one telephony server. The management console provides a telephony server configuration page for adding and configuring telephony servers and devices on those servers. When adding a telephony server, however, its devices must be associated with one or more call route groups.
Just as a media server group functions as a container for media servers, a call route group functions as a container for telephony devices. Each telephony device must belong to one or more call route groups.
Note Creating a call route group is optional; the system provides a default call route group to be used if multiple groups are not needed.
From the main Main Control Panel, click Telephony Servers to open the Telephony Servers page ( Figure 3-17).
Figure 3-17 Telephony Servers Page
The application server currently supports these call control protocols:
•H.323
•CTI
•SCCP
•SIP
It also supports these types of telephony servers:
•H.323 gateways—Telephony servers, which are used exclusively with H.323.
•CallManager—Multipurpose telephony server devices supporting SCCP and CTI in the Cisco Unified system.
•Cisco SIP domain—Defines a SIP interface into Cisco Unified CallManager. By creating a Cisco SIP domain, you can use SIP trunks and SIP devices that the Cisco Unified Application Server creates in Cisco Unified CallManager.
•IETF SIP domain—Defines a telephony server that supports IETF-specific SIP.
Creating H.323 Call Route Groups and Gateways
This section describes how to create and configure H.323 call route groups and gateways. If a call route group other than the default is required, you can create a new H.323 call route group using this procedure.
To add a new call route group, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Telephony Servers.
Step 2 Select H.323 Group from the Create New Group pull-down list.
Step 3 Click Create New Group to open the Create Group page ( Figure 3-18).
Figure 3-18 Configuring a New H.323 Telephony Group
Step 4 Enter the name of the group in the Name field.
Step 5 Enter a description in the Description field.
Step 6 To specify a previously created failover group, select the group from the Failover Group drop-down list.
Step 7 Select Create Group.
Before you can add an H.323 telephony server to a group, you must create an H.323 gateway. Because H.323 does not require static configuration of devices, the gateway is added to a call route group. All logical devices created during runtime will automatically be part of that same group.
To create an H.323 gateway, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Telephony Servers.
Step 2 Select H.323 Gateway from the Add a Telephony Server pull-down list.
Step 3 Click Add Server.
Step 4 Configure settings as described in Table 3-16.
Step 5 Click Add H.323 Gateway to create the gateway.
Table 3-16 H.323 Gateway Parameters
Field
|
Description
|
Name
|
Name of gateway
|
Description
|
Information to identify the gateway
|
IP address
|
IP address of gateway
|
Add to Group
|
Group to which gateway is assigned
|
Creating CTI Telephony Devices
Computer Telephony Integration (CTI), unlike H.323, is an IP telephony protocol based on line-oriented telephony devices. This section describes how to set up and administer CTI ports and route points that are configured on a CTI Manager. These properties apply to CTI devices:
•A CTI route point is a group unto itself.
•CTI ports are grouped into device pools.
•CTI ports and route points must each have at least one CTI manager associated with them.
•Call route groups should contain exactly one route point or one device pool. The application server does not allow a call route group containing a combination of route points and device pools.
•CTI route points and device pools are contained within a CTI Manager and are associated with CTI Groups.
These procedures describe how to create:
•CTI Groups
•CTI Managers
–CTI route points
–CTI device pools
To create a CTI route group, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Telephony Servers.
Step 2 Select CTI Server Group from the Create New Group drop-down list.
Step 3 Click Create New Group.
Step 4 Enter the name of the group in the Name field.
Step 5 Enter a description in the Description field.
Step 6 To specify a previously created failover group, select the group from the Failover Group drop-down list.
Step 7 Click Create Group.
Cisco Unified CTI clusters are known as Cisco Unified CallManager clusters. You can create a Cisco Unified CallManager cluster and associate it with the new group.
To add a Cisco Unified CallManager cluster, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Telephony Servers.
Step 2 Select CallManager from the Add Server drop-down list.
Step 3 Click Add Server.
Step 4 Configure settings as described in Table 3-17.
Step 5 Click Create CallManager Cluster.
Table 3-17 Cisco Unified CallManager Parameters
Field
|
Description
|
Name
|
Name to identify the server
|
Version
|
Cisco Unified CallManager version
Note When entering the Cisco Unified CallManager versions 3.3, 4.0, and 4.1, enter only the first two digits of the version number (example: 4.0, not 4.0.1). If the gateway is not part of a Cisco Unified CallManager installation, enter 1.0.
|
Publisher IP
|
IP address of the publisher of the Cisco Unified CallManager cluster
|
Publisher Admin Username
|
Administrator user name for the publisher
|
Publisher Admin Password
|
Password for the publisher
|
Retype Publisher Admin Password
|
Password verification for the publisher
|
SNMP Community
|
SNMP community string for the publisher
|
Description
|
Text to describe the publisher
|
To create a CTI manager, follow these steps:
Procedure
Step 1 On the Telephony Servers page, click the underlined name of the server to open the server configuration page.
Step 2 Scroll down and click Add CTI Manager.
Step 3 Enter the manager name in the Name field.
Step 4 Enter the IP address in the IP Address field.
Step 5 Click Add CTI Manager.
You can now create devices.
To create a CTI device pool, follow these steps:
Procedure
Step 1 On the Telephony Servers page, click the underlined name of the server to open the server configuration page.
Step 2 Scroll down and click Create CTI Device Pool.
Step 3 Configure values as described in Table 3-18.
Step 4 Click Create CTI Device Pool.
Table 3-18 CTI Device Pool Parameters
Field
|
Description
|
Name
|
Name of the pool (enter in Name field)
|
How many devices to register?
|
Valid range: 1 - 9999
|
Device Name Prefix
|
String used to construct the device names in conjunction with the number of devices registered. Format is Device Name Prefix + Device Count
|
Primary CTI Manager
|
Primary CTI Manager for CTI device pool
|
Secondary CTI Manager
|
Secondary CTI Manager for CTI device pool
|
Username
|
Username to allow monitoring of CTI device pool
|
Password
|
Password for monitoring the CTI device pool (must reenter to verify)
|
Add To Group
|
Call route group selected for this device pool
|
To create a CTI route point, follow these steps:
Procedure
Step 1 On the Telephony Servers page, click the underlined name of the server to open the server configuration page.
Step 2 Scroll down and Create CTI Route Point.
Step 3 Configure values as described in Table 3-19.
Step 4 Click Create CTI Route Point.
Table 3-19 CTI Route Point Parameters
Field
|
Description
|
Name
|
Name of the pool (enter in Name field)
|
Device Name
|
Device name of the CTI route point as created in Cisco Unified CallManager (name is case-sensitive)
|
Primary CTI Manager
|
Primary CTI Manager for CTI device pool
|
Secondary CTI Manager
|
Secondary CTI Manager for CTI device pool
|
Username
|
Username to allow monitoring of CTI device pool
|
Password
|
Password for monitoring CTI device pool (must reenter to verify)
|
Add To Group
|
Call route group selected for this device pool
|
Click any of the View or Edit buttons associated with the devices to view or edit them.
Configuring SCCP Devices
For applications that require the use of SCCP devices, there must be at least one SCCP device pool configured to contain SCCP devices.
To add a subscriber to Cisco Unified CallManager, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Telephony Servers.
Step 2 Click the underlined name of the telephony server to be added as an SCCP subscriber.
Step 3 Click Add Subscriber.
Step 4 Enter the subscriber Name in the Name field.
Step 5 Enter the Subscriber IP address in the IP Address field.
Step 6 Click Add Subscriber.
To create a device pool on the subscriber created to contain SCCP devices, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Telephony Servers.
Step 2 Click the underlined name of the telephony server.
Step 3 Click Create SCCP Device Pool in the SCCP Device Pools section.
Step 4 Configure settings as described in Table 3-20.
Step 5 Click Create Device Pool.
Table 3-20 Device Pool Parameters
Field
|
Description
|
Name
|
Name of the pool (enter in Name field)
|
Device Name
|
Text used to construct the device names of SCCP devices in conjunction with the number of devices registered, in the form device name prefix + device count
|
Primary CTI Manager
|
Primary CTI Manager for CTI device pool
|
Secondary CTI Manager
|
Secondary CTI Manager for CTI device pool
|
Username
|
Username to allow monitoring of CTI device pool
|
Password
|
Password for monitoring CTI device pool (must reenter to verify)
|
Add To Group
|
Call route group selected for this device pool
|
Configuring System Parameters
The System group contains links to these Cisco Unified Application Environment configuration pages:
• Service Control
• SSL Management
• Redundancy Setup
• Applications
Service Control
The Service Control page is used to enable, disable, stop, restart, or kill services that run on the application server. Under normal circumstances, it should not be necessary to perform these functions; these functions are required only in these instances:
•You have modified configuration parameters using the management console, and a message has indicated that you must restart a particular service for the configuration change to take effect.
•A service is not functioning properly.
•A Cisco support representative has asked you to restart a service to help debug an issue.
Note Services require differing amounts of time to restart. The media engine and application server can take approximately one minute to start or stop.
From the Main Control Panel, open the Service Control page ( Figure 3-19) to show the services that are currently running and to enable, disable, start, restart, or stop the services.
Figure 3-19 Service Control Page
The following information is presented for each service:
•Service Name—Name of service
•Description—Explanation of service
•Enabled—Indication of whether the service is active
•Status:
–Running—Service is available
–Stop Pending—Service is shutting down
–Stopped—Service is unavailable
–Start Pending—Service is starting up
–Unknown—Status is unknown
•Actions:
–Disable—Make service unavailable (disallows automatic start at reboot)
–Restart—Stop and restart the service
–Stop—Make service unavailable
–Kill—Stop the service
–Enable—Allow automatic start at reboot
–Start — Make service available
An enabled service automatically starts when the system is rebooted; a disabled service does not. When a service is disabled, the system automatically stops it.
To perform an action on a service, click the desired button to the right of the action.
SSL Management
The management console web server does not have an SSL certificate or SSL key. If you need to use HTTPS (HTTP-over-SSL) instead of HTTP for management console access, then you must supply a security certificate and key. Open the SSL Management page ( Figure 3-20) to manage SSL certificates and keys.
If you already have your own SSL certificate and key, they are verified upon upload to make sure that they are compatible. Make sure you upload them at the same time.
Figure 3-20 SSL Management Page
To upload an SSL certificate and key, follow these steps:
Procedure
Step 1 Open the SSL Management page.
Step 2 Click Browse and highlight the certificate file, then click Open to make the file available for uploading.
Step 3 Click Browse and highlight the key file, then click Open to make the file available for uploading.
Step 4 Click Upload to copy the certificate and key to the server.
To generate a new SSL certificate and key, follow these steps:
Procedure
Step 1 Open the SSL Management page.
Step 2 Enter the values as described in Table 3-21.
Step 3 Click Generate Certificate/Key.
Table 3-21 SSL Certificate Parameters
Field
|
Description
|
Passphrase
|
Code that is used to encrypt the private key
|
Organization Name
|
Name of the organization submitting the certificate request
|
Organizational Unit
|
Type of organization submitting the certificate request
|
Country
|
Standard two-letter country code
|
State/Province
|
Full name of the state or province where the server is located
|
City/Locality
|
City or other local jurisdiction where the server is located
|
Domain/Common Name
|
Host and domain name (for example, cisco.com)
|
E-mail Address
|
Contact email address
|
Years Until Expire
|
Number of years SSL certificate should be valid
|
Redundancy Setup
The Cisco Unified Application Environment supports redundant configurations for certain protocols, including Session Initiation Protocol (SIP), Skinny Client Control Protocol (SCCP), and computer telephony integration (CTI). You can configure a master and stand-by application server. The stand-by server attempts to contact the master server every few seconds. If the specified number of attempts fails, the stand-by server takes over.
Use the Redundancy Setup page ( Figure 3-21) to assign a unique ID number for each of the application servers and to configure the master and stand-by servers.
Figure 3-21 Redundancy Setup
Page
To set up redundant operations, follow these steps:
Procedure
Step 1 From the Main Control Panel page, click Redundancy Setup.
Step 2 Enter a unique server ID to identify this server.
Step 3 Enter settings in the As Master fields as described in Table 3-22.
Step 4 Enter settings in the As Stand-by fields as described in Table 3-23.
Step 5 Click Apply Settings.
Step 6 Click Done to return to the Main Control Panel.
Table 3-22 Master Server Parameters
Field
|
Description
|
IP Address of Standby
|
IP address of stand-by server
|
Database Username
|
User name for access to stand-by server
|
Database Password
|
Password or access to stand-by server
|
Verify Password
|
Field in which to verify password
|
Startup Synchronization Timeout
|
Number of seconds after which the master server is considered unavailable
|
Table 3-23 Stand-by Server Parameters
Field
|
Description
|
IP Address of Master
|
IP address of stand-by server
|
Database Username
|
User name for access to stand-by server
|
Database Password
|
Password for access to the stand-by server
|
Verify Password
|
Field in which to verify password
|
Heartbeat Interval
|
Number of seconds stand-by server waits between attempts to contact the master server
|
Max Missed Heartbeats
|
Number of attempts after which the master server is considered unavailable
|
Note When you make changes that involve the Server ID or address of the master or stand-by appliance, you must shut down and restart the application server and database.
Configuring Environment Parameters
The Environment group contains links to the following Cisco Unified Application Environment configuration pages:
• User Management
• Configuring Core Components
• Log Server
• Alarm Management
User Management
A user account is required for each user who will access the system. By creating a different account for each user, you can ensure that audit logs will accurately record each user's interactions with the system. From the Main Control Panel, open the Users page ( Figure 3-22) to add users and to list existing users and their access levels.
Figure 3-22 Users Page
To add a user, follow these steps:
Procedure
Step 1 From the Main Control Panel, click User Management.
Step 2 Click Add a User.
The Add User page opens.
Note From the Users page, you can list all users or click a letter to select the users whose names begin with that letter. Click the asterisk (*) next to the A in the alphabet string to return to the default view (all users).
Figure 3-23 Add User Page
Step 3 Enter the user name in the Username field.
Step 4 Enter a password in the Password field, then reenter it in the Verify (Reenter) Password field.
Step 5 Select Normal User or Administrator from the Access Level pull-down menu. Users assigned the Administrator role are allowed full access to the management console. Users assigned the Normal User role may manage only the following system components:
•Core Components
•Applications
•Media servers
•Providers
•Telephony Servers
Step 6 Click Add User.
Step 7 Click Go Back to return to the Users page.
To change a user password, follow these steps:
Procedure
Step 1 From the Main Control Panel, click User Management.
Step 2 Click * to list all users, or click the first letter of the user name.
Step 3 Scroll to find the user name, and click the associated Edit User button.
The Edit User page opens.
Step 4 Enter and verify the new password.
Step 5 Click Apply.
Step 6 Click Go Back to return to the Users page.
To remove a user, follow these steps:
Procedure
Step 1 From the Main Control Panel, click User Management.
Step 2 Click * to list all users, or click the first letter of the user name.
Step 3 Scroll to find the user name, and click the associated Delete User button.
Step 4 Click Yes to confirm.
The user record is deleted.
Step 5 Click Go Back to return to the Users page.
Configuring Core Components
From the Main Control Panel, open the Cores page ( Figure 3-24) to configure Cisco Unified Application Environment core components.
Figure 3-24 Cores Page
To configure core components, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Core Components.
Step 2 Click the link for the desired application.
Step 3 Enter or select values as described in the following tables:
•Application Environment, Table 3-24
•Application Server, Table 3-25
•Application Manager, Table 3-26
•Cluster Interface, Table 3-27
•Logger, Table 3-28
•Management Interface, Table 3-29
•Provider Manager, Table 3-30
•Router, Table 3-31
•Telephony Manager, Table 3-32
Step 4 Click Apply.
Step 5 Click Done to return to the Cores page.
You can also invoke extensions from some of the core components pages that provide additional services.
Table 3-24 Application Environment Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
GC Interval
|
Time interval in seconds between garbage collection events (periodically, the system searches the runtime environment for objects that are no longer being used by the application, but have not released memory, then removes those objects and any associated resources)
|
Max Threads
|
Size of thread pool used for concurrent execution of actions
|
Table 3-25 Application Server Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
Server Name
|
Identifier for application server
|
Table 3-26 Application Manager Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
Debug Listen Port
|
Number of port on which the debugger listens for debug commands
|
Table 3-27 Cluster Interface Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
Table 3-28 Logger Parameters
Field
|
Description
|
DebugView Logger Level
|
Filter for Windows debug output (below specified level)
|
Console Logger Level
|
Filter for console debug output (below specified level)
|
Event Log Level
|
Filter for Windows debug output (below specified level)
|
File Logger Level
|
Filter for file debug output (below specified level)
|
Max File Log Lines
|
Maximum number of lines written to the log file before starting a new file (valid range: 100 - 1000000)
|
TCP Logger Level
|
Filter for remote console debug output (below specified level)
|
TCP Logger Port
|
Number of port on which the TCP remote console logger remote server listens for connections
|
Log Server Sink Logger Level
|
Filter for log server debug output (below specified level)
|
Enable Logger
|
Queue diagnostics
|
Table 3-29 Management Interface Parameters
Field
|
Description
|
Log Level
|
Filter for all debug output (below specified level)
|
Management Port
|
Port on which the application server listens for commands from the management console and the Cisco Unified Application Designer
|
Table 3-30 Provider Manager Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
Shutdown Timeout
|
Length of time in milliseconds the system waits before forcing a shutdown
|
Startup Timeout
|
Length of time in milliseconds the system waits before considering a provider unloadable
|
Table 3-31 Router Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
Default Action Timeout
|
Maximum length of time in milliseconds the system waits for a provider to respond to an action
|
Table 3-32 Telephony Manager Parameters
Field
|
Description
|
Log Level
|
Type and amount of information the system writes to the log for each component
|
Enable Call/Connection Sandboxing
|
Indication of whether or not sandboxing is enabled (when enabled, the system clears any remaining calls and media connections while the controlling script exits)
|
Missing Enable Periodic Diagnostics
|
Indication of whether the Telephony Manager will occasionally output diagnostics about calls and performance
|
Log Server
From the Main Control Panel, open the Log Server Configuration page ( Figure 3-25) to specify the maximum size and number of log files.
Figure 3-25 Log Server Configuration Page
To configure the log server, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Log Server Configuration.
Step 2 Enter or select values as described Table 3-33.
Step 3 Click Apply.
Step 4 Click Done to return to the Main Control Panel.
Table 3-33 Log Server Parameters
Field
|
Description
|
Max File Log Lines
|
Maximum number of lines written to the log file before starting a new file (valid range: 100 - 1000000)
|
Max Files
|
Maximum number of files to store in an individual log folder; when this limit is surpassed, older files are deleted to keep the total within the maximum
|
Alarm Management
Real-time alarm messages warn of critical system events, such as a server failing to start. Use the Alarms page to define which SMTP or SNMP manager receives the alarm messages.
From the Main Control Panel, open the Alarms page ( Figure 3-26) to list current alarms and specify the destinations to receive alarm messages.
Figure 3-26 Alarms Page
To add new alarm destinations, follow these steps:
Procedure
Step 1 From the Main Control Panel, click Alarm Management.
Step 2 Choose SMTP Manager or SNMP Manager, then click Create.
Step 3 Configure settings for the selected option:
•SMTP Manager—Enter values as described in Table 3-34, then click Add SMTP Manager.
•SNMP Manager—Enter values as described in Table 3-35, then click Add SNMP Manager.
Table 3-34 SMTP Alarm Manager Parameters
Field
|
Description
|
Name
|
Name of alarm manager
|
Description
|
Description of alarm manager
|
Recipient
|
Email address to which to send alarm message
|
Sender
|
Email address from which to send alarm message
|
Server
|
IP address of SMTP server
|
Username
|
(Optional) User name for outbound SMTP authentication
|
Password
|
(Optional) Password for outbound SMTP authentication
|
Server Port
|
SMTP server port (default is 25)
|
Trigger Level
|
Event level that triggers alarm
|
Table 3-35 SNMP Alarm Manager Parameters
Field
|
Description
|
Name
|
Name of alarm manager
|
Description
|
Description of alarm manager
|
SNMP Manager
|
IP address of SNMP manager
|
Trigger Level
|
Event level that triggers alarm
|
