I have all that data in my documentation scripts. Here is the table I have built over the last ten years.

Maintaining this table after July 1, 2023, should be easy for whoever updates the list.

• In Function OutputDesktopOSMachine:
  • test if there is a Desktop.DNSName
  • If not, test Desktop.MachineName
  • If not, test Desktop.HostedMachineName
  • If not, use error message “error, there was no name found for the Desktop”
• In Function OutputHosting:
  • for Word output:
  • if there are no single-session OS or multi-session OS or sessions, output a
  • message and don’t waste a page
  • add a page break after outputting Session data
• In Function OutputServerOSMachine:
  • test if there is a Server.DNSName
  • If not, test Server.MachineName
  • If not, test Server.HostedMachineName
  • If not, use error message “error, there was no name found for the Server”
• Updated for CVAD 2206/2209/2212/2303/7.34/7.35/7.36/7.37

You can always find the most current script by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

• Added Computer policy
  • Profile Management\Advanced settings\Maximum number of VHDX disks for storing Outlook OST files
  • Profile Management\Citrix Virtual Apps Optimization settings\Enable Citrix Virtual Apps Optimization
  • Profile Management\Citrix Virtual Apps Optimization settings\Path to Citrix Virtual Apps optimization definitions:
  • Profile Management\File deduplication\Files to exclude from the shared store
  • Profile Management\File deduplication\Files to include from the shared store

You can always find the most current script by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

• Updated Function ProcessScriptSetup to support multiple Section items
• Updated the script to allow the Section parameter to support multiple items
• Updated the help text
• Updated the ReadMe file

You can always find the most current script by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

• Fixed bug reported by James Rankin where in Function OutputDatastores I didn’t check for SQLServerName,TCPPortNumber
  • https://support.citrix.com/article/CTX234610/how-to-configure-xendesktop-to-use-custom-sql-port
  • For example, to to [sic] add custom port to the connection strings, then set the $ServerName variable to “DBServername\Instance,CustomPortNumber”.
• Updated Function GetDBCompatibilityLevel to support SQL Server 2022
• Updated the help text
• Updated the ReadMe file

You can always find the most current script by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

• Fixed text output for hardware inventory
• General code cleanup
• In Function OutputNicItem, fixed several issues with DHCP data

You can always find the most current script by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

• Replaced all Get-WmiObject with Get-CimInstance
• Updated for CVAD 2203/7.33 and CVAD 2206/7.34
• Updated the Policies setting table to match the V3 and Citrix Cloud scripts

You can always find the most current script by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

I am sure I may have missed something, so if I did, please let me know.

You can always find the most current Excel file by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

Script Bug Fix Updates 7-Feb-2022

• Changed the date format for the transcript and error log files from yyyy-MM-dd_HHmm format to the FileDateTime format
  • The format is yyyyMMddTHHmmssffff (case-sensitive, using a 4-digit year, 2-digit month, 2-digit day, the letter T as a time separator, 2-digit hour, 2-digit minute, 2-digit second, and 4-digit millisecond).
  • For example: 20221225T0840107271.
• Fixed the German Table of Contents (Thanks to Rene Bigler)
  • From
    • ‘de-‘ { ‘Automatische Tabelle 2’; Break }
  • To
    • ‘de-‘ { ‘Automatisches Verzeichnis 2’; Break }
• In Function AbortScript, add test for the winword process and terminate it if it is running
  • Added stopping the transcript log if the log was enabled and started
• In Functions AbortScript and SaveandCloseDocumentandShutdownWord, add code from Guy Leech to test for the “Id” property before using it
• Replaced most script Exit calls with AbortScript to stop the transcript log if the log was enabled and started
• Updated the help text
• Updated the ReadMe file

Active Directory 3.09 7-Feb-2022

• • Added to Domain Information the data for ms-DS-MachineAccountQuota

Active Directory Health Check 3.09 7-Feb-2022

• • Add missing variable $Script:ThisScriptPath
  • Changed all Write-Verbose statements from Get-Date to Get-Date -Format G as requested by Guy Leech
  • Removed Function Stop-Winword
  • Updated Functions CheckWordPrereq and SetupWord with the versions used in the other documentation scripts

Citrix Federated Authentication Services 1.14 7-Feb-2022

Citrix Provisioning Services (PVS) New 6.03 8-Feb-2022

Citrix Provisioning Services (PVS) Old 4.32 10-Feb-2022

Citrix XenApp/XenDesktop 7.0 through 7.7 1.51 13-Feb-2022

• • Since the Citrix.GroupPolicy.Commands.psm1 module file was removed in  1.50,  removed the block for Elevation if $Policies is True

Citrix XenApp/XenDesktop 7.8 through CVAD 2006 2.46 15-Feb-2022

Citrix Virtual Apps and Desktops V3.32 15-Feb-2022

Microsoft Configuration Manager 2012R2 V2.40 17-Feb-2022

Microsoft DHCP V2.05 17-Feb-2022

Microsoft DNS V2.03 18-Feb-2022

Citrix NetScaler Old (uses ns.conf file) V2.62 18-Feb-2022

• • Fixed $Null comparisons that were on the wrong side
  • Updated Functions CheckWordPrereq and SendEmail to the latest version

Parallels RAS V17 V1.02 18-Feb-2022

