CTX124949
Feature Pack 1 for Presentation Server 4.5,Presentation Server 4.0 for Microsoft Windows 2000,Presentation Server 4.0 for Microsoft Windows 2003,Presentation Server 4.5 for Windows Server 2003,XenApp 5.0 for Windows Server 2003 x64,XenApp 5.0 for Windows
Feature Pack 1 for Presentation Server 4.5,Presentation Server 4.0 for Microsoft Windows 2000,Presentation Server 4.0 for Microsoft Windows 2003,Presentation Server 4.5 for Windows Server 2003,XenApp 5.0 for Windows Server 2003 x64,XenApp 5.0 for Windows
Tools and Resources
Tools and Resources
2015-12-15
2013-12-13
Download CTXSessionMgt3.1.zip. /supportkc/filedownload?uri=/filedownload/ CTX124949/CTXSessionMgt3.1.zip. Citrix Support. ...

    Created Date: 05/25/2009

    Modified Date: 12/13/2013

    Overview

    Citrix Session Management Tool provides a quick and easy way for Citrix administrator teams in order to manage users’ sessions.

    The tool offers the following features :

    ????" Filter the sessions by server name, username, application name, session status as the Citrix Management Console (from CPS4.0) could.

    ????" Log any action done to a user session by an administrator (logoff, disconnect, killing process, shadowing) to the server’s event log or, on 64bit version, to a central SQL database.

    ????" Custom administrators can immediately identify the user’s branch office and user’s workstation.

    ????" Offer customization using registry keys and GUI (change timer, columns and window size, display of domain name etc.). Customization differs between the 32bit and 64bit versions.

    ????" Allow non Citrix administrators to log off their own sessions in the farm (32bit version only).

    Requirements

    For the 32bit version :

    Citrix XenApp 4.x, XenApp 5.0 running on Windows Server 2003 or Windows Server 2008 (32bit or 64bit) with Microsoft .Net Framework 3.0.

      The account running the tool must have Citrix Administrator rights

      Note: XenApp versions up to 5.0 are supported by this release

    For the 64-bit version :

    Citrix XenApp 6.0 or XenApp 6.5 with Microsoft .Net Framework 3.5 SP1.

      Note: XenApp 6.5 must be in Controller mode to use the tool.

      The account running the tool must have Citrix Administrator rights

    Note: XenApp versions 6.0 and 6.5 are supported by this release

    Changes

    For the 32bit version :

    - Bug Fix : session enumeration fails with delegated XenApp administrator

    For the 64-bit version :

    - Bug Fix : session enumeration fails when no username is specified in the tool

    - Bug Fix : error reading the registry keys

    - Bug Fix : crash when launching the tool as administrator

    - Bug Fix : cannot launch the tool as read-only administrator

    Installing Citrix Session Management

    1. Extract the ZIP file to a folder

    2. The x32 subfolder should be copied to a XenApp 4.x or 5.0 server

    3. The x64 sub folder should be copied to a XenApp 6.0 or 6.5 server

    The below registry key must be set prior running the tool, so that a user without local administrator right can generate the required event log messages :

    HKLM\System\CurrentControlSet\services\eventlog\Application\CTXSessionMgt

    Keyname : EventMessageFile

      For 32-bit, value (Reg_Expand_Sz) : c:\Windows\Microsoft.NET\Framework\v2.0.50727\EventLogMessages.dll

      For 64-bit, value (Reg_Expand_Sz) : c:\Windows\Microsoft.NET\Framework64\v2.0.50727\EventLogMessages.dll

    Using the tool

    Launch and configuration

    The tool accepts the following switches :

      /debug : to output debugging data. This data can be captured using DebugView from SysInternals

      /shadowonly: force the tool to only allow the shadowing option, outside of any other session action like logoff

      /noshadow : shadowing option is not available

      /ro : the Username field is read-only

      /u:<username> : fillout the Username field when the tool starts

    The below registry key can be used to customize the tool

      HKLM\Software\Citrix\SessionManagementTool

        o DisplayFlags (dword) accepts the below hexadecimal values :

          § 0x1 – disable the filtering by published application

          § 0x2 – disable the filtering by servers

          § 0x4 – Force the shadowing to generate a new ICA session

        o SQLInfo (string) contains the SQL server name and instance, the database name and the table name. If there is no registry key, the tool checks for the file SQL.CFG in the same location as the tool, if it can’t find it then normal logging to the local server’s event log will be used. (x64 only)

        o Domain (string) will determine if the domain name is displayed in the tool. If value is 1, then the domain is not displayed. Full administrators (with access to that registry key) can change this setting in the GUI. (x64 only)

        o Refresh (dword) to specify, in decimal and in millisecond, the interval to prompt the user to refresh the session list. By default, it is set to 600000 (10 minutes). A value of 0 will disable the timer. (x32 only)

      HKCU\Software\Citrix\SessionManagementTool (x64 only)

        o Refresh (string) to specify, in seconds, the interval to prompt the user to refresh the session list. By default, it is set to 600 (10 minutes). A value of 0 will disable the timer. This can be configured in the GUI.

        o Windowsize (string) will contain the size of the main application form

        o Colsize (string) will contain the size of the columns in the tool

      If a file called logo.jpg (size 128x45) is found in the same location as the tool executable, it will be used in replacement of the Citrix logo within the tool main GUI. (x64 only)

    Note: to speed up the tool initialization, it is recommended to deselect “Check for publisher’s certicifate revocation” in Internet Explorer options for the session where the tool runs.

    d:image001.png@01CEF71B.53E9C510

    Usage

