It has been an honor and a privilege to provide the XenApp/XenDesktop/CVAD series of scripts to you since 30-Sep-2011.

None of those scripts would have happened without the help of Michael B. Smith, James Rankin, and Jarian Gibson. None of the scripts would have been released without the pressure, I mean encouragement, of Jarian.

• Added Broker Registry Keys:
  • HKLM:\Software\Policies\Citrix\DesktopServer\AssignmentPolicyMaxDesktops
    • Type: int
    • Default: 5
    • Info: Minimum=1, Maximum=100
    • Summary: The maximum value accepted for the MaxDesktops parameter of the New/Set-BrokerAssignmentPolicyRule cmdlets. This is limited here because enumeration creates MaxDesktops AOFU resources – which if inadvertently set to a very large value impacts enumeration performance and also consumes large amounts of memory.
  • HKLM:\Software\Policies\Citrix\DesktopServer\SetSiteDataPeriodSecs
    • Type: int
    • Default: 600
    • Info: Seconds, Minimum=30
    • Summary: The period in seconds for polling for updates to the site data.
  • HKLM:\Software\Citrix\DesktopServer\LHC\OutageSummaryEventIntervalSecs
    • Type: int
    • Default: 120
    • Info: Seconds Minimum=60
    • Summary: The interval at which LHC would refresh the outage summary event.
  • HKLM:\Software\Citrix\Broker\Service\State\LHC\PeerStatus
    • Type: string
    • Default:
    • Info:
    • Summary: The status information of peers participating in election process.
• Added Computer policy
  • Profile Management\Advanced settings\Disable defragmentation for VHD disk compaction
  • Profile Management\Advanced settings\Enable user-level policy settings
  • Profile Management\Advanced settings\Set priority order for user groups
  • VDA Data Collection\Security\Clipboard place metadata collection for Security monitoring
• In Function OutputMachines, for ProvisioningType -eq “MCS” added:
  • Device Management Type – This can be Intune, IntuneWithCitrixTags, or None
  • Identity Type – This can be ActiveDirectory, AzureAD, HybridAzureAD, or Workgroup
  • Master Image VM Date – The date and time when the VM snapshot copy used by the provisioning scheme was made
  • MDM Enrollment – This can be Intune, IntuneWithCitrixTags, or None
  • Prepared Image Definition Name – The name for the image definition used for the provisioning scheme
  • Prepared Image Version Number – The version number for the image version used for the provisioning scheme
  • Windows Activation Type – Windows Activation Type set on the Master Image which has a mapping with the Provisioning Scheme
• In Function OutputMachines:
  • Made the code consistent between the Daas and CVAD scripts
  • Added missing fields that were in one script but not the other
  • Added the Machine data metadatamap keys output that was in the Word output but not in the Text and HTML output
  • Added Custom Properties For VMware
    • FolderId
  • Renamed “Master VM” to “Master Image VM”
• Renamed Computer policy
  • VDA Data Collection\VDA data collection for Performance Analytics to VDA Data Collection\VDA data collection for Analytics
• Updated for CVAD 2305/7.38

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 please let me know if I did.

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

Computer Multi-session Settings:

• Added: Clipboard place metadata collection for Security monitoring – Enabled
• Added: Disable defragmentation for VHD disk compaction – Disabled
• Added: Enable user-level policy settings – Disabled
• Added: Set priority order for user groups – Disabled
• Modified: Original – VDA data collection for Performance Analytics – Prohibited
  • • •  New – VDA data collection for Analytics – Enabled

Computer Single-session Settings:

• Added: Clipboard place metadata collection for Security monitoring – Enabled
• Added: Disable defragmentation for VHD disk compaction – Disabled
• Added: Enable user-level policy settings – Disabled
• Added: Set priority order for user groups – Disabled
• Modified: Original – VDA data collection for Performance Analytics – Prohibited
  • • •  New – VDA data collection for Analytics – Enabled

User Multi-session Settings:

• I didn’t find anything

User Single-session Settings:

• Removed: Allow file transfer between desktop and client

Thanks

Webster

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.

On May 24, 2021, I published the Building Webster’s Lab V2 article series that used vSphere/vCenter 7.0 original release and XenServer 8.2.0.

This is a follow-up on building the lab with vSphere/vCenter 7.0U3L and XenServer 8.2.1.

Why didn’t I use vSphere/vCenter 8? Neither my hardware nor Synology units support vSphere 8. There is a change I can make to an install file to bypass the hardware compatibility check, but I would rather not risk it. It took Synology a long time to add vSphere 7 support, so I have no idea how long before they add support for vSphere 8.

I need to rebuild the lab because something terrible happened after powering down the lab for an extended weekend. When I powered on the lab after returning to the lab the following Monday, the vSphere servers would not connect to local storage and NFS storage, nor connect to any switches or networking.