• • Added Function OutputReportFooter
  • Added Parameter ReportFooter
    • Outputs a footer section at the end of the report.
    • Report Footer
      • Report information:
        • Created with: <Script Name> – Release Date: <Script Release Date>
        • Script version: <Script Version>
        • Started on <Date Time in Local Format>
        • Elapsed time: nn days, nn hours, nn minutes, nn.nn seconds
        • Ran from domain <Domain Name> by user <Username>
        • Ran from the folder <Folder Name>
  • Updated Functions SaveandCloseTextDocument and  SaveandCloseHTMLDocument to add a “Report Complete” line
  • Updated Functions ShowScriptOptions and ProcessScriptEnd to add  $ReportFooter

Parallels RAS V18 V2.11 18-Feb-2022

• • Added Function OutputReportFooter
  • Added Parameter ReportFooter
    • Outputs a footer section at the end of the report.
    • Report Footer
      • Report information:
        • Created with: <Script Name> – Release Date: <Script Release Date>
        • Script version: <Script Version>
        • Started on <Date Time in Local Format>
        • Elapsed time: nn days, nn hours, nn minutes, nn.nn seconds
        • Ran from domain <Domain Name> by user <Username>
        • Ran from the folder <Folder Name>
  • Updated Functions SaveandCloseTextDocument and  SaveandCloseHTMLDocument to add a “Report Complete” line
  • Updated Functions ShowScriptOptions and ProcessScriptEnd to add  $ReportFooter

VMware vSphere 1.93 23-Feb-2022

Citrix XenApp 6.5 5.06 23-Feb-2022

If you have questions or issues, please email me. webster at carlwebster dot com.

You can always find the most current script by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

I am sure I may have missed something, so if I did, please let me know.

You can always find the most current Excel file by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

• Added Function OutputReportFooter
• Added Parameter ReportFooter
  • Outputs a footer section at the end of the report
  • Report Footer
    • Report information:
      • Created with: <Script Name> – Release Date: <Script Release Date>
      • Script version: <Script Version>
      • Started on <Date Time in Local Format>
      • Elapsed time: nn days, nn hours, nn minutes, nn.nn seconds
      • Ran from domain <Domain Name> by user <Username>
      • Ran from the folder <Folder Name>
• Fixed a logic error in Function ProcessPolicySummary
  • Instead of getting both Computer and User policies at one time, get them separately
• In Function AbortScript, add test for the winword process and terminate it if it is running
• In Functions AbortScript and SaveandCloseDocumentandShutdownWord, add code from Guy Leech to test for the “Id” property before using it
• Removed the requirement for the Citrix.GroupPolicy.Commands.psm1 module file (Thanks to Guy Leech for the help)
  • Added the following functions from the module to the script and cleaned up the Citrix code
    • CreateDictionary
    • CreateObject
    • FilterString
    • Get-CitrixGroupPolicy
    • Get-CitrixGroupPolicyConfiguration
    • Get-CitrixGroupPolicyFilter
• Reworked the use of LocalFarmGPO PSDrive to prevent multiple creations and deletions
• Updated for CVAD 2109/7.31 and CVAD 2112/7.32
• Updated Functions SaveandCloseTextDocument and SaveandCloseHTMLDocument to add a “Report Complete” line
• Updated Functions ShowScriptOptions and ProcessScriptEnd to add $ReportFooter
• Updated the help text
• Updated the ReadMe file

You can always find the most current script by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

