April, 2013 Troubleshooting Excalibur – XenDesktop7 Mick Glover Worldwide Support Readiness

April, 2013

TroubleshootingExcalibur – XenDesktop7

Mick Glover Worldwide Support Readiness

© 2013 Citrix | Confidential – Do Not Distribute

Tracing & Logging

• Very little has changed…

• Out of the box… ᵒ CDF Tracing enabled for all servicesᵒ Clear text logging disabled for all services

• Configured through .NET service config filesᵒ One for each controller service


.NET Service LoggingAvailable logging mechanisms

• Managed under the <AppSettings> section of each .Config file

• "LogToCDF" - if present and set to 1, will log to CDF using the supplied CDF trace moduleᵒ Present and set to 1 for all Controller services

• "LogFileName" - if present, will log to the specified file nameᵒ "OverwriteLogFile" - if present, will overwrite existing log file if it already exists

• Note: More than one mechanism can be specified…


.Net Service Logging - Manual ConfigurationEnabling clear text logging - Example

1. Edit WorkStationAgent.exe.Config (Now called BrokerAgent.exe.Config)

2. Add the lines in Green below to enable and control clear text logging

3. Set appropriate NTFS permissions

4. Restart Citrix Desktop Service (BrokerAgent.exe.Config)


.Net Service Logging - Auto ConfigurationLogging Enabler (Excalibur version to be confirmed)

• Latest version: v3ᵒ Log file location ᵒ Remote Logging

• Tool runs on XenDesktop DC and VDA but is only aware of the XD5 legacy services so provides limited functionality

• Full Supportability ETA with Excalibur needs to be confirmed with Sakthi Ganesh (Lead Escalation Engineer)ᵒ Support communication to follow…


New Services = New .Config files 1/2Control CDF\Clear Text Logging

• Environment Test Serviceᵒ Citrix.EnvTest.exe.Config

• Configuration Logging Serviceᵒ Citrix.ConfigurationLogging.exe.Config

• Monitor Serviceᵒ Citrix.Monitor.exe.Config


New Services = New .Config files 2/2Control CDF\Clear Text Logging

• Storefront Serviceᵒ Citrix.Storefront.exe.Config

• Delegated Admin Serviceᵒ Citrix.DelegatedAdmin.exe.Config

• Citrix Desktop Serviceᵒ BrokerAgent.exe.Config

© 2013 Citrix | Confidential – Do Not Distribute© 2012 Citrix | Confidential – Do Not Distribute

Service config logging reference - XD5Service Configuration File Location Component

Broker Service BrokerService.exe.Config %ProgramFiles%\Citrix\Broker\Service DC

Machine Creation Service Citrix.MachineCreation.SdkWcfEndpoint.exe.Config

%ProgramFiles%\Citrix\MachineCreation\Service DC

ADIdentity Service Citrix.ADIdentity.SdkWcfEndpoint.exe.Config

%ProgramFiles%\Citrix\ADIdentity\Service DC

Configuration Service Citrix.Configuration.SdkWcfEndpoint.exe.Config

%ProgramFiles%\Citrix\Configuration\Service DC

Machine Identity Service Citrix.MachineIdentity.SdkWcfEndpoint.exe.Config

%ProgramFiles%\Citrix\MachineIdentity\Service DC

Citrix Host Service Citrix.Host.SdkWcfEndpoint.exe.Config

%ProgramFiles%\Citrix\Host\Service DC

WorkStation Agent WorkStationAgent.exe.config %ProgramFiles%\Citrix\Virtual Desktop Agent VDA

© 2013 Citrix | Confidential – Do Not Distribute© 2012 Citrix | Confidential – Do Not Distribute

Service config logging reference - XD7Service Configuration File Location Component

Broker Service BrokerService.exe.Config %ProgramFiles%\Citrix\Broker\Service DC

Machine Creation Service Citrix.MachineCreation.SdkWcfEndpoint.exe.Config

%ProgramFiles%\Citrix\MachineCreation\Service DC

ADIdentity Service Citrix.ADIdentity.SdkWcfEndpoint.exe.Config

%ProgramFiles%\Citrix\ADIdentity\Service DC

Configuration Service Citrix.Configuration.SdkWcfEndpoint.exe.Config

%ProgramFiles%\Citrix\Configuration\Service DC

Citrix Host Service Citrix.Host.SdkWcfEndpoint.exe.Config

%ProgramFiles%\Citrix\Host\Service DC

Citrix Desktop Service BrokerAgent.exe.Config %ProgramFiles%\Citrix\Virtual Desktop Agent VDA


PorticaService Logging (picaSvc2.exe)Logging Mechanisms

• CDFᵒ Disabled by default

• Clear text ᵒ Disabled by default

• Create PorticaConfig.XML and place under the following directoryᵒ C:\Program Files\citrix\ICAService\

XMLᵒ XML directory must be manually

created

Note: Once PorticaConfig.xml has been created and placed in the correct directory, it must be configured…


Configuring PorticaConfig.XML

• LogFileᵒ Level 0,1,5,9 supportedᵒ 0 = disabled

• CdfTraceᵒ Level 1,5,9 supported

• FunctionTraceᵒ Values 1,5,9 supportedᵒ Master flow control

