WMI_Guide

Provider for Microsoft WMI Administrator’s GuideFor other guides in this document set, go to the Document Center

Citrix Presentation Server™ Provider for Microsoft® Windows® Management InstrumentationCitrix Presentation Server™ 4.5, Enterprise Edition for Windows®Citrix Access Suite™ 4.5

Use of the product documented in this guide is subject to your prior acceptance of the End User License Agreement. Copies of the End User License Agreement are included in the root directory of the Citrix Presentation Server CD-ROM and in the root directory of the Components CD-ROM.

Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. Other than printing one copy for personal use, no part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Citrix Systems, Inc.

© 2001-2006 Citrix Systems, Inc. All rights reserved.

Citrix, Citrix Presentation Server, Citrix Access Suite, ICA (Independent Computing Architecture), Program Neighborhood, MetaFrame, and MetaFrame XP are registered trademarks or trademarks of Citrix Systems, Inc. in the U.S.A. and other countries.

Adobe, Reader, and PostScript are registered trademarks or trademarks of Adobe Systems Incorporated in the U.S. and/or other countries.

Microsoft, MS, MS-DOS, Windows, Windows NT and Windows 2000 Server are registered trademarks or trademarks of Microsoft Corporation in the U.S.A. and other countries.

Last Updated: December 12 2005 (SC)

Go to Document Center Contents 3

Contents

Chapter 1 Using the Citrix Presentation Server ProvidersOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Accessing Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Introducing WMI and the Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

WMI Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7WMI Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

About the Citrix Presentation Server Provider. . . . . . . . . . . . . . . . . . . . . . . . . . . 9What Information Is Supplied? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9What Does the Provider Allow You to Control? . . . . . . . . . . . . . . . . . . . 10

About the Licensing Provider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Installing the Providers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Installing the Citrix Presentation Server Provider . . . . . . . . . . . . . . . . . . . . . . . 11Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11What Is Installed Where? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Installing the Licensing Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12What Is Installed Where? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

What to Do Next. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Uninstalling the Providers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Appendix A WMI Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4 Provider for Microsoft WMI Administrator’s Guide Go to Document Center

Go to Document CenterCHAPTER 1

Using the Citrix Presentation Server Providers

OverviewWelcome to the Citrix Presentation Server Provider for Microsoft Windows Management Instrumentation (WMI), for Citrix Presentation Server 4.5, Enterprise Edition. This chapter introduces you to the documentation and to the Citrix Presentation Server Provider and Licensing Provider. Topics include:

• About this guide• An overview of WMI • An introduction to the Citrix Presentation Server Provider and Licensing

Provider• How to install the Citrix Presentation Server Provider and Licensing Provider• Security considerations


About this GuideThe Provider for Microsoft WMI Administrator’s Guide (this guide) is for Citrix administrators responsible for installing, configuring, and maintaining Presentation Server computers, and for system administrators using management tools who want information about these servers. The guide is also aimed at software developers writing management tools for the Presentation Server platform.

This guide introduces WMI, the Citrix Presentation Server Provider and Licensing Provider, and explains how to install these providers. This guide assumes knowledge of Presentation Server.

Note The Citrix Presentation Server Provider for Microsoft Windows Management Instrumentation is also referred to as the Citrix Presentation Server Provider or the Provider throughout the documentation. Similarly, the Citrix Presentation Server Licensing Provider is referred to as the Licensing Provider throughout the documentation.

Accessing DocumentationThis administrator’s guide is part of the Presentation Server documentation set. The documentation set includes guides that correspond to different features of Presentation Server. These guides are provided as Adobe Portable Document Format (PDF) files.

Use the Document Center to access the complete set of online guides. The Document Center provides a single point of access to the documentation that enables you to go straight to the section of documentation that you need. The Document Center includes:

• A list of common tasks and a link to each item of documentation.

• A search function that covers all the PDF guides. This is useful when you need to consult a number of different guides.

• Cross-references between documents. You can move between documents as often as you need using the links to other guides and the links to the Document Center.

Important To view, search, and print the PDF documentation, you need to have the Adobe Reader 5.0.5 with Search or a later version with Search. You can download Adobe Reader for free from Adobe Systems’ Web site at http://www.adobe.com/.

http://www.adobe.com/



http://www.adobe.com

Go to Document Center Chapter 1 Using the Citrix Presentation Server Providers 7

If you prefer to access the guides without using the Document Center, you can navigate to the component PDF files using Windows Explorer. If you prefer to use printed documentation, you can also print each guide from Adobe Reader.

More information about Citrix documentation, and details about how to obtain further information and support, is included in Getting Started with Citrix Presentation Server.

To provide feedback on the documentation, go to www.citrix.com and click Support > Knowledge Center > Product Documentation. To access the feedback form, click the Submit Documentation Feedback link.

Introducing WMI and the Providers This section provides information about WMI in general, the Citrix Presentation Server Provider, and the Licensing Provider.

WMI OverviewWindows Management Instrumentation (WMI) is the standard management infrastructure included as part of Microsoft Windows 2000 and later.

WMI is designed to help system administrators manage large, complex enterprise systems, applications, and networks. WMI is a standard for accessing and sharing management information from a variety of underlying technologies in an enterprise environment. It provides system administrators with a single, consistent object-oriented interface to monitor and control system components locally or remotely.

http://www.citrix.com


WMI ComponentsThe following diagram illustrates the main components in a WMI installation:

Diagram showing the main components in a WMI installation

WMI Provider. This acts as an intermediary between the CIM (Common Information Model) Object Manager and the system being managed. The purpose of a WMI provider is to extract management information from the underlying system and present this to a WMI consumer.

The CIM Object Manager (CIMOM). This acts as a broker between the WMI providers and consumers. When a WMI consumer requests information, CIMOM identifies the WMI provider that can supply the information, obtains the information, and passes it to the consumer. CIMOM has its own repository in which it stores the data supplied to consumers. The Managed Object Format (MOF) files are also stored in the CIMOM repository. A MOF file defines the schema, which is the data that a WMI provider can supply and the methods it can execute in response to WMI requests.

WMI Consumer. This is a management tool such as Microsoft Operations Manager (MOM), an MMC snap-in such as the Citrix Access Management Console, or a third party application.

The Citrix Presentation Server Management Pack for MOM is included with Presentation Server. See the Management Pack Administrator’s Guide for more details.

Tip For more information about Windows Management Instrumentation, see Microsoft’s Web site: http://msdn.microsoft.com/.

http://msdn.microsoft.com/


About the Citrix Presentation Server ProviderThe Citrix Presentation Server Provider extracts information about the server on which it is installed and, where appropriate, about the server farm in which this server operates. It presents this information to a WMI consumer, such as MOM, for display.

For example, information about sessions on the server and published applications in the server farm is provided. Administrators can use this information to monitor the health and availability of the server and server farm.

The Provider runs on the server as a Windows service.

What Information Is Supplied?The Provider supplies information that includes:

Server farm data. A server farm is a group of Presentation Server computers managed as a single entity. Details about servers in the server farm, zones in the server farm, and published applications are provided.

Zone data. A zone is a grouping of Presentation Server computers that share a common data collector, which is a server that receives information from all the servers in the zone. The name of the zone in which the server operates is provided, together with details about the master and the other servers in the zone.

Server data. Information about the server on which the Provider is installed is supplied; for example, details about the sessions and applications running.

Session data. Information about the ICA sessions running on the server is provided, such as session ID and name, together with information about the processes running within a session.

Load balancing data. If you are using Load Manager for Citrix Presentation Server, information is provided about the server load level and the application load level on the local server. If load balancing is not enabled, the load level displays 99999. Note that you must configure the application load level in the Presentation Server Console; the server load level is configured by default. For more information about Load Manager, see the Load Manager Administrator’s Guide and the online help.

Application data. Published application details, such as the name, type, and version number of applications are provided. Information about applications published on a particular server is also supplied.

User data. User details, such as user name and account information, are provided, together with information about user groups and membership.


Static instances. The date and time of static instances such as zone elections and disconnected sessions are recorded. This data is useful in monitoring whether or not these events are occurring too frequently. If you subscribe to zone election or disconnected session events, the event history is recorded in the CIM Repository. Note that Citrix provides two classes that allow you to purge this information from the CIM Repository, either completely or before a given date and time. For more information, please see the .mof files.

Events. Information about events that occur, such as when an application is published, deleted, moved, or updated is provided. Also included are details about the creation, maintenance, and deletion of published application folders, servers, server folders, and sessions, together with many more events.

What Does the Provider Allow You to Control?The Provider allows you to:

Log off a session. Logging off a session terminates the connection and all running programs. The user cannot reconnect to the session.

Disconnect a session. Disconnecting a session terminates the connection between the server and the client. However, the user is not logged off and all running programs remain active. The user can later reconnect to the disconnected session.

Send messages to users. You can send messages to particular sessions.

Tip For more information about the data the Provider can supply, and the methods it can execute in response to WMI requests, see the Citrix .mof files. The files are in the \WMI folder (for example: C:\Program Files\Citrix\System32\WMI). For diagrams of WMI schema for the Provider, see “WMI Schema” on page 15.

About the Licensing ProviderWith the Citrix Access Suite licensing feature, Citrix licensing is handled by one or more license servers. Presentation Server computers communicate with a license server to obtain licenses.

The Licensing Provider is available on each Windows-based license server. It is installed by default when you install the license server. This WMI provider extracts information about Citrix licensing from the license server on which it runs and presents this to a WMI consumer, such as MOM, for display. For example, the Licensing Provider supplies information about the number of licenses in use and licenses that are about to expire.