• Added Broker Registry Keys:
  • HKLM:\Software\Policies\Citrix\DesktopServer\AppProtectionAuthorizationCheckPeriodMin
  • HKLM:\Software\Policies\Citrix\DesktopServer\AutoTagRuleIntervalsTimeSecs
  • HKLM:\Software\Policies\Citrix\DesktopServer\DisconnectOperationTimeOutSecs
  • HKLM:\Software\Policies\Citrix\DesktopServer\DynamicSequenceStirIntervalMins
  • HKLM:\Software\Policies\Citrix\DesktopServer\FirstHeartbeatDistributionWidthSecs
  • HKLM:\Software\Policies\Citrix\DesktopServer\LaunchDelayedRetryPeriodSec
  • HKLM:\Software\Policies\Citrix\DesktopServer\MaxTotalConcurrentMachineCommands
  • HKLM:\Software\Policies\Citrix\DesktopServer\RoTPublicKeysUpdateMaxDelayHours
  • HKLM:\Software\Policies\Citrix\DesktopServer\UseLegacyLaunchZoneLogic
  • HKLM:\Software\Policies\Citrix\DesktopServer\UserDrivenResetDebounceTimeSecs
  • HKLM:\Software\Policies\Citrix\DesktopServer\UserDrivenShutDownTimeoutMs
  • HKLM:\Software\Policies\Citrix\DesktopServer\UserNotify2SigningKeyLifetimeHours
  • HKLM:\Software\Citrix\DesktopServer\AppProtectionAuthorizationCheckPeriodMin
  • HKLM:\Software\Citrix\DesktopServer\AutoTagRuleIntervalsTimeSecs
  • HKLM:\Software\Citrix\DesktopServer\DisconnectOperationTimeOutSecs
  • HKLM:\Software\Citrix\DesktopServer\DynamicSequenceStirIntervalMins
  • HKLM:\Software\Citrix\DesktopServer\FirstHeartbeatDistributionWidthSecs
  • HKLM:\Software\Citrix\DesktopServer\LaunchDelayedRetryPeriodSec
  • HKLM:\Software\Citrix\DesktopServer\LogoffOperationTimeOutSecs
  • HKLM:\Software\Citrix\DesktopServer\MaxTotalConcurrentMachineCommands
  • HKLM:\Software\Citrix\DesktopServer\RoTPublicKeysUpdateMaxDelayHours
  • HKLM:\Software\Citrix\DesktopServer\UseLegacyLaunchZoneLogic
  • HKLM:\Software\Citrix\DesktopServer\UserDrivenResetDebounceTimeSecs
  • HKLM:\Software\Citrix\DesktopServer\UserDrivenShutDownTimeoutMs
  • HKLM:\Software\Citrix\DesktopServer\UserNotify2SigningKeyLifetimeHours
  • HKLM:\Software\Policies\Citrix\DesktopServer\AutoscalePowerActionQueuingPeriodSeconds
  • HKLM:\Software\Policies\Citrix\DesktopServer\BulkPowerActionBusyBufferSecs
  • HKLM:\Software\Policies\Citrix\DesktopServer\HclConnectionStateCachePeriodSecs
  • HKLM:\Software\Policies\Citrix\DesktopServer\HypervisorConnectionMaxPollFailures
  • HKLM:\Software\Policies\Citrix\DesktopServer\HypervisorConnectionPollMaxPeriodSecs
  • HKLM:\Software\Policies\Citrix\DesktopServer\MaxNotificationThreads
  • HKLM:\Software\Policies\Citrix\DesktopServer\ParallelDesktopGroupScalingMaxThreads
  • HKLM:\Software\Policies\Citrix\DesktopServer\SimplePowerActionTimeoutSecs
  • HKLM:\Software\Citrix\DesktopServer\AutoscalePowerActionQueuingPeriodSeconds
  • HKLM:\Software\Citrix\DesktopServer\BulkPowerActionBusyBufferSecs
  • HKLM:\Software\Citrix\DesktopServer\HclConnectionStateCachePeriodSecs
  • HKLM:\Software\Citrix\DesktopServer\HypervisorConnectionMaxPollFailures
  • HKLM:\Software\Citrix\DesktopServer\HypervisorConnectionPollMaxPeriodSecs
  • HKLM:\Software\Citrix\DesktopServer\MaxNotificationThreads
  • HKLM:\Software\Citrix\DesktopServer\ParallelDesktopGroupScalingMaxThreads
  • HKLM:\Software\Citrix\DesktopServer\ParallelPowerStateReadMaxThreads
  • HKLM:\Software\Policies\Citrix\DesktopServer\IdleSessions\AutoSessionDisconnectGracePeriodSecs
  • HKLM:\Software\Citrix\DesktopServer\IdleSessions\AutoSessionDisconnectGracePeriodSecs
  • HKLM:\Software\Citrix\DesktopServer\LHC\ConfigSyncIntervalSeconds
  • HKLM:\Software\Citrix\DesktopServer\LHC\HypervisorConnectionSyncIntervalSeconds
  • HKLM:\Software\Citrix\DesktopServer\LHC\MissedMessagesLimitBeforeBecomingLeader
  • HKLM:\Software\Citrix\DesktopServer\LHC\StaRecentActivityTimespanMinutes
  • HKLM:\Software\Citrix\DesktopServer\LHC\StoreFrontRecentActivityTimespanMinutes
  • HKLM:\Software\Citrix\DesktopServer\LHC\TimeToWaitForAllPeerOutageStateInfoSeconds
  • HKLM:\Software\Citrix\Broker\Service\State\LHC\IsElected
  • HKLM:\Software\Citrix\Broker\Service\State\LHC\IsOnPremStoreFrontPresent
  • HKLM:\Software\Citrix\Broker\Service\State\LHC\IsStaRequestReceived
  • HKLM:\Software\Citrix\Broker\Service\State\LHC\LeaderConnectorId
  • HKLM:\Software\Citrix\Broker\Service\State\LHC\LeaderFqdn
  • HKLM:\Software\Citrix\Broker\Service\State\LHC\OutageModeThresholdReached
  • HKLM:\Software\Citrix\Broker\Service\State\LHC\ResourceLocationId
  • HKLM:\Software\Citrix\Broker\Service\State\LHC\ResourceLocationName
  • HKLM:\Software\Citrix\Broker\Service\State\LHC\ZoneUid
  • HKLM:\Software\Policies\Citrix\DesktopServer\Logging\HypervisorSummaryReportIntervalSecs
  • HKLM:\Software\Policies\Citrix\DesktopServer\Logging\SlowDBAccessLogThresholdMs
  • HKLM:\Software\Policies\Citrix\DesktopServer\Logging\SlowSdkDBAccessLogThresholdMs
  • HKLM:\Software\Policies\Citrix\DesktopServer\Logging\TraceWcfBindings
  • HKLM:\Software\Citrix\DesktopServer\Logging\HypervisorSummaryReportIntervalSecs
  • HKLM:\Software\Citrix\DesktopServer\Logging\SlowDBAccessLogThresholdMs
  • HKLM:\Software\Citrix\DesktopServer\Logging\SlowSdkDBAccessLogThresholdMs
  • HKLM:\Software\Citrix\DesktopServer\Logging\TraceWcfBindings
  • HKLM:\Software\Policies\Citrix\DesktopServer\MachineCommandQueues\VdaCommandBufferExpiryTime
  • HKLM:\Software\Policies\Citrix\DesktopServer\MachineCommandQueues\VdaCommandBufferSizeLimitKB
  • HKLM:\Software\Citrix\DesktopServer\MachineCommandQueues\VdaCommandBufferExpiryTime
  • HKLM:\Software\Citrix\DesktopServer\MachineCommandQueues\VdaCommandBufferSizeLimitKB
  • HKLM:\Software\Policies\Citrix\DesktopServer\NameCache\NameRefreshExponentialBackoffMaximumMins
  • HKLM:\Software\Policies\Citrix\DesktopServer\NameCache\NameRefreshMaximumPeriodSecs
  • HKLM:\Software\Citrix\DesktopServer\NameCache\NameRefreshExponentialBackoffMaximumMins
  • HKLM:\Software\Citrix\DesktopServer\NameCache\NameRefreshMaximumPeriodSecs
  • HKLM:\Software\Citrix\Broker\Service\State\XmlServiceKeyAuth\RequireXmlServiceKeyForNFuse
  • HKLM:\Software\Citrix\Broker\Service\State\XmlServiceKeyAuth\RequireXmlServiceKeyForSta
  • HKLM:\Software\Citrix\Broker\Service\State\XmlServiceKeyAuth\XmlServiceKey1
  • HKLM:\Software\Citrix\Broker\Service\State\XmlServiceKeyAuth\XmlServiceKey2
  • HKLM:\Software\Policies\Citrix\DesktopServer\DisableGetPasswordExpiryInfo
  • HKLM:\Software\Policies\Citrix\DesktopServer\LocalXmlAuthHeaderAllowedDelaySecs
  • HKLM:\Software\Policies\Citrix\DesktopServer\StableServerFarmDataCachePeriodSecs
  • HKLM:\Software\Policies\Citrix\DesktopServer\UnstableServerFarmDataCachePeriodSecs
  • HKLM:\Software\Policies\Citrix\DesktopServer\UseForwardedHeaderForSFAddress
  • HKLM:\Software\Policies\Citrix\DesktopServer\XmlAuthHeaderTimeoutMs
  • HKLM:\Software\Policies\Citrix\DesktopServer\XmlUserLookupTimeoutMs
  • HKLM:\Software\Citrix\DesktopServer\DisableGetPasswordExpiryInfo
  • HKLM:\Software\Citrix\DesktopServer\LocalXmlAuthHeaderAllowedDelaySecs
  • HKLM:\Software\Citrix\DesktopServer\StableServerFarmDataCachePeriodSecs
  • HKLM:\Software\Citrix\DesktopServer\UnstableServerFarmDataCachePeriodSecs
  • HKLM:\Software\Citrix\DesktopServer\UseForwardedHeaderForSFAddress
  • HKLM:\Software\Citrix\DesktopServer\XmlAuthHeaderTimeoutMs
  • HKLM:\Software\Citrix\DesktopServer\XmlUserLookupTimeoutMs
