Click here to Skip to main content
13,095,218 members (84,335 online)
Click here to Skip to main content
Add your own
alternative version


17 bookmarked
Posted 5 May 2008

How to get the Client IP address or hostname of a Citrix session or Terminal Services Session?

, 5 May 2008
Rate this:
Please Sign up or sign in to vote.
How to get the Client IP address or hostname of a Citrix session or Terminal Services Session?


Have you ever tried to get the Client IP address for a Citrix or terminal services session and got stuck? I have had several emails asking me on how to do it. Well I thought I might just blog about it. I can think four ways to do it and if you can add to the list then please do via comments. So let's get to the business right away.

Using the code

The simplest way is to use the MFCOM API to get a list of session and enumerate each session to get username and the Client IP address. Here is a code snippet.
Set objFarm = CreateObject("MetaFrameCOM.MetaFrameFarm")
For Each objSession In objFarm.Sessions
WScript.Echo "User name : " & objSession.UserName
WScript.Echo "IP Address: " & objSession.ClientAddress

You need to be an admin on XenApp (Formerly known as Presentation Sever) Farm to run MFCOM queries. You can read more and download the MFCOM example here.

2. Use WFAPI SDK WFEnumerateSessions method to get a list of all the sessions on a server and then use WFQuerySessionInformation to extract Client IP for each session on the server I have written a Sample program on how to do it. Follow this link to download WFAPI and Csharp .Net program which enumerates all sessions on a server and their Client IP address.

3. Use native terminal Services API. Similar to WFAPI use TSEnumerateSessions to get a list of sessions on a server and then use TSQuerySessionInformation to extract Client IP address each session on the server. To read more follow this link to download Terminal Services API sample example written in Csharp .Net.

4. You can also use ICO SDK and GetClientAddress API to get client IP within a ICO session The ICA Client Object is the framework that exposes the functionality of the Citrix ICA Win32 Client to third party applications. The ICA Client Object (ICO) SDK enables developers and administrators to modify the behavior and appearance of a Windows 32-bit Citrix ICA client. The SDK is a series of documents that detail available application programming interface (API) in the Citrix ICA client Follow this link to download an ICO example which illustrates the use of methods and properties available to get client network name and IP address information using Citrix ICO SDK.

Code snippet for ICO in JavaScript

function GetClientNetworkName(form)
        form.netname.value = document.ICO1.GetClientNetworkName()
    function GetAddrCnt(form)
        form.addrcnt.value = document.ICO1.GetClientAddressCount()
    function GetAddr(form)
        form.addr.value = document.ICO1.GetClientAddress(0)


If you have any questions regarding Citrix MFCOM then drop me a line at my blog

Vishal Ganeriwala


This article, along with any associated source code and files, is licensed under The BSD License


About the Author

Vishal Ganeriwala
Team Leader Citrix Systems
United States United States
No Biography provided

You may also be interested in...


Comments and Discussions

GeneralActual client machine IP Pin
Stephen Drew3-Jun-09 6:16
memberStephen Drew3-Jun-09 6:16 
GeneralLink Broken Pin
PradeepMM10-Mar-09 11:24
memberPradeepMM10-Mar-09 11:24 
Questiontest if citrix session before getting the client IP address [modified] Pin
Patricia Nassif17-Nov-08 2:58
memberPatricia Nassif17-Nov-08 2:58 
AnswerRe: test if citrix session before getting the client IP address Pin
jp2code8-Apr-09 11:14
memberjp2code8-Apr-09 11:14 
QuestionHow to get the actual client IP? Pin
vrbear8-Sep-08 22:19
membervrbear8-Sep-08 22:19 
GeneralAnother method Pin
mav.northwind6-May-08 7:19
membermav.northwind6-May-08 7:19 
GeneralRe: Another method Pin
Vishal Ganeriwala6-May-08 9:29
memberVishal Ganeriwala6-May-08 9:29 
GeneralRe: Another method Pin
mav.northwind6-May-08 22:09
membermav.northwind6-May-08 22:09 
GeneralRe: Another method Pin
Jürgen Kliegl13-May-08 23:34
memberJürgen Kliegl13-May-08 23:34 
QuestionRe: Another method Pin
StevoM12-Jun-08 22:03
memberStevoM12-Jun-08 22:03 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Permalink | Advertise | Privacy | Terms of Use | Mobile
Web03 | 2.8.170813.1 | Last Updated 5 May 2008
Article Copyright 2008 by Vishal Ganeriwala
Everything else Copyright © CodeProject, 1999-2017
Layout: fixed | fluid