Installation and Administration Guide for the Cisco TelePresence Exchange System Release 1.0
Configuring System Settings
Downloads: This chapterpdf (PDF - 131.0KB) The complete bookPDF (PDF - 2.64MB) | Feedback

Configuring System Settings

Table Of Contents

Configuring System Settings

Understanding System Status

Live System Ping

Configuring Cluster Nodes

Editing Cluster Nodes

Deleting Cluster Nodes

Cluster Node Fields

Configuring Time Zones

Configuring Users

Adding Users

Editing User Settings

Deleting Users

User Fields

Configuring Database Backups

Retention Policy


Configuring System Settings


Revised June 30, 2011

The administration console shows the status of key system functions. The following sections describe the system status display and how to configure system settings:

Understanding System Status

Configuring Cluster Nodes

Configuring Time Zones

Configuring Users

Configuring Database Backups

Understanding System Status

The administration console home page displays the system configuration status for the following key functions:

Scheduling—Configuration required before you can schedule meetings.

Attending—Configuration required before anyone can attend meetings.

OBTP—Configuration required for One-Button-to-Push (OBTP) functionality.

System—Cisco TelePresence Exchange System will only launch meetings if valid licenses are provisioned.

A green check-mark icon next to the function indicates that the system configuration is complete for the corresponding function. A red stop-sign icon indicates that the system configuration is missing or incomplete for the corresponding function.

If any of the key functions display a red icon, the What's Wrong field provides a description of the configuration issue that needs to be addressed. Click the fix link (the button with the hammer icon) to open the configuration page on which the issue can be resolved.


Note The system configuration status also is displayed in the System Status panel (below the navigation pane) on all administration console pages.



Note The system status display refreshes each time that you navigate to a new page.


Live System Ping

The live system ping displays the overall health of the other platforms that communicate with the Cisco TelePresence Exchange System. The system monitors these platforms by sending status messages periodically. Systems that respond to the message display a green icon and systems that are not responding to the message display a red icon.

Configuring Cluster Nodes

The Cisco TelePresence Exchange System is a cluster node, which is composed of at least two administration servers, two call engines, and two database engines.

After installation of a Cisco TelePresence Exchange System completes, the cluster node registers itself to the database (every five minutes). When the administration server discovers the new cluster node, it appears in the cluster node list within the administration console. When you remove a cluster node from the network, the system automatically removes the corresponding entry in the administration console. However, you can modify information for a cluster node by using the administration console.


Note Updates to the administration console can take up to five minutes.


The following sections describe how to modify cluster nodes:

Editing Cluster Nodes

Deleting Cluster Nodes

Cluster Node Fields

Editing Cluster Nodes

Procedure

To edit a Cluster Node, do the following procedure:


Step 1 From the navigation pane, choose System > Cluster Nodes.

The Cluster Nodes window is displayed.

Step 2 In the item table, click the applicable entry.

The node details window is displayed.

Step 3 From the toolbar, click Edit this Cluster Node.

The Edit Node window is displayed. Fields contain the currently-configured values.

Step 4 Modify field entries as required.

Fields are described in Table 8-1.

Step 5 To save your changes, click Save.


Deleting Cluster Nodes

Procedure

To delete a cluster node, do the following procedure:


Step 1 From the navigation pane, choose System > Cluster Nodes.

The Cluster Nodes window is displayed.

Step 2 Do the following sub-steps, depending on your Cisco TelePresence Exchange System version.

Cisco TelePresence Exchange System Release 1.0(3)

a. In the item table, check the check box next to the entry that you want to delete. You can delete multiple cluster nodes at one time by checking the check box next to each entry that you want to delete.

b. Click Delete.

c. In the Deletion Confirmation dialog box, click Delete to confirm the deletion.

Cisco TelePresence Exchange System Release 1.0(2) and earlier

a. In the item table, check the check box next to the entry you want to delete.

b. From the drop-down list that appears, choose Delete.

c. Click Go.

d. In the panel that opens to confirm the deletion, click OK.


Tip If you prefer to view the details of a cluster node prior to deleting it, in the Cluster Nodes window, you can click the applicable Cluster Node to go to the Cluster Node page. After verifying that you have chosen the correct cluster node to delete, click Delete This Cluster Node, and then in the Deletion Confirmation dialog box, click Delete to confirm the deletion.



Cluster Node Fields

.

Table 8-1 Cluster Node Field Descriptions 

Field
Description

Node Name

Node name of the node.

Host Name

Hostname of the node.

