cisco virtualized voice browser serviceability administration ......cisco virtualized voice browser...

Cisco Virtualized Voice Browser Serviceability Administration Guide,Release 12.5(1)First Published: 2020-01-31

Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAhttp://www.cisco.comTel: 408 526-4000

800 553-NETS (6387)Fax: 408 527-0883

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITHTHE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version ofthe UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHERWARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS.CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUTLIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERSHAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, networktopology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentionaland coincidental.

All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version.

Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.comgo trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and anyother company. (1721R)

© 1994–2020 Cisco Systems, Inc. All rights reserved.

www.cisco.com/go/trademarks

www.cisco.com/go/trademarks

C O N T E N T S

Preface vP R E F A C E

Change History v

About this Guide vi

Audience vi

Organization vi

Documentation Conventions vii

Related Documentation vii

Documentation and Service Requests vii

Cisco Serviceability 1C H A P T E R 1

Browser Support 1

Access Cisco VVB Serviceability 1

Cisco VVB Serviceability Interface 2

Alarms 3C H A P T E R 2

Alarm Configuration 3

Configure Alarm Settings 4

Alarm Configuration Settings 5

Traces 7C H A P T E R 3

Component Trace Files 7

Configure Trace Parameters 7

Trace Level Options 9

Trace file location 11

Trace File Information 11

Log Profiles Management 12

Cisco Virtualized Voice Browser Serviceability Administration Guide, Release 12.5(1)iii

Enable Profile 12

Serviceability Tools 15C H A P T E R 4

Access Control Center — Network Services Menu 15

Network Services 16

System Services 16

Admin Services 16

DB Services 17

Manage Network Services 17

Simple Network Management Protocol 18

SNMP Management Information Base (MIB) 18

More Info on SNMP 20

Configure Performance Monitoring of Cisco VVB Servers 20

Online Help 23C H A P T E R 5

Contents and Index Option 23

Access Context-Sensitive Help 24

Access Troubleshooting Tips Tool 24

Cisco VVB Online Documentation 24

Access Cisco VVB Version Information 24

Cisco Virtualized Voice Browser Serviceability Administration Guide, Release 12.5(1)iv

Contents

Preface

Cisco Virtualized Voice Browser (VVB) is designed to facilitate concurrent multimedia communicationprocessing.

The Cisco VVB provides following features:

• Facilitates self-service options such as access to check account information or user-directed call routing,by processing user commands through touchtone input or speech-recognition technologies

• Allows customers to retrieve the required information through voice commands without interacting withan agent, to navigate to the correct department, or to get help from an agent

• Provides multilingual support for Cisco VVB server prompts, for automated speech recognition (ASR)and text-to-speech (TTS) capabilities

• Provides more comprehensive and effective customer service by efficiently handling call traffic withself-service or fast transfer to the correct agent the first time.

The Cisco VVB Serviceability Administration Guide provides instructions for using the Serviceability webinterface of Cisco VVB.

• Change History, on page v• About this Guide, on page vi• Audience, on page vi• Organization, on page vi• Documentation Conventions, on page vii• Related Documentation, on page vii• Documentation and Service Requests, on page vii

Change HistoryDateSeeChange

January 2020Initial Release of Document for Release 12.5(1)

System ServicesAdded Speech Server to the list ofsystem services.

Cisco Virtualized Voice Browser Serviceability Administration Guide, Release 12.5(1)v

About this GuideThe Administration Guide for Cisco VVB Serviceability provides description and procedures for configuringalarms, traces, service parameters, and performance configuration and logging.

It also describes how to activate, start, and stop network services. Use this guide with the following documentsfor your configuration:

• Cisco VVB Administration Guide—This document describes how to use the Cisco VVB Administrationinterface to configure and manage Cisco VVB.

• Cisco Unified Serviceability Administration Guide—This document provides description and proceduresfor defining and configuring alarms, configuring traces, and SNMP for common platform services. Italso describes how to activate, start, and stop network services.

AudienceThe Administration Guide for Cisco VVB Serviceability assists administrators who configure, troubleshoot,and support Cisco VVB. This guide requires knowledge of telephony and IP networking technology.

For Cisco VVB, you must perform serviceability-related tasks in both Cisco Unified Serviceability and CiscoVVB Serviceability; for example, you may need to start and stop services, view alarms, and configure tracesin both applications to troubleshoot a problem.

Cisco Unified Serviceability supports the functionality described in the Cisco Unified ServiceabilityAdministration Guide; for tasks that are specific to Cisco VVB Serviceability, use this guide, the AdministrationGuide for Cisco VVB Serviceability.

Tip

OrganizationThe following table shows the organization of this guide:

DescriptionSection title

Provides an overview of Cisco VVB Serviceability, including browser supportand information on how to access and use the GUI.

Cisco Serviceability , onpage 1

Provides an overview of Cisco VVB Serviceability alarms and the procedure forconfiguring the alarms.

Alarms

Provides an overview of traces in Cisco VVB Serviceability, the procedure forconfiguring trace parameters, and trace filter settings. You can also create andmanage log profiles for different VVB components.

