Click here to Skip to main content
Click here to Skip to main content
Go to top

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?

Introduction

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")
objFarm.Initialize(1)
For Each objSession In objFarm.Sessions
WScript.Echo "User name : " & objSession.UserName
WScript.Echo "IP Address: " & objSession.ClientAddress
Next 

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)
    } 



History

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

Vishal Ganeriwala

http://community.citrix.com/blogs/citrite/vishalg/

License

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

Share

About the Author

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

Comments and Discussions

 
GeneralActual client machine IP PinmemberStephen Drew3-Jun-09 6:16 
GeneralLink Broken PinmemberPradeepMM10-Mar-09 11:24 
Questiontest if citrix session before getting the client IP address [modified] PinmemberPatricia Nassif17-Nov-08 2:58 
AnswerRe: test if citrix session before getting the client IP address Pinmemberjp2code8-Apr-09 11:14 
QuestionHow to get the actual client IP? Pinmembervrbear8-Sep-08 22:19 
GeneralAnother method Pinmembermav.northwind6-May-08 7:19 
GeneralRe: Another method PinmemberVishal Ganeriwala6-May-08 9:29 
GeneralRe: Another method Pinmembermav.northwind6-May-08 22:09 
GeneralRe: Another method PinmemberJürgen Kliegl13-May-08 23:34 
QuestionRe: Another method PinmemberStevoM12-Jun-08 22:03 

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

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

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