PCoIP® Software Session Statistics

WMI Interface Specification

TER1009005
Issue 2
 PCoIP® Software Session Statistics WMI Interface Specification

Teradici Corporation
#101-4621 Canada Way, Burnaby, BC V5G 4X8 Canada
phone +1.604.451.5800 fax +1.604.451.5818
www.teradici.com
The information contained in this documentation represents the current view of Teradici Corporation as of the date of
publication. Because Teradici must respond to changing market conditions, it should not be interpreted to be a commitment
on the part of Teradici, and Teradici cannot guarantee the accuracy of any information presented after the date of publication.
This document is for informational purposes only. TERADICI MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO
THE INFORMATION IN THIS DOCUMENT.
Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no
part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any
means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written
permission of Teradici Corporation.
Teradici may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject
matter in this document. Except as expressly provided in any written license agreement from Teradici, the furnishing of this
document does not give you any license to these patents, trademarks, copyrights, or other intellectual property. Visit Notice of
Intellectual Property Rights for more information.
© 2000-2016 Teradici Corporation. All rights reserved.
Teradici, PC-over-IP, and PCoIP are trademarks of Teradici Corporation and may be registered in the United States and/or other
countries. Any other trademarks or registered trademarks mentioned in this release are the intellectual property of their
respective owners.

TER1009005 Issue 2 2
 PCoIP® Software Session Statistics WMI Interface Specification

Revision History

Issue Date Description

2 June 13, 2016 Added new PCoIP Session Imaging Statistics WMI statistics as of Teradici
Pervasive Computing Platform Standard/Graphics Agent version 2.2:
 ImagingChangedFramesPersec
 ImagingFlipFramesPersec

1 July 28, 2011 Initial release.

TER1009005 Issue 2 3
 PCoIP® Software Session Statistics WMI Interface Specification

Contents
1 PCoIP Session Statistics .............................................................................................................. 5
1.1 PCoIP Session General Statistics ....................................................................................................................... 5
1.2 PCoIP Session Network Statistics ...................................................................................................................... 6
1.3 PCoIP Session Audio Statistics ........................................................................................................................... 7
1.4 PCoIP Session Imaging Statistics ....................................................................................................................... 8
1.5 PCoIP Session USB Statistics .............................................................................................................................. 9

2 Scripting with WMI .................................................................................................................. 11

Glossary of Definitions ........................................................................................................................... 12

TER1009005 Issue 2 4
 PCoIP® Software Session Statistics WMI Interface Specification

1 PCoIP Session Statistics

This document provides a list of PCoIP session statistics available through the WMI
(Windows Management Instrumentation) interface for the Teradici Pervasive Computing
Platform (“Platform”). The information here may not reflect what is available from
customers of the Platform as they have their own schedules when they release the new
features.
The PCoIP session statistics are available for a host Virtual Machine (VM) and can be
retrieved from the host VM. Transmit or Sent indicate traffic from the host VM to the client.
Received indicates traffic from the client to the host VM.
The PCoIP statistics are grouped within the following names:
 PCoIP Session General Statistics
 PCoIP Session Network Statistics
 PCoIP Session Audio Statistics
 PCoIP Session Imaging Statistics
 PCoIP Session USB Statistics
PCoIP session statistics are updated every second. When a PCoIP session is closed, all the
statistics are reset to zero.
If the WMI property SessionDurationSeconds stays as an unchanging non-zero value, it
means the PCoIP session has encountered an issue that prevents it from updating the WMI
property.
If SessionDurationSeconds changes from a non-zero to zero value, it means the PCoIP
session has been closed.

The applicable WMI Namespace for the PCoIP Session Statistics is root\CIMV2

1.1 PCoIP Session General Statistics

WMI Class Name: Win32_PerfRawData_TeradiciPerf_PCoIPSessionGeneralStatistics

Statistic Name Description WMI Property Name

Session Duration An incrementing number that represents SessionDurationSeconds
Seconds the total number of seconds the PCoIP
session has been open.
Bytes Received Total number of bytes that have been BytesReceived
received since the PCoIP session started.
Bytes Sent Total number of bytes that have been BytesSent
transmitted since the PCoIP session
started.

TER1009005 Issue 2 5
 PCoIP® Software Session Statistics WMI Interface Specification

Statistic Name Description WMI Property Name

Packets Received Total number of packets that have been PacketsReceived
received since the PCoIP session started.
Note: Not all packets are the same size.

Packets Sent Total number of packets that have been PacketsSent

transmitted since the PCoIP session
started.
Note: Not all packets are the same size.