Traces

Provides detailed information on the following submenu options in Tools of theCisco VVB Serviceability:

• Control Center - Network Services

• Performance Configuration and Logging

Serviceability Tools

Cisco Virtualized Voice Browser Serviceability Administration Guide, Release 12.5(1)vi

PrefaceAbout this Guide

Documentation ConventionsDescriptionConvention

Boldfaced text is used for:

• Key and button names. (Example: Click OK.)

• Information that you enter. (Example: Enter Administrator in the UserName box.)

boldface text

Angle brackets are used around parameters for which you supply a value.(Example: In your browser, go to https://<CiscoVVB server IP address>/cuadmin.)

<>(angle brackets)

Hyphens separate keys that must be pressed simultaneously. (Example: PressCtrl-Alt-Delete.)

-(hyphen)

A right angle bracket is used to separate selections that you make in the navigationbar.

>(right angle bracket)

The Administration Guide for Cisco VVB Serviceability also uses the following conventions:

Means reader take note. Notes contain helpful suggestions or references tomaterial not covered in the document.Note

Means reader be careful. In this situation, you might do something that could result in equipment damage orloss of data.

Caution

Related DocumentationRelated Cisco VVB documentation is available at the URL mentioned below:

https://www.cisco.com/en/US/products/sw/custcosw/ps1846/tsd_products_support_series_home.html.

Documentation and Service RequestsFor information on obtaining documentation, submitting a service request, and gathering additional information,see the monthlyWhat’s New in Cisco Product Documentation, which also lists all new and revised Ciscotechnical documentation, at:

https://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html.

Subscribe to theWhat’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feedand set content to be delivered directly to your desktop using a reader application. The RSS feeds are a freeservice and Cisco currently supports RSS Version 2.0.

Cisco Virtualized Voice Browser Serviceability Administration Guide, Release 12.5(1)vii

PrefaceDocumentation Conventions

https://www.cisco.com/en/US/products/sw/custcosw/ps1846/tsd_products_support_series_home.html

https://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Cisco Virtualized Voice Browser Serviceability Administration Guide, Release 12.5(1)viii

PrefaceDocumentation and Service Requests

C H A P T E R 1Cisco Serviceability

• Browser Support, on page 1• Access Cisco VVB Serviceability, on page 1• Cisco VVB Serviceability Interface, on page 2

Browser SupportFor supported browsers, see Solution Compatibility Matrix.

Access Cisco VVB ServiceabilityWhen you complete the AppAdmin inital setup, the end user with administrator capability as configured inAppAdmin web interface can login to Cisco VVB Serviceability. You can also log in as an Application userwith default administrator capability configured during the installation of Cisco VVB. See theCisco VirtualizedVoice Browser Installation Guide and Cisco Unified CVP Configuration Guide for detailed instructions oninitial AppAdmin setup and how to assign administrator capability to end users.

Cisco VVB does not support clustering. Therefore, you may ignore any message on the Cisco VVB AdminUI/CLI that refers to cluster, publisher, subscriber, etc.

Note

To access Cisco VVB Serviceability:

Procedure

Step 1 By using a supported web browser, open a browser session.Step 2 From the VVB Administration page click the Navigation drop down and select Cisco VVB Serviceablity

then Go.Step 3 Enter an applicable username and password, and click Login.

If you log in as an Application user, you can access Cisco Unified Serviceability.Note

Cisco Virtualized Voice Browser Serviceability Administration Guide, Release 12.5(1)1

Cisco VVB Serviceability InterfaceIn addition to troubleshooting, configuring logging and tracing, and doing service-related tasks in Cisco VVBServiceability, you can do the following tasks:

• To display documentation for a single window, click Help > For this page.

• To verify the version of Cisco VVB Serviceability running on the server, click Help > About or clickthe About link in the upper-right corner of the window.

• To go directly to the home page in Cisco VVB Serviceability from a configuration window, click CiscoVVB Serviceability from the Navigation drop-down box.

• To access Cisco VVB Administration or other applications, click the applicable application from theNavigation drop-down box and click Go.

• To log out of Cisco VVB Serviceability, click the Logout link in the upper-right corner of the window.

• On each Cisco VVB Serviceability configuration page, configuration icons appear that correspond tothe configuration buttons at the bottom of the page. (For example, you can click either the Save icon orthe Save button to complete the task.)


Cisco ServiceabilityCisco VVB Serviceability Interface

C H A P T E R 2Alarms

Cisco VVB Serviceability alarms provide information on runtime status and the state of the system so thatyou can monitor the status and troubleshoot problems that are associated with the system. Alarm informationincludes the catalog, name, severity, explanation, recommended action, routing list, and parameters.

You can view alarm information by using the SysLog Viewer in Cisco Unified Real-Time Monitoring Tool(RTMT).

Use the Alarm Definitions web page in Cisco Unified Serviceability to find information about an alarmmessage.

For a complete list of alarm definitions, seehttps://www.cisco.com/en/US/products/sw/custcosw/ps1846/tsd_products_support_troubleshoot_and_alerts.html.

For information on how to view alarm definitions, see the Cisco Unified Contact Center Express ServiceabilityAdministration Guide available at: https://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/tsd-products-support-series-home.html.

Note

• Alarm Configuration, on page 3• Configure Alarm Settings, on page 4• Alarm Configuration Settings, on page 5

Alarm ConfigurationUse the Alarm Configuration web page in Cisco VVB Serviceability to view and configure alarm serversettings for different VVB components.

Alarm Server Configuration is applicable for the VVB components such as VVB Administration and Engine.Note

The alarm configuration submenu allows you to:

• Enable or disable sending of alarms to local or remote syslog server.

• Configure alarm event level for local or remote syslog server


https://www.cisco.com/en/US/products/sw/custcosw/ps1846/tsd_products_support_troubleshoot_and_alerts.html

https://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/tsd-products-support-series-home.html


SelectAlarm >Configuration from the CiscoVVB Serviceabilitymenu bar to access the AlarmConfigurationweb page.

Related TopicsConfigure Alarm Settings, on page 4Alarm Configuration Settings, on page 5

Configure Alarm SettingsThe Alarm Configuration page is used to view and update Cisco VVB Alarm Configuration for local andremote syslogs.

Procedure

Step 1 From the Cisco VVB Serviceability menu bar, choose Alarm and click Configuration.

The Alarm Configuration web page opens and the following fields are displayed on the Alarm Configurationweb page, if configured on your Cisco VVB server:

DescriptionField

Local Syslogs

Use the check box next to Enable Alarm field to enable or disable the alarms forlocal syslog.

Enable Alarm

Lists the alarm severity level.Alarm Event Level

Remote Syslogs

Use the check box next to Enable Alarm field to enable or disable the alarms forremote syslog.

Enable Alarm

Lists the alarm severity level.Alarm Event Level

IP address or host name of the Syslog server to which system should send thealarm messages. If you are using CiscoWorks, enter the IP address or the hostname of the CiscoWorks server.

Server Name

Step 2 To update the Alarm Event Level for local or remote syslogs, check the check box before Enable Alarm field.Step 3 Modify Alarm Event Level for the local or remote syslogs by selecting from the Alarm Event Level drop-down

list. Modify the syslog server name in case of remote syslog.Step 4 Click Update icon that displays in the tool bar in the upper, left corner of the window or the Update button

that displays at the bottom of the window to save your configuration. ClickClear to reset data to the previousvalues.

You should activate logging only for the purpose of debugging and remember to deactivate loggingonce the debugging session is complete.

Caution


AlarmsConfigure Alarm Settings

Alarm Configuration SettingsUse the Alarm Configuration page to modify alarm settings.

In the case of a High Availability deployment, the alarm configuration changes are automatically propagatedto the second node. If the second node cannot be contacted, an alert message indicating that the update hasfailed on the remote node is displayed.

Following table defines the options available on this page:

DescriptionSetting

The SysLog viewer serves as the alarm destination. The program logs errors in theApplication Logs within SysLog Viewer and provides a description of the alarm anda recommended action. You can access the SysLog Viewer from the Cisco UnifiedReal-Time Monitoring Tool.

Enable Alarm forLocal Syslogs

The Syslog file serves as the alarm destination. Check this check box to enable theSyslog messages to be stored on a Syslog server and to specify the Syslog server name.

Enable Alarm forRemote Syslogs

Alarm event level messages range from severity 0 (most severe) to severity 7 (leastsevere) description of which is mentioned below. When you choose a severity level,all messages of that severity level and higher are sent.

For example, if you choose ERROR_ALARM (Severity 3), all messages of severity3, severity 2, severity 1, and severity 0 are sent. The default is“INFORMATIONAL_ALARM (Severity 6)”, which will sendmessages of all severitylevels starting from 6 to severity level 0.

You can choose one of the following alarm event level options from the drop-downlist box:

EmergencyThis level designates system as unusable.

AlertThis level indicates that immediate action is needed.

CriticalThe system detects a critical condition.

ErrorThis level signifies an error condition exists.

WarningThis level indicates that a warning condition is detected.

NoticeThis level designates a normal but significant condition.

InformationalThis level designates information messages only.

DebugThis level designates detailed event information that Cisco TAC engineers use fordebugging.

Alarm Event Level


AlarmsAlarm Configuration Settings


AlarmsAlarm Configuration Settings

C H A P T E R 3Traces

A trace file is a log file that records activity from the Cisco VVB components. Trace files let you obtainspecific, detailed information about the system that can help you troubleshoot problems.

The Cisco VVB system can generate trace information for different services. This information is stored in atrace file. To help you control the size of a trace file, you can specify the services for which you want to collectinformation and the level of information that you want to collect.

The Cisco VVB system also generates information about all threads that are running on the system. Thisinformation is stored in the thread dump file and is useful for troubleshooting.

• Component Trace Files, on page 7• Configure Trace Parameters, on page 7• Trace Level Options, on page 9• Trace file location, on page 11• Log Profiles Management, on page 12

Component Trace FilesThe component trace file contains information about each component. You can create a trace file for any ofthe following Cisco VVB components:

• Administration

• Engine

• Speech Server

The component trace file contains information about each component. To set up the trace file, follow theprocedure mentioned in Configure Trace Parameters section.

After configuring the information that you want to include in the trace files for the various services, you cancollect and view trace files by using the trace and log central option in the Cisco Unified Real-TimeMonitoringTool.

Configure Trace ParametersTo update trace file information and to activate and deactivate logging, follow the procedure mentioned below:


Procedure

Step 1 From the Cisco VVB Serviceability menu bar, choose Trace > Configuration.

The Trace Configuration web page opens displaying the default trace configuration for Cisco VVB Engine.

Step 2 From the Select Service drop-down list box, choose a service or component for which you want to configuretrace. Then, click Go.

You should be able to view the existing Trace configurations and debug levels for the selected Cisco VVBservice with check boxes for the various Debugging and XDebugging levels for each sub facility.

The debug levels for different Cisco VVB subfacilities or services might vary depending on the selectedservice and are listed in the following table:

Table 1: Debug Levels for Different Cisco VVB Subfacilities

Subfacilities or ServicesCisco VVB Components

Libraries

Managers

Miscellaneous

Cisco VVB Administration

Libraries

Managers

Miscellaneous

Steps

Subsystems

Cisco VVB Engine

SubsystemsCisco VVB Speech Server

Step 3 Update the debug level for one or more of the libraries or sub facilities for the selected service by doing thefollowing:a) To activate traces for a specific component or logging for a server, check the check box for the service