<?xml version="1.0" encoding="utf-8"?><Config xmlns="Portica.xsd"> <Portica> <LogFile> <LogLevel>5</LogLevel> </LogFile> <CdfTrace> <LogLevel>5</LogLevel> </CdfTrace> <FunctionTrace> <LogLevel>5</LogLevel> </FunctionTrace> </Portica></Config>

<?xml version="1.0" encoding="utf-8"?><Config xmlns="Portica.xsd"> <Portica> <LogFile> <LogLevel>5</LogLevel> </LogFile> <CdfTrace> <LogLevel>5</LogLevel> <

<?xml version="1.0" encoding="utf-8"?><Config xmlns="Portica.xsd"> <Portica> <LogFile> <LogLevel>5</LogLevel> </LogFile> <CdfTrace> <LogLevel>5</LogLevel> </CdfTrace> <FunctionTrace> <LogLevel>5</LogLevel> </FunctionTrace> </Portica></Config>


PortICA clear text logs

• Restart PorticaService

• Logs files are automatically saved to the following locationsᵒ XP C:\Documents and Settings\

LocalService\Local Settings\Temp ᵒ Win7 C:\Windows\ServiceProfiles\

LocalService\AppData\Local\Temp


Validating service statusRemaining Legacy Services

• Get-BrokerServiceStatus (Broker Service)

• Get-ConfigServiceStatus (Configuration Service)

• Get-HypServiceStatus (Host Service)

• Get-AcctServiceStatus (AD Identity Service)

• Get-ProvServiceStatus (Machine Creation Service)

• Get-LicServiceStatus (License Service)


Validating service statusNew Services

• Get-EnvTestServiceStatus (Environment Test Service)

• Get-LogServiceStatus (Configuration Logging Service)

• Get-MonitorDBConnection (Monitor Service)

• Get-SFServiceStatus (Storefront Service)

• Get-AdminServiceStatus (Delegated Admin Service)


Service status return values Status Meaning

OK The broker is connected to a database that is valid, and the service is running.

DBUnconfigured The broker does not have a database connection configured

DBRejectedConnection The database rejected the logon from the Broker Service. This may be caused by bad credentials, or the database not being installed.

InvalidDBConfigured The database schema is missing (possibly just the stored procedures in it).

DBNotFound The specified database could not be located with the configured connection string.

DBMissingOptionalFeature The broker is connected to a database that is valid, but it does not have the full functionality required for optimal performance. Upgrading the database is advisable.

DBMissingMandatoryFeatureThe broker is connected to a database that is valid, but it does not have the full functionality required so the broker cannot function. Upgrading the database is required.


Service status return values (cont...)Status Meaning

DBNewerVersionThanService The broker is too old to use the database. A newer version is required.

DBOlderVersionThanService The database is too old for the Broker Service. Upgrade the database.

DBVersionChangeInProgress A database schema upgrade is in progress.

PendingFailure Connectivity between the Broker Service and the database has been lost. This may be a transitory network error, but may indicate a loss of connectivity that requires administrator intervention.

Failed Connectivity between the broker and the database has been lost for an extended period of time, or has failed due to a configuration problem. The broker service cannot operate while its connection to the database is unavailable.

Unknown The Service's status cannot be determined


PowerShell Ref:

• Load XenDesktop Snapinsᵒ asnp citrix* (alias for Add-PSSnapin)

• Return all available XenDesktop cmdletsᵒ Get-command –module citrix.*

• Verify ability to run scriptsᵒ Get-ExecutionPolicy

• Enable the running of PoSH scriptsᵒ Set-ExecutionPolicy Unrestricted


New Built-in Supportability Features\ToolsXenDesktop 7

• Configuration Tests

• Learn More Links

• Diagnostic Reporting & Export

• User Reporting and TAAS link-up

• Configuration Logging Reporting

• Director integrated EdgeSight functionality


Configuration TestsBuilt-in functionality\Citrix Studio

• Functionality introduced through the Environment Test Service

• Includes report functionalityᵒ Successᵒ Warningsᵒ Failures

• Skip tests option included


Configuration TestsTesting Reports

• .HTML format

• Provides guidance & Reduces need to hunt for configuration errors…


Configuration TestsAnytime Testing

• Quick launch Tab allows anytime testing of the followingᵒ Site Configurationᵒ Machine Catalogsᵒ Delivery Groups


Learn more linksBuilt-in functionality\Citrix Studio

• Active links will auto launch default browser and take admin to relevant documentation for specific task to be carried out

• Available throughout Studio configuration wizards…


Diagnostic Reporting & Export featuresNew Supportability Features\Tools


User Reporting and TAAS link-upNew Supportability Features\Tools



Configuration Logging Reporting


Desktop Director

• Reset Profile management profile function

• Reset PvD VHD (mirror of c:\ (Application data)


Excalibur Ready ToolsTAAS Team

• Scoutᵒ XDPingᵒ CDF Controlᵒ XDDBDIag

• All tools above are part of the current public version of Scout which is Excalibur Readyᵒ New version of Scout released the same week as Excalibur with some added tweaks

• All KB articles will be updated for RTW (26th June)


XDDbDiag v4.x

• Part of Scout

• No Separate Download

• Contact: Rene Alfonso (Director, product Dev - TAAS) for more information


Other well known Support toolsExcalibur supportability still to be confirmed…

• XD Site Checker

• CDFMonitor

• CDFMarker

• CDFCheck

• HDX Monitor

Work better. Live better.