• Added CVAD 2109/7.31 to version list
• Added User policy
  • ICA\Audio\Adaptive audio
• In Function GetControllerRegistryKeys, put the registry keys in the order supplied by Citrix
• In Function GetVDARegistryKeys, sorted the VDA registry key paths in alpha order
• Updated Function ProcessScriptSetup to have better error handling
• Updated the help text
• Updated the ReadMe file

I want to thank WC and CG at Citrix for the sanitized list of Broker registry keys.

You can always find the most current script by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

I am sure I may have missed something, so if I did, please let me know.

You can always find the most current Excel file by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

• Added Computer Policy
  • ICA\Graphics\Dynamic windows preview
  • Profile Management\Enable profile streaming for folders
  • Profile Management\Advanced settings\Enable credential-based access to user stores
  • Profile Management\Advanced settings\Replicate user stores – Paths to replicate a user store
  • Profile Management\File system\Large File Handling List – Files to be created as symbolic links
  • Profile Management\Profile container settings\Enable local caching for profile containers
  • Profile Management\Profile container settings\Folders to exclude in profile container
  • Profile Management\Profile container settings\Folders to include in profile container
  • Workspace Environment Management\Citrix Cloud Connectors
• Added CVAD 2106/7.30 to version list
• Changed the array built for the User policy setting ICA\Printing\Universal printing\Universal printing optimization defaults from splitting on “,” to splitting on “;”
• Changed the processing for the following policy settings. When they are Disabled in the console, the State value is still Enabled. If the State property is Enabled and the Value property is “”, then show the policy setting  as disabled.
  • Profile Management\Basic settings\Migrate user store
  • Profile Management\Basic settings\Path to user store
  • Profile Management\Cross-Platform settings\Path to cross-platform  definitions
  • Profile Management\Cross-Platform settings\Path to cross-platform settings store
  • Profile Management\Log settings\Path to log file
  • Profile Management\Profile handling\Path to the template profile
  • Profile Management\Citrix Virtual Apps Optimization settings\Path to Citrix Virtual Apps optimization definitions:
  • ICA\Multimedia\Browser Content Redirection Proxy Configuration
  • Profile Management\Folder  Redirection\AppData(Roaming)\AppData(Roaming) path
  • Profile Management\Folder Redirection\Contacts\Contacts path
  • Profile Management\Folder Redirection\Desktop\Desktop path
  • Profile Management\Folder Redirection\Documents\Documents path
  • Profile Management\Folder Redirection\Downloads\Downloads path
  • Profile Management\Folder Redirection\Favorites\Favorites path
  • Profile Management\Folder Redirection\Links\Links path
  • Profile Management\Folder Redirection\Music\Music path
  • Profile Management\Folder Redirection\Pictures\Pictures path
  • Profile Management\Folder Redirection\Saved Games\Saved Games path
  • Profile Management\Folder Redirection\Searches\Searches path
  • Profile Management\Folder Redirection\Start Menu\Start Menu path
  • Profile Management\Folder Redirection\Videos\Videos path