that you chose.b) To deactivate logging for a server, uncheck the specific check box.

Step 4 To limit the number and size of the trace files, you can specify the trace output setting using the followingtwo fields. See the following table for description and default values for these two fields.

DescriptionField

The maximum number of trace files to be retained by the system.

This field specifies the total number of trace files for a given service. Cisco VVBServiceability automatically appends a sequence number to the file name to indicatewhich file it is; for example, Cisco001MADM14.log. When the last file in thesequence is full, the trace data begins writing over the first file. The default valuevaries by service.

MaximumNo. of Files


TracesConfigure Trace Parameters

DescriptionField

This field specifies the maximum size of the trace file in kilobytes or megabytesdepending on the selected service. The default value varies by service.

Maximum File Size

Step 5 Click Save icon in the tool bar in the upper, left corner of the window or the Save button at the bottom of thewindow to save your trace parameter configuration. The settings are updated in the system and the trace fileswill be generated as per the saved settings. Click Restore Defaults icon to revert to the default settings forthe selected service.

You should activate additional logging only for the purpose of debugging and remember to deactivatelogging once the debugging session is complete.

Caution

Related TopicsTrace file location, on page 11

Trace Level OptionsA trace file is a log file that records activity from the Cisco VVB component subsystems and steps. Tracefiles let you obtain specific, detailed information about the system that can help you troubleshoot problems.

