April, 2013 Configuration Logging Project Excalibur Miho Hoshino, WW Support Readiness

© 2013 Citrix | Confidential – Do Not Distribute Document management CategoryTracking Information Company:Citrix Systems, Inc. Author(s):Miho Hoshino Owner(s):Worldwide Support Readiness Last modified:May, 2013 Version:Draft 3 Length:30 minutes

© 2013 Citrix | Confidential – Do Not Distribute Agenda Feature Description Architectural Components Pre-requisites and supported platforms Troubleshooting References

© 2013 Citrix | Confidential – Do Not Distribute Configuration logging Log administrative changes to database Makes it easy to identify any modifications that may need to be rolled back Configuration logging has been available with XenApp (4.5 and higher) and XenDesktop 4 SP1 No configuration logging capability with XenDesktop 5.x

© 2013 Citrix | Confidential – Do Not Distribute Configuration logging in Excalibur Capture site configuration changes and administrative activities to database Can be viewed in Studio using a variety of filters and generate HTML and CSV reports Requires the Edit Logging Preferences and View Configuration Logs permissions to control Configuration logging Enabled by default

© 2013 Citrix | Confidential – Do Not Distribute What is logged PowerShell Desktop StudioDirector logged

© 2013 Citrix | Confidential – Do Not Distribute What is not logged Not logged

© 2013 Citrix | Confidential – Do Not Distribute How to enable/disable Configuration Logging 1.From Citrix Studio, select Logging in the left pane 2.In the Actions pane, click Preference. Select the Enable/Disable radio button (Enable is selected by default)

© 2013 Citrix | Confidential – Do Not Distribute Configuration Logging Database Uses the main site database by default Can use a different database for Configuration Logging (highly recommended) Supported database:  SQL Server 2012 SP1 - Express, Standard, and Enterprise Editions  SQL Server 2008 R2 SP2 – Express, Standard, Enterprise, and Datacenter Editions Includes by default Site Configuration Database Configuration Logging Database Monitoring Database

© 2013 Citrix | Confidential – Do Not Distribute Using the main site database by default Configuration Logging database ConfigLoggingSchema

© 2013 Citrix | Confidential – Do Not Distribute How to change the database location (1/2) From Studio, select Logging in the left pane In the Actions pane, click Preferences Click Change logging database

© 2013 Citrix | Confidential – Do Not Distribute How to change the database location (2/2) Specify the location of the server containing the new database server and the database name If you want Studio to create the database, click OK or Test connection. When prompted, click OK Studio will create the database automatically

© 2013 Citrix | Confidential – Do Not Distribute How to enable/disable mandatory logging 1.From Citrix Studio, select Logging in the left pane 2.In the Actions pane, click Preference. o Clear the Allow changes when the database is disconnected checkbox to enable mandatory logging. o Select the Allow changes when the database is disconnected checkbox to disable mandatory logging (This is selected by default) Mandatory logging enabled: No configuration change or administrative activity that would normally be logged will be allowed unless it can be written in the database used for Configuration Logging Mandatory logging enabled: No configuration change or administrative activity that would normally be logged will be allowed unless it can be written in the database used for Configuration Logging

© 2013 Citrix | Confidential – Do Not Distribute Displaying configuration log content (1/2) Newest Enter text in the Search box to filter logs Select an interval from the drop down list box: Last six months Last three months Last 28 days Last 7 days Today Select an interval from the drop down list box: Last six months Last three months Last 28 days Last 7 days Today The log content is displayed chronologically (newest entries first) by default Select Logging to display configuration log content

© 2013 Citrix | Confidential – Do Not Distribute Displaying configuration log content (2/2) High level operations: A high level operation results in one or more service and SDK calls, which are low level operations High level operations: A high level operation results in one or more service and SDK calls, which are low level operations Low level operations are displayed when you select a high level operation in the upper portion of the center pane

© 2013 Citrix | Confidential – Do Not Distribute Generating configuration log reports (1/2) Click Create custom report in the Actions pane Select the date range for the report Select the report format and browse to the location where the report should be saved

© 2013 Citrix | Confidential – Do Not Distribute Generating configuration log reports (2/2)

© 2013 Citrix | Confidential – Do Not Distribute Deleting configuration log content Click Delete logs in the Actions pane Choose to create a backup or not Review your selection and click Finish

© 2013 Citrix | Confidential – Do Not Distribute Requirements to delete configuration logs (1/3) Delegated Administration permission SQL Server database permission Can delete configuration logs

© 2013 Citrix | Confidential – Do Not Distribute Requirements to delete configuration logs (2/3) For delegated Administration permission Delegated Administration

© 2013 Citrix | Confidential – Do Not Distribute Requirements to delete configuration logs (3/3) For SQL Server database permission SQL Server database login with at least one of the following roles:

© 2013 Citrix | Confidential – Do Not Distribute How-to: Creating a SQL Server login (1/2) Setting server role(s) Right-click the Security folder, point to New and then click Login Enter a name (and password) for the login on the General page Select the Server Roles page and set server roles

© 2013 Citrix | Confidential – Do Not Distribute How-to: Creating a SQL Server login (2/2) Specifying the database that the login is allowed to access Place a check mark next to the database that you wish to have the login to get access Can set database roles here

© 2013 Citrix | Confidential – Do Not Distribute Configuration logging internals Uses PowerShell SDK  Installed with Studio  Configuration logging is configured via SDK Uses the Citrix Configuration Logging Service  Installed with the Delivery Controller

© 2013 Citrix | Confidential – Do Not Distribute Configuration Logging architecture Each service can generate configuration log entries and log entries are conveyed via inter-service WCF call to the logging service

© 2013 Citrix | Confidential – Do Not Distribute PowerShell cmdlets (1/2) For configuration logging Set-LogSite  Allows settings to be set  Example: Set-LogSite -State Enabled -Locale Chinese –AdminAddress “ ” Get-LogHighLevelOperation  Retrieves existing High Level Operations based on filter criteria Get-LogLowLevelOperation  Retrieves existing Low Level Operations based on filter criteria

© 2013 Citrix | Confidential – Do Not Distribute PowerShell cmdlets (2/2) For configuration logging Start-LogHighLevelOperation  Logs the start of a new High Level Operation in the Logging Database Stop-LogHighLevelOperation  Logs the completion of a new High Level Operation in the Logging Database Delete-LogOperation  Deletes records from the database within a specified time range Export-LogCsvReport  Generates a CSV report of the data in the database Export-LogHtmlReport  Generates an HTML report of the data in the database

© 2013 Citrix | Confidential – Do Not Distribute PowerShell cmdlets for Configuration logging Example Desktop Studio uses configuration logging high level entries to tie each configuration logging entries. $loggingId = Start-LogHighLevelOperation “Create Machine Catalog” New-BrokerCatalog –Name “Catalog1” … -LoggingId $loggingId New-ProvScheme –Name “Catalog1” … -LoggingId $loggingId Etc… Stop-LogHighLevelOperation –Id $loggingId The logging id (which is a GUID) relates the operations together

© 2013 Citrix | Confidential – Do Not Distribute Tracing Configuration Logging ConfigurationLogging ConfigurationLoggingDAL ConfigurationLoggingFiltering ConfigurationLoggingLog ConfigurationLoggingLogging ConfigurationLoggingSnapin ConfigurationLogging ConfigurationLoggingDAL ConfigurationLoggingFiltering ConfigurationLoggingLog ConfigurationLoggingLogging ConfigurationLoggingSnapin

© 2013 Citrix | Confidential – Do Not Distribute References eDocs (sandbox) 

Work better. Live better.