RX Packets Lost Total number of receive packets that have RXPacketsLost

been lost since the PCoIP session started.
TX Packets Lost Total number of transmit packets that have TXPacketsLost
been lost since the PCoIP session started.

1.2 PCoIP Session Network Statistics

WMI Class Name: Win32_PerfRawData_TeradiciPerf_PCoIPSessionNetworkStatistics
Note: In some of the calculations below, some WMI properties come from
PCoIPSessionGeneralStatistics.

Statistic Name Description WMI Property Name

Round Trip Latency ms Round trip latency (in
milliseconds) between
server and client.
RX BW kbit/sec Overall bandwidth for
incoming PCoIP packets
averaged over the
sampling period (in
seconds).
RoundTripLatencyms
To calculate bandwidth:
(BytesReceivedsample2 – BytesReceivedsample1)
X 8 / 1024 / SamplePeriod
Do not use: RXBWkbitPersec

RX BW Peak kbit/sec Peak bandwidth for RXBWPeakkbitPersec

incoming PCoIP packets
within a one second
sampling period.
RX Packet Loss % Percentage of received
packets lost during a
sampling period.
To calculate packet loss:
∆PacketReceived = PacketsReceivedsample2 –
PacketsReceivedsample1
∆RXPacketsLost = RXPacketsLostsample2 –
RXPacketsLostsample1
RXPacketLoss % = ∆RXPacketsLost /
(∆RXPacketsLost + ∆PacketReceived) X 100
Do not use: RXPacketLossPercent,
RXPacketLossPercent_Base

TER1009005 Issue 2 6
 PCoIP® Software Session Statistics WMI Interface Specification

Statistic Name Description WMI Property Name

TX BW kbit/sec Overall bandwidth for
outgoing PCoIP packets
averaged over the
sampling period (in
seconds).
To calculate bandwidth:
(BytesSentsample2 – BytesSentsample1) X 8 /
1024 / SamplePeriod
Do not use: TXBWkbitPersec

TX BW Active Limit The current estimate of TXBWActiveLimitkbitPersec

kbit/sec the available network
bandwidth, updated every
second.
TX BW Limit kbit/sec Transmit bandwidth limit TXBWLimitkbitPersec
for outgoing packets as
defined by the minimum
of: GPO setting on client
and server, local network
connection, and zero
client firmware negotiated
value based on encryption
limits.
TX Packet Loss % Percentage of transmitted To calculate packet loss:
packets lost during a ∆PacketSent = PacketSentsample2 –
sampling period. PacketSentsample1
∆TXPacketsLost = TXPacketsLostsample2 –
TXPacketsLostsample1
TXPacketLoss % = ∆TXPacketsLost /
(∆TXPacketsLost + ∆PacketSent) X 100
Note: The above formula is used to avoid
the packet loss % from being greater than
100%. This is required due to the
asynchronous nature of PacketsLost and
PacketsSent.
Do not use: TXPacketLossPercent,
TXPacketLossPercent_Base

1.3 PCoIP Session Audio Statistics

WMI Class Name: Win32_PerfRawData_TeradiciPerf_PCoIPSessionAudioStatistics
Note: The following audio session statistics are not applicable to USB audio that is not
locally terminated at the client.

Statistic Name Description WMI Property Name

Audio Bytes Received Total number of audio AudioBytesReceived
bytes that have been
received since the PCoIP
session started.

TER1009005 Issue 2 7
 PCoIP® Software Session Statistics WMI Interface Specification
Statistic Name Description
Audio Bytes Sent Total number of audio
bytes that have been sent
since the PCoIP session
started.
Audio RX BW kbit/sec Bandwidth for incoming
audio packets averaged
over the sampling period (in
seconds).
Audio TX BW kbit/sec Bandwidth for outgoing
audio packets averaged
over the sampling period (in
seconds).
Audio TX BW Limit Transmit bandwidth limit
kbit/sec for outgoing audio packets
as defined by the GPO
setting.
1.4 PCoIP Session Imaging Statistics
WMI Class Name: Win32_PerfRawData_TeradiciPerf_PCoIPSessionImagingStatistics
Statistic Name Description
Imaging Bytes Total number of imaging
Received bytes that have been received
since the PCoIP session
started.
Imaging Bytes Sent Total number of imaging
bytes that have been sent
since the PCoIP session
started.
Imaging RX BW Bandwidth for incoming
kbit/sec imaging packets averaged
over the sampling period (in
seconds).
Imaging TX BW Bandwidth for outgoing
kbit/sec imaging packets averaged
over the sampling period (in
seconds).
TER1009005 Issue 2
WMI Property Name
AudioBytesSent
To calculate bandwidth:
(AudioBytesReceivedsample2 –
AudioBytesReceivedsample1) X 8 / 1024 /
SamplePeriod
Do not use: AudioRXBWkbitPersec
To calculate bandwidth:
(AudioBytesSentsample2 –
AudioBytesSentsample1) X 8 / 1024 /
SamplePeriod
Do not use: AudioTXBWkbitPersec
AudioTXBWLimitkbitPersec
WMI Property Name
ImagingBytesReceived
ImagingBytesSent
To calculate bandwidth:
(ImagingBytesReceivedsample2 –
ImagingBytesReceivedsample1) X 8 / 1024 /
SamplePeriod
Do not use: ImagingRXBWkbitPersec
To calculate bandwidth:
(ImagingBytesSentsample2 –
ImagingBytesSentsample1) X 8 / 1024 /
SamplePeriod
Do not use: ImagingTXBWkbitPersec
8
 PCoIP® Software Session Statistics WMI Interface Specification

