Administration Guide for Cisco Virtualization Experience Client 2111/2211 PCoIP Firmware Release 4.1.2
Diagnostics tools
Downloads: This chapterpdf (PDF - 1.85 MB) The complete bookPDF (PDF - 7.59 MB) | The complete bookePub (ePub - 3.25 MB) | Feedback

Diagnostics tools

Diagnostics tools

The Diagnostics menu contains links to pages with run-time information and functions that may be useful for troubleshooting.


The diagnostic options in the OSD are a subset of those available through the Administrative Web Interface.

Event log message display

The Event Log page lets you view and clear event log messages from the client. The web interface lets you change the log filter setting on the device, which controls which messages are put in the log. When you set the filter to “terse,” the device logs terse messages.

The Event Log page also lets you enable and define syslog as a way of collecting and reporting your events that meets the IETF standard for logging program messages.

Syslog Features

  • Allows separation of the software that generates messages from the system that stores them and the software that reports and analyzes them.
  • Provides devices that would otherwise be unable to communicate a way to notify administrators of problems or performance.
  • Can be used for computer system management and security auditing as well as generalized informational, analysis, and debugging messages.
  • Is supported by a wide variety of devices and receivers across multiple platforms.
  • Can be used to integrate log data from many different types of systems into a central repository.
  • Has messages that:
    • refer to a facility (auth, authpriv, daemon, cron, ftp, lpr, kern, mail, news, syslog, user, uucp, local0, ... , local7 ) .
    • are assigned a priority/level (Emergency, Alert, Critical, Error, Warning, Notice, Info or Debug) by the sender of the message.
  • Lets you direct messages to various local devices (console), files (/var/log/) or remote syslog daemons.


Take care when you update the configuration as omitting or misdirecting message facilities or levels can cause important messages to be ignored by syslog or overlooked by the administrator.
Figure 1. Event Log Web Page

Figure 2. OSD: Event Log

Table 1 Event Log Parameters
Parameter Description
Event log Messages

View: Click to open a browser page that displays the event log messages (with timestamp information) stored on the device. Press F5 to refresh the browser page log information.

Clear: Click to delete all event log messages stored on the device.

Event Log Filter Mode

Click the pull-down menu to filter the event logs. Options include:

  • Verbose (this is the default setting)
  • Terse
Enable Syslog

Enable the syslog standard for your event logs. If syslog is enabled, you must configure the remaining fields (if disabled, they are non-editable).

Identify Syslog Host By

Choose if the syslog host is identified by IP address or by FQDN. If you enter an invalid IP address or DNS name, a message appears to prompt you to correct it. The parameter depends on which method you choose:

  • IP Address: The IP address for the syslog host
  • FQDN: The DNS name of the syslog host
Syslog Host IP Address / Syslog Host DNS Name

If you set the Identify Syslog Host By field to:

  • IP Address: Enter the IP address for the syslog host
  • FQDN: Enter the DNS name for the syslog host
Syslog Host Port Lets you configure the syslog port number.
Syslog Facility

The facility is a number attached to every syslog message used to categorize the source of the syslog messages. The facility is part of the standard syslog header and can be interpreted by all syslog servers.

Enter a facility to suit your logging needs. For example, you could configure:

  • zero clients to use facility 19
  • Cisco routers to use facility 20
  • VMware ESX hosts to use facility 21

The default facility is set to “19 – local use 3”. Cisco routers default to “23 – local use 7”.

Enhanced logging mode

If you require enhanced logging details in the event log to help troubleshoot a problem with a zero client, select an enhanced logging category, and then click Apply > Continue. (To return to normal logging mode, click Disable, and then Apply > Continue.)


Enhanced logging may be enabled for only one category at a time. Enhanced logging mode messages can be located in the event log by their Level 3 (LVL:3) designation, which indicates a debug-level message.

Enhanced logging mode categories:

  • Audio: Provides enhanced audio-related details, such as audio compression levels and audio bandwidth. Enable this mode if you are experiencing any problems with audio quality.
  • Management Console: Provides debug-level details for the connection state between the device and the MC. Enable this mode if you are having trouble connecting to or managing the device using the MC.
  • Networking: Provides socket-level details for a device's network connections. Enable this mode for network-related issues, for example, if the device cannot connect to a peer or broker, or if it cannot get an IP address from a DHCP server.
  • OneSign: Provides enhanced logging for connections using Imprivata's OneSign Single Sign-On proximity cards. Enable this mode to see debug-level messages between a device and a OneSign authentication server.
  • Session Negotiation: Provides pre-session messaging details, such as the full feature set advertised by each device. Enable this mode for low-level session negotiation details.
  • SmartCard: Provides debug-level messages for smart cards. Enable this mode if you experience trouble tapping or logging in using a smart card.
  • System: Provides heartbeat details about the device, such as ambient temperature. Enable this mode for system-level problems.
  • USB: Provides details of the traffic between the device and any connected USB devices. Enable this mode if you are experiencing problems with a connected USB device.
  • Video: Displays enhanced image-related logging information. Enable this mode for image problems, monitor problems, or display topology issues.

Session control

The Session Control web page allows control of the device session.

Figure 3. Session Control Web Page

Table 2 Session Control Parameters
Parameter Description
Connection State

This field displays the current state for the session. Options include:

  • Disconnected
  • Connection Pending
  • Connected