IP Address

The IP address of the node.

See the "Common Field Properties" section on page 2-4.

Cluster

Drop-down list of clusters. Currently, Default Cluster is the only choice.

Node Type

Drop-down list of node types. For the licensing server, choose ENGINE. For the CDR collection service, choose ADMIN. For the database server, choose DATABASE.


Configuring Time Zones

You can activate any number of time zones for the administration console. All of the supported time zones are listed alphabetically on the System > Time Zones page by continent and city. A time zone with a check in the Active check box is active and assignable by the system within various configuration panels of the administration console.

You must define a time zone to allow configuration of the time of day within the administration console such as setting the starting time for a meeting.

Procedure

To activate a time zone, do the following procedure:


Step 1 From the navigation pane, choose System > Time Zones.

The Time Zones window is displayed.

Step 2 To activate a time zone, check the Active check box next to the desired time zone.

The time zone is now active.

Step 3 To determine which time zones are active, click the T icon next to the Active heading.

Step 4 In the panel that is displayed, check the Active check box and click Filter.


Configuring Users

System administrators can create new users and modify user settings such as name, user ID, email, and password.

The Cisco TelePresence Exchange System administration console supports the following user roles:

System—System administrators have the authority to configure or modify all settings that are associated with the Cisco TelePresence Exchange System. The system administrator can create new users and assign roles to all users.

Admin—Administrators have the authority to configure or modify all settings that are associated with the Cisco TelePresence Exchange System. Admin users can create API users.

Provisioning—(available only in Cisco TelePresence Exchange System Release 1.0(3) and later) Provisioning users can log in to the administrative console, and can modify data on the Customers and Endpoint Management pages only. For all other pages in the system, the provisioning user has read-only privileges, and the add, edit, and delete buttons are hidden. Provisioning users can be created by system administrators with the System user role.

Read only—(available only in Cisco TelePresence Exchange System Release 1.0(3) and later) Read-only users can log in to the administrative console to view pages, but all add, edit, and delete buttons are hidden from them. Read-only users can be created by system administrators with the System user role.

API—The API role allows billing and operational systems to access the Cisco TelePresence Exchange System API. Systems that access the API cannot access the administration console. For additional information about the API, see the API User Guide for the Cisco TelePresence Exchange System, available at http://www.cisco.com/en/US/products/ps11276/products_programming_reference_guides_list.html.

The following sections describe how to configure users:

Adding Users

Editing User Settings

Deleting Users

User Fields

Adding Users

Before You Begin

Configure the time zones served by this Cisco TelePresence Exchange System.

Only system administrators can modify user settings.

Procedure

To add a new user, do the following procedure:


Step 1 From the navigation pane, choose System > Users.

The Users window is displayed.

Step 2 Click Add A New User.

Step 3 Enter the settings as indicated in Table 8-2 to configure the user.

Step 4 To save your changes, click Save.


Editing User Settings

Before You Begin

Only system administrators can modify user settings.

Procedure

To edit user settings, do the following procedure:


Step 1 From the navigation pane, choose System > Users.

The Users window is displayed.

Step 2 In the item table, click the applicable user ID.

The User Details window is displayed.

Step 3 From the toolbar, click Edit This User.

The Edit User window is displayed. Fields contain the currently-configured values.

Step 4 Modify field entries as required.

Fields are described in Table 8-2.

Step 5 To save your changes, click Save.


Deleting Users

Before You Begin

Only system administrators can delete users.

Procedure

To delete a user, do the following procedure:


Step 1 From the navigation pane, choose System > Users.

The Users window is displayed.

Step 2 Do the following sub-steps, depending on your Cisco TelePresence Exchange System version.

Cisco TelePresence Exchange System Release 1.0(3)

a. In the item table, check the check box next to the entry that you want to delete. You can delete multiple users at one time by checking the check box next to each entry that you want to delete.

b. Click Delete.

c. In the Deletion Confirmation dialog box, click Delete to confirm the deletion.

Cisco TelePresence Exchange System Release 1.0(2) and earlier

a. In the item table, check the check box next to the entry you want to delete.

b. From the drop-down list that appears, choose Delete.

c. Click Go.

d. In the panel that is displayed to confirm the deletion, click OK.


Tip If you prefer to view the details of a user prior to deleting it, in the Users window, you can click the applicable User ID to go to the User page. After verifying that you have chosen the correct user to delete, click Delete This User, and then in the Deletion Confirmation dialog box, click Delete to confirm the deletion.



User Fields