The Cisco VVB system can generate trace information for every component. This information is stored in antrace file. To help you control the size of an trace file, you specify the components for which you want tocollect information and the level of information that you want to collect.

A trace file that records all information for a component, such as Engine, can become large and difficult toread. To help you manage the trace file, the Cisco VVB system lets you specify the subfacilities for whichyou want to record information.

For each component, you can select one or more Debugging trace levels. These selections specify the levelof details in the debugging messages that the system sends to a trace file. For instance, if you select Debugging,the system sends only the basic error messages while if you select XDebugging5, the system will send errors,warnings, informational, debugging, verbose messages and so on in detail to the trace file.

The table below describes the Trace file subfacilities.

Table 2: Trace File Subfacilities

DescriptionComponent Code

Applications ManagerAPP_MGR

Archive ManagerARCHIVE_MGR

Cisco VVB Bootstrap ManagerBOOTSTRAP_MGR

Configuration ManagerCFG_MGR

Channel ManagerCHANNEL_MGR

Cluster ManagerCLUSTER_MGR

Contact ManagerCONTACT_MGR


TracesTrace Level Options


Document ManagerDOC_MGR

EngineENG

Executor ManagerEXECUTOR_MGR

Generic catalog for a facilityGENERIC

Java Signaling and Monitoring InterfaceJASMIN

Configuration LibraryLIB_CFG

Event Message LibraryLIB_EVENT

JDBC LibraryLIB_JDBC

JINI ServicesLIB_JINI

License LibraryLIB_LICENSE

Media LibraryLIB_MEDIA

Java Remote Method Invocation LibraryLIB_RMI

Servlet LibraryLIB_SERVLET

Tomcat LibraryLIB_TC

Log ManagerLOG_MGR

Manager ManagerMGR_MGR

Node ManagerNODE_MGR

Prompt ManagerPROMPT_MGR

RTP ManagerRTPPORT_MGR

Script ManagerSCRIPT_MGR

Session ManagerSESSION_MGR