Statistic Name Description WMI Property Name

Imaging Encoded The number of imaging ImagingEncodedFramesPersec
Frames/sec frames which were encoded
and sent to the client over a
one second sampling period.
Imaging Changed The number of captured ImagingChangedFramesPersec
Frames/sec (flipped) imaging frames that
were changed over a one
second sampling period. Note
that applications sometimes
update frames with content
identical to the previous
frame causing the “changed”
frame rate to be less than the
“flip” frame rate
Imaging Flip The number of imaging ImagingFlipFramesPersec
Frames/sec frames captured (flipped) by
the PCoIP Server from the
device driver over a one
second sampling period. Note
that this rate may be less than
the rate the application is
updating frames
Imaging Active The lowest encoded quality (0 ImagingActiveMinimumQuality
Minimum Quality to 100), updated every
second.
Note: Do not confuse this
with the GPO setting.

Imaging Decoder The current estimate of the ImagingDecoderCapabilitykbitPersec

Capability kbit/sec decoder processing capability.
A value of 0 indicates
“unlimited”.

1.5 PCoIP Session USB Statistics

WMI Class Name: Win32_PerfRawData_TeradiciPerf_PCoIPSessionUSBStatistics
Note: The following USB session statistics are only available for Teradici clients that support
USB bridging. This includes all PCoIP Zero Clients and Teradici software clients with version
1.8 or higher and provide support for USB bridging. Otherwise, values of 0 are returned.

Statistic Name Description WMI Property Name

USB Bytes Received Total number of USB bytes that USBBytesReceived
have been received since the
PCoIP session started.

TER1009005 Issue 2 9
 PCoIP® Software Session Statistics WMI Interface Specification
Statistic Name Description
USB Bytes Sent Total number of USB bytes that
have been sent since the PCoIP
session started.
USB RX BW kbit/sec Bandwidth for incoming USB
packets averaged over the
sampling period (in seconds).
USB TX BW kbit/sec Bandwidth for outgoing USB
packets averaged over the
sampling period (in seconds).
TER1009005 Issue 2
WMI Property Name
USBBytesSent
To calculate bandwidth:
(USBBytesReceivedsample2 –
USBBytesReceivedsample1) X 8 / 1024 /
SamplePeriod
Do not use: USBRXBWkbitPersec
To calculate bandwidth:
(USBBytesSentsample2 –
USBBytesSentsample1) X 8 / 1024 /
SamplePeriod
Do not use: USBTXBWkbitPersec
10
 PCoIP® Software Session Statistics WMI Interface Specification

2 Scripting with WMI

Microsoft has a WMI Code Creator tool. This tool allows you to generate VBScript, C#, and
VB .NET code that uses WMI to complete a management task such as querying for
management data, executing a method from a WMI class, or receiving event notifications
using WMI.
For more information, see Microsoft’s WMI Code Creator at:
http://www.microsoft.com/downloads/en/details.aspx?familyid=2cc30a64-ea15-4661-
8da4-55bbc145c30e&displaylang=en

TER1009005 Issue 2 11
 PCoIP® Software Session Statistics WMI Interface Specification

Glossary of Definitions
BW
Bandwidth
PCoIP
Personal Computer over Internet Protocol (PC-over-IP)
RX
Receive (indicates traffic from the client to the host VM)
Sampling Period
The rate at which the WMI counters are queried
TX
Transmit (indicates traffic to the client from the host VM)
WMI
Windows Management Instrumentation
VM
Virtual Machine

TER1009005 Issue 2 12