Read the rest in the PDF…

You can always find the most current PDF 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\GetEntitlementTypePeriodHours
    • Type: int
    • Default: 24
    • Info: Hours Minimum=1
    • Summary: The time between checks in hours for GetEntitlementType check
  • HKLM:\Software\Policies\Citrix\DesktopServer\LaunchResumeRetryPeriodSec
    • Type: int
    • Default: 15
    • Info: Seconds Minimum=0
    • Summary: Period after which users of the XML service are hinted to retry  launches that are delayed due to a resume request just being sent to that VDA  to satisfy launch.
  • HKLM:\Software\Policies\Citrix\DesktopServer\ResourceLimitRetryDelaySec s
    • Type: int
    • Default: 15
    • Info: Seconds Minimum=2
    • Summary: Interval between command batch retries when a resource limit appears to have been reached.
  • HKLM:\Software\Policies\Citrix\DesktopServer\IsFirstConfigSyncSuccess
    • Type: bool
    • Default: false
    • Info:
    • Summary: Indicates on the machine where the secondary broker resides that the secondary Broker successfully completed first config sync. An important function of this value is to ensure that if services are re-installed for any reason, the config sync ensures that we have the latest Lhc database.
  • HKLM:\Software\Policies\Citrix\DesktopServer\LeaderInHAMode
    • Type: bool
    • Default: false
    • Info:
    • Summary: Indicates whether the leader connector is in outage mode.
  • HKLM:\Software\Policies\Citrix\DesktopServer\AlwaysRefreshNamesOnRegistration
    • Type: bool
    • Default: false
    • Info:
    • Summary: Forces machine’s cached name entries to be updated each time it  registers. By default names are only updated by normal cache refresh logic.
  • HKLM:\Software\Policies\Citrix\DesktopServer\FeatureTelemetryCollectionPeriodSec
    • Type: int
    • Default: 21600
    • Info: Seconds Minimum=1
    • Summary: Period between instances of reporting of feature use.
  • HKLM:\Software\Policies\Citrix\DesktopServer\NFuseAppDataBulkLookupThreshold
    • Type: int
    • Default: 2
    • Info: Minimum=0
    • Summary: Defines the threshold number of resources in an AppData transaction above which a bulk lookup mechanism is used. For small numbers of resources the higher setup cost outweighs the improved efficiency.
• Added Computer policy
  • ICA\HDX Direct
  • Profile Management\Advanced settings\Free space ration (%)
  • Profile Management\Advanced settings\Number of logoffs
  • Profile Management\App access control
  • Profile Management\Basic settings\Active write back on session lock and disconnection
  • Profile Management\Profile container settings\Enable VHD disk compaction
  • User Personalization Layer\User Layer Exclusions
• Added User policy
  • ICA\File Redirection\Download file for Citrix Workspace app for Chrome  OS/HTML5
  • ICA\File Redirection\File transfer for Citrix Workspace app for Chrome  OS/HTML5
  • ICA\File Redirection\Upload file for Citrix Workspace app for Chrome  OS/HTML5
• In Function GetRolePermissions:
  • Added new permissions
    • Image_Create
    • Image_Delete
    • Image_EditProperties
    • Image_Read
• 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:
  • update the list of Hypervisor Plugins
  • 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 2303/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

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

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: Active write back on session lock and disconnection – Disabled
• Added: App access control – Disabled
• Added: Enable VHD disk compaction – Disabled
• Added: Free space ratio (%) – 20
• Added: HDX Direct – Prohibited
• Modified: Multi-Stream virtual channel stream assignment – Removed the App Flow Stream Number 2
• Added: Number of logoffs – 5

Computer Single-session Settings:

• Added: Active write back on session lock and disconnection – Disabled
• Added: App access control – Disabled
• Added: Enable VHD disk compaction – Disabled
• Added: HDX Direct – Prohibited
• Modified: Multi-Stream virtual channel stream assignment – Removed the App Flow Stream Number 2
• Added: Number of logoffs – 5
• Added: User Layer Exclusions – Blank

User Multi-session Settings:

• Removed: Download file from desktop
• Added: Download file for Citrix Workspace app for Chrome OS/HTML5 – Allowed
• Added: File transfer for Citrix Workspace app for Chrome OS/HTML5 – Allowed
• Removed: Upload file to desktop
• Added: Upload file for Citrix Workspace app for Chrome OS/HTML5 – Allowed
• Removed: USB device redirection rules (Version 2)

User Single-session Settings:

• Removed: Download file from desktop
• Added: Download file for Citrix Workspace app for Chrome OS/HTML5 – Allowed
• Added: File transfer for Citrix Workspace app for Chrome OS/HTML5 – Allowed
• Removed: Upload file to desktop
• Added: Upload file for Citrix Workspace app for Chrome OS/HTML5 – Allowed
• Removed: USB device redirection rules (Version 2)

