PVS – Carl Webster

Citrix Provisioning Services 7.x Documentation Script Update Version 6.07

Carl Webster — Mon, 17 Apr 2023 17:42:33 +0000

Version 6.07 17-Apr-2023

Added new Farm properties introduced in 2303, SetupType and CloudSetupActive
- If(SetupType -eq 1 -and CloudSetupActive -eq $True )
- {
  - “Farm is in cloud setup and all PVS servers have updated to cloud mode”
- }
- ElseIf(SetupType -eq 1 -and CloudSetupActive -eq $False )
- {
  - “Farm is in cloud setup and all PVS servers have not updated to cloud mode”
- }
- ElseIf(SetupType -eq 0)
- {
  - “Farm is in on-premises mode”
- }
For Text output, fixed some formatting and alignment issues
In Function OutputSite:
- If SetupType is 1 (Cloud), output the Cloud Customer ID and Name in the Licensing section
- Added two new Virtual Hosting Pool connection types added in 2303:
  - 4 = Azure
  - 5 = Google Cloud Platform
- Notes:
  - You must run the PVS server and console in Azure to see Azure-specific options.
  - You must run the PVS server and console in GCP to see GCP-specific options.
  - You cannot stream to Azure or GCP from On-premises, for example.
  - Citrix only supports creating PVS targets in Azure or GCP as part of streaming CVAD catalog VDAs.
  - Citrix only supports creating virtual hosting pool records for Azure and GCP from a CVAD Hosting unit as part of the CVAD Setup Wizard.

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

Citrix Provisioning Services Health Check Script Update Version 2.03

Carl Webster — Mon, 17 Apr 2023 17:23:58 +0000

Version 2.03 17-Apr-2023

Added new Farm properties introduced in 2303, SetupType and CloudSetupActive
- If(SetupType -eq 1 -and CloudSetupActive -eq $True )
- {
  - “Farm is in cloud setup and all PVS servers have updated to cloud mode”
- }
- ElseIf(SetupType -eq 1 -and CloudSetupActive -eq $False )
- {
  - “Farm is in cloud setup and all PVS servers have not updated to cloud mode”
- }
- ElseIf(SetupType -eq 0)
- {
  - “Farm is in on-premises mode”
- }
In Function OutputSite:
- If SetupType is 1 (Cloud), output the Cloud Customer ID and Name in the Licensing section
Renamed transcript log file from PVSHealthCheckScriptTranscript to PVSHealthCheckV2ScriptTranscript
Renamed script errors file from PVSHealthCheckScriptErrors to PVSHealthCheckV2ScriptErrors
Renamed script info file from PVSInventoryScriptInfo to PVSHealthCheckV2ScriptInfo
Updated the ReadMe file
Updated the help text

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

Citrix Provisioning Services Health Check Script Update Version 1.27

Carl Webster — Mon, 17 Apr 2023 17:10:08 +0000

Version 1.27 17-Apr-2023

Added new Farm properties introduced in 2303, SetupType and CloudSetupActive
- If(SetupType -eq 1 -and CloudSetupActive -eq $True )
- {
  - “Farm is in cloud setup and all PVS servers have updated to cloud mode”
- }
- ElseIf(SetupType -eq 1 -and CloudSetupActive -eq $False )
- {
  - “Farm is in cloud setup and all PVS servers have not updated to cloud mode”
- }
- ElseIf(SetupType -eq 0)
- {
  - “Farm is in on-premises mode”
- }
In Function OutputSite:
- If SetupType is 1 (Cloud), output the Cloud Customer ID and Name in the Licensing section

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

Citrix Provisioning Services Health Check Script Update Version 2.02

Carl Webster — Tue, 26 Apr 2022 09:35:58 +0000

Version 2.02 26-Apr-2022

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

Citrix Provisioning Services Health Check Script Update Version 1.26

Carl Webster — Tue, 26 Apr 2022 09:17:02 +0000

Version 1.26 26-Apr-2022

Change all Get-WMIObject to Get-CIMInstance
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

Citrix “Old” Provisioning Services Documentation Script Update 4.34

Carl Webster — Mon, 25 Apr 2022 15:43:08 +0000

Version 4.34 25-Apr-2022

Change all Get-WMIObject to Get-CIMInstance
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

Citrix Provisioning Services 7.x Documentation Script Update Version 6.06

Carl Webster — Mon, 25 Apr 2022 12:02:24 +0000

Version 6.06 25-Apr-2022

Change all Get-WMIObject to Get-CIMInstance
General code cleanup
In Function OutputNicItem, fixed several issues with DHCP data
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

Citrix Provisioning Services 7.x Documentation Script Update Version 6.05

Carl Webster — Tue, 29 Mar 2022 13:01:00 +0000

