Cisco CDA Visual Quality Experience Application User Guide, Release 2.0
Using the VQE Channel Provisioning Tool

Table Of Contents

Using the VQE Channel Provisioning Tool

Logging in to VCPT

Working with VCPT Configuration Files

Performing Non-Push Configuration-File Operations

Sending or Pushing Channel Information to Servers

Send Button

Force Update Button

Sending Channel Information to a Subset of Servers

Provisioning VQE Channels

Adding a Channel

Viewing or Updating Channel Information

Cloning a Channel

Deleting a Channel

Defining VQE Servers and VQE Client Channel Configuration Delivery Servers

Adding a Server

Viewing or Updating Server Information

Deleting a Server

Defining Channel Associations

Defining Channel Associations for a Server

Copying Channel Associations from Another Server


Using the VQE Channel Provisioning Tool


This chapter describes how to use Cisco VQE Channel Provisioning Tool (VCPT). The tasks that you perform with VCPT are listed in Table 3-1. When you use VCPT for the first time, the required tasks are performed in the order shown in the table.

Table 3-1 VCPT Tasks

VCPT Task
Section Where Described

1. Log in to VCPT

Logging in to VCPT

2. Create a new VCPT configuration file

Working with VCPT Configuration Files

3. Provision VQE channels

Provisioning VQE Channels

4. Create VQE Servers and VQE Client Channel Configuration Delivery Servers

Defining VQE Servers and VQE Client Channel Configuration Delivery Servers

5. Specify channel associations for the VQE Servers and VQE Client Channel Configuration Delivery Servers

Defining Channel Associations

6. Send the channel information file to the VQE Servers and VQE Client Channel Configuration Delivery Servers

Working with VCPT Configuration Files


Logging in to VCPT

Before logging in to VCPT, you need a valid UNIX username and password on the Cisco CDE110 hosting VCPT. The username does not have to belong to any special group. Creation of the username is the responsibility of the Cisco CDE110 system administrator.

VCPT supports two web browsers: Microsoft Internet Explorer version 6.0 or later, and Mozilla Firefox version 2.0 or later. VCPT uses secure HTTPS. The minimum screen resolution required for VCPT is 1024 x 768 pixels.

To log in to VCPT, follow these steps:


Step 1 Point your web browser to the Cisco CDE110 that hosts VCPT using an IP address or fully qualified domain name:

https://ip_address 

           or

https://fully_qualified_domain_name 

The VQE login dialog box is displayed.

Step 2 Enter a UNIX username and password.

Step 3 Click OK.

If the username and password are valid, the VQE Channel Provisioning Tool main window is displayed.


If you log in to VCPT when another person is using the same VCPT, the following message is displayed and your access to VCPT is a read-only view. To get read-write access, wait and try to open a VCPT session at a later time when no one else is using the tool.

Figure 3-1 Read-only View Message

VCPT sessions are timed out after 25 minutes of inactivity. If VCPT detects a network failure or server failure, the session is timed out after one minute.

With certain versions of Microsoft Internet Explorer 6, if you close a read-write session and try to open it again immediately, you get a read-only view. In this case, wait a minute and open another session to get read-write access.

Working with VCPT Configuration Files

The VCPT channel, server, and association provisioning information is stored in a persistent local database on the Cisco CDE110 appliance. When the Cisco CDE110 or VCPT is restarted, channel, server, and association data are read from the local database. The VCPT configuration file can be saved at any time and should be saved frequently to store your work.


Caution If a VCPT session times out because of inactivity or because of a server or network failure, unsaved data is lost. Therefore, you should save the VCPT configuration file frequently.

VCPT configuration files are stored in the /etc/opt/vcpt/data directory on the Cisco CDE110. File management tasks for VCPT are the responsibility of the VCPT user.


Caution The VCPT configuration files must be backed up in a safe location that is not on the local Cisco CDE110 disk. If an appliance or software failure occurs, the latest VCPT configuration file must be retrievable from the backup location.