• Changed the way the array was built and processed for ICA\Multi-Stream Connections\Multi-Port Policy\CGP default port and CGP default port priority
• Cleaned up text output for policy settings
• Fixed numerous typos in Switch statements for policy settings
• Fixed wrong variable name used to create array for Virtual Delivery Agent Settings\Monitoring\List of applications excluded from failure monitoring
• For Computer policy setting ICA\Keyboard and IME\Client keyboard layout synchronization and IME improvement, add Disabled option to Switch statement
• Renamed Computer policy
  • ICA\Virtual channel white list to ICA\Virtual channel allow list
  • ICA\WebSockets\WebSocket connections to ICA\WebSockets\WebSockets connections
• Update the Site version Switch statement for version 7.30/2106

You can always find the most current script by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

I am sure I may have missed something, so if I did, please let me know.

You can always find the most current Excel file by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

Version 2.42 12-Apr-2021

• Added CVAD 2106/7.30 to version list
• Changed how the Session Recording Status was obtained
• Fixed four typos of “Unabled” to “Unable”
• For the following three Delivery Group properties, if there is no data or value, use “-” to match all the other empty values
  • All connections not through NetScaler Gateway
  • Connections through NetScaler Gateway
  • Restrict to tag
• In Machine details added
  • Draining Until Shutdown (Multi-session only)
  • Last Connection Failure reason
    • “None” = “None”
    • “SessionPreparation” = “Session preparation”
    • “RegistrationTimeout” = “Registration timeout”
    • “ConnectionTimeout” = “Connection Timeout”
    • “Licensing” = “Licensing”
    • “Ticketing” = “Ticketing”
    • “Other” = “Other”
  • Maintenance Mode reason
    • “Administrator” = “Machine was manually placed in maintenance mode by an administrator”
    • “MaxFailedRegistrations” = “Machine was automatically placed in maintenance mode due to reaching the maximum failed registration limit”
    • “None” = “Machine is not in maintenance mode”
  • Will Shutdown After Use reason
    • “None” = “Machine will not shutdown after use”
    • “ResetDiskImage” = “Machine will shutdown after use to reset its disk image”
    • “ScheduledNaturalReboot” = “Machine will shutdown after use as part of the scheduled natural reboot process”
    • “OnDemandNaturalReboot” = “Machine will shutdown after use as part of an on-demand natural reboot process”
• In Machine Details, for MCS catalogs, if the Provisioning Scheme doesn’t exist, set the $MasterVM variable to “Unable to retrieve details”
• To get the Master VM for an Azure Catalog, add searching for “.manageddisk”
  • Also added “.snapshot” which was found in customer data
• Updated the text explanations for:
  • Machine Fault State
    • “None” = “No fault; machine is healthy”
    • “FailedToStart” = “Last power-on operation for machine failed”
    • “StuckOnBoot” = “Machine does not seem to have booted following power on”
    • “Unregistered” = “Machine has failed to register within expected period, or its registration has been rejected”
    • “MaxCapacity” = “Machine is reporting itself at maximum capacity”
  • Machine Scheduled Reboot
    • “None” = “No reboot is scheduled”
    • “Pending” = “Machine is awaiting reboot but is available for us”
    • “Draining” = “Machine is awaiting reboot and is unavailable for new sessions; reconnections to existing connections are still allowed, however”
    • “InProgress” = “Machine is actively undergoing a scheduled reboot”
    • “Natural” = “Natural reboot in progress. Machine is awaiting a restart”
• When testing a session for Session Recording status, add a test for $null -ne $results

You can always find the most current script by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

I am sure I may have missed something, so if I did, please let me know.

You can always find the most current Excel file by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

I am sure I may have missed something, so if I did, please let me know.

You can always find the most current Excel file by going to https://www.carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

Thanks

Webster

Updated 1-Jun-2021: Fixed the images, grammar, and missing text.

Update 13-Sep-2016: The article from Dell that I reference is no longer available. I found a cached copy, saved the relevant information, and put that information in place of the Dell support link.

The SQL database provides the foundation for all configuration information in the CVAD Site. Configuration, Logging, and Monitoring information are stored in the databases. The databases contained within a SQL server infrastructure are crucial to the continuous operation of the CVAD architecture and if it fails, effects ranging from loss of the ability to administer the CVAD site to the inability to connect to CVAD virtual desktops. SQL Server can be made highly available through a number of technologies.

Citrix supports various levels of database high availability for CVAD:

