Configuration Rules

These rules show the potential configuration errors and warnings for CCE, CVP, UCM machines, ESX hosts, and Gateways. Each section has a rule table that applies to all machines listed in that category, as well as a rule table for each type of machine in that category.

CCE Machines

These rules show the potential configuration errors and warnings for CCE machines (Call Server, Data Server, and External AW).

Rules for All CCE Machines (Call Server, Data Server, External AW)
Rule Description
TRACE_LEVEL_NORMAL

The trace level must be set to normal to ensure performance.

Call Server Rules
Rule Description
MR_PG_MR_PIM_COUNT

The number of media routing PG MR_PIM processes (mr_pim.exe) on Side A and Side B must match. Valid if 0, 1, or 2 MR_PIMs are enabled.

CTI_SVR_INSTALLED

The CTI Server service must be installed.

CTI_SVR_AUTOMATIC

The CTI server service startup type must be set to automatic.

GENERIC_PG_INSTALLED

The generic PG service must be installed.

GENERIC_PG_AUTOMATIC

The generic PG service startup type must be set to automatic.

ROUTER_INSTALLED

The router service must be installed.

ROUTER_AUTOMATIC

The router service startup type must be set to automatic.

MR_PG_INSTALLED

The media routing PG service must be installed.

MR_PG_AUTOMATIC

The generic PG service startup type must be set to automatic.

DIALER_INSTALLED

If installed, the dialer service must be installed on both sides.

DIALER_AUTOMATIC

If installed, the dialer service startup type must be set to automatic.

CTIOS_SVR_INSTALLED

If installed, the CTIOS Server service must be installed on both sides.

CTIOS_SVR_AUTOMATIC

If installed, the CTIOS server service startup type must be set to automatic.

GENERIC_PG_JTAPI_MATCHES_CM_SUB

The Communications Manager PIM service address configured in PG Setup must match the Communications Manager Subscriber address on the same side

GENERIC_PG_JTAPI_CLIENT_VERSION _MATCH_UCM The JTAPI Client version installed must match the JTAPI Client version available on Unified Call Manager.
GENERIC_PG_SIDE_A_NAME Generic PG on Side A must be named PG1A.
GENERIC_PG_SIDE_B_NAME Generic PG on Side B must be named PG1B.
MR_PG_SIDE_A_NAME Media Routing PG on Side A must be named PG2A.
MR_PG_SIDE_B_NAME Media Routing PG on Side B must be named PG2B.
GENERIC_PG_APPUSER_BOTH_SIDES_MATCH The Generic PG Communications Manager PIM application user configured on Side A must be identical to the user configured on Side B.
GENERIC_PG_APPUSER_FOUND_ON_CUCM The Generic PG Communications Manager PIM application user must be configured on the Communications Manager as an application user.
DIALER_INSTALLED_OUTBOUND_ENABLED

The dialers must be installed correctly when outbound is enabled.

MR_PG_MULTICHANNEL_APPLICATION_SERVER _HOSTNAME_BOTH_SIDES_MATCH

Application Server Host Name for Media Routing Peripheral Multichannel must be the same on both sides.

MR_PG_MULTICHANNEL2_APPLICATION_SERVER _HOSTNAME_BOTH_SIDES_MATCH

Application Server Host Name for Media Routing Peripheral Multichannel2 must be the same on both sides.

MR_PG_MULTICHANNEL3_APPLICATION_SERVER _HOSTNAME_BOTH_SIDES_MATCH

Application Server Host Name for Media Routing Peripheral Multichannel3 must be the same on both sides.

MR_PG_MULTICHANNEL_APPLICATION_SERVERS _HOSTNAME_FOUND_IN_INVENTORY

Application Server Host Name for all multichannel peripherals must be found in the solution inventory. The machine type must be one of the following:

  • EXTERNAL_SOCIAL_MINER
  • EXTERNAL_EIM_WIM_SERVICES_SERVER
  • EXTERNAL_THIRD_PARTY_MULTICHANNEL
MR_PG_APPLICATION_SERVER _HOSTNAME_NO_DUPLICATES

Application Server Host Name for each peripheral must be unique.

NO_EXTRA_SERVICES_INSTALLED_CS

Only required and optional services can be installed (extra services such as an additional PG or CTI Server are not permitted).

Data Server Rules
Rule Description
DISTRIBUTOR_INSTALLED

The distributor service must be installed.

DISTRIBUTOR_AUTOMATIC

The distributor service startup type must be set to automatic.

LOGGER_INSTALLED

The logger service must be installed.

LOGGER_AUTOMATIC

The logger service startup type must be set to automatic.

NO_EXTRA_SERVICES_INSTALLED_DS

Only required services can be installed.

Data Server and External AW Rules
Rule Description
DISTRIBUTOR_CONAPI_MUST_BE_DISABLED

Configuration Management Service (CMS) Node and Agent Re-skilling Web Tool must be disabled using Unified CCE Web Setup.

Gateways

These rules show the potential configuration errors and warnings for gateways.

Gateway Rules
Rule Description
GW_CODEC The dial peers for each CVP call server on each gateway are configured with the supported codec:
  • voice-class codec #num
  • dial-peer voice #num voip (codec ).The supported voice codecs are g711alaw, g711ulaw, g729r8, mp4a-latm and g722-64 for the above four dial peers to CVP call servers (if the dial peers are configured on the voice gateway). The supported video codec is h264. The dial peer is identified via "session target ipaddress xxxxx". The IP address must point to the IP address of CVP call server.

GW_SIP_PROTOCOL

The dial peers for each CVP call server on each gateway must be configured with the supported session protocol, sipv2.

CVP Machines

These rules show the potential configuration errors and warnings for CVP machines.

Rules for All CVP Machines (CVP, CVP OPS, CVP Reporting)
Rule Description
TRACE_LEVEL_NORMAL

The trace level must be set to normal to ensure performance.

CVP Rules
Rule Description
CVP_CUCM_SIP_SERVER_GROUPS_MATCH _CUCM_FQDN

The CVP SIP Server Group names that contain Communication Manager addresses must match the Communication Manager Cluster Fully Qualified Domain Name.

CVP_CUCM_SIP_SERVER_GROUPS_ONLY _CONTAIN_CUCM_HOSTS

The CVP SIP Server Groups that contain Communication Manager addresses cannot contain non-Communication Manager addresses (which include Communication Manager hosts that are not part of the inventory).

CVP_RING_TONE_DN_PATTERN The Ring Tone Label under Dialed Number Patterns must match the pattern 91*.
CVP_ERROR_LABEL_DN_PATTERN The Error Label under Dialed Number Patterns must match the pattern 92*.

UCM Machines

These rules show the potential configuration errors and warnings for UCM machines.

Rules for All UCM Machines (CM Publisher, CM Subscriber)
Rule Description
TRACE_LEVEL_NORMAL

The trace level must be set to normal to ensure performance.

CM Publisher Rules
Rule Description
CUCM_FQDN_DEFINED

The Communication Manager Cluster Fully Qualified Domain Name must be defined.

ESX Hosts

These rules show the potential configuration errors and warnings for ESX hosts.

Rules for All ESX Hosts
Rule Description
VMHOST_ESXI_VERSION_MATCH Side A and Side B VM Hosts must be on the same ESXi version.