The picture below shows the main interface of this tool

    Note: columns to the right of “Published Application” only apply to the 64bit version.

    Filter by servers

    This button will display the below window, to offer the possibility to limit to the selected servers when enumerating the sessions in the farm.

    Filter by applications

    This button will display the below window, to offer the possibility to limit to the selected applications when enumerating the sessions in the farm.

    Managing the user sessions

    When the administrator presses the “Search” button, the tool will enumerate the sessions in the entire farm

    The results will be displayed based on the below criteria :

      ??§ If a name has been entered in the textbox, the listed sessions will be limited to the usernames of the sessions containing that name. For example, “training” in the Search box will display all sessions for “training”, “traning1”.. “training 100” users.

      ??§ If the Hide active sessions button is active, all sessions but the active ones will be displayed

      ??§ If the Hide disconnected sessions button is active, all sessions but the disconnected ones will be displayed

      ??§ If the Hide idle sessions button is active, all sessions but the idle ones will be displayed

      ??§ If the Hide sessions being shadowed button is active, all sessions but the ones currently shadowed will be displayed

    A right click on the selected session(s) will display the context menu where different actions are available, based on the custom administrator rights :

      ??§ Logoff will perform a graceful logoff of the target session

      ??§ Disconnect will disconnect the target session

      ??§ View Process will open a new window with the active processes for the target session

      ??§ Send Message will send an administrative message to the target session

      ??§ Shadow will initiate a shadowing of the target session

      ??§ Session Information will open a new window displaying additional information about the target session

      ??§ Filter Results will open a new window, offering advanced filtering on username, server name and application name :

      ??§ (64bit only) Column display will open a new window, offering a list of columns to hide or display :

    View and kill Process

    This option will display the below window, listing the active processes for the user :

    Killing a process is displayed if enough delegated administrator rights are provided. A confirmation is required and an event will be logged if the administrator confirms the action.

    (32bit only) If the tool runs on the same server as the target session, it is possible (for a full Citrix administrator) to generate a memory dump for the desired process, which can be provided to Technical Support of the application vendor for further analysis.

    Logoff and Disconnect

    When logoff or disconnect actions are chosen, a confirmation message will be sent :

    When confirmed, the target session(s) will be logged off or disconnected, an event will be recorded and the below message appears :

    If the action is declined, the below message is displayed. No event is recorded

    Timer

    As soon as the administrator clicks on the “Search” button, a timer will start, with a default value of 10 minutes to invite to refresh the session’s list :

    If the registry key is set to 0, this will disable the timer.

    Shadowing

    By default, the tool will leverage the Citrix native APIs to shadow a target session. This will re-use the ICA session from which the tool is run in order to get the maximum performance.

      A click on the “Generate ICA file for shadowing” (checked by default on 64-bit) button will force the creation of a new ICA session to shadow the target user. However, the error reporting is limited in this mode.

      The ICA file supports single-sign on so the user does not have to authenticate into the newly generated session.

      Notes for 64-bit versions :

      Shadowing of multi monitor sessions is not supported. Refer to http://support.ctx.org.cn/CTX125693.citrix for more details.

    API functionality is disabled when running the tool, but it can be turned it using the GUI or a registry key.

    Tool options (x64 version only)

    When clicking the “Options” button, the user can customize different settings.

      The “User settings” will allow user to save the size of the columns (and ones he hide) and the size of the main window. The Refresh timer delay can also be set in this section.

      The “Machine settings” can only be modified by full Citrix administrators, assuming they have the proper rights access to the local machine registry.

    Sessions selection

    One or more sessions can be selected for action. When multiple sessions are selected, the only possible actions are : logoff, disconnect and send message. The other options from the context menu are automatically disabled.

      CTRL+A will select / deselect all the sessions currently displayed

      CTRL + LMouse click will help to select different sessions

    SHIFT + LMouse click will select several sessions at once

    Exporting data

    The tool can export the listed sessions to a CSV or HTML file. It is also possible to copy them to the clipboard in order to import them manually into another application.

    Detailed session information can also be copied to clipboard.

    Reporting to event log

    Below is the list of all messages logged by the tool in the Application log. An entry must exist in the XenApp server running the tool to be able to generate the event. This key is automatically generated by Windows whenever the first event is logged. Therefore, it is required that a user with local administrator rights is used to create the key.

    Action

    EventID

    Type

    Description

    Killing process

    700

    Information

    “user " <administrator> " terminated " <process> " from user " <username> " on server " <ActiveServer>

    Killing process

    701

    Error

    “ERROR : user " <administrator> " while trying to kill " <process> " from user " <username> " on server " <ActiveServer> <WindowsError>

    Killing process

    702

    Error

    “ERROR : user " <administrator> " could not kill " <process> " from user " <username> " on server " <ActiveServer>

    Generate UserDump

    710

    Information

    User " <administrator> " generated a dump and saved it to " <crashlocation>

    Session Action (logoff, disconnect)

    800

    Information

    "user " <administrator> " initiated a “ <session action> “ to " to session ID " <SessionID> " on server " <servername>

    Session Action (logoff, disconnect)

    801

    Error

    "user " <administrator> " initiated a “ <session action> “ to " to session ID " <SessionID> " on server " <servername>

    Shadowing (using Citrix API)

    900

    Information

    "user " <administrator> " initiated a shadow to the user user " <username> " in session ID " <SessionID> " on server " <servername>

    Shadowing (using Citrix API)

    901

    Error

    "Error 7050 when trying to shadow user " <username> " in session ID " <SessionID> " on server " <servername> "You cannot shadow using this tool from the console."

    Shadowing (using Citrix API)

    902

    Information

    " user " <username> " in session ID " <SessionID> " on server " <servername> “declined the shadow request"

    Shadowing (using Citrix API)

    903

    Error

    "Error “ <errorID> when trying to shadow user " <username> " in session ID " <SessionID> " on server " <servername>

    Reporting to SQL database

    For 64-bit version, the tool can send reporting information to a SQL Server database. This SQL database will only need a single table with the below fields