Two buttons appear below the Connection State field:

  • Connect: If the connection state is Disconnected, click this button to initiate a PCoIP session between the client and its peer device. If the connection state is Connection Pending or Connected, this button is disabled.
  • Disconnect: If the connection state is Connected or Connection Pending, click this button to end the PCoIP session for the device. If the connection state is Disconnected, this button is disabled.
Peer IP Address Displays the IP address for the peer device. When not in session, this field is blank.
Peer MAC Address Displays the MAC address of the peer device. When not in session, this field is blank.

PCoIP protocol statistics display

The Session Statistics page on the Administrative Web Interface and OSD lets you view current statistics when a session is active. If a session is not active, you can view the statistics from the last session.

Figure 4. Session Statistics Web Page

Figure 5. OSD: Session Statistics

Table 3 Session Statistics Parameters
Parameter Description
Connection State

The current (or last) state of the PCoIP session. Values include:

  • Asleep
  • Canceling
  • Connected
  • Connection Pending
  • Disconnected
  • Waking
802.1X Authentication Status Identify if 802.1X authentication is enabled or disabled on the device.
PCoIP Packets Statistics

PCoIP Packets Sent: The total number of PCoIP packets sent in the current/last session.

PCoIP Packets Received: The total number of PCoIP packets received in the current/last session.

PCoIP Packets Lost: The total number of PCoIP packets lost in the current/last session.


Bytes Sent: The total number of bytes sent in the current/last session.

Bytes Received: The total number of bytes received in the current/last session.

Round Trip Latency

The minimum, average, and maximum round-trip PCoIP system (for example, virtual machine to client and then back to the virtual machine) and network latency in milliseconds (+/- 1 ms).

Bandwidth Statistics

Transmit Bandwidth: The minimum, average, and maximum traffic transmitted by the Tera1x00 processor. The active bandwidth limit is the maximum amount of network traffic the Tera1x00 processor may currently generate. The value is derived from the configured bandwidth parameters and the current (or last) network congestion levels.

Receive Bandwidth: The minimum, average, and maximum traffic received by the Tera1x00 processor.

Pipeline Processing Rate How much image data is currently being processed by the image engine (in megapixels per second).
Endpoint Image Settings In Use Displays if the image settings being used are configured within the client or within the host.
Initial Image Quality The minimum and maximum quality setting is taken from the Image page for the device.
Image Quality Preference This setting is taken from the Image Quality Preference field on the Image page. The value determines if the image is set to a smoother versus a sharper image.
Build to Lossless Options that may appear in this field include:
  • Enabled: The Disable Build to Lossless field on the Image page is unchecked.
  • Disabled: The Disable Build to Lossless field is checked.
Reset Statistics

Click this button to reset the statistic information on this page.


This button also resets the statistics reported in the home page.

Display The port number for the display.
Maximum Rate This column shows the refresh rate of the attached display. If the Maximum Rate field on the Image page is set to:
  • 0 (that is, there is no limit): The maximum rate is taken from the monitor's refresh rate.
  • A value greater than 0: The refresh rate shows as "User Defined".
Output Process Rate The frame rate currently being sent from the image engine on the virtual machine to the client.
Image Quality Shows the current lossless state of the attached display:
  • Lossy
  • Perceptually lossless
  • Lossless

Audio test tone

The Audio page allows you to generate an audio test tone from the client.


Cisco recommends that you do not wear the headphones during the audio test. Instead, hold them approximately two feet away from your ears because the volume level is loud and cannot be adjusted.

To generate an audio test tone, click Start to start the test tone. Click Stop to stop the test.


The Audio page functionality is only available on a client when the client is not in a PCoIP session.

Figure 6. Audio page

Test pattern display

The Display web page lets you initiate and view a test pattern on the client display.


The test pattern only appears on the Display page when the client is not in a PCoIP session. If you click Start when the client is in session, an error message appears.

Figure 7. Display Web Page

Table 4 Display Parameters
Parameter Description
Test mode

Set the type of test pattern for the attached monitor(s) as:

  • Video Test Pattern Generator
  • Pseudo Random Bitstream
Test resolution

Set the test pattern resolution from the drop-down menu.


Click Start to begin the test pattern. Click Stop to stop the test.

Device processor reset

The PCoIP Processor page lets you reset the client and view the amount of time that has elapsed since the client PCoIP processor last booted.

Figure 8. PCoIP Processor Web Page

Figure 9. OSD: PCoIP Processor

Table 5 PCoIP Process Parameters
Parameter Description
Current Time

The current time. This feature requires that the NTP be enabled and configured. For details about configuring the NTP settings, see NTP parameter configuration.

Time Since Boot (Uptime)

View the time that has elapsed since the PCoIP processor last booted.

Reset PCoIP Processor

Click this button to reset the client.


The Ping page lets you ping a device to see if it is reachable across the IP network. This may help you determine if a broker server is reachable. Because the firmware forces the “do not fragment flag” in the ping command, you can also use this feature to determine the maximum MTU size.


The Ping tab has no matching menu in the Administrative Web Interface.

Figure 10. OSD: Ping

Table 6 Ping Parameters
Parameter Description

IP Address or FQDN to ping


Interval between ping packets

Packet Size

Size of ping packet

Packets Sent

Number of ping packets transmitted

Packets Received

Number of ping packets received