• Citrix Virtual Apps and Desktops Documentation Script V3.00

    After a lot of hard work by the community, Guy Leech, and myself, we are pleased to release a rewritten Citrix Virtual Apps and Desktops (CVAD) documentation script.

    There are four important things you should know about this script.

    1. It requires a minimum CVAD version of 2006
    2. It requires a minimum PowerShell version of 5
    3. The default output is now HTML, not Microsoft Word
    4. You can now select any combination of the four output report types: HTML, MSWord, PDF, and Text

    If you need support for CVAD version 2006 and below, use the V2.36 script. The 100s of fixes in this V3 script were backported to the 2.36 script since 2.36 also includes support for CVAD 2006.

    The V1 script supports 7.0 through 7.7.

    The V2 script supports 7.8 through 2006.

    The V3 script supports 2006 and later.

    Work is underway on a separate documentation script for Citrix Cloud or Citrix Virtual Apps and Desktop service. Email me if you would like to test that script.

    I thought it would take a few months to rewrite this script with all the planned changes. After spending 1.5 years working with Michael B. Smith rewriting the AD documentation script, it only took one weekend to have the rewrite done as a lot of the same rewrite changes made to the AD script were also moved over to this script.

    I do want to make a HUGE shout out to fellow CTP Guy Leech. He spent a lot of time reviewing the code and showing me how to improve my PowerShell skills, improve my PowerShell knowledge, and improve the script for the good of the community. If your pride and ego are tender and fragile, NEVER EVER ask Guy to review one of your scripts. Guy is a great mentor and teacher, but prepare yourself to be schooled in the “correct” way of writing PowerShell.

    Version 3.00 3-Sep-2020

    • Added a ValidateSet to the Sections parameter. You can use -Section, press tab, and tab through all the section options. (Credit to Guy Leech)
    • Added the following missing Administrator Role permissions:
      • Administrators
        • Manage Administrator Custom Roles
        • Manage Administrator Scopes
        • Manage ServiceSettings
      • Application Groups
        • Add Application Group to Scope
        • Add Application to Application Group
        • Add Delivery Group to Application Group
        • Change Tags on Application Group
        • Change users assigned to an application (Application Group)
        • Create Application (Application Group)
        • Create Application Folder (Application Group)
        • Create Application Group
        • Delete Application (Application Group)
        • Delete Application Group
        • Edit Application Folder (Application Group)
        • Edit Application Group Properties
        • Edit Application Properties (Application Group)
        • Edit Application tags (Application Group)
        • Edit User Assignment on Application Group
        • Move Application Folder (Application Group)
        • Remove Application Folder (Application Group)
        • Remove Application from Application Group
        • Remove Application Group from Scope
        • Remove Delivery Group from Application Group
        • View Application Groups
        • View Applications (Application Group)
      • App-V
        • Add App-V Application Libraries and Packages
        • Create App-V Isolation Group
        • Read App-V Application Libraries and Packages
        • Remove App-V Application Libraries and Packages
        • Remove App-V Isolation Groups
      • Controllers
        • Edit Controller
      • Delivery Groups
        • Add Application Group to Delivery Group
        • Add Webhooks to Delivery Group
        • Edit Delivery Group machine tags
        • Edit machine tags
        • Remove Application Group from Delivery Group
      • Director
        • Create\Edit\Delete Alert Policies
        • Create\Edit\Remove Alert Email Server Configuration
        • Create\Edit\Remove Cloud Analytics Configurations
        • Create\Edit\Remove Probe Configurations
        • Dismiss Alerts
        • Edit Disk metrics related Broker machine command properties
        • Edit GPO Data related Broker machine command properties
        • Edit Gpu metrics related Broker machine command properties
        • Edit HDX Protocol related Broker machine command properties
        • Edit Profile Load Data related Broker machine command properties
        • Edit Startup related Broker machine command properties
        • View Alert Policies
        • View Alerts
        • View Applications page
        • View Configurations page
      • Machine Catalogs
        • Edit Catalog tags
        • Edit Catalog machine tags
      • Other Permissions
        • Create Tags
        • Delete Tags
        • Edit Tags
        • Manage Orchestration Service REST API
        • Manage Trust Service Keys
        • Read Tags
      • Zones
        • Create Zone
        • Delete Zone
        • Edit Zone
        • Manage Citrix Cloud Connector
    • Allow multiple output formats. You can now select any combination of HTML, MSWord, PDF, or Text
    • Change Policy Filter from Citrix CloudBridge to NetScaler SD-WAN
    • Change some Write-Error to Write-Warning and changed some Write-Warning to Write-Host
      • Added Function OutputNotice
    • Change the beginning of the file names from XAXDV2 to CVAD for the error log, script info, and transcript logging files.
    • Change the default output to HTML
    • Change the Splats XDParams1 and XDParams2 to CVADParams1 and CVADParams2
    • Change the variable XDSiteName to CVADSiteName
    • Change the variable XDSiteVersion to CVADSiteVersion
    • Change the variables XDSite1 and XDSite2 to CVADSite1 and CVADSite2
    • Clean up HTML, MSWord, PDF, and text output
    • CVAD 2006 is the minimum version supported
    • Fixed an issue for RemotePC machine catalogs based on OUs. (Thanks to Rene Bigler)
      • Added all OUs defined
      • Added Allow SubOUs by each defined OU
      • Added machines excluded from the catalog
      • Added machines included in the catalog
    • If PDF is selected for Output and Microsoft Word is not installed, update the error message to state that PDF uses Word’s SaveAs PDF function (Guy Leech)
    • Implemented a lot of fixes for bugs found by Guy Leech
    • PowerShell 5 is the minimum version supported since CVAD 2006 DDC requires a minimum of Windows Server 2016 which ships with PowerShell V5
    • PowerShell 5 is the minimum version supported since CVAD 2006 Studio requires a minimum of Windows Server 2016 or Windows 10 which ship with PowerShell V5
    • Reformatted most Write-Error message to show better in the console
    • Removed all invalid links from comments
    • Remove all checks for *AddedServiceCapability
    • Remove all checks for determining what version supports what feature
    • Remove all code and references to AppDisk
    • Remove all code and references to Connection Leasing
    • Remove all code and references to Personal vDisk/PvD
    • Remove all comments referencing V2.xx
    • Remove all comments referencing versions 7.xx
    • Remove all comments referencing versions 18xx, 19xx, and 2003
    • Remove all policy settings that do not apply to CVAD 2006
    • Remove all references to Desktop OS and Server OS
    • Remove existing Script ParameterSets and leave only one for “WordPDF”
    • Remove Citrix snapin Citrix.EnvTest.Admin as it is not needed for this script
    • Replaced, where appropriate, XenApp and XenDesktop with CVAD, or Virtual Apps, or Virtual Desktops
    • Updated the help text and all 46 examples
    • Updated the link for the ReadMe file

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

    Thanks

    Webster







    About Carl Webster

    Webster is a Sr. Infrastructure Consultant for Conversant Group and specializes in Citrix, Active Directory and Technical Documentation. Webster has been working with Citrix products for many years starting with Multi-User OS/2 in 1990.

    View all posts by Carl Webster

    No comments yet.

    Leave a Reply