Thanks

Webster

• Added to Function OutputMachines, the Catalog’s reboot schedule if one exists
  • https://docs.citrix.com/en-us/citrix-virtual-apps-desktops/install-configure/machine-catalogs-manage.html#update-the-catalog
• For Provisioning Custom Properties, added two Azure properties I hadn’t noticed before:
  • https://developer-docs.citrix.com/projects/citrix-virtual-apps-desktops-sdk/en/latest/MachineCreation/about_Prov_CustomProperties/
  • PageFileDiskDriveLetterOverride
  • StorageTypeAtShutdown
• In Function GetRolePermissions:
  • Added new permissions
    • AppLib_PackageDiscovery_Create
    • AppLib_PackageDiscoveryProfile_Create
    • AppLib_PackageDiscoveryProfile_Remove
    • DesktopGroup_CreateFolder
    • DesktopGroup_EditFolder
    • DesktopGroup_MoveFolder
    • DesktopGroup_RemoveFolder
    • Catalog_CreateFolder
    • Catalog_EditFolder
    • Catalog_MoveFolder
    • Catalog_RemoveFolder
    • PolicySets_AddScope
    • PolicySets_Manage
    • PolicySets_Read
    • PolicySets_RemoveScope
    • Setting_Edit
    • Setting_Read
• In Function OutputMachineDetails, fixed the missing $WillShutdownAfterUseReason variable
• In Function OutputMachines, fixed the misplaced code for image history and additional data
• Updated for CVAD 2209/7.35 and CVAD 2212/7.36

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 please let me know if I did.

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 found nothing

Computer Single-session Settings:

• I found nothing

User Multi-session Settings:

• Added: Client USB device redirection rules (Version 2)

User Single-session Settings:

• Added: Client USB device redirection rules (Version 2)

The documentation for CVAD 2212 states: “This release includes three new policy settings to manage USB device selection and auto-connection user experience preferences through Citrix Studio.”

I could only find the one policy setting listed above. I emailed a couple of my Citrix contacts, and after waiting three weeks for responses, I gave up. I guess the documentation is wrong.

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
• Added User policy
  • ICA\Printing\Client Printers\Client printer names
  • ICA\Server Limits\Session connection timer – Multi-session
  • ICA\Server Limits\Session connection timer interval (minutes) – Multi-session
  • ICA\Server Limits\Session idle timer – Multi-session
  • ICA\Server Limits\Session idle timer interval (minutes) – Multi-session

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

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

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

• Removed: Duplicate policy setting for Enable concurrent session support for Outlook search data roaming with a default value of 2.
• Added: Files to exclude from the shared store – Disabled
• Added: Files to include in the shared store for deduplication – Disabled
• Added: Maximum number of VHDX disks for storing Outlook OST files – 2

Computer Single-session Settings:

• Removed the duplicate policy setting for Enable concurrent session support for Outlook search data roaming with a default value of 2.
• Added: Files to exclude from the shared store – Disabled
• Added: Files to include in the shared store for deduplication – Disabled
• Added: Maximum number of VHDX disks for storing Outlook OST files – 2

User Multi-session Settings:

• Added: Client printer names – Standard printer names
• Added: Session connection timer – Multi-session – Disabled
• Added: Session connection timer interval – Multi-session – 1440 minutes
• Added: Session idle timer – Multi-session – Disabled
• Added: Session idle time interval – Multi-session – 1440 minutes

User Single-session Settings:

• Added: Client printer names – Standard printer names

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

• 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

• Added support for Minimum Catalog Level 2206 (L7_34)

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 Key:
  • HKLM:\Software\Policies\Citrix\DesktopServer\MaxCompletedActionsToPurge
    • Type: int
    • Default: 700
    • Info: Minimum=100
    • Summary: Maximum completed power actions to purge in a single batch. This limit avoids timeouts/failures if for some reason huge numbers of actions have accumulated that need to be deleted.
    • The default value allows for about 2 million actions to be purged per day if needed (700 every 30 seconds).
  • HKLM:\Software\Policies\Citrix\DesktopServer\ParallelPowerStateReadMaxThreads
    • Type: int
    • Default: 5
    • Info: Minimum=0, Maximum=100
    • Summary: Maximum number of threads to use when reading multiple machine states from the HCL in parallel.
    • Note: (1) Value does not apply to HCL plugins that support bulk power state operations (e.g. Azure).
    • (2) For Cloud, value is capped at 1 as the RemoteHCL does not support
    • multiple concurrent operations, thus there’s no advantage in using multiple threads.
    • (3) A value of zero forces use of a simple loop for all such operations. This puts all machine state reads and database writes into a single thread. This uses the minimum resources but at the expense of throughput, and delayed database updates.