.

Table 8-2 User Field Descriptions 

Field
Description

First Name

The first name of the user.

See the "Common Field Properties" section on page 2-4.

Last Name

The last name of the user.

See the "Common Field Properties" section on page 2-4.

User ID

Unique ID assigned to this user. The user enters the user ID when logging in to the administration console.

Email Address

Email address of the user.

Password

Password assigned to the user during system installation or by the system administrator. The user enters the password when logging in to the administration console.

Note You can also reach the Systems > Users window by clicking the username link in the banner pane. For more details, see the "Banner Pane" section on page 2-2.

Verify Password

Password entered again for verification.

Role

Drop-down list. Sets the role of the user:

System—System Administrator

Admin—Administrator

Provisioning (available only in Cisco TelePresence Exchange System Release 1.0(3) and later)—A user with access only to the Customers and Endpoint Management pages

Read Only (available only in Cisco TelePresence Exchange System Release 1.0(3) and later)—A user with read-only access

API—A user with access to the Cisco TelePresence Exchange System API

Timezone

Drop-down list displays the active time zones. Choose the time zone that matches the location of the user.

See the "Configuring Time Zones" section.


Configuring Database Backups

You can configure regular backups of the database server that run automatically at scheduled times, or you can do a manual, on-demand backup as needed.

After each database backup completes, the system marks the backup attempt with one of the following statuses in the Status column of the Database Backup window: success, failed, missing (server cannot find file to delete), or deleted.

When a database backup is in process, the system notes the status as In Progress.

When the system (or administrator) cancels a database backup, the system notes the status as Cancelled.

Retention Policy

You can define how many copies of database backups that you retain, and define the retention method in terms of backup number, size (MB), and time (days). You can define multiple retention methods.

When the number of database backups exceeds the retention policy settings, the system deletes database backups in accordance with the following rules:

The system applies the retention policy during each database backup.

The system deletes the oldest successful backup first.

When there are multiple retention policies in use, the system deletes the oldest successful backup that exists among all defined policies.

No system warning is given before the database backup deletion occurs.


Note Cisco recommends that the administrator not perform manual deletions of database backup files on the server. Manual deletions can cause the defined retention policy to delete more database backup files than necessary.



Note For details on reviewing the number of database backups stored on the backup server, see the "Viewing Past Database Server Backups and Restores" section on page 23-1.



Note For details on running a manual backup or restoring a backup to a database server, see the "Managing Database Backups" chapter.


Before You Begin

Create a directory on a server on which you can save the database backups.

Ensure that you have the log in information (username and password) for the server on which you are saving the database backups.

Test access to the designated backup server by using either FTP or SFTP.

Procedure

To configure a database backup, do the following procedure:


Step 1 From the navigation pane, choose System > Database Backup.

The Backup Summary window is displayed.

Step 2 To configure a backup, click Configure Backups (near the top of the window).

Step 3 To indicate how often you want the backup to automatically run, select one of the following options:

To do a database backup at the same time each day, click the Daily at radio button.

To do a database backup at the same time for multiple days during the week, click the Weekly on radio button, and then check the check box next to the days of the week that you want the automatic backup to run.

Step 4 In the two at fields, enter the time of day that you want the backup to run (such as 2:00).

Step 5 From the drop-down list next to the time of day entry fields, choose either AM or PM.

Step 6 From the drop-down list next to the AM/PM drop-down list, choose the time zone.

Step 7 To enter details for the server on which you want to save the database backup, enter the following:

a. Enter either the server name (if DNS is in use) or the IP address.

b. Enter the directory path to the server.

c. Enter the username and password for the server.

d. Choose the transfer protocol from the drop-down list.

e. Enter the port number.

By default, the port number field auto-populates with one of the following port numbers to match the transfer protocol that you select in Step 7d.

When you select FTP as the transfer protocol, the port number 21 auto-populates.

When you select SFTP as the transfer protocol, the port number 22 auto-populates.

Step 8 To define a retention policy for the database backups, choose one or more of the following options:

To define the number of database backups that you want to save, check the This many backups check box and enter a number in the field.

To place a size limit on the memory that is allocated for the database backups on the server, check the Until total size reaches check box, and then enter the appropriate number in the MB field.


Note Although the size of a database file can increase as a system gathers more logs, Cisco recommends that the administrator plan for a database file of approximately 400 MB per backup.


To save database backups for a set number of days, check the Backups for up to check box, and then enter a number in the days field.

Step 9 To save your configuration, click Save.