When the user completes channel and server configuration and initiates the VCPT send operation, VCPT sends the channel information in Session Description Protocol (SDP) format to the set of VQE Servers and VQE Client Channel Configuration Delivery Servers.

Figure 3-2 shows the buttons that you use for working with VCPT configuration files and for sending channel information.

Figure 3-2 VCPT Configuration File Operations

The following sections explain the configuration file and channel information operations:

Performing Non-Push Configuration-File Operations

Sending or Pushing Channel Information to Servers

Sending Channel Information to a Subset of Servers

Performing Non-Push Configuration-File Operations

The VCPT configuration file buttons used for non-push operations are:

New Config—Clears the current configuration (if any) so that you can start a new one. The new configuration is not saved until you click Store, specify a file name, and click OK.

Open Configuration—Allows you to choose an existing configuration file from the pull-down menu and open it. If needed, you should save the current configuration file before opening another one because any unsaved data in the current configuration file is lost.

Store—Saves the current configuration file on the Cisco CDE110 that hosts VCPT.

Store As—Saves the current file under a new file name that you specify.

Delete—Deletes the current configuration file and clears the configuration.

VCPT configuration file names can be up to 60 characters long and use lowercase a to z, uppercase A to Z, numeric characters 0 to 9, and the underscore (_), hyphen (-) and period (.) characters. No spaces are allowed in the name.

Sending or Pushing Channel Information to Servers

The VCPT buttons used to send or push channel information to VQE Servers and VQE Client Channel Configuration Delivery Servers are the Send and Force Update buttons.

Send Button

Use the Send button to send channel information in the current configuration file to the VQE Servers and VQE Client Channel Configuration Delivery Servers that have been defined.


Note Use the Send button for "normal" configuration file changes where the changes modify the base file that was most recently pushed to the servers.



Note Using the Send button causes temporary disruption to Error Repair services for modified channels while the VQE-S cache used for packet retransmission on the modified channels is flushed.


The channel information to send is based on the channel associations that have been defined for the VQE Servers and VQE Client Channel Configuration Delivery Servers. When channel information is sent to a set of servers, VCPT saves the current configuration file. When channel information is sent to servers, VCPT displays the following:

The status line next to the configuration file name is updated (for example, Last update was sent to 1 out of 2 servers at: 5/11/2007 14:47:20).

On the Servers tab, the Status of Last Send column is updated. For a description of the status values that can appear in this column, see the "Viewing or Updating Server Information" section.

Force Update Button


Note Using the Force Update button causes temporary disruption to Error Repair services for all channels while the VQE-S cache used for packet retransmission is flushed.


For the following types of configuration file changes, use the Force Update button to send the channel information to the VQE Servers and VQE Client Channel Configuration Delivery Servers.

Configuration file changes where you are reverting to an old version of the configuration file (older that the most recently pushed configuration file)

Configuration file changes where the changes modify some file other than the base file that was most recently pushed to the servers

Configuration file changes when you are not certain whether the file used was the base file that was most recently pushed to the servers

If configuration information is sent to the servers and the changes to channel information are not present on the servers after the send, you can use the Force Update button to force the channel information changes to be accomplished on the servers.

Sending Channel Information to a Subset of Servers

To send a channel information file to a subset of servers, follow these steps:


Step 1 Open an existing VCPT configuration file that has the needed server, channel, and association information.

Step 2 Click Save As to save the VCPT configuration file using a new file name.

Step 3 On the Servers tab, adjust the servers list by deleting the VQE Servers and VQE Client Channel Configuration Delivery Servers that are not wanted.

Step 4 Click Store to save the VCPT configuration file.

Step 5 Click Send to send the channel information file to the adjusted list of VQE Servers and VQE Client Channel Configuration Delivery Servers.


Provisioning VQE Channels