• Added Computer policy
  • ICA\Printing\Universal Print Server\Universal Print Server web service (HTTP/SOAP) connect timeout (Seconds)
  • ICA\Printing\Universal Print Server\Universal Print Server web service (HTTP/SOAP) receive timeout (Seconds)
  • ICA\Printing\Universal Print Server\Universal Print Server web service (HTTP/SOAP) send timeout (Seconds)
  • Profile Management\Advanced settings\Automatically reattach VHDX disks in sessions
  • Profile Management\Advanced settings\Enable asynchronous processing for user Group Policy on logon
  • Profile Management\Advanced settings\Enable concurrent session support for Outlook search data roaming
  • Profile Management\Advanced settings\Enable concurrent session support for Outlook search data roaming [two different settings with the same name]
• Added User policy
  • ICA\Server Limits\Disconnected session timer – Multi-session
  • ICA\Server Limits\Disconnected session timer interval (minutes) – Multi-session
  • ICA\USB Devices\Allow existing USB devices to be automatically connected
  • ICA\USB Devices\Allow newly arrived USB devices to be automatically connected
  • ICA\USB devices\USB device redirection rules (Version 2)
• Added VDA Registry Key:
  • HKLM:\Software\Citrix\Citrix Virtual Desktop Agent\ShellBridge
  • https://docs.citrix.com/en-us/citrix-virtual-apps-desktops/whats-new/fixed-issues.html#vda-for-single-session-os
• 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”.
  • Also fixed a bug where if unable to connect to the SQL server, that error was
  • not handled and many variables were then not defined
• In Function GetRolePermissions:
  • Added new permissions
    • ApplicationGroup_CreateFolder
    • ApplicationGroup_EditFolder
    • ApplicationGroup_MoveFolder
    • ApplicationGroup_RemoveFolder
    • AutoTagRule_Create
    • AutoTagRule_Delete
    • AutoTagRule_Edit
    • AutoTagRule_Read
    • VdaUpgrade_CatalogManage
    • VdaUpgrade_MachineManage
• In Function OutputMachines, fix the headings and output for Text
  • Added error check to verify that the variables $TempDiskCacheSize and $TempMemoryCacheSize exist before using them
  • Added the catalog’s custom properties for the Provisioning Scheme
    • Custom Properties For Azure
      • DedicatedHostGroupId
      • DiskEncryptionSetId
      • EnableIntuneEnroll
      • IdentityDiskStorageType
      • InitialPageFileSizeInMB
      • LicenseType
      • MachinesPerStorageAccount
      • MaxPageFileSizeInMB
      • OsType
      • PageFileDiskDriveLetter
      • PersistOsDisk
      • PersistVm
      • PersistWBC
      • ResourceGroups
      • SchemaVersion
      • SharedImageGalleryReplicaMaximum
      • SharedImageGalleryReplicaRatio
      • SharedImageGalleryStorageAccountType (not documented but found in testing)
      • StorageAccountsPerResourceGroup
      • StorageAccountType
      • StorageType
      • UseEphemeralOsDisk
      • UseManagedDisks
      • UseSharedImageGallery
      • UseTempDiskForWBC
      • WBCDiskStorageType
      • Zones
    • Custom Properties For Aws
      • AwsCaptureInstanceProperties
      • AwsOperationalResourcesTagging
    • Custom Properties For Gcp
      • CatalogZones
      • CryptoKeyId
      • IdentityDiskStorageType
      • PersistOsDisk
      • PersistWBC
      • StorageType
      • WBCDiskStorageType
  • Added Image History for the catalog’s Provisioning Scheme
    • Provisioning Scheme Name
    • Date
    • Master Image VM
    • Master Image Note
    • Functional Level
    • Image Status
• In Function OutputSiteSettings, add the following items:
  • Bypass Authentication for Cached Resources
    • Allows client to display cached resources without authentication
  • Credential Forwarding to Cloud Allowed
    • The indicator that whether the Connector is allowed to forward user credentials to cloud
  • Default Reuse Machines Without Shutdown In Outage
    • The default ReuseMachinesWithoutShutdownInOutage used for new desktop groups when no explicit value is provided
  • Delete Resource Leases on Logoff
    • Forces client to delete all leases on explicit logoff
  • Resource Lease Validity Period in Days
    • Validity period for a lease
  • Resource Leasing Enabled
    • Enables lease syncing on client
  • Telemetry Headless Launch Enabled
    • Enables client to perform headless telemetry launches
  • Telemetry Launch Minimum Time Interval in Minutes
    • Configures minimum time interval (in minutes) between headless telemetry launches
  • Telemetry Launch Shadow Delay in Minutes
    • Configures delay (in minutes) between ICA-HDX launch and headless telemetry launch
  • Removed “Is Secondary Broker”, as that is an internal Citrix setting
• 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 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