SIP Stack loggingSIP_STACK

Socket ManagerSOCKET_MGR

Cisco Media Termination SubsystemSS_CMT

Database SubsystemSS_DB

HTTP SubsystemSS_HTTP

MRCP ASR SubsystemSS_MRCP_ASR

MRCP TTS SubsystemSS_MRCP_TTS

Resource Manager SubsystemSS_RM

Resource Manager Contact Manager SubsystemSS_RMCM

Route and Queue SubsystemSS_ROUTEANDQUEUE

Real-Time Reporting SubsystemSS_RTR


TracesTrace Level Options


SIP SubsystemSS_SIP

Voice Browser SubsystemSS_VB

Call Control StepsSTEP_CALL_CONTROL

Media Control StepsSTEP_MEDIA_CONTROL

Session Management StepsSTEP_SESSION_MGMT

Call Contact StepsSTEP_CALL_CONTACT

Contact StepsSTEPS_CONTACT

Database StepsSTEPS_DB

Document StepsSTEPS_DOCUMENT

Grammar StepsSTEPS_GRAMMAR

Cisco Unified ICME StepsSTEPS_ICM

Java StepsSTEPS_JAVA

Prompt StepsSTEPS_PROMPT

Session StepsSTEPS_SESSION

User StepsSTEPS_USER

Trace file locationYou can collect and view trace information using the Real-Time Monitoring Tool (RTMT).

Trace File InformationThe trace files contain information in standard Syslog format. The file includes some or all of the followinginformation for each event that it records:

• Line number

• Date and time the event occurred

• Facility and subfacility (component) name

• Severity level

• Message name

• Explanation

• Parameters and values


TracesTrace file location

Log Profiles ManagementLog Profile is an aggregated entity that preserves trace settings of the following Cisco VVB services:

• Cisco VVB Engine (Traces termed as MIVR)

• Cisco VVB Administration (Traces termed as MADM)

Choose Trace > Profile from the Cisco VVB Serviceability menu bar to access the Log Profiles Managementweb page. The Log Profiles Management web page opens displaying the available log profiles each with aradio button. You can perform different operations on the listed log profiles, which are explained in detail inthe following sub-sections.

Log profiles in Cisco VVB can be one of the following two types:

1. System Log Profiles: These log profiles are pre-installed with Cisco VVB and you cannot modify theseprofiles.

The following table provides information on the log profiles that are factory shipped with Cisco VVB:

Table 3: System Log Profiles

Scenario in which this profile must be activatedName

Generic logs are enabled.DefaultVVB

For issues with web administration through AppAdmin, Cisco VVBServiceability, and other web pages.

AppAdminVVB

For issues with media setup or media transmission.MediaVVB

For issues with handling calls.VoiceBrowserVVB

For issues with ASR/TTS with Cisco VVB interaction.MRCPVVB

For issues with SIP signaling related are published in the log.CallControlVVB

Enable ProfileTo enable or activate a log profile, perform the following steps:

Procedure

Step 1 From the Cisco VVB Serviceability menu bar, choose Trace > Profile. The Log Profiles Management webpage displays.

You can enable a log profile using any one of the following methods from the Log Profiles Management webpage:

a) Select the radio button for the profile and click Enable icon or buttonb) Click the hyperlink for the desired profile. Log Profile Configuration web page for the selected profile is

displayed. Click Enable icon or button in the Profile Configuration web page


TracesLog Profiles Management

c) Click Add New. Enter the desired trace settings in the Profile Configuration web page and click Saveand Enable icon or button in the Profile Configuration web page.

Step 2 The trace setting for the selected profile is transferred to system's trace settings and on successful activation,a message will be displayed in the status bar.


TracesEnable Profile


TracesEnable Profile

C H A P T E R 4Serviceability Tools

• Access Control Center — Network Services Menu, on page 15• Network Services, on page 16• Manage Network Services, on page 17• Simple Network Management Protocol, on page 18• Configure Performance Monitoring of Cisco VVB Servers, on page 20

Access Control Center — Network Services MenuControl Center in Cisco VVB Serviceability lets you do the following tasks:

• Start, stop, and restart Cisco VVB services

• View the status the status of Cisco VVB services

• Refresh the status of Cisco VVB services

Cisco VVB Serviceability provides Control Center - Network Services menu option, which is essential foryour system to function.

Procedure

ChooseTools >Control Center - Network Services from the Cisco VVB Serviceability menu bar to performthe above-mentioned actions.

Youmay need to manage services in both Cisco VVB Serviceability and Cisco Unified Serviceabilityto troubleshoot a problem. For information on Unified Serviceability services, see the Cisco UnifiedContact Center Express Serviceability Administration Guide available at: https://www.cisco.com/c/en/us/support/unified-communications/unified-communications-manager-callmanager/tsd-products-support-series-home.html.

Tip





Network ServicesInstalled automatically, network services include services that the system requires to function; for example,database and system services. Because these services are required for basic functionality, you cannot activatethem in the Service Activation window.