In the Cisco VQE Channel Provisioning Tool, use the Channels tab to add a new channel, clone an existing channel, delete an existing channel, and get detailed information on an existing channel. The practical limit on the number of channels that can be serviced by one VQE-S is approximately 250.

When you click the Channels tab, VCPT displays summary information (Figure 3-3) on all channels that have been created. An incomplete channel is displayed in red.

Figure 3-3 Channels Summary

From the Channels tab, you can do the following:

Click Incomplete Channels or Valid Channels to display only the corresponding subsets of channels.

Click a column heading to reorder the channels in the list. For example, clicking Feedback Target orders the entries by feedback target: the combination of IP address and RTCP port number.

Double-click any item in a channel's row to display the full details for the channel in a new window. You can update the channel information.

Click Add to display a dialog box so that you can create a new channel.

Click a channel to select it and then use one of the following buttons:

Details—Displays a dialog box with detailed information on an existing channel and allows you to update the information.

Clone—Displays a dialog box with appropriate cloned information from an existing channel so that you can use the information to create a new channel.

Delete—Deletes an existing channel.

The sections that follow provide more information on the tasks that can be performed from the Channels tab.

Adding a Channel

In the VCPT channel definition, each channel is associated with a feedback target IP address. The feedback target address is a unique anycast address that VQE Server configures on its host Cisco CDE110 based on the channel information that is sent to it by VCPT. An anycast address is a unicast address that is assigned to multiple interfaces. With the appropriate routing topology, packets addressed to an anycast address are delivered to a single interface (in this case, the nearest VQE Server's CDE110 interface that is identified by the address). The use of anycast addresses to identify feedback targets is useful for VQE Server redundancy.

To add a channel, follow these steps:


Step 1 On the Channels tab, click Add.

The New Channel dialog box (Figure 3-4) is displayed.

Figure 3-4 New Channel Dialog Box

Step 2 Fill in the information for the new channel. Table 3-2 has information on the fields that you need to complete.

Table 3-2 VQE Channel Information  

VCPT Field
Description
                                       Channel Details

Channel Name

String having 1 to 40 alphanumeric characters.

Channel Mode

Currently Lookaside mode is supported.

Feedback Target IP

A unique anycast address on the VQE Servers that provide VQE services for this channel. Using the Feedback Target IP address that is sent to it by VCPT in the channel information, VQE Server automatically configures the specified address on one of its Cisco CDE110 interfaces.

Enable Error Repair

Check the check box to enable VQE Error Repair.

Enable Rapid Channel Change

Not currently supported.

                                       Original Stream

Multicast IP

Multicast IP address for the channel's original source stream. The first octet must be within the range of a valid multicast address. The multicast address must be unique for each channel.

Protocol

Protocol of the original source stream: either UDP or RTP.

When Channel Mode is Lookaside, the option must be RTP, and the protocol value in Session Description Protocol (SDP) will be RTP/AVPF.

Bit Rate

Bit rate of the channel's original source stream in Kbits per second. This parameter defines how many packets VQE Server will accept and send for this multicast stream.


Note Do not specify a bit rate that is too low. The bit rate does not have to be exact, but a somewhat higher bit rate is preferable to a bit rate that is too low for the multicast stream.


Source IP

IP address of the channel's original source stream.

Port

RTP/UDP port number of the channel's original source stream.

RTCP Port

When Protocol is RTP, the RTCP port number of the channel's original source stream. By default, RTCP Port is the (RTP/UDP) port number plus one.

                                      Re-sourced Stream

Multicast IP

Not currently used.

Source IP

Not currently used.  

RTP Port

Not currently used.

RTCP Port

Not currently used.

                                      Unicast Retransmission Stream

Source IP

IP address of the unicast retransmission stream. The IP address must be the same as is defined for Feedback Target IP.

RTP Port

RTP port number of the unicast retransmission stream. By default, RTP Port is a valid port number.

RTCP Port

RTCP port number of the unicast retransmission stream. By default, RTCP Port is a valid port number.


The following rules apply when adding a channel:

VCPT can support up to 255 channels and unique IP addresses for channels.

The Feedback Target IP address must specify a unique IP address for each channel.

The combination of the Feedback Target IP address and RTCP port number must be unique for each channel.

When Channel Mode is Lookaside, the RTCP port is compared to the RTCP port of original stream.

For the Original Stream, the Source IP address must not be equal to the Feedback Target IP address.

For the Unicast Retransmission Stream, the combination of the Source IP address and RTP port number must be unique per channel.

In any given stream, the RTP port number must not be equal to RTCP port number.

If you enter invalid data, the field name is displayed in red. You must correct the invalid data before creating or updating the channel.

If you enter incomplete data, you can create or update the channel, but it will be marked incomplete.

A channel configuration file with an incomplete channel definition cannot be sent to VQE Servers or VQE Client Channel Configuration Delivery Servers.

Step 3 When you have specified all required values, click Create to create the new channel, or click Cancel to exit the dialog box without creating the new channel.


Viewing or Updating Channel Information

To view or update channel information, follow these steps:


Step 1 On the Channels tab, click the channel you want to view or update.

Step 2 Click Details.

The Details dialog box (Figure 3-5) is displayed.

Figure 3-5 Details Dialog Box

Step 3 If needed, change or add channel information.

Step 4 Do one of the following:

Click Update to update the channel information.

Click Cancel to close the dialog box without updating the channel information.


Cloning a Channel

To clone a channel, follow these steps:


Step 1 On the Channels tab, click the channel you want to clone.

Step 2 Click Clone.

The Clone dialog box is displayed. Only appropriate information from the existing channel is cloned.

Step 3 Verify that the cloned values are what you require. Where needed, change the values and add channel information where that is required.

Step 4 Do one of the following:

Click Create to create the new channel.

Click Cancel to close the dialog box without creating the new channel.


Deleting a Channel

To delete a channel, follow these steps:


Step 1 On the Channels tab, click the channel you want to delete.

Step 2 Click Delete.

A dialog box asking if you want to delete the channel is displayed.

Step 3 Do one of the following:

Click Delete to delete the channel.

Click Cancel to close the dialog box without deleting the channel.

Step 4 If you clicked Delete, a confirmation dialog box is displayed. Click OK.


Defining VQE Servers and VQE Client Channel Configuration Delivery Servers

The Cisco VQE Channel Provisioning Tool requires that you provide information on each VQE Server and each VQE Client Channel Configuration Delivery Server that will receive channel configuration information from the VQE Channel Provisioning Tool.

In the VQE Channel Provisioning Tool, use the Servers tab to add a new server, delete an existing server, and get information on an existing server. When you click the Servers tab, VCPT displays summary information (Figure 3-3) on all servers that have been created.

Figure 3-6 Servers Summary

From the Servers tab, you can do the following:

Click a column heading to reorder the servers in the list. For example, clicking Status of Last Send orders the servers by their channel configuration file status.

Double-click any item in a server's row to display the full details for the server in a new window. You can update the server information.

Click Add to display a dialog box so that you can create a new server.

Click a channel to select it and then use one of the following buttons:

Details—Displays a dialog box with detailed information on an existing server and allows you to update the information.

Delete—Deletes an existing server.

The Status of Last Send column provides information on the last attempt by VCPT to send channel configuration information to the server. Table 3-3 lists the possible messages.

Table 3-3 Status of Last Send Messages

Message
Explanation

Success

The server has received the channel configuration information. Success information is for the most current configuration information.

Failed - Network Error

VCPT did not receive any error message back from VQE-S or VQE Client Channel Configuration Delivery Server.

Failed - Security Exception

An exception occurred while VCPT was authenticating the server SSL certificate.

Failed - VCPT Server Error

A generic internal VCPT coding error has occurred. This may be because of a coding bug or because VCPT failed to read a file.

Channel config file is not writable

The channel configuration file could not be written to disk on the VQE-S or VQE Client Channel Configuration Delivery Server host.

File failed to open

VQE-S or VQE Client Channel Configuration Delivery Server could not open the channel configuration file.

Parsing channel config file failed

VQE-S or VQE Client Channel Configuration Delivery Server could not parse the channel configuration file.

Failed - Tomcat Service Unavailable

The Tomcat application server has failed on the VCPT host.

Failed - Server failed to parse SDP file

VCPT is not able parse the SDP file.

Failed - Unable to store the SDP data on VCPT Server

The SDP data could not be saved on the VCPT host.


The sections that follow provide more information on the tasks that can be performed from the Servers tab.

Adding a Server

To add a server, follow these steps:


Step 1 On the Servers tab, click Add.

The New Server dialog box (Figure 3-7) is displayed.

Figure 3-7 New Server Dialog Box

Step 2 Fill in the information for the new server. For descriptions of the fields that you need to fill in, see Table 3-4.

Table 3-4 VQE Server and VQE Client Channel Configuration Delivery Server Information

VCPT Field
Description
                                       Server Details

Server Name

String having 1 to 40 alphanumeric characters.

Management IP

IP address of an Ethernet interface on the server's Cisco CDE110.

Role

One of the following:

VQE-S (VQE Server)

VCDS (VQE Client Channel Configuration Delivery Server)

                                       Server Wide Channel Configuration

Maximum Receivers

Total number of VQE Clients that are expected to tune in this channel. This value is used by VQE-S to calculate how often VQE-S sends an RTCP report to the video source for this channel.

RTCP Interval

Defines how often VQE Clients send an RTCP report. By default, RTCP Interval is five seconds.


Step 3 Do one of the following:

Click Create to create the new server.

Click Cancel to close the dialog box without creating the new server.

Viewing or Updating Server Information

To view or update server information, follow these steps:


Step 1 On the Servers tab, click the server you want to view or update.

Step 2 Click Details.

The Details dialog box is displayed.

Step 3 If needed, change the server information.

Step 4 Do one of the following:

Click Update to update the server information.

Click Cancel to close the dialog box without changing server information.


Deleting a Server

To delete a server, follow these steps:


Step 1 On the Servers tab, click the server you want to delete.

Step 2 Click Delete.

A dialog box asking if you want to delete the server is displayed.

Step 3 Do one of the following:

Click Delete to delete the server.

Click Cancel to close the server dialog box without deleting the server.

Step 4 If you clicked Delete, a confirmation dialog box is displayed. Click OK.


Defining Channel Associations

After VQE channels and the VQE Servers and VQE Client Channel Configuration Delivery Servers have been defined, you associate a set of channels with the servers. When the channel information file is sent to the VQE Servers and VQE Client Channel Configuration Delivery Servers, only the channels associated with the server are included in the file.

In the VQE Channel Provisioning Tool, use the Association tab (Figure 3-8) to associate servers with channels or copy an existing channel association.

Figure 3-8 Association Tab

The following sections explain how to associate channels with servers:

Defining Channel Associations for a Server

Copying Channel Associations from Another Server

Defining Channel Associations for a Server

To define channel associations for a server, follow these steps:


Step 1 From the Select Server pull-down menu, select the server for which you want to define channel associations.

VCPT displays the IP address and role for the server.

Step 2 Select one or more channels to associate or disassociate with the server by using the arrow buttons. For example:

The > button moves a single available channel or group of available channels to the Selected group.

The >> button moves all available channels to the Selected group.

The associations for the channel are updated.


Copying Channel Associations from Another Server

To copy channel associations for a server, follow these steps:


Step 1 From the Select Server pull-down menu, select the server for which you want to define channel associations.

VCPT displays the IP address and role for the server.

Step 2 From the Copy Association from Server pull-down menu, select the server whose channel associations you want to copy.

Step 3 Click OK.

The associations for the channel are updated.