• Citrix Cloud Documentation Script V1.13

    April 14, 2021

    Citrix Cloud, PowerShell

    Version 1.13 14-Apr-2021

    • Added Computer policy
      • Profile Management\Enable profile streaming for folders
      • Workspace Environment Management\Citrix Cloud Connectors
    • Added User policy
      • ICA\Multimedia\Browser Content Redirection Server Fetch Proxy Auth
    • Changed $Application.IconFromClient to $Application.IconFromClient.ToString()
    • Changed how the Session Recording Status was obtained
    • Fixed three typos of “Unabled” to “Unable”
    • Fixed typos of “Descriptione” to “Description”
    • For Restart schedules added the following items:
      • Use natural reboot
      • Ignore maintenance mode
      • Maximum Overtime Start Minutes
    • 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”
    • Moved Authentication code to right after the test for elevation. If authentication fails, there is no need to test and set a bunch of variables.
    • Renamed computer policy
      • Enable multi-session write-back for FSLogix Profile Container to Enable multi-session write-back for profile containers
      • Virtual channel white list to Virtual channel allow list
    • To get the Master VM for an Azure Catalog, add searching for “.manageddisk”
      • Also added “.snapshot” which was found in customer data
    • Updated the Authentication section in the ReadMe
    • 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://carlwebster.com/where-to-get-copies-of-the-documentation-scripts/

    Thanks

    Webster







    About Carl Webster

    Carl Webster is an independent consultant specializing in Citrix, Active Directory, and technical documentation. Carl (aka “Webster”) serves the broader Citrix community by writing articles (see CarlWebster.com) and by being the most active person in the Citrix Zone on Experts Exchange. Webster has a long history in the IT industry beginning with mainframes in 1977, PCs and application development in 1986, and network engineering in 2001. He has worked with Citrix products since 1990 with the premiere of their first product – the MULTIUSER OS/2.

    View all posts by Carl Webster

    6 Responses to “Citrix Cloud Documentation Script V1.13”

    1. Tobias Riebesel Says:

      Hello,

      when it try to run the script I get this output after I signed in to Citrix Cloud:

      VERBOSE: 21.04.2021 13:07:46: Testing for elevation
      This is an elevated PowerShell session
      VERBOSE: Performing the operation “New Alias” on target “Name: Get-AdminAdministrator Value: Get-XDAdminAdministrator”.
      VERBOSE: __AllParameterSets
      Get-XDCredentials : ProfileNotFound
      At C:\Users\triadmin\Downloads\CCV1.13\CC_Inventory_V1_Signed.ps1:1564 char:15
      + $CCCreds = (Get-XDCredentials -ProfileName default).Credentia …
      + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      + CategoryInfo : InvalidOperation: (Get-XDCredentials:String) [Get-XDCredentials], InvalidOperationExcept
      ion
      + FullyQualifiedErrorId : Citrix.Sdk.Proxy.ProfileNotFound,Citrix.Sdk.Proxy.GetXDCredentialsCommand

      The property ‘CustomerID’ cannot be found on this object. Verify that the property exists.
      At C:\Users\triadmin\Downloads\CCV1.13\CC_Inventory_V1_Signed.ps1:1668 char:1
      + $Script:CustomerID = $CCCreds.CustomerID
      + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      + CategoryInfo : NotSpecified: (:) [], PropertyNotFoundException
      + FullyQualifiedErrorId : PropertyNotFoundStrict

      VERBOSE: 21.04.2021 13:08:14: Testing output parameters
      VERBOSE: 21.04.2021 13:08:14: HTML is set
      VERBOSE: 21.04.2021 13:08:14: Testing required PowerShell modules for Citrix Cloud
      VERBOSE: Loading module from path ‘C:\Program
      Files\Citrix\PowerShellModules\Citrix.PoshSdkProxy.Commands\..\..\Sdkproxy\Snapin\v1\Citrix.SdkProxy.PowerShellSnapIn.d
      ll’.
      VERBOSE: 21.04.2021 13:08:14: Loading Citrix.Common.GroupPolicy PSSnapin
      Loading Windows PowerShell snap-in: Citrix.Common.GroupPolicy
      VERBOSE: 21.04.2021 13:08:15: Importing required Citrix PowerShell modules
      VERBOSE: 21.04.2021 13:08:15: Citrix.ADIdentity.Commands
      Import-Module : The specified module ‘Citrix.ADIdentity.Commands’ was not loaded because no valid module file was
      found in any module directory.
      At C:\Users\triadmin\Downloads\CCV1.13\CC_Inventory_V1_Signed.ps1:30679 char:2
      + Import-Module “Citrix.ADIdentity.Commands” 4>$Null
      + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      + CategoryInfo : ResourceUnavailable: (Citrix.ADIdentity.Commands:String) [Import-Module], FileNotFoundEx
      ception
      + FullyQualifiedErrorId : Modules_ModuleNotFound,Microsoft.PowerShell.Commands.ImportModuleCommand

      ProcessScriptSetup : Unable to import the Citrix.ADIdentity.Commands module. Script cannot continue.
      At C:\Users\triadmin\Downloads\CCV1.13\CC_Inventory_V1_Signed.ps1:31293 char:1
      + ProcessScriptSetup
      + ~~~~~~~~~~~~~~~~~~
      + CategoryInfo : NotSpecified: (:) [Write-Error], WriteErrorException
      + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,ProcessScriptSetup

      Thank
      Tobias

      Reply

      • Shane O'Neill Says:

        Tobias, did you run the Set-XDCredentials cmdlet first to create a profile before running the documentation script?

        Shane

        Reply

        • Tobias Riebesel Says:

          Hello,

          now i have set the XDCredentials. But i get this message:

          VERBOSE: 22.04.2021 13:34:18: Loading Citrix.Common.GroupPolicy PSSnapin
          VERBOSE: 22.04.2021 13:34:19: Importing required Citrix PowerShell modules
          VERBOSE: 22.04.2021 13:34:19: Citrix.ADIdentity.Commands
          Import-Module : The specified module ‘Citrix.ADIdentity.Commands’ was not loaded because no valid module file was
          found in any module directory.
          At C:\Users\triadmin\Downloads\CCV1.13\CC_Inventory_V1.ps1:30679 char:2
          + Import-Module “Citrix.ADIdentity.Commands” 4>$Null
          + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
          + CategoryInfo : ResourceUnavailable: (Citrix.ADIdentity.Commands:String) [Import-Module], FileNotFoundEx
          ception
          + FullyQualifiedErrorId : Modules_ModuleNotFound,Microsoft.PowerShell.Commands.ImportModuleCommand

          ProcessScriptSetup : Unable to import the Citrix.ADIdentity.Commands module. Script cannot continue.
          At C:\Users\triadmin\Downloads\CCV1.13\CC_Inventory_V1.ps1:31293 char:1
          + ProcessScriptSetup
          + ~~~~~~~~~~~~~~~~~~
          + CategoryInfo : NotSpecified: (:) [Write-Error], WriteErrorException
          + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException,ProcessScriptSetup

          Tobias

          Reply

          • Carl Webster Says:

            Did you install the Remote PowerShell SDK from Step 3 in the Prerequisites?

            Webster

            Reply

            • Tobias Says:

              Hello,

              on the Client is the powershell sdk, the group policy Management extension and the pvs console installed.
              Tobias

            • Carl Webster Says:

              Tobias had to reinstall the Remote PowerShell SDK to get past the issue of modules not loading. Shane O’Neill is now working with Tobias on the issue “Unable to connect to your Citrix Cloud account”.

              Update: There is apparently a conflict between the PVS PowerShell and Citrix Cloud PowerShell. The last installed wins and the other ceases to work.

              Webster

    Leave a Reply