After the installation of your application, network services start automatically. The list of services displayedin the Control Center—Network Services web page depends on the license package of your Cisco VVB. TheServiceability categorizes the network services into the following categories, which are explained in thesubsequent sections:

• System Services, on page 16

• Admin Services, on page 16

• DB Services, on page 17

The Control Center—Network Services web page displays the following information for the network services:

• Name of the network services, their dependant subsystems, managers, or components

• Status of the service (IN SERVICE, PARTIAL SERVICE, or SHUT DOWN; for individual subsystems,the status could be OUT OF SERVICE or NOT CONFIGURED).

• Start Time of the service

• Up Time of the service

• Only System and Admin Services Information will be visible in Cisco VVB Node Services Information.Note

System ServicesThe Cisco VVB Serviceability service supports starting and stopping of the following System Services:

• Perfmon Counter Service

• Cluster View Daemon—List of Managers

• Engine—List of Subsystems and Managers

• Voice Subagent

• SNMP Java Adapter

• Speech Server

Admin ServicesThe Cisco VVB Serviceability service supports starting and stopping of the following Admin Services:

• Cisco VVB Configuration API


Serviceability ToolsNetwork Services

• Cisco VVB Administration

• Cisco VVB Serviceability - List of Managers

You can start or stop this service only by using CLI. Cisco VVB Serviceabilityweb interface does not provide the functionality to start or stop this service.

Note

DB ServicesYou can start and stop Cisco VVB Database service.

Manage Network ServicesControl Center in Cisco VVB Serviceability allows you to view status, refresh the status, and to start, stop,and restart network services.

Perform the following procedure to start, stop, restart, or view the status of services for a server. You canstart, stop, or refresh only one service at a time. Be aware that when a service is stopping, you cannot start ituntil the service is stopped. Likewise, when a service is starting, you cannot stop it until the service starts.

Procedure

Step 1 Choose Tools > Control Center—Network Services from the Cisco VVB Serviceability menu bar.Step 2 From the Server drop-down list box, choose the sever and then click Go.

The window displays the following items:

a) The service names for the server that you chose.b) The service status; for example, In Service, Shutdown, Partial Service and so on. (Status column)c) The exact time that the service started running. (Start Time column)d) The amount of time that the service has been running. (Up Time column)

Step 3 Perform one of the following tasks:a) Click the radio button before the service that you want to start and click the Start button.

The Status changes to reflect the updated status.

b) Click the radio button before the service that you want to stop and click the Stop button.

The Status changes to reflect the updated status.

c) Click the radio button before the service that you want to restart and click the Restart button.

A message indicates that restarting may take a while. Click OK.

d) To get the latest status of the services, click the Refresh button. The status information is updated toreflect the current status.


Serviceability ToolsDB Services

Simple Network Management ProtocolSimple NetworkManagement Protocol (SNMP) is an industry-standard interface for exchanging managementinformation between network devices. SNMP enables you to monitor and manage the Cisco VVB system.You also can set up SNMP traps to automatically notify any high-severity messages and errors that aregenerated by the Cisco VVB system.

You can configure the SNMP settings using the Cisco Unified Serviceability web interface.

SNMP Management Information Base (MIB)AManagement Information Base (MIB) designates a collection of information that is organized hierarchically.MIBs are made up of managed objects, which are referenced by object identifiers. Managed objects are madeup of one or more object instances, which are essentially variables. MIBs provide status monitoring,provisioning, and notification.

Table 4: SNMP MIBs

Agent ServiceMIB

Cisco VVB Voice SubagentCISCO-VOICE-APPS-MIB

Cisco CDP AgentCISCO-CDP-MIB

Cisco Syslog AgentCISCO-SYSLOG-MIB

System Application AgentSYSAPPL-MIB

MIB2 AgentMIB-II

Host Resources AgentHOST-RESOURCES-MIB

• In Cisco VVB, the SysAppl MIB will not provide the Cisco VVB subsystem information and their statusinformation. You can view the subsystem and their status information through Cisco VVB Serviceabilityweb interface.

• Syslog messages can also be sent as SNMP traps using the CISCO-SYSLOG-MIB. Refer to the sectionon CISCO-SYSLOG-MIB for details. They can be correlated to the failure of important features of CiscoVVB.

Note

The following section describes CISCO-VOICE-APPS-MIB. For more information about other Cisco VVBsupported MIBs, see Cisco Unified CM SNMP chapter in the Cisco Unified Serviceability AdministrationGuide available at https://www.cisco.com/en/US/partner/products/sw/voicesw/ps556/prod_maintenance_guides_list.html


Serviceability ToolsSimple Network Management Protocol

https://www.cisco.com/en/US/partner/products/sw/voicesw/ps556/prod_maintenance_guides_list.html


CISCO-VOICE-APPS-MIB

The CISCO-VOICE-APPS-MIB provides information associated with the installed workflow applicationsprovisioned on the Cisco VVB Server. It also provides information on the supported SNMP Traps on CiscoVVB. You can manage CISCO-VOICE-APPS-MIB through Cisco VVB Serviceability web interface.

Cisco VVB Voice Subagent

Cisco VVBVoice Subagent service implements the CISCO-VOICE-APPS-MIB. Cisco VVBVoice SubagentService communicates with the SNMP Master Agent through Cisco VVB SNMP Java Adaptor. The CiscoVVB SNMP Java Adaptor service should be up and running for the Cisco VVB Voice Subagent to workproperly.

For more information about the CISCO-VOICE-APPS-MIB, see this URL:ftp://ftp.cisco.com/pub/mibs/v2/CISCO-VOICE-APPS-MIB.my.

• In CiscoVVB,while exposing the CiscoVVBworkflow information throughCISCO-VOICE-APPS-MIB,only one trigger per application row will be returned when doing a walk on the workflow table(cvaWorkflowInstallTable object). If there are multiple triggers associated with a Workflow application,these are shown as separate entries (rows).

Note

SNMP Traps

Subsystems, which are the functional blocks of Cisco VVB, sends out alarms that are routed to the Syslog oras SNMP Traps. SNMP Traps are generated when any Cisco VVB Subsystem or module or processes startor stop or runtime failure occurs for a module. These failures can be tracked for each major component totrack the health of the Cisco VVB system.

The following Traps are supported as part of the CISCO-VOICE-APPS-MIB:

DescriptionTrap Name

A cvaModuleStart notification signifies that an application module orsubsystem has successfully started and transitioned into in-service state.

cvaModuleStart

A cvaModuleStop notification signifies that an application module orsubsystem has stopped. If cause of the failure is known then, it will bespecified as part of the Trap message.

cvaModuleStop

cvaModuleRunTimeFailure notification signifies that a run time failurehas occurred. If cause of the failure is known then it will be specified aspart of the Trap message.

cvaModuleRunTimeFailure

A cvaProcessStart notification signifies that a process has just started.cvaProcessStart

A cvaProcessStop notification signifies that a process has just stopped.cvaProcessStop

The ModuleStart and ModuleStop traps are generated when the key Cisco VVB services including CiscoVVBEngine and CiscoVVBAdministration and their modules/subsystems are started and stopped respectively.

The ProcessStart and ProcessStop traps are generated when the key Cisco VVB services including Cisco VVBEngine, and Cisco VVB Administration are started and stopped.


Serviceability ToolsSNMP Management Information Base (MIB)

ftp://ftp.cisco.com/pub/mibs/v2/CISCO-VOICE-APPS-MIB.my

You can configure the notification destinations by using the SNMPNotification Destination Configurationpage in Cisco Unified Serviceability.

SNMP Traps are not generated for events when the Cisco VVB services and/or their subsystems go Out ofService or are In Service. These events are sent as Remote Syslog messages and can be viewed through anythird-party Syslog Viewers. You can refer to the list of Cisco VVB services and their subsystems/modulesfrom the Cisco VVB Serviceability under Tools > Control Center - Network Services.

Note

• Cisco VVB does not support SNMP trap V3 notifications.

• CISCO-VOICE-APPS-MIB does not support INFORM notifications.

Note

For all notifications, the system sends traps immediately if the corresponding trap flags are enabled. Beforeyou configure notification destination, verify that the required SNMP services are activated and running. Also,make sure that you configured the privileges for the community string or user correctly.

More Info on SNMPFor more information related to SNMP such as SNMP Version 1, Version 2C, Version 3, SNMP system groupconfiguration, SNMP informs and SNMP trap parameters, see Cisco Unified Serviceability AdministrationGuide available at https://www.cisco.com/en/US/partner/products/sw/voicesw/ps556/prod_maintenance_guides_list.html

Configure Performance Monitoring of Cisco VVB ServersUse the Performance Configuration and Logging page to configure JVM parameters and dump Thread andMemory traces for performancemonitoring of VVB servers. You can configure settings only for the followingservices of VVB:

• Cluster View Daemon• Engine• Serviceability

Use the following procedure to configure JVM parameters for a particular service on a particular server.

Procedure

Step 1 From the Cisco VVB Serviceability menu bar, choose Tools > Performance Configuration and Logging.Step 2 Choose a server from the Server drop-down list box and click Go.

The first node is selected by default and JVM options for the VVB Engine service in the first node is displayed.

Step 3 Choose a service for which you want to see the JVM options from the Service drop-down list box. You shouldbe able to select any one of the following services from this list box:


Serviceability ToolsMore Info on SNMP



• Cluster View Daemon• Engine• Serviceability

The following JVM options are displayed for each service:

• PrintClassHistogram

• PrintGCDetails

• PrintGC

• PrintGCTimeStamps

Step 4 Click theDumpThread Trace icon or button to dump the thread traces for the selected service in the selectedserver. You can collect the corresponding jvm.log from the log folder for that facility using Real-TimeMonitoring Tool (RTMT).

Step 5 Click the Dump Memory Trace icon or button to dump the memory traces. This creates the following twologs in the log folder for that facility.a) Memory-<facility name>-<time stamp>.hprof (for heap dump)b) histo-<facility name> <time stamp>.log (for histogram)