Version 6.05 29-Mar-2022

Fixed bug in Function DeviceStatus where I used the wrong device property to check for the active status
In Function DeviceStatus, added the following BDM properties:
- BDM Boot type: Use PXE boot when set to 0, BDM (Bios) boot when set to 1, and BDM (UEFI) boot when set to 2. Default=0
- BDM Boot format: 1 use VHD for BDMboot, 2 use ISO, 3 use USB. Default=0
- BDM created: Timestamp when BDM device was created Default=Empty
- BDM updated: Timestamp of the last BDM boot disk update. Default=Empty
Removed Function Check-NeededPSSnapins
Some general code cleanup

Thanks to R. Davis and K. Johansen from the World of EUC Slack for taking the time to test.

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

Citrix Provisioning Services Health Check Script Update Version 2.01

Carl Webster — Tue, 29 Mar 2022 12:53:54 +0000

Version 2.01 29-Mar-2022

Fixed bug in Function DeviceStatus where I used the wrong device property to check for the active status
Some general code cleanup

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

Citrix Provisioning Services Health Check Script Update Version 2.00

Carl Webster — Mon, 14 Mar 2022 09:43:28 +0000

Image with me, please. Either you are a new Citrix admin or a consultant tasked with updating/upgrading a Citrix PVS 6.x or 7.x Farm with multiple servers. What do you use to verify that all the servers have:

The same Network Advanced Server items
The same settings from the configuration wizard
The same Server Bootstrap settings
The same DisableTaskOffload registry key value
PVS services configured properly
PVS services failure actions configured properly
Are there any vDisks past the Farm merge setting
Are there any empty Device Collections
Are there any vDisks not associated with any Target Device
Do any of the servers have bad streaming IP addresses
Registry keys set the same across all server
Are there any vDisks configured for server-side caching
Do they have the same Windows Updates
Do they have the same Windows components installed
Are the PVS processes working
Are there any Farm or Server items that need reviewing
- Hardware configuration
- Hard drive configurations
- Processor configurations
- NIC configurations
Citrix components

There is nothing publicly available from Citrix to help you assess the overall health and configuration of a Citrix PVS Farm. That is the purpose behind the PVS Health Check script. The V2 update now supports HTML and Word/PDF output in addition to plain text output. You can also generate multiple outputs in one run.

I want to thank all the testers who spent weeks testing all the updates. I want to especially thank the testers who sent sample reports and who found bugs and worked with me to test the fixes. This script is better because of their help.

Version 2.00 14-Mar-2022

Added MultiSubnetFailover to Farm Status section
- Thanks to Arnaud Pain
- I can’t believe no one has asked for this since PVS 7.11 was released on 14-Sep-2016
Added the following functions to support Word/PDF and HTML output and new parameters:
- AddHTMLTable
- AddWordTable
- CheckWordPrereq
- FindWordDocumentEnd
- FormatHTMLTable
- GetCulture
- Get-LocalRegistryValue
- Get-RegistryValue
- OutputauthGroups
- OutputNotice
- OutputReportFooter
- OutputWarning
- ProcessDocumentOutput
- SaveandCloseDocumentandShutdownWord
- SaveandCloseHTMLDocument
- Set-DocumentProperty
- SetupWord
- SetWordCellFormat
- SetWordHashTable
- SetWordTableAlternateRowColor
- Test-RegistryValue
- UpdateDocumentProperties
- ValidateCompanyName
- ValidateCoverPage
- validObject
- validStateProp
- WriteHTMLLine
- WriteWordLine
Added the following parameters:
- AddDateTime
- CompanyAddress
- CompanyEmail
- CompanyFax
- CompanyName
- CompanyPhone
- CoverPage
- HTML
- MSWord
- PDF
- ReportFooter
- Text
- UserName
Any Function in this script not listed anywhere else in this changelog was updated to support Word/PDF and HTML output
Changed all file names by adding a V2 somewhere in the name
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
Dropped support for PVS 5. The V1.25 script still supports PVS 5.x
Fixed a bug in Function GetInstalledRolesAndFeatures that didn’t handle the condition of no installed Roles or Features
- Thanks to Arnaud Pain for reporting this
Fixed a bug when retrieving a Device Collection’s Administrators and Operators
- I was not comparing to the specific device collection name, which returned all administrators and operators for all device collections and not the device collection being processed
Fixed a bug with handling a PVS server with multiple NICs and multiple IPv4 addresses
- This bug has existed since I created the script in 2012
- I changed the $Script:NICIPAddresses array from @{} to New-Object System.Collections.ArrayList
- Updated Function ProcessPVSSite to use Get-NetIPAddress -CimSession to get all the IPv4 addresses
- This allows the gathering of IPv4 addresses regardless of the OS or PVS version
- Updated Function GetBadStreamingIPAddresses to work with the new array type for $Script:NICIPAddresses
Format the Farm, Properties, Status section to match the console output
In Function DeviceStatus, change the output of the Target device’s active/inactive status and license type
In Function GetBootstrapInfo, for HTML output, check if any array items exist before outputting a blank table with only column headings
In Function GetConfigWizardInfo, fix $PXEServices to work with PVS7+
- If DHCPType is equal to 1073741824, then if PXE is set to PVS, in PVS V6, PXEType is set to 0, but in PVS7, PXEType is set to 1
- Updated the function to check for both 0 and 1 values
In Function GetDisableTaskOffloadInfo, changed the value of $TaskOffloadValue:
- If the registry value DisableTaskOffload does not exist, from “Missing” to “Not defined”
- To a String[] so the HTML output works
In Function ProcessStores, change the Word/PDF and HTML output to tables instead of individual lines
Replaced all Get-WmiObject with Get-CimInstance
Replaced most script Exit calls with AbortScript to stop the transcript log if the log was enabled and started
Updated the following functions to the latest versions:
- AbortScript
- GetComputerWMIInfo
- line
- OutputComputerItem
- OutputDriveItem
- OutputNicItem
- OutputProcessorItem
- ProcessScriptEnd
- SaveandCloseTextDocument
- SendEmail
- SetFilenames
- SetupText
- ShowScriptOptions
Updated the help text
Updated the ReadMe file
Went to Set-StrictMode -Version Latest, from Version 2 and cleaned up all related errors
You can select multiple output formats

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

