Command Line Interface Guide for Cisco Unified Communications Solutions, Release 9.1(1)
Run Commands
Downloads: This chapterpdf (PDF - 1.24MB) The complete bookPDF (PDF - 3.86MB) | Feedback

Run Commands

Run Commands

run cuc*

run cuc dbquery

This command runs an SQL query and displays the results.

run cuc dbquery database_name sql_query [page]

Syntax Description

Parameters Description
database_name

Specifies the database that sql_statement operates on.

Note   

Be aware that database names are case sensitive.

Connection databases include:

unitydirdb: Contains the directory and configuration data.

unitydyndb: Contains dynamic data that Connection uses internally.

unitymbxdb1 to unitymbxdb5: Contains the data about the current voice messages in the corresponding mailbox store. This data includes pointers to the audio files that are stored in the file system. If only one mailbox store is configured, the name of the mailbox store database is always unitymbxdb1.

unityrptdb: Contains audit log data.

sql_query

Specifies the SQL query that you want to run.

page

Shows the output one page at a time.

Note   

Be aware that page is case sensitive.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

The following example runs the SQL query select alias from vw_usertemplate on the unitydirdb database.
admin: run cuc dbquery unitydirdb select alias from vw_usertemplate


alias

---------------------

AdministratorTemplate

VoiceMailUserTemplate

run cuc preupgrade test

This command verifies the state of the connection server on which the upgrade process is to be performed and specifies the actions that can be taken before upgrading the system.

run cuc preupgrade test

Command Modes

Administrator (admin:)

Usage Guidelines

None

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection only.

Example

admin:run cuc preupgrade test
===========================================================================
DISCLAIMER ::
This cli command should be executed from publisher before upgrade to
check system health. This cli command is not intended to correct the
system state , rather it aims at informing the administrator what all
actions are advised to be taken before running upgrade.
===========================================================================
Checking connection db. Please wait...Done
Checking critical services. Please wait...Done
Checking cluster state. Please wait...Done
Checking cop file installation. Please wait...Done
Checking locales installation. Please wait...Done
Checking drs backup history. Please wait...Done
===========================================================================
R E P O R T    C A R D
===========================================================================
Locales Installation Test: PASS
Connection DB Test: PASS
DRS Backup History Test: FAIL
Cluster State Test: SKIPPED
Critical Services Test: PASS
Cop File Installation Test: SKIPPED
===========================================================================
A C T I O N   S U M M A R Y
===========================================================================
ACTION : Connection DB is online.
         NO constraints were found disabled in :unitydirdb,NO ACTION required before upgrade.
         NO indexes were found disabled in :unitydirdb,NO ACTION required before upgrade.
         NO constraints were found disabled in :unitydyndb,NO ACTION required before upgrade.
         NO indexes were found disabled in :unitydyndb,NO ACTION required before upgrade.
         NO constraints were found disabled in :unitymbxdb1,NO ACTION required before upgrade.
         NO indexes were found disabled in :unitymbxdb1,NO ACTION required before upgrade.
         NO constraints were found disabled in :unityrptdb,NO ACTION required before upgrade.
         NO indexes were found disabled in :unityrptdb,NO ACTION required before upgrade.
        Connection DB state is GOOD,NO ACTION required before upgrade.
ACTION : All Critical services are running ,NO ACTION required before upgrade.
ACTION : Standalone/Cores detected , excluding cluster state checking
ACTION : Skipping COP installation check, product version detected :'8.6.2.21018-1',NO ACTION required before upgrade.
ACTION : No locales were found installed ,NO ACTION required before upgrade.
ACTION : Make Sure DRS backup is taken aleast a day before upgrade.
Check report /var/log/active/cuc/cli/preupgrade_120325-224523.txt for details.

run cuc smtptest

This command initiates a test that helps to verify the outgoing or incoming SMTP configuration for SpeechView transcriptions.

run cuc smtptest email-address

Syntax Description

Parameters Description
email-address

Specifies the email address.

Command Modes

Administrator (admin:)

Usage Guidelines

The test sends a test message to a specified email address. You then access the email account and reply to the test message without changing the subject line. The test passes after the Cisco Unity Connection server receives the response. The success or failure of parts of the test help to pinpoint problems in the outgoing or incoming SMTP configuration for transcriptions.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection.

Example

The following example runs the Sysagent task CleanDeletedMessagesTask.
admin: run cuc sysagent task CleanDeletedMessagesTask

run cuc sysagent task

This command runs a Sysagent task.

run cuc sysagent task task_name

Syntax Description

Parameters Description
task_name

Specifies the name of the Sysagent task that you want to run.

Command Modes

Administrator (admin:)

Usage Guidelines

For a list of Sysagent tasks, run the command show cuc sysagent task list (Cisco Unity Connection only). Be aware that sysagent task names are case sensitive.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

Example

The following example runs the Sysagent task CleanDeletedMessagesTask.
admin: run cuc sysagent task Umss.CleanDeletedMessagesTask


CleanDeletedMessagesTask started

run cuc vui rebuild

This command instructs the voice recognition transport utility to immediately rebuild the voice recognition name grammars with pending changes.

run cuc vui rebuild

Command Modes

Administrator (admin:)

Usage Guidelines

This command rebuilds only grammars that have changes flagged in the database. This command ignores name grammar update blackout schedules and executes immediately. Due to the overhead of retrieving potentially large amounts of name-related data from the database, you should use this command sparingly and only when absolutely necessary.

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: Cisco Unity Connection

run loadxml

This command is a workaround for when service parameters or product-specific information does not appear in the administration window as expected.

run loadxml

Command Modes

Administrator (admin:)

Usage Guidelines


Note


This command is processor intensive, and you may need to restart some services after you run this command.


Requirements

Command privilege level: 1

Allowed during upgrade: No

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

run sql

This command allows you to run an SQL command.

run sql sql_statement

Syntax Description

Parameters Description
sql_statement

Specifies the SQL command to run.

Command Modes

Administrator (admin:)

Requirements

Command privilege level: 1

Allowed during upgrade: 0

Applies to: Unified Communications Manager, IM and Presence service on Unified Communications Manager, Cisco Unity Connection

Example

This example runs an SQL command.
admin: run sql select name from device

run pe sql

This command allows you to run an input SQL statement against the specified presence datastore.

run pe sql datastore_name sql_statement

Syntax Description

Parameters Description
datastore_name

Represents the name of the datastore.

sql_statement

Represents the SQL command to run.

Command Modes

Administrator (admin:)

Usage Guidelines

Requirements

Command privilege level: 1

Allowed during upgrade: Yes

Applies to: IM and Presence service on Unified Communications Manager

Example

This example runs an SQL command against the datastore.
admin: run pe sql ttsoft select * from presenceeventtable