Name

Type

Allow Null

Comments

ID

Int

No

auto-increment

EventID

Int

No

Same as table above

Type

String

No

Error, Info or Warning

DateTime

string

No

 

UserName

String

No

User running the tool

Text

text

No

 

      Each user running the tool will need write access to this database and Windows authentication is used. Note that SQL authentication is not supported.

      The registry key SQLInfo must have the following format :

      SQLServer\SQLInstance,DBName,TableName

      The text file SQL.CFG (please note the file information is checked only if the registry key does not exist) must contain the following line :

      SQLInfo=SQLServer\SQLInstance,DBName,TableName

    The SQL.CFG file must be in the same folder as the tool.

    Troubleshooting

    Whenever an issue is found, please try to reproduce the issue after running the tool with the /debug switch (see the Launch section above). DebugView from SysInternals must be running in the same session as the tool in order to capture debugging information.

    This log file, with a description of the issue, must be sent to supporttools@citrix.com

    Security Permissions Required by Citrix Session Management Tool

    There are no specific permissions required to run the tool because it behaves differently if you are a Citrix administrator or not. A minimum set of Citrix Administrator rights required :?? View Session Management?? and?? View Server Information

    Data Modified by Citrix Session Management Tool

    The following registry keys are created or modified :

    HKLM\System\CurrentControlSet\services\eventlog\Application\CTXSessionMgt

    HKLM\Software\Citrix\SessionManagementTool

      HKCU\Software\Citrix\SessionManagementTool

    Contact Information

    Questions? Concerns? Send any feedback for this tool to supporttools@citrix.com

    Uninstalling Citrix Session Management Tool

    Delete the folder where the tool was extracted and delete the registry keys listed in the previous section.

    Disclaimer

    This software application is provided to you "as is" with no representations, warranties or conditions of any kind. You may use and distribute it at your own risk. CITRIX DISCLAIMS ALL WARRANTIES WHATSOEVER, EXPRESS, IMPLIED, WRITTEN, ORAL OR STATUTORY, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NONINFRINGEMENT. Without limiting the generality of the foregoing, you acknowledge and agree that (a) the software application may exhibit errors, design flaws or other problems, possibly resulting in loss of data or damage to property; (b) it may not be possible to make the software application fully functional; and (c) Citrix may, without notice or liability to you, cease to make available the current version and/or any future versions of the software application. In no event should the code be used to support of ultra-hazardous activities, including but not limited to life support or blasting activities. NEITHER CITRIX NOR ITS AFFILIATES OR AGENTS WILL BE LIABLE, UNDER BREACH OF CONTRACT OR ANY OTHER THEORY OF LIABILITY, FOR ANY DAMAGES WHATSOEVER ARISING FROM USE OF THE SOFTWARE APPLICATION, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the code.

 

Join the conversation

Citrix Discussions

Open a case

Citrix Support

特别说明


本文来源为Citrix.com所有,翻译后版权归翻译者所有.如需转载请注明出处.

文档版本


.

广告招租


最新留言


.

广告招租


.