Step 6 You can change the JVM options by clicking Enable or Disable radio buttons in this page.

Click the Update JVM Options icon or button to update the new settings for selected service on selectednode.


Serviceability ToolsConfigure Performance Monitoring of Cisco VVB Servers


Serviceability ToolsConfigure Performance Monitoring of Cisco VVB Servers

C H A P T E R 5Online Help

The Help Menu of the Cisco VVB Serviceability web interface provides access to online help for the VVBsystem. Use the Help menu to access configuration procedures and description of VVB components.

The Help menu contains the following menu options:

• Contents and Index—Choose this option to view the entire VVB Serviceability Administration Guideonline help system and index (see Contents and Index Option, on page 23).

• For this page—Choose this option to view context-sensitive help (see Access Context-Sensitive Help,on page 24).

• Cisco VVB Documentation on Cisco.com—Choose this option to view the documentation index page(see Access Context-Sensitive Help, on page 24).

• About—Choose this option to viewVVBversion information (seeAccess CiscoVVBVersion Information,on page 24).

• Contents and Index Option, on page 23• Access Context-Sensitive Help, on page 24• Access Troubleshooting Tips Tool, on page 24• Cisco VVB Online Documentation, on page 24• Access Cisco VVB Version Information, on page 24

Contents and Index OptionTo view the entire Cisco VVB Serviceability Administration Guide online help system and index, chooseHelp > Contents and Index from the Cisco VVB Serviceability menu bar. TheCisco VVB ServiceabilityAdministration Guide Online Help window opens.

When you click any topic in the left pane, the section of the online help that corresponds to that topic appearsin the right pane.

The following table describes the menu options in the Cisco VVB Administrator Guide Online Help window.

DescriptionMenu Option

Returns you to the beginning of the online help document.Home

Opens a search window, in which you can search for specific words in the online helpfiles.

Search

Opens a file explaining how to use the online help files.Using Help


Opens a glossary of definitions for terms used in Cisco VVB and Cisco Unified IPIVR.

Glossary

Opens a PDF version of the Cisco VVB Serviceability Administration Guide.View PDF

Displays the contents of the Cisco VVB Serviceability Administration Guide onlinehelp files in the left pane of the online help window.

Contents

Displays the index of the Cisco VVB Serviceability Administration Guide online helpfiles in the left pane of the online help window.

Index

Access Context-Sensitive HelpTo access context-sensitive help, open the web page for which you want help and choose Help > For ThisPage from the Cisco VVB Serviceability menu bar. The Cisco VVB Serviceability online help displaysinformation that is specific to the open web page.

Access Troubleshooting Tips ToolTheCisco VVB system provides the Troubleshooting Tips tool as a way for you to search the troubleshootingwiki page for suggestions on how to solve problems that may arise in the performance of your Cisco VVBsystem.

Procedure

ChooseHelp >Troubleshooting Tips from the Cisco VVB Serviceability Administration menu bar to accessthe Troubleshooting Tips wiki page

Cisco VVB Online DocumentationTo access the complete VVB documentation set for VVB, choose Help > Cisco VVB Documentation onCisco.com from the VVB Administration menu bar. A new browser window opens to display the followingdocumentation index page: https://www.cisco.com/en/US/products/sw/custcosw/ps1846/tsd_products_support_series_home.html

Access Cisco VVB Version InformationProcedure

Choose Help > About from the VVB Serviceability menu bar to access VVB version informationThe VVB Serviceability web page opens, displaying version information and package information.


Online HelpAccess Context-Sensitive Help



I N D E X

A

accessing 2Help 2

alarm settings 4, 20alarms 3, 5

alarms 5destinations 5

configuration overview 3configuration settings 5Event Level 5overview 3viewing information 3

C

Cisco Unified Real-Time Monitoring Tool., See RTMTControl Center 15, 17

network services 15overview 15starting services 17stopping services 17viewing status 17

F

finding version 2

H

Help menu 23, 24About 24Contents and Index 23For this Page 24

Help, accessing 2

I

interface, using 2

L

logging alarms 4, 20

N

network services 16Control Center 16overview 16starting 16stopping 16viewing status 16

O

output settings for trace 12overview 16

network services 16

R

RTMT, using to collect and view alarms 3

S

service 15, 16Control Center overview 15network services 16starting services 15stopping services 15

T

Tools menu 24troubleshooting tips 24

trace 7, 12configuration overview 7configuring 7output settings 12service 7

activating trace 7trace files 7, 9, 11, 12

facilities 9interpreting 11level options 9subfacilities 9, 12viewing and interpreting 11

Cisco Virtualized Voice Browser Serviceability Administration Guide, Release 12.5(1)IN-1

U

using interface 2

V

version, finding 2viewing alarm information 3

Cisco Virtualized Voice Browser Serviceability Administration Guide, Release 12.5(1)IN-2

INDEX

cisco virtualized voice browser serviceability administration ......cisco virtualized voice browser...

Documents