Citrix Provisioning Services 7.x Documentation Script Update Version 6.04

Carl Webster — Mon, 07 Mar 2022 10:07:48 +0000

While working on the V2 PVS Health Check script, I found several bugs. I backported those fixes into this V6 script update.

Version 6.04 6-Mar-2022

Add Function Get-IPAddress
Fixed bug when retrieving a Device Collection’s Administrators and Operators
- I was not comparing to the specific device collection name, which returned all administrators and operators for all device collections and not the device collection being processed
Format the Farm, Properties, Status section to match the console output
In Function OutputFarm, add the following:
- License server IP address
- For the Options tab info, section headings to Word/PDF and HTML output that were in the Text output
- SQL Server IP address
- Failover partner IP address
- MultiSubnetFailover to Farm Status section
  - Thanks to Arnaud Pain
  - I can’t believe no one has asked for this since PVS 7.11 was released on 14-Sep-2016

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

Citrix “Old” Provisioning Services Documentation Script Update 4.33

Carl Webster — Mon, 07 Mar 2022 10:02:42 +0000

While working on the V2 PVS Health Check script, I found several bugs. I backported those fixes into this V4 script update.

Version 4.33 6-Mar-2022

Added MultiSubnetFailover to Farm Status section
- Thanks to Arnaud Pain
- I can’t believe no one has asked for this since PVS 7.11 was released on 14-Sep-2016
Fixed bug when retrieving a Device Collection’s Administrators and Operators
- I was not comparing to the specific device collection name, which returned all administrators and operators for all device collections and not the device collection being processed
Format the Farm, Properties, Status section to match the console output

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

Citrix Provisioning Services Health Check Script Update Version 1.25

Carl Webster — Mon, 07 Mar 2022 09:53:48 +0000

While working on the V2 PVS Health Check script, I found several bugs. I backported those fixes into this V1 script update.

Version 1.25 6-Mar-2022

Added MultiSubnetFailover to Farm Status section
- Thanks to Arnaud Pain
- I can’t believe no one has asked for this since PVS 7.11 was released on 14-Sep-2016
Fixed a bug in Function GetInstalledRolesAndFeatures that didn’t handle the condition of no installed Roles or Features
- Thanks to Arnaud Pain for reporting this
Fixed bug when retrieving a Device Collection’s Administrators and Operators
- I was not comparing to the specific device collection name, which returned all administrators and operators for all device collections and not the device collection being processed
Fixed several incorrect variable names
Format the Farm, Properties, Status section to match the console output
In Function GetConfigWizardInfo, fix $PXEServices to work with PVS7+
- If DHCPType is equal to 1073741824, then if PXE is set to PVS, in PVS V5/6, PXEType is set to 0, but in PVS7, PXEType is set to 1
- Updated the function to check for both 0 and 1 values

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

All Current Documentation Scripts are Getting Updated 7-Feb-2022

Carl Webster — Mon, 07 Feb 2022 12:21:34 +0000

As I get time over the next couple of days, I am updating all the current documentation scripts with a few minor bug fixes. Any script that has anything different from the fixes listed below will have that change(s) listed separately.

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: