How To Enable Configuration Logging In XenApp

How To Enable Configuration Logging In XenApp

book

Article ID: CTX211438

calendar_today

Updated On:

Description

This article goes over the steps needed to setup the configuration logging database for XenApp and explains what the feature does.


Instructions

1. First you need to create a new database in SQL or Oracle it must be a separate database than your XenApp farm is using.(Refer to your database manufacturers documentation on how to create a new database if needed.)

2. Once the database has been created you are now ready to setup the Configuration logging feature.

3. Open the Citrix Delivery Services Console or Citrix AppCenter console.

4. Right click on your XenApp farm name and select Farm Properties.

5. On the Farm Properties window select the Configuration Logging Option.

6. Then click on the Configure Database button.

7. Select the database you will be using (SQL or Oracle are supported)  , the authentication type, and credentials needed to access your database and database server.

8. For Connection Options and Connection Pooling leave the default settings and click Next.

9. On the final page of the Configuration Logging setup you will have a Test Database Connection button to make sure the database and credentials you entered are correct and valid.

10. If it passes the Test Database Connection then you can click the Finish button.

11. Configuration logging is now enabled for your XenApp farm.

Additional Information

The Configuration Logging feature allows you to keep track of administrative changes made to your server farm environment. By generating the reports that this feature makes available, you can determine what changes were made to your server farm, when they were made, and which administrators made them. This is especially useful when multiple administrators are modifying the configuration of your server farm. It also facilitates the identification and, if necessary, reversion of administrative changes that may be causing problems for the server farm.

When this feature is enabled for a licensed server farm, administrative changes initiated from the following components lead to the creation of log entries in a central Configuration Logging database:
  • Citrix AppCenter
  • some command-line utilities
  • tools custom built with SDKs

Before you enable the Configuration Logging feature:
  • Determine the level of security and control you need over the configuration logs. This determines if you need to set up additional database user accounts and if you want to make XenApp administrators enter credentials before clearing logs.
  • Determine how strictly you want to log tasks; for example, if you want to log administrative tasks and if you want to allow administrators to make changes to a farm if the task cannot be logged (for example, if the database is disconnected).
  • Determine if you want to allow administrators to be able to clear configuration logs and if you want them to have to supply credentials for this purpose. This requires the permission to Edit Configuration Logging settings.
Important: To securely store the credentials used for accessing the Configuration Logging database, you can enable the IMA encryption feature when you deploy your server farm. After this is enabled, however, you cannot disable it without losing the data it encrypted. Citrix recommends that you configure IMA encryption before the Configuration Logging feature is configured and used.

To enable the Configuration Logging feature:
  • Set up the Configuration Logging database.
  • Define the Configuration Logging database access permissions.
  • Configure the Configuration Logging database connection.
  • Set the Configuration Logging properties.
  • Delegate administrative permissions as needed.
The Configuration Logging feature, after it is properly enabled, runs in the background as administrative changes trigger entries in the Configuration Logging database. The only activities that are initiated by the user are generating reports, clearing the Configuration Logging database, and displaying the Configuration Logging properties.

To generate a configuration logging report, use the PowerShell command
Get-CtxConfigurationLogReport

For more information, see help for
Get-CtxConfigurationLogReport or Windows PowerShell with Common Commands.

Issue/Introduction

How to enable the Configuration Logging feature in XenApp. This article goes over the steps needed to setup the configuration logging database for XenApp and explains what the feature does.