The Citrix Presentation Server Provider no longer supplies licensing information for machines running MetaFrame Presentation Server 3.0 or Citrix Presentation Server 4.0 or 4.5. However, the Provider still supplies licensing information for servers running MetaFrame Presentation Server prior to these versions. This means that you can monitor multiple farms, some running MetaFrame Presentation Server 3.0 or Citrix Presentation Server 4.0 or 4.5, and some running earlier releases such as MetaFrame XP, Feature Release 3. For backwards compatibility, the licensing classes are still in the schema for the Citrix Presentation Server Provider.

Tip For information about the data the Licensing Provider can supply, see the Citrix .mof files. The files are in the \LicWMI folder (for example: C:\Program Files\Citrix\Licensing\LicWMI). For diagrams of WMI schema for the Licensing Provider, see “WMI Schema” on page 15. For more information about the Citrix Access Suite licensing feature, see the Citrix Access Suite Licensing Guide.

Installing the ProvidersInstalling the Citrix Presentation Server ProviderYou must install the Citrix Presentation Server Provider on every Presentation Server computer in the server farm about which you want to gather information.

You can install or remove the Provider using the Presentation Server Setup program. Setup installs the Provider by default if you select the Enterprise Edition during the installation sequence. When you run the Enterprise Edition Setup, you can decide whether or not to install the management components, including the Provider.

The Provider runs as a Windows service called Citrix WMI Service.

RequirementsOn each server on which you install the Provider, you need to add and activate a MetaFrame XPe, Feature Release 2, or later, license. For example, for Citrix Presentation Server 4.0, you must allocate an Enterprise Edition license.

What Is Installed Where?When you install the Provider, the files are installed in the \WMI folder, in the same directory in which Presentation Server is installed. Typically, this is: C:\Program Files\Citrix\System32\Citrix\WMI. The following files are included in this folder:

• The executable file for CitrixWMIService (ctxwmisvc.exe)

• Provider DLLs


• Various .fom files

• Managed Object Format files (.mof files)

Installing the Licensing ProviderThe Licensing Provider is installed by default when you install the Citrix Access Suite license server. The license server is an optional part of Presentation Server installation.

The Licensing Provider runs as a Windows service called CitrixLicensingProviderService.

For more information about installing the license server and the Licensing Provider, see the Citrix Access Suite Licensing Guide.

What Is Installed Where?When you install the Licensing Provider, the files are installed in the \LicWMI folder. Typically, this is: C:\Program Files\Citrix\Licensing\LicWMI. The following files are included in this folder:

• The executable file for the service (Citrix_GTLicensingProv.exe)

• A Helper file for the uninstaller (Citrix_Licensing_WMI.fom)

• A Managed Object Format file (Citrix_Licensing_WMI.mof)

What to Do NextAfter you install the Citrix Presentation Server Provider, and if an appropriate license is allocated on the server, the Provider service is ready to start. There is no need to manually start and stop the service as WMI will do this as required. After the Licensing Provider is installed, the Licensing Provider service is ready to start.

To gather and display information, use a suitable WMI consumer, such as the Citrix Presentation Server Management Pack for Microsoft Operations Manager. For further information about this feature, see the Citrix Web site.




Security ConsiderationsTo display information about Presentation Server computers and server farms using a WMI consumer, you must have access to the Root\Citrix namespace in the WMI configuration. You must also have the appropriate Citrix administration rights to display information about servers and server farms.

If you delegate areas of Presentation Server administration and server farm management to Citrix administrators, these administrators can monitor and control only the specific administration tasks that they have permissions for. For example, if a Citrix administrator can manage only published applications, then only information on published applications is available to them from the Citrix Presentation Server Provider. For more information about delegated administration, see the Citrix Presentation Server Administrator’s Guide.

Uninstalling the Providers To uninstall the Citrix Presentation Server Provider

You uninstall the Provider using the Presentation Server uninstaller.

For full details, see the Citrix Presentation Server Administrator’s Guide.

To uninstall the Licensing Provider

The Licensing Provider is part of the Citrix Access Suite Licensing feature. Therefore, to uninstall the Licensing Provider, you must uninstall the Citrix Access Suite licensing component. For full details, see the Citrix Access Suite Licensing Guide.


Go to Document CenterAPPENDIX A

WMI Schema

OverviewThis appendix provides diagrams of the WMI schema for the Citrix Presentation Server Provider and Licensing Provider. The schema is the data that a WMI provider can supply and the methods it can execute in response to WMI requests. The following schema are shown:

• Citrix Presentation Server Provider

• Licensing Provider


Citrix Presentation Server Provider WMI Schema (page 1 of 2)

Go to Document Center Appendix A WMI Schema 17

Citrix Presentation Server Provider WMI Schema (page 2 of 2)


Citrix Presentation Server Licensing Provider WMI Schema

Documents

WMI_Guide