• SQL Server database mirroring
• Using the hypervisor’s high availability features
• SQL Clustering
• AlwaysOn Availability Groups

Those were the preferred order for versions 7.0, 7.1, 7.5, and 7.6. Starting with version 7.7, Citrix changed the order to:

• AlwaysOn Availability Groups
• SQL Server database mirroring
• SQL Clustering
• Using the hypervisor’s high availability features

Beginning with SQL Server 2016, Microsoft offers a new form of AlwaysOn Availability Groups (AAGs) named Basic Availability Groups (BAGs).

Overview of AlwaysOn Availability Groups

What are the differences between AAGs and BAGs?

• BAGs are only supported on SQL Server 2016 Standard Edition
• BAGs cannot be upgraded to AAGs
• A BAG is limited to one database
• You cannot add or remove a replica to an existing BAG
• Replicas can only run SQL Server 2016 Standard Edition (no prior versions)
• No backups on the secondary replica
• No read access on the secondary replica
• Limit of two replicas

There are, as expected, some Microsoft licensing guidelines you should pay attention to. Download the SQL Server 2016 License Guide for detailed licensing information.

The important financial part from page 20 of the license guide:

Failover Basics
For each server licensed with SQL Server 2016 and covered by active SA, customers can run-up to the same number of passive failover instances in a separate, operating system environment to support failover events. A passive SQL Server instance is one that is not serving SQL Server data to clients or running active SQL Server workloads. The passive failover instances can run on a separate server. These may only be used to synchronize with the primary server and otherwise maintain the passive database instance in a warm standby state in order to minimize downtime due to hardware or software failure.
• The secondary server used for failover support does not need to be separately licensed for SQL Server as long as it is truly passive, and the primary SQL Server is covered with active SA.

What this means is that if you have Microsoft SA on your SQL Server 2016 Standard software, the second SQL Server used for the BAG’s replica does not need a separate license if it meets the criteria. I am no Microsoft (or Citrix) license expert so please check with Microsoft licensing if you have any questions.

Citrix tested CVAD 7.9 with SQL Server 2016 Standard Edition Basic Availability Groups and fully supports using the two together.

This article describes, in detail, the process I used to implement BAGs for use with a new CVAD Site.

High-Level Overview

• Create a Windows Failover Cluster
• Give the new cluster object the right to create computer objects in the container or OU the cluster object resides in
• Give the new cluster object the right to create child objects in the DNS forward lookup zone
• Install two independent Microsoft SQL Server 2016 Standard Edition servers using Latin_100_General_CI_AS_KS Collation
• On the first SQL server, install the SQL Management Studio
• Add the second SQL server to the SQL Management Studio
• Create a share for the BAG database seeding
• Enable AlwaysOn Availability Groups on the SQL Server service on both SQL servers
• Create the three databases needed for CVAD
• Do a full backup of the three databases
• Create three BAGs and Listeners
• Verify on the second SQL server that the BAGs have replicated
• Now you are ready for the CVAD Site creation

Create a Windows Failover Cluster

If you plan to create your Windows Failover Cluster using multiple subnets or spanning different physical locations, there are some important considerations. Please read this Microsoft article before you start building such a cluster.

https://blogs.msdn.microsoft.com/sambetts/2014/05/16/building-true-multi-subnet-windows-server-failover-clusters/

From the advice given by several SQL MVPs, I created an OU named SQL2016Cluster that contains the two SQL servers.

On both SQL servers, install the Failover Clustering Feature, as shown in Figure 1.

Add the Failover Clustering management tools, as shown in Figure 2.

Before creating the failover cluster, install all Windows Updates and restart the server.

After the server restarts, log in on the first SQL server, go to Administrative Tools and select Failover Cluster Manager, as shown in Figure 3.

In the middle pane, under Management, select Validate Configuration…, as shown in Figure 4

Click Next, as shown in Figure 5.

Enter the FQDN of the two SQL servers by typing in the names or by clicking Browse and searching for the servers and click Next, as shown in Figure 6.

Select Run all tests and click Next, as shown in Figure 7.

Click Next, as shown in Figure 8.

Validation testing begins, as shown in Figure 9.

Click View Report… and leave Create the cluster now using the validated nodes… selected, as shown in Figure 10.

Analyze the report for warnings and errors. In a lab or small environment, some warnings can be safely ignored. In a production environment, you will need multiple paths to the network. It is also important that both SQL servers have the same Windows Updates.

Click Finish to create the cluster, as shown in Figure 11.

Click Next, as shown in Figure 12.

Enter a Cluster Name, an IP Address, and click Next, as shown in Figure 13.

The Cluster Name is the name of a computer account created in Active Directory and a DNS “A” record is created with the IP address entered. The Cluster Name is used to refer to the cluster instead of using the name of the two SQL servers.

Unselect Add all eligible storage to the cluster and click Next, as shown in Figure 14.

The cluster creation process starts, as shown in Figure 15.

When the cluster creation is complete, click Finish, as shown in Figure 16.

The Failover Cluster Manager console shows the new cluster, as shown in Figure 17.

As shown in Figure 18, the console shows there is no Witness configured for the cluster.

Right-click the Cluster name, select More Actions, and click Configure Cluster Quorum Settings…, as shown in Figure 19

Click Next, as shown in Figure 20.

Select Select the quorum witness and click Next, as shown in Figure 21.

A Basic Availability Group requires two independent Microsoft SQL Server 2016 Standard servers built on top of a Windows Failover Cluster. There is no need for shared storage for the cluster or the two SQL servers. A Windows Failover Cluster requires a Witness to determine if the two nodes of the cluster are online and communicating. For this cluster, a simple file share is used. In a production environment, this file share should be on a highly available server and highly available storage. For this lab, I am using my single domain controller.

Note: If this is a multiple subnet cluster or a cluster spanning different physical locations, make sure the quorum witness is on a third subnet or location.

Select Configure a file share witness and click Next, as shown in Figure 22.

Click Browse, as shown in Figure 23.

Enter the name of the server and click New Shared Folder…, as shown in Figure 24

Dell had a very good article on configuring the file share and NTFS permissions but it has since been removed. Here is the relevant information from the original Dell article:

Quorum File Share Witness

Both NTFS permissions and File Share permissions need to be assigned to the Cluster Host Name Object Account. For permissions, the Cluster Host Name Object is an Active Directory Computer account. Assign both NTFS and File Share identical permissions.

Click on the share permissions and clear out the previous inherited entries and add the following permissions:

Cluster Name Object (CNO) Account – Full Control

SYSTEM – Full Control

SQL Database Engine Service Account – Full Control

Local Server Administrators Group – Full Control

Configure the share as required and click OK, as shown in Figure 25.

Click Yes, as shown in Figure 26.

Click OK, as shown in Figure 27.

Click Next, as shown in Figure 28.

Click Next, as shown in Figure 29.

Click Finish, as shown in Figure 30.

Next, I went to the server with the share to verify Share and NTFS permissions according to the Dell document, as shown in Figures 31 and 32.

Share permissions:

NTFS permissions:

As seen in Figure 33, the Failover Cluster Manager now shows the Witness configured.

Configure Cluster Object

Before continuing, the cluster computer object requires the rights to create computer objects and DNS child objects.

Because I moved my two SQL server computer accounts to a specific OU, the cluster computer account is in the same OU, as shown in Figure 34.

The cluster computer account needs rights to create computer accounts in the Container or OU it resides in. The process of creating the Basic Availability Groups creates computer accounts for the Listeners.

In Active Directory Users and Computers, click View and then Advanced Features, as shown in Figure 35.

Right-click the Container or OU and click Properties, as shown in Figure 36.

Click the Security tab, as shown in Figure 37.

Click Add…, as shown in Figure 38.

Click Object Types…, as shown in Figure 39.

Select Computers and click OK, as shown in Figure 40.

Enter the name of the cluster computer account, click Check Name and click OK, as shown in Figure 41.

Click Advanced, as shown in Figure 42.

Select the cluster computer account and click Edit, as shown in Figure 43.

Scroll down, select Create Computer objects and click OK, as shown in Figure 44.

Click OK, as shown in Figure 45.

Click OK, as shown in Figure 46.

Exit Active Directory Users and Computers, open the DNS Manager, and expand to the domain’s Forward Lookup Zone, as shown in Figure 47. The SQL cluster computer account needs rights to create DNS records. The process of creating the Basic Availability Groups creates DNS “A” records for the Listeners.

Right-click the domain’s zone and click Properties, as shown in Figure 48.

Click the Security tab, as shown in Figure 49.

Click Add…, as shown in Figure 50.

Click Object Types…, as shown in Figure 51

Select Computers and click OK, as shown in Figure 52.

Enter the name of the SQL cluster computer account, click Check Names, and click OK, as shown in Figure 53.

Select the SQL cluster computer account, select Allow for Create all child objects and click OK, as shown in Figure 54.

Exit the DNS Manager.

Install Microsoft SQL Server 2016 Standard

I created two SQL-related user accounts in AD. A service account, svc_sql, that is used for the SQL services and sqldba, that is a full SQL sysadmin and local admin. I created a GPO Preference to place the sqldba account in the local administrators group.

On both SQL server VMs, mount the ISO for SQL Server 2016 Standard.
When the SQL Server Installation Center appears, click Installation, as shown in Figure 55.

Click New SQL Server stand-alone installation or add features to an existing installation, as shown in Figure 56.

Click Next, as shown in Figure 57.

Note: This step could be different for you as I am using MSDN media for my lab. I believe the commercial version of the SQL Server installation may have you select the licensing method.

Select I accept the license terms and click Next, as shown in Figure 58.

Select Use Microsoft Update to check for updates and click Next, as shown in Figure 59.

Resolve any Warning and Failures and click Next, as shown in Figure 60.

Select Database Engine Service and SQL Server Replication and click Next, as shown in Figure 61.

Do not (and you cannot) put any of the root directories on the cluster shared drive.

Click Next, as shown in Figure 62.

Enter the SQL service account name and password and click the Collation tab, as shown in Figure 63.

Click Customize…, as shown in Figure 64.

Select Windows collation designator and sort order, Latin1_General_100 for Collation designator, Accent-sensitive, Kana-sensitive, and click OK, as shown in Figure 65.

The Citrix recommended SQL collation of Latin1_General_100_CI_AS_KS is created by the previous options. Click Next, as shown in Figure 66.

https://docs.citrix.com/en-us/xenapp-and-xendesktop/7-9/technical-overview/databases.html

“Use a collation that ends with “_CI_AS_KS”. Citrix recommends using a collation that ends with “_100_CI_AS_KS”.”

Select Windows authentication mode and click Add Current User, as shown in Figure 67.

Click Add…, add the sqldba account and click Next, as shown in Figure 68.

Click Install, as shown in Figure 69.

As shown in Figure 70, the installation of SQL Server 2016 Standard begins.

After SQL Server installation completes, click Close, as shown in Figure 71.

On the second SQL Server, exit the SQL Server Installation Center and eject the ISO.

On the first SQL Server, select Install SQL Server Management Tools, as shown in Figure 72.

Download and install the SQL Server Management Studio, as shown in Figure 73.

Exit your Internet browser and the SQL Server Installation Center on the first SQL Server. Eject the SQL Server ISO.

On both SQL servers, start SQL Server 2016 Configuration Manager, as shown in Figure 74.

Click SQL Server Services, then right-click SQL Server (instance name) and click Properties, as shown in Figure 75.

Click the AlwaysOn High Availability tab, as shown in Figure 76.

Select Enable AlwaysOn Availability Group and click OK, as shown in Figure 77.

Right-click SQL Server (instance name) and click Restart, as shown in Figure 78.

After the service restarts, exit the SQL Server 2016 Configuration Manager.

Install all Windows Updates on both SQL Servers.

Create Databases for CVAD

CVAD uses three databases: Site, Logging, and Monitoring. Each is created and configured the same way. The only difference is the name.

Creating the Basic Availability Groups requires a network file share for the initial data synchronization. I created a folder and share name SQL2016Share with default Share and NTFS permissions.

On the first SQL Server, launch SQL Server Management Studio, as shown in Figure 79.

Click Connect, as shown in Figure 80.

Right-click Databases and click New Database…, as shown in Figure 81.

Enter a Database name, as shown in Figure 82.

Click Options, set Recovery model to Full, scroll down in Other options, and set Is Read Committed Snapshot On to True and click OK, as shown in Figure 83.

https://docs.citrix.com/en-us/xenapp-and-xendesktop/7-9/technical-overview/databases.html

“For optimum performance, enable the SQL Server Read-Committed Snapshot. For details, see CTX 137161.”

Expand Databases, right-click the new database, click Tasks, and click Backup…, as shown in Figure 84.

Before the Basic Availability Group is created, the database must have a full backup completed.

Make sure Backup type is set to Full and click OK, as shown in Figure 85.

Click OK, as shown in Figure 86.

Repeat these steps to create and back up the Logging and Monitoring databases.

Now that all three databases are created and backed up, the Basic Availability Groups can be created.

Right-click AlwaysOn High Availability and click New Availability Group Wizard…, as shown in Figure 87

Click Next, as shown in Figure 88.

Enter an Availability group name and click Next, as shown in Figure 89.

Select the one database to include in the availability group and click Next, as shown in Figure 90.

Click Add Replica…, as shown in Figure 91

Enter the name of the second SQL server and click Connect, as shown in Figure 92.

The second SQL server is added as a replica. Click the Listener tab, as shown in Figure 93.

Expand the size of the wizard, select Create an availability group listener, enter a Listener DNS Name, a Port and click Add…, as shown in Figure 94

Note: The Listener DNS Name is limited to 15 characters. The Listener name is needed when the Site is created in Citrix Studio.

Enter a unique IP address for this Listener and click OK, as shown in Figure 95.

Note: If this is a multiple subnet cluster, enter an IP address for both subnets.

Click Next, as shown in Figure 96.

Select Full, enter a file share that the replicas can use for the initial data synchronization, and click Next, as shown in Figure 97.

Note: If this is a multiple subnet cluster or a cluster spanning different physical locations, make sure the file share is on a third subnet or location.

If there are any errors reported, resolve the errors and click Next, as shown in Figure 98.

Click Finish, as shown in Figure 99.

As shown in Figure 100, the Basic Availability Group is created.

Click Close, as shown in Figure 101.

Repeat the steps to create Basic Availability Groups for the other two databases.

As shown in Figure 102, all three databases and Basic Availability Groups show on the first SQL server.

As shown in Figure 103, adding the second SQL server to Management Studio shows the databases and Basic Availability Groups in the Synchronizing and Secondary states.

Create CVAD Site

After installing CVAD, select Launch Studio and click Finish, as shown in Figure 104.

Click Deliver application and desktops to your users, as shown in Figure 105.

Enter a Site name and click Next, as shown in Figure 106.

As shown in Figures 107 through 110. Enter the database names created earlier. For the location, enter the name of each Listener that matches the database. If there are additional Controllers for this Site, click Select, enter the additional Controller FQDNs and click Next.

If the logon account does not have rights to create databases on the SQL server, you are prompted for credentials for each of the three Listeners, as shown in Figures 11 through 113.

Continue with the rest of the Configuration Wizard steps.

On the Summary step, verify the information and if correct, click Finish, as shown in Figure 114.

Once the Site creation process is complete, select the Configuration node in Studio, as shown in Figure 115.

You can see that the three databases with the Listener names.

In my opinion, it is far easier to set up the databases, BAGs, and Listeners before configuring the Site than to try to reconfigure the Site to use BAGs and Listeners later.

Thanks

Webster