{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"XDHealthCheck Description Creates daily health check, and config reports for your on-premise Citrix farm. - To get started, you need to run Install-ParametersFile. - This will capture and save needed farm details, to allow scripts to run automatically. Function Synopsis Get-CitrixConfigurationChange Show the changes that was made to the farm Get-CitrixFarmDetail Get needed Farm details. Get-CitrixLicenseInformation Show Citrix License details Get-CitrixObjects Get details of citrix objects Get-CitrixServerEventLog Get windows event log details Get-CitrixServerPerformance Combine perfmon of multiple servers for reporting. Get-CitrixSingleServerPerformance Get perfmon statistics Get-CitrixWebsiteStatus Get the status of a website Get-RDSLicenseInformation Report on RDS License Useage Get-StoreFrontDetail Report on Storefront status. Import-ParametersFile Import the config file and creates the needed variables Install-CTXPSModule Checks and installs needed modules Install-ParametersFile Create a json config file with all needed farm details. Set-XDHealthReportColors Set the color and logo for HTML Reports Start-CitrixAudit Creates and distributes a report on catalog, groups and published app config. Start-CitrixHealthCheck Creates and distributes a report on citrix farm health.","title":"XDHealthCheck"},{"location":"#xdhealthcheck","text":"","title":"XDHealthCheck"},{"location":"#description","text":"Creates daily health check, and config reports for your on-premise Citrix farm. - To get started, you need to run Install-ParametersFile. - This will capture and save needed farm details, to allow scripts to run automatically.","title":"Description"},{"location":"#function-synopsis","text":"","title":"Function Synopsis"},{"location":"#get-citrixconfigurationchange","text":"Show the changes that was made to the farm","title":"Get-CitrixConfigurationChange"},{"location":"#get-citrixfarmdetail","text":"Get needed Farm details.","title":"Get-CitrixFarmDetail"},{"location":"#get-citrixlicenseinformation","text":"Show Citrix License details","title":"Get-CitrixLicenseInformation"},{"location":"#get-citrixobjects","text":"Get details of citrix objects","title":"Get-CitrixObjects"},{"location":"#get-citrixservereventlog","text":"Get windows event log details","title":"Get-CitrixServerEventLog"},{"location":"#get-citrixserverperformance","text":"Combine perfmon of multiple servers for reporting.","title":"Get-CitrixServerPerformance"},{"location":"#get-citrixsingleserverperformance","text":"Get perfmon statistics","title":"Get-CitrixSingleServerPerformance"},{"location":"#get-citrixwebsitestatus","text":"Get the status of a website","title":"Get-CitrixWebsiteStatus"},{"location":"#get-rdslicenseinformation","text":"Report on RDS License Useage","title":"Get-RDSLicenseInformation"},{"location":"#get-storefrontdetail","text":"Report on Storefront status.","title":"Get-StoreFrontDetail"},{"location":"#import-parametersfile","text":"Import the config file and creates the needed variables","title":"Import-ParametersFile"},{"location":"#install-ctxpsmodule","text":"Checks and installs needed modules","title":"Install-CTXPSModule"},{"location":"#install-parametersfile","text":"Create a json config file with all needed farm details.","title":"Install-ParametersFile"},{"location":"#set-xdhealthreportcolors","text":"Set the color and logo for HTML Reports","title":"Set-XDHealthReportColors"},{"location":"#start-citrixaudit","text":"Creates and distributes a report on catalog, groups and published app config.","title":"Start-CitrixAudit"},{"location":"#start-citrixhealthcheck","text":"Creates and distributes a report on citrix farm health.","title":"Start-CitrixHealthCheck"},{"location":"Get-CitrixConfigurationChange/","text":"Get-CitrixConfigurationChange SYNOPSIS Show the changes that was made to the farm SYNTAX Get-CitrixConfigurationChange [-AdminServer] <String> [-Indays] <Int32> [-RemoteCredentials] <PSCredential> [<CommonParameters>] DESCRIPTION Show the changes that was made to the farm EXAMPLES Example 1 PS C:\\> Get-CitrixConfigurationChange -DDC $CTXDDC -Indays 7 -RemoteCredentials $CTXAdmin PARAMETERS -AdminServer Name of data collector Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -Indays Limit the search, to only show changes from the last couple of days Type: Int32 Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -RemoteCredentials Enable function to run remotely, if the CItrix cmdlets are not available Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Get-CitrixConfigurationChange"},{"location":"Get-CitrixConfigurationChange/#get-citrixconfigurationchange","text":"","title":"Get-CitrixConfigurationChange"},{"location":"Get-CitrixConfigurationChange/#synopsis","text":"Show the changes that was made to the farm","title":"SYNOPSIS"},{"location":"Get-CitrixConfigurationChange/#syntax","text":"Get-CitrixConfigurationChange [-AdminServer] <String> [-Indays] <Int32> [-RemoteCredentials] <PSCredential> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CitrixConfigurationChange/#description","text":"Show the changes that was made to the farm","title":"DESCRIPTION"},{"location":"Get-CitrixConfigurationChange/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CitrixConfigurationChange/#example-1","text":"PS C:\\> Get-CitrixConfigurationChange -DDC $CTXDDC -Indays 7 -RemoteCredentials $CTXAdmin","title":"Example 1"},{"location":"Get-CitrixConfigurationChange/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CitrixConfigurationChange/#-adminserver","text":"Name of data collector Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-AdminServer"},{"location":"Get-CitrixConfigurationChange/#-indays","text":"Limit the search, to only show changes from the last couple of days Type: Int32 Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-Indays"},{"location":"Get-CitrixConfigurationChange/#-remotecredentials","text":"Enable function to run remotely, if the CItrix cmdlets are not available Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-RemoteCredentials"},{"location":"Get-CitrixConfigurationChange/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CitrixConfigurationChange/#inputs","text":"","title":"INPUTS"},{"location":"Get-CitrixConfigurationChange/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CitrixConfigurationChange/#notes","text":"","title":"NOTES"},{"location":"Get-CitrixConfigurationChange/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CitrixFarmDetail/","text":"Get-CitrixFarmDetail SYNOPSIS Get needed Farm details. SYNTAX Get-CitrixFarmDetail [-AdminServer] <String> [-RunAsPSRemote] [[-RemoteCredentials] <PSCredential>] [<CommonParameters>] DESCRIPTION Get needed Farm details. EXAMPLES EXAMPLE 1 Get-CitrixFarmDetail -AdminServer $CTXDDC -RemoteCredentials $CTXAdmin -RunAsPSRemote PARAMETERS -AdminServer Name of a data collector Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -RemoteCredentials Enable function to run remotely, if the CItrix cmdlets are not available Type: PSCredential Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False -RunAsPSRemote Credentials if running psremote Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: False Accept pipeline input: False Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Get-CitrixFarmDetail"},{"location":"Get-CitrixFarmDetail/#get-citrixfarmdetail","text":"","title":"Get-CitrixFarmDetail"},{"location":"Get-CitrixFarmDetail/#synopsis","text":"Get needed Farm details.","title":"SYNOPSIS"},{"location":"Get-CitrixFarmDetail/#syntax","text":"Get-CitrixFarmDetail [-AdminServer] <String> [-RunAsPSRemote] [[-RemoteCredentials] <PSCredential>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CitrixFarmDetail/#description","text":"Get needed Farm details.","title":"DESCRIPTION"},{"location":"Get-CitrixFarmDetail/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CitrixFarmDetail/#example-1","text":"Get-CitrixFarmDetail -AdminServer $CTXDDC -RemoteCredentials $CTXAdmin -RunAsPSRemote","title":"EXAMPLE 1"},{"location":"Get-CitrixFarmDetail/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CitrixFarmDetail/#-adminserver","text":"Name of a data collector Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-AdminServer"},{"location":"Get-CitrixFarmDetail/#-remotecredentials","text":"Enable function to run remotely, if the CItrix cmdlets are not available Type: PSCredential Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-RemoteCredentials"},{"location":"Get-CitrixFarmDetail/#-runaspsremote","text":"Credentials if running psremote Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-RunAsPSRemote"},{"location":"Get-CitrixFarmDetail/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CitrixFarmDetail/#inputs","text":"","title":"INPUTS"},{"location":"Get-CitrixFarmDetail/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CitrixFarmDetail/#notes","text":"","title":"NOTES"},{"location":"Get-CitrixFarmDetail/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CitrixLicenseInformation/","text":"Get-CitrixLicenseInformation SYNOPSIS Show Citrix License details SYNTAX Get-CitrixLicenseInformation [-AdminServer] <String> [-RemoteCredentials] <PSCredential> [-RunAsPSRemote] [<CommonParameters>] DESCRIPTION Show Citrix License details EXAMPLES Example 1 PS C:\\> Get-CitrixLicenseInformation -AdminServer $CTXDDC -RemoteCredentials $CTXAdmin -RunAsPSRemote PARAMETERS -AdminServer Name of data collector Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False -RemoteCredentials Credentials if running remote Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -RunAsPSRemote Enable function to run remotely, if the CItrix cmdlets are not available Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: False Accept pipeline input: False Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Get-CitrixLicenseInformation"},{"location":"Get-CitrixLicenseInformation/#get-citrixlicenseinformation","text":"","title":"Get-CitrixLicenseInformation"},{"location":"Get-CitrixLicenseInformation/#synopsis","text":"Show Citrix License details","title":"SYNOPSIS"},{"location":"Get-CitrixLicenseInformation/#syntax","text":"Get-CitrixLicenseInformation [-AdminServer] <String> [-RemoteCredentials] <PSCredential> [-RunAsPSRemote] [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CitrixLicenseInformation/#description","text":"Show Citrix License details","title":"DESCRIPTION"},{"location":"Get-CitrixLicenseInformation/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CitrixLicenseInformation/#example-1","text":"PS C:\\> Get-CitrixLicenseInformation -AdminServer $CTXDDC -RemoteCredentials $CTXAdmin -RunAsPSRemote","title":"Example 1"},{"location":"Get-CitrixLicenseInformation/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CitrixLicenseInformation/#-adminserver","text":"Name of data collector Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False","title":"-AdminServer"},{"location":"Get-CitrixLicenseInformation/#-remotecredentials","text":"Credentials if running remote Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-RemoteCredentials"},{"location":"Get-CitrixLicenseInformation/#-runaspsremote","text":"Enable function to run remotely, if the CItrix cmdlets are not available Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-RunAsPSRemote"},{"location":"Get-CitrixLicenseInformation/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CitrixLicenseInformation/#inputs","text":"","title":"INPUTS"},{"location":"Get-CitrixLicenseInformation/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CitrixLicenseInformation/#notes","text":"","title":"NOTES"},{"location":"Get-CitrixLicenseInformation/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CitrixObjects/","text":"Get-CitrixObjects SYNOPSIS Get details about catalogs, delivery groups and published apps SYNTAX Get-CitrixObjects [-AdminServer] <String> [-RunAsPSRemote] [[-RemoteCredentials] <PSCredential>] [<CommonParameters>] DESCRIPTION Get details about catalogs, delivery groups and published apps EXAMPLES Example 1 PS C:\\> Get-CitrixObjects -AdminServer $CTXDDC -RunAsPSRemote -RemoteCredentials $CTXAdmin -Verbose PARAMETERS -AdminServer Name of data collector Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -RemoteCredentials Credentials if running remote Type: PSCredential Parameter Sets: (All) Aliases: Required: False Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False -RunAsPSRemote Enable function to run remotely, if the CItrix cmdlets are not available Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: False Accept pipeline input: False Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Get-CitrixObjects"},{"location":"Get-CitrixObjects/#get-citrixobjects","text":"","title":"Get-CitrixObjects"},{"location":"Get-CitrixObjects/#synopsis","text":"Get details about catalogs, delivery groups and published apps","title":"SYNOPSIS"},{"location":"Get-CitrixObjects/#syntax","text":"Get-CitrixObjects [-AdminServer] <String> [-RunAsPSRemote] [[-RemoteCredentials] <PSCredential>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CitrixObjects/#description","text":"Get details about catalogs, delivery groups and published apps","title":"DESCRIPTION"},{"location":"Get-CitrixObjects/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CitrixObjects/#example-1","text":"PS C:\\> Get-CitrixObjects -AdminServer $CTXDDC -RunAsPSRemote -RemoteCredentials $CTXAdmin -Verbose","title":"Example 1"},{"location":"Get-CitrixObjects/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CitrixObjects/#-adminserver","text":"Name of data collector Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-AdminServer"},{"location":"Get-CitrixObjects/#-remotecredentials","text":"Credentials if running remote Type: PSCredential Parameter Sets: (All) Aliases: Required: False Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-RemoteCredentials"},{"location":"Get-CitrixObjects/#-runaspsremote","text":"Enable function to run remotely, if the CItrix cmdlets are not available Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-RunAsPSRemote"},{"location":"Get-CitrixObjects/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CitrixObjects/#inputs","text":"","title":"INPUTS"},{"location":"Get-CitrixObjects/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CitrixObjects/#notes","text":"","title":"NOTES"},{"location":"Get-CitrixObjects/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CitrixServerEventLog/","text":"Get-CitrixServerEventLog SYNOPSIS Get windows event log details SYNTAX Get-CitrixServerEventLog [-Serverlist] <Array> [-Days] <Int32> [-RemoteCredentials] <PSCredential> [<CommonParameters>] DESCRIPTION Get windows event log details EXAMPLES Example 1 PS C:\\> Get-CitrixServerEventLog -Serverlist $CTXCore -Days 1 -RemoteCredentials $CTXAdmin PARAMETERS -Days Limit the search for only do many days. Type: Int32 Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: 0 Accept pipeline input: False Accept wildcard characters: False -RemoteCredentials Credentials used to connect to server remotely. Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False -Serverlist List of server names. Type: Array Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Get-CitrixServerEventLog"},{"location":"Get-CitrixServerEventLog/#get-citrixservereventlog","text":"","title":"Get-CitrixServerEventLog"},{"location":"Get-CitrixServerEventLog/#synopsis","text":"Get windows event log details","title":"SYNOPSIS"},{"location":"Get-CitrixServerEventLog/#syntax","text":"Get-CitrixServerEventLog [-Serverlist] <Array> [-Days] <Int32> [-RemoteCredentials] <PSCredential> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CitrixServerEventLog/#description","text":"Get windows event log details","title":"DESCRIPTION"},{"location":"Get-CitrixServerEventLog/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CitrixServerEventLog/#example-1","text":"PS C:\\> Get-CitrixServerEventLog -Serverlist $CTXCore -Days 1 -RemoteCredentials $CTXAdmin","title":"Example 1"},{"location":"Get-CitrixServerEventLog/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CitrixServerEventLog/#-days","text":"Limit the search for only do many days. Type: Int32 Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: 0 Accept pipeline input: False Accept wildcard characters: False","title":"-Days"},{"location":"Get-CitrixServerEventLog/#-remotecredentials","text":"Credentials used to connect to server remotely. Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-RemoteCredentials"},{"location":"Get-CitrixServerEventLog/#-serverlist","text":"List of server names. Type: Array Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False","title":"-Serverlist"},{"location":"Get-CitrixServerEventLog/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CitrixServerEventLog/#inputs","text":"","title":"INPUTS"},{"location":"Get-CitrixServerEventLog/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CitrixServerEventLog/#notes","text":"","title":"NOTES"},{"location":"Get-CitrixServerEventLog/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CitrixServerPerformance/","text":"Get-CitrixServerPerformance SYNOPSIS Combine perfmon of multiple servers for reporting. SYNTAX Get-CitrixServerPerformance [-Serverlist] <Array> [-RemoteCredentials] <PSCredential> [<CommonParameters>] DESCRIPTION Combine perfmon of multiple servers for reporting. EXAMPLES EXAMPLE 1 Get-CitrixServerPerformance -Serverlist $CTXCore -RemoteCredentials $CTXAdmin PARAMETERS -RemoteCredentials Enable function to run remotely, if the CItrix cmdlets are not available Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -Serverlist List of servers to get the permon details Type: Array Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Get-CitrixServerPerformance"},{"location":"Get-CitrixServerPerformance/#get-citrixserverperformance","text":"","title":"Get-CitrixServerPerformance"},{"location":"Get-CitrixServerPerformance/#synopsis","text":"Combine perfmon of multiple servers for reporting.","title":"SYNOPSIS"},{"location":"Get-CitrixServerPerformance/#syntax","text":"Get-CitrixServerPerformance [-Serverlist] <Array> [-RemoteCredentials] <PSCredential> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CitrixServerPerformance/#description","text":"Combine perfmon of multiple servers for reporting.","title":"DESCRIPTION"},{"location":"Get-CitrixServerPerformance/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CitrixServerPerformance/#example-1","text":"Get-CitrixServerPerformance -Serverlist $CTXCore -RemoteCredentials $CTXAdmin","title":"EXAMPLE 1"},{"location":"Get-CitrixServerPerformance/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CitrixServerPerformance/#-remotecredentials","text":"Enable function to run remotely, if the CItrix cmdlets are not available Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-RemoteCredentials"},{"location":"Get-CitrixServerPerformance/#-serverlist","text":"List of servers to get the permon details Type: Array Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False","title":"-Serverlist"},{"location":"Get-CitrixServerPerformance/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CitrixServerPerformance/#inputs","text":"","title":"INPUTS"},{"location":"Get-CitrixServerPerformance/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CitrixServerPerformance/#notes","text":"","title":"NOTES"},{"location":"Get-CitrixServerPerformance/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CitrixSingleServerPerformance/","text":"Get-CitrixSingleServerPerformance SYNOPSIS Get perfmon statistics SYNTAX Get-CitrixSingleServerPerformance [-Server] <String> [-RemoteCredentials] <PSCredential> [<CommonParameters>] DESCRIPTION Get perfmon statistics EXAMPLES EXAMPLE 1 Get-CitrixSingleServerPerformance -Server ddc01 -RemoteCredentials $CTXAdmin PARAMETERS -RemoteCredentials Enable function to run remotely, if the CItrix cmdlets are not available Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -Server Server to get the permon details Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Get-CitrixSingleServerPerformance"},{"location":"Get-CitrixSingleServerPerformance/#get-citrixsingleserverperformance","text":"","title":"Get-CitrixSingleServerPerformance"},{"location":"Get-CitrixSingleServerPerformance/#synopsis","text":"Get perfmon statistics","title":"SYNOPSIS"},{"location":"Get-CitrixSingleServerPerformance/#syntax","text":"Get-CitrixSingleServerPerformance [-Server] <String> [-RemoteCredentials] <PSCredential> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CitrixSingleServerPerformance/#description","text":"Get perfmon statistics","title":"DESCRIPTION"},{"location":"Get-CitrixSingleServerPerformance/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CitrixSingleServerPerformance/#example-1","text":"Get-CitrixSingleServerPerformance -Server ddc01 -RemoteCredentials $CTXAdmin","title":"EXAMPLE 1"},{"location":"Get-CitrixSingleServerPerformance/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CitrixSingleServerPerformance/#-remotecredentials","text":"Enable function to run remotely, if the CItrix cmdlets are not available Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-RemoteCredentials"},{"location":"Get-CitrixSingleServerPerformance/#-server","text":"Server to get the permon details Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False","title":"-Server"},{"location":"Get-CitrixSingleServerPerformance/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CitrixSingleServerPerformance/#inputs","text":"","title":"INPUTS"},{"location":"Get-CitrixSingleServerPerformance/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CitrixSingleServerPerformance/#notes","text":"","title":"NOTES"},{"location":"Get-CitrixSingleServerPerformance/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CitrixWebsiteStatus/","text":"Get-CitrixWebsiteStatus SYNOPSIS Get the status of a website SYNTAX Get-CitrixWebsiteStatus [-Websitelist] <Array> [<CommonParameters>] DESCRIPTION Get the status of a website EXAMPLES EXAMPLE 1 Get-CitrixWebsiteStatus -Websitelist 'https://store.example.com' PARAMETERS -Websitelist List of websites to check Type: Array Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Get-CitrixWebsiteStatus"},{"location":"Get-CitrixWebsiteStatus/#get-citrixwebsitestatus","text":"","title":"Get-CitrixWebsiteStatus"},{"location":"Get-CitrixWebsiteStatus/#synopsis","text":"Get the status of a website","title":"SYNOPSIS"},{"location":"Get-CitrixWebsiteStatus/#syntax","text":"Get-CitrixWebsiteStatus [-Websitelist] <Array> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CitrixWebsiteStatus/#description","text":"Get the status of a website","title":"DESCRIPTION"},{"location":"Get-CitrixWebsiteStatus/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CitrixWebsiteStatus/#example-1","text":"Get-CitrixWebsiteStatus -Websitelist 'https://store.example.com'","title":"EXAMPLE 1"},{"location":"Get-CitrixWebsiteStatus/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CitrixWebsiteStatus/#-websitelist","text":"List of websites to check Type: Array Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False","title":"-Websitelist"},{"location":"Get-CitrixWebsiteStatus/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CitrixWebsiteStatus/#inputs","text":"","title":"INPUTS"},{"location":"Get-CitrixWebsiteStatus/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CitrixWebsiteStatus/#notes","text":"","title":"NOTES"},{"location":"Get-CitrixWebsiteStatus/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-RDSLicenseInformation/","text":"Get-RDSLicenseInformation SYNOPSIS Report on RDS License Usage SYNTAX Get-RDSLicenseInformation [-LicenseServer] <String> [-RemoteCredentials] <PSCredential> [<CommonParameters>] DESCRIPTION Report on RDS License Usage EXAMPLES Example 1 PS C:\\> Get-RDSLicenseInformation -LicenseServer $RDSLicenseServer -RemoteCredentials $CTXAdmin PARAMETERS -LicenseServer Name of a RDS License Server Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False -RemoteCredentials Enable function to run remotely, if the CItrix cmdlets are not available Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Get-RDSLicenseInformation"},{"location":"Get-RDSLicenseInformation/#get-rdslicenseinformation","text":"","title":"Get-RDSLicenseInformation"},{"location":"Get-RDSLicenseInformation/#synopsis","text":"Report on RDS License Usage","title":"SYNOPSIS"},{"location":"Get-RDSLicenseInformation/#syntax","text":"Get-RDSLicenseInformation [-LicenseServer] <String> [-RemoteCredentials] <PSCredential> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-RDSLicenseInformation/#description","text":"Report on RDS License Usage","title":"DESCRIPTION"},{"location":"Get-RDSLicenseInformation/#examples","text":"","title":"EXAMPLES"},{"location":"Get-RDSLicenseInformation/#example-1","text":"PS C:\\> Get-RDSLicenseInformation -LicenseServer $RDSLicenseServer -RemoteCredentials $CTXAdmin","title":"Example 1"},{"location":"Get-RDSLicenseInformation/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-RDSLicenseInformation/#-licenseserver","text":"Name of a RDS License Server Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False","title":"-LicenseServer"},{"location":"Get-RDSLicenseInformation/#-remotecredentials","text":"Enable function to run remotely, if the CItrix cmdlets are not available Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-RemoteCredentials"},{"location":"Get-RDSLicenseInformation/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-RDSLicenseInformation/#inputs","text":"","title":"INPUTS"},{"location":"Get-RDSLicenseInformation/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-RDSLicenseInformation/#notes","text":"","title":"NOTES"},{"location":"Get-RDSLicenseInformation/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-StoreFrontDetail/","text":"Get-StoreFrontDetail SYNOPSIS Report on StoreFront Status SYNTAX Get-StoreFrontDetail [-StoreFrontServer] <String> [-RemoteCredentials] <PSCredential> [-RunAsPSRemote] [<CommonParameters>] DESCRIPTION Report on StoreFront Status EXAMPLES Example 1 PS C:\\> Get-StoreFrontDetail -StoreFrontServer $CTXStoreFront -RemoteCredentials $CTXAdmin -RunAsPSRemote PARAMETERS -RemoteCredentials Credentials if running remote Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -RunAsPSRemote Enable function to run remotely, if the CItrix cmdlets are not available Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: False Accept pipeline input: False Accept wildcard characters: False -StoreFrontServer Name of one of the StoreFront servers in the farm Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Get-StoreFrontDetail"},{"location":"Get-StoreFrontDetail/#get-storefrontdetail","text":"","title":"Get-StoreFrontDetail"},{"location":"Get-StoreFrontDetail/#synopsis","text":"Report on StoreFront Status","title":"SYNOPSIS"},{"location":"Get-StoreFrontDetail/#syntax","text":"Get-StoreFrontDetail [-StoreFrontServer] <String> [-RemoteCredentials] <PSCredential> [-RunAsPSRemote] [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-StoreFrontDetail/#description","text":"Report on StoreFront Status","title":"DESCRIPTION"},{"location":"Get-StoreFrontDetail/#examples","text":"","title":"EXAMPLES"},{"location":"Get-StoreFrontDetail/#example-1","text":"PS C:\\> Get-StoreFrontDetail -StoreFrontServer $CTXStoreFront -RemoteCredentials $CTXAdmin -RunAsPSRemote","title":"Example 1"},{"location":"Get-StoreFrontDetail/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-StoreFrontDetail/#-remotecredentials","text":"Credentials if running remote Type: PSCredential Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-RemoteCredentials"},{"location":"Get-StoreFrontDetail/#-runaspsremote","text":"Enable function to run remotely, if the CItrix cmdlets are not available Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-RunAsPSRemote"},{"location":"Get-StoreFrontDetail/#-storefrontserver","text":"Name of one of the StoreFront servers in the farm Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False","title":"-StoreFrontServer"},{"location":"Get-StoreFrontDetail/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-StoreFrontDetail/#inputs","text":"","title":"INPUTS"},{"location":"Get-StoreFrontDetail/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-StoreFrontDetail/#notes","text":"","title":"NOTES"},{"location":"Get-StoreFrontDetail/#related-links","text":"","title":"RELATED LINKS"},{"location":"Import-ParametersFile/","text":"Import-ParametersFile SYNOPSIS Import the config file and creates the needed variables SYNTAX Import-ParametersFile [[-JSONParameterFilePath] <String>] [-RedoCredentials] [<CommonParameters>] DESCRIPTION Import the config file and creates the needed variables EXAMPLES EXAMPLE 1 Import-ParametersFile -JSONParameterFilePath $JSONParameterFilePath PARAMETERS -JSONParameterFilePath Path to the json config file, created by Install-ParametersFile Type: String Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: (Get-Item $profile).DirectoryName + '\\Parameters.json' Accept pipeline input: False Accept wildcard characters: False -RedoCredentials Deletes the saved credentials, and allow you to recreate them. Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: False Accept pipeline input: False Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Import-ParametersFile"},{"location":"Import-ParametersFile/#import-parametersfile","text":"","title":"Import-ParametersFile"},{"location":"Import-ParametersFile/#synopsis","text":"Import the config file and creates the needed variables","title":"SYNOPSIS"},{"location":"Import-ParametersFile/#syntax","text":"Import-ParametersFile [[-JSONParameterFilePath] <String>] [-RedoCredentials] [<CommonParameters>]","title":"SYNTAX"},{"location":"Import-ParametersFile/#description","text":"Import the config file and creates the needed variables","title":"DESCRIPTION"},{"location":"Import-ParametersFile/#examples","text":"","title":"EXAMPLES"},{"location":"Import-ParametersFile/#example-1","text":"Import-ParametersFile -JSONParameterFilePath $JSONParameterFilePath","title":"EXAMPLE 1"},{"location":"Import-ParametersFile/#parameters","text":"","title":"PARAMETERS"},{"location":"Import-ParametersFile/#-jsonparameterfilepath","text":"Path to the json config file, created by Install-ParametersFile Type: String Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: (Get-Item $profile).DirectoryName + '\\Parameters.json' Accept pipeline input: False Accept wildcard characters: False","title":"-JSONParameterFilePath"},{"location":"Import-ParametersFile/#-redocredentials","text":"Deletes the saved credentials, and allow you to recreate them. Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-RedoCredentials"},{"location":"Import-ParametersFile/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Import-ParametersFile/#inputs","text":"","title":"INPUTS"},{"location":"Import-ParametersFile/#outputs","text":"","title":"OUTPUTS"},{"location":"Import-ParametersFile/#notes","text":"","title":"NOTES"},{"location":"Import-ParametersFile/#related-links","text":"","title":"RELATED LINKS"},{"location":"Install-CTXPSModule/","text":"Install-CTXPSModule SYNOPSIS Checks and installs needed modules SYNTAX Install-CTXPSModule [[-ModuleList] <String>] [-ForceInstall] [-UpdateModules] [-RemoveAll] [<CommonParameters>] DESCRIPTION Checks and installs needed modules EXAMPLES Example 1 PS C:\\> Install-CTXPSModule -ModuleList 'C:\\Temp\\modules.json' PARAMETERS -ForceInstall Force reinstall of modules Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False -ModuleList Path to json file Type: String Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -RemoveAll Force Uninstall of the modules Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False -UpdateModules Perform module update. Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Install-CTXPSModule"},{"location":"Install-CTXPSModule/#install-ctxpsmodule","text":"","title":"Install-CTXPSModule"},{"location":"Install-CTXPSModule/#synopsis","text":"Checks and installs needed modules","title":"SYNOPSIS"},{"location":"Install-CTXPSModule/#syntax","text":"Install-CTXPSModule [[-ModuleList] <String>] [-ForceInstall] [-UpdateModules] [-RemoveAll] [<CommonParameters>]","title":"SYNTAX"},{"location":"Install-CTXPSModule/#description","text":"Checks and installs needed modules","title":"DESCRIPTION"},{"location":"Install-CTXPSModule/#examples","text":"","title":"EXAMPLES"},{"location":"Install-CTXPSModule/#example-1","text":"PS C:\\> Install-CTXPSModule -ModuleList 'C:\\Temp\\modules.json'","title":"Example 1"},{"location":"Install-CTXPSModule/#parameters","text":"","title":"PARAMETERS"},{"location":"Install-CTXPSModule/#-forceinstall","text":"Force reinstall of modules Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-ForceInstall"},{"location":"Install-CTXPSModule/#-modulelist","text":"Path to json file Type: String Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-ModuleList"},{"location":"Install-CTXPSModule/#-removeall","text":"Force Uninstall of the modules Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-RemoveAll"},{"location":"Install-CTXPSModule/#-updatemodules","text":"Perform module update. Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-UpdateModules"},{"location":"Install-CTXPSModule/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Install-CTXPSModule/#inputs","text":"","title":"INPUTS"},{"location":"Install-CTXPSModule/#outputs","text":"","title":"OUTPUTS"},{"location":"Install-CTXPSModule/#notes","text":"","title":"NOTES"},{"location":"Install-CTXPSModule/#related-links","text":"","title":"RELATED LINKS"},{"location":"Install-ParametersFile/","text":"Install-ParametersFile SYNOPSIS Create a json config with all needed farm details. SYNTAX Install-ParametersFile [<CommonParameters>] DESCRIPTION Create a json config with all needed farm details. EXAMPLES Example 1 PS C:\\>Install-ParametersFile PARAMETERS CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Install-ParametersFile"},{"location":"Install-ParametersFile/#install-parametersfile","text":"","title":"Install-ParametersFile"},{"location":"Install-ParametersFile/#synopsis","text":"Create a json config with all needed farm details.","title":"SYNOPSIS"},{"location":"Install-ParametersFile/#syntax","text":"Install-ParametersFile [<CommonParameters>]","title":"SYNTAX"},{"location":"Install-ParametersFile/#description","text":"Create a json config with all needed farm details.","title":"DESCRIPTION"},{"location":"Install-ParametersFile/#examples","text":"","title":"EXAMPLES"},{"location":"Install-ParametersFile/#example-1","text":"PS C:\\>Install-ParametersFile","title":"Example 1"},{"location":"Install-ParametersFile/#parameters","text":"","title":"PARAMETERS"},{"location":"Install-ParametersFile/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Install-ParametersFile/#inputs","text":"","title":"INPUTS"},{"location":"Install-ParametersFile/#outputs","text":"","title":"OUTPUTS"},{"location":"Install-ParametersFile/#notes","text":"","title":"NOTES"},{"location":"Install-ParametersFile/#related-links","text":"","title":"RELATED LINKS"},{"location":"Set-XDHealthReportColors/","text":"Set-XDHealthReportColors SYNOPSIS Set the color and logo for HTML Reports SYNTAX Set-XDHealthReportColors [[-Color1] <String>] [[-Color2] <String>] [[-LogoURL] <String>] [<CommonParameters>] DESCRIPTION Set the color and logo for HTML Reports. It updates the registry keys in HKCU:\\Software\\XDHealth with the new details and display a test report. EXAMPLES EXAMPLE 1 Set-XDHealthReportColors -Color1 '#d22c26' -Color2 '#2bb74e' -LogoURL 'https://gist.githubusercontent.com/default-monochrome.png' PARAMETERS -Color1 New Background Color # code Type: String Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: #061820 Accept pipeline input: False Accept wildcard characters: False -Color2 New foreground Color # code Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: #FFD400 Accept pipeline input: False Accept wildcard characters: False -LogoURL URL to the new Logo Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: Https://c.na65.content.force.com/servlet/servlet.ImageServer?id=0150h000003yYnkAAE&oid=00DE0000000c48tMAA Accept pipeline input: False Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Set-XDHealthReportColors"},{"location":"Set-XDHealthReportColors/#set-xdhealthreportcolors","text":"","title":"Set-XDHealthReportColors"},{"location":"Set-XDHealthReportColors/#synopsis","text":"Set the color and logo for HTML Reports","title":"SYNOPSIS"},{"location":"Set-XDHealthReportColors/#syntax","text":"Set-XDHealthReportColors [[-Color1] <String>] [[-Color2] <String>] [[-LogoURL] <String>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Set-XDHealthReportColors/#description","text":"Set the color and logo for HTML Reports. It updates the registry keys in HKCU:\\Software\\XDHealth with the new details and display a test report.","title":"DESCRIPTION"},{"location":"Set-XDHealthReportColors/#examples","text":"","title":"EXAMPLES"},{"location":"Set-XDHealthReportColors/#example-1","text":"Set-XDHealthReportColors -Color1 '#d22c26' -Color2 '#2bb74e' -LogoURL 'https://gist.githubusercontent.com/default-monochrome.png'","title":"EXAMPLE 1"},{"location":"Set-XDHealthReportColors/#parameters","text":"","title":"PARAMETERS"},{"location":"Set-XDHealthReportColors/#-color1","text":"New Background Color # code Type: String Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: #061820 Accept pipeline input: False Accept wildcard characters: False","title":"-Color1"},{"location":"Set-XDHealthReportColors/#-color2","text":"New foreground Color # code Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: #FFD400 Accept pipeline input: False Accept wildcard characters: False","title":"-Color2"},{"location":"Set-XDHealthReportColors/#-logourl","text":"URL to the new Logo Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: Https://c.na65.content.force.com/servlet/servlet.ImageServer?id=0150h000003yYnkAAE&oid=00DE0000000c48tMAA Accept pipeline input: False Accept wildcard characters: False","title":"-LogoURL"},{"location":"Set-XDHealthReportColors/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Set-XDHealthReportColors/#inputs","text":"","title":"INPUTS"},{"location":"Set-XDHealthReportColors/#outputs","text":"","title":"OUTPUTS"},{"location":"Set-XDHealthReportColors/#notes","text":"","title":"NOTES"},{"location":"Set-XDHealthReportColors/#related-links","text":"","title":"RELATED LINKS"},{"location":"Start-CitrixAudit/","text":"Start-CitrixAudit SYNOPSIS Creates and distributes a report on catalog, groups and published app config. SYNTAX Start-CitrixAudit [[-JSONParameterFilePath] <String>] [<CommonParameters>] DESCRIPTION Creates and distributes a report on catalog, groups and published app config. HTML Reports - When creating a HTML report: - The logo can be changed by replacing the variable - $Global:Logourl ='' - The colors of the report can be changed, by replacing: - $global:colour1 = '#061820' - $global:colour2 = '#FFD400' - Or permanently replace it by editing the following file - \\<Module base>\\Private\\Reports-Variables.ps1 EXAMPLES EXAMPLE 1 Start-CitrixAudit -JSONParameterFilePath 'C:\\temp\\Parameters.json' PARAMETERS -JSONParameterFilePath Path to the json config file, created by Install-ParametersFile Type: String Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: (Get-Item $profile).DirectoryName + \"\\Parameters.json\" Accept pipeline input: False Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Start-CitrixAudit"},{"location":"Start-CitrixAudit/#start-citrixaudit","text":"","title":"Start-CitrixAudit"},{"location":"Start-CitrixAudit/#synopsis","text":"Creates and distributes a report on catalog, groups and published app config.","title":"SYNOPSIS"},{"location":"Start-CitrixAudit/#syntax","text":"Start-CitrixAudit [[-JSONParameterFilePath] <String>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Start-CitrixAudit/#description","text":"Creates and distributes a report on catalog, groups and published app config. HTML Reports - When creating a HTML report: - The logo can be changed by replacing the variable - $Global:Logourl ='' - The colors of the report can be changed, by replacing: - $global:colour1 = '#061820' - $global:colour2 = '#FFD400' - Or permanently replace it by editing the following file - \\<Module base>\\Private\\Reports-Variables.ps1","title":"DESCRIPTION"},{"location":"Start-CitrixAudit/#examples","text":"","title":"EXAMPLES"},{"location":"Start-CitrixAudit/#example-1","text":"Start-CitrixAudit -JSONParameterFilePath 'C:\\temp\\Parameters.json'","title":"EXAMPLE 1"},{"location":"Start-CitrixAudit/#parameters","text":"","title":"PARAMETERS"},{"location":"Start-CitrixAudit/#-jsonparameterfilepath","text":"Path to the json config file, created by Install-ParametersFile Type: String Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: (Get-Item $profile).DirectoryName + \"\\Parameters.json\" Accept pipeline input: False Accept wildcard characters: False","title":"-JSONParameterFilePath"},{"location":"Start-CitrixAudit/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Start-CitrixAudit/#inputs","text":"","title":"INPUTS"},{"location":"Start-CitrixAudit/#outputs","text":"","title":"OUTPUTS"},{"location":"Start-CitrixAudit/#notes","text":"","title":"NOTES"},{"location":"Start-CitrixAudit/#related-links","text":"","title":"RELATED LINKS"},{"location":"Start-CitrixHealthCheck/","text":"Start-CitrixHealthCheck SYNOPSIS Creates and distributes a report on citrix farm health. SYNTAX Start-CitrixHealthCheck [[-JSONParameterFilePath] <String>] [<CommonParameters>] DESCRIPTION Creates and distributes a report on citrix farm health. HTML Reports - When creating a HTML report: The logo can be changed by replacing the variable $Global:Logourl ='' The colors of the report can be changed, by replacing: $global:colour1 = '#061820' $global:colour2 = '#FFD400' Or permanently replace it by editing the following file \\Private\\Reports-Variables.ps1 EXAMPLES Example 1 PS C:\\> Start-CitrixHealthCheck -JSONParameterFilePath 'C:\\temp\\Parameters.json' PARAMETERS -JSONParameterFilePath Path to the json config file, created by Install-ParametersFile Type: String Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: (Get-Item $profile).DirectoryName + \"\\Parameters.json\" Accept pipeline input: False Accept wildcard characters: False CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters . INPUTS OUTPUTS NOTES RELATED LINKS","title":"Start-CitrixHealthCheck"},{"location":"Start-CitrixHealthCheck/#start-citrixhealthcheck","text":"","title":"Start-CitrixHealthCheck"},{"location":"Start-CitrixHealthCheck/#synopsis","text":"Creates and distributes a report on citrix farm health.","title":"SYNOPSIS"},{"location":"Start-CitrixHealthCheck/#syntax","text":"Start-CitrixHealthCheck [[-JSONParameterFilePath] <String>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Start-CitrixHealthCheck/#description","text":"Creates and distributes a report on citrix farm health. HTML Reports - When creating a HTML report: The logo can be changed by replacing the variable $Global:Logourl ='' The colors of the report can be changed, by replacing: $global:colour1 = '#061820' $global:colour2 = '#FFD400' Or permanently replace it by editing the following file \\Private\\Reports-Variables.ps1","title":"DESCRIPTION"},{"location":"Start-CitrixHealthCheck/#examples","text":"","title":"EXAMPLES"},{"location":"Start-CitrixHealthCheck/#example-1","text":"PS C:\\> Start-CitrixHealthCheck -JSONParameterFilePath 'C:\\temp\\Parameters.json'","title":"Example 1"},{"location":"Start-CitrixHealthCheck/#parameters","text":"","title":"PARAMETERS"},{"location":"Start-CitrixHealthCheck/#-jsonparameterfilepath","text":"Path to the json config file, created by Install-ParametersFile Type: String Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: (Get-Item $profile).DirectoryName + \"\\Parameters.json\" Accept pipeline input: False Accept wildcard characters: False","title":"-JSONParameterFilePath"},{"location":"Start-CitrixHealthCheck/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Start-CitrixHealthCheck/#inputs","text":"","title":"INPUTS"},{"location":"Start-CitrixHealthCheck/#outputs","text":"","title":"OUTPUTS"},{"location":"Start-CitrixHealthCheck/#notes","text":"","title":"NOTES"},{"location":"Start-CitrixHealthCheck/#related-links","text":"","title":"RELATED LINKS"},{"location":"XDHealthCheck/","text":"XDHealthCheck Module Description Creates daily health check, and config reports for your on-premise Citrix farm. - To get started, you need to run Install-ParametersFile. - This will capture and save needed farm details, to allow scripts to run automatically. - This will capture and save needed farm details, to allow scripts to run automatically. HTML Reports - When creating a HTML report: - The logo can be changed by replacing the variable - $Global:Logourl ='' - The colors of the report can be changed, by replacing: - $global:colour1 = \"#061820\" - $global:colour2 = \"#FFD400\" - Or permanently replace it by editing the following file - \\Private\\Reports-Variables.ps1 XDHealthCheck Cmdlets Get-CitrixConfigurationChange Show the changes that was made to the farm Get-CitrixFarmDetail Get needed Farm details. Get-CitrixLicenseInformation Show Citrix License details Get-CitrixObjects Get details about catalogs, delivery groups and published apps Get-CitrixServerEventLog Get windows event log details Get-CitrixServerPerformance Combine perfmon of multiple servers for reporting. Get-CitrixSingleServerPerformance Get perfmon statistics Get-CitrixWebsiteStatus Get the status of a website Get-RDSLicenseInformation Report on RDS License Usage Get-StoreFrontDetail Report on StoreFront Status Import-ParametersFile Import the config file and creates the needed variables Install-CTXPSModule Checks and installs needed modules Install-ParametersFile Create a json config with all needed farm details. Set-XDHealthReportColors Set the color and logo for HTML Reports Start-CitrixAudit Creates and distributes a report on catalog, groups and published app config. Start-CitrixHealthCheck Creates and distributes a report on citrix farm health.","title":"XDHealthCheck Module"},{"location":"XDHealthCheck/#xdhealthcheck-module","text":"","title":"XDHealthCheck Module"},{"location":"XDHealthCheck/#description","text":"Creates daily health check, and config reports for your on-premise Citrix farm. - To get started, you need to run Install-ParametersFile. - This will capture and save needed farm details, to allow scripts to run automatically. - This will capture and save needed farm details, to allow scripts to run automatically. HTML Reports - When creating a HTML report: - The logo can be changed by replacing the variable - $Global:Logourl ='' - The colors of the report can be changed, by replacing: - $global:colour1 = \"#061820\" - $global:colour2 = \"#FFD400\" - Or permanently replace it by editing the following file - \\Private\\Reports-Variables.ps1","title":"Description"},{"location":"XDHealthCheck/#xdhealthcheck-cmdlets","text":"","title":"XDHealthCheck Cmdlets"},{"location":"XDHealthCheck/#get-citrixconfigurationchange","text":"Show the changes that was made to the farm","title":"Get-CitrixConfigurationChange"},{"location":"XDHealthCheck/#get-citrixfarmdetail","text":"Get needed Farm details.","title":"Get-CitrixFarmDetail"},{"location":"XDHealthCheck/#get-citrixlicenseinformation","text":"Show Citrix License details","title":"Get-CitrixLicenseInformation"},{"location":"XDHealthCheck/#get-citrixobjects","text":"Get details about catalogs, delivery groups and published apps","title":"Get-CitrixObjects"},{"location":"XDHealthCheck/#get-citrixservereventlog","text":"Get windows event log details","title":"Get-CitrixServerEventLog"},{"location":"XDHealthCheck/#get-citrixserverperformance","text":"Combine perfmon of multiple servers for reporting.","title":"Get-CitrixServerPerformance"},{"location":"XDHealthCheck/#get-citrixsingleserverperformance","text":"Get perfmon statistics","title":"Get-CitrixSingleServerPerformance"},{"location":"XDHealthCheck/#get-citrixwebsitestatus","text":"Get the status of a website","title":"Get-CitrixWebsiteStatus"},{"location":"XDHealthCheck/#get-rdslicenseinformation","text":"Report on RDS License Usage","title":"Get-RDSLicenseInformation"},{"location":"XDHealthCheck/#get-storefrontdetail","text":"Report on StoreFront Status","title":"Get-StoreFrontDetail"},{"location":"XDHealthCheck/#import-parametersfile","text":"Import the config file and creates the needed variables","title":"Import-ParametersFile"},{"location":"XDHealthCheck/#install-ctxpsmodule","text":"Checks and installs needed modules","title":"Install-CTXPSModule"},{"location":"XDHealthCheck/#install-parametersfile","text":"Create a json config with all needed farm details.","title":"Install-ParametersFile"},{"location":"XDHealthCheck/#set-xdhealthreportcolors","text":"Set the color and logo for HTML Reports","title":"Set-XDHealthReportColors"},{"location":"XDHealthCheck/#start-citrixaudit","text":"Creates and distributes a report on catalog, groups and published app config.","title":"Start-CitrixAudit"},{"location":"XDHealthCheck/#start-citrixhealthcheck","text":"Creates and distributes a report on citrix farm health.","title":"Start-CitrixHealthCheck"},{"location":"about_XDHealthCheck/","text":"XDHealthCheck about_XDHealthCheck SHORT DESCRIPTION Creates daily health check, and config reports for your on-premise Citrix farm. LONG DESCRIPTION Creates daily health check, and config reports for your on-premise Citrix farm. - To get started, you need to run Install-ParametersFile. - This will capture and save needed farm details, to allow scripts to run automatically. NOTES Get-CitrixConfigurationChange -- Show the changes that was made to the farm Get-CitrixFarmDetail -- Get needed Farm details. Get-CitrixLicenseInformation -- Show Citrix License details Get-CitrixObjects -- Get details of citrix objects Get-CitrixServerEventLog -- Get windows event log details Get-CitrixServerPerformance -- Combine perfmon of multiple servers for reporting. Get-CitrixSingleServerPerformance -- Get perfmon statistics Get-CitrixWebsiteStatus -- Get the status of a website Get-RDSLicenseInformation -- Report on RDS License Useage Get-StoreFrontDetail -- Report on Storefront status. Import-ParametersFile -- Import the config file and creates the needed variables Install-CTXPSModule -- Checks and installs needed modules Install-ParametersFile -- Create a json config file with all needed farm details. Set-XDHealthReportColors -- Set the color and logo for HTML Reports Start-CitrixAudit -- Creates and distributes a report on catalog, groups and published app config. Start-CitrixHealthCheck -- Creates and distributes a report on citrix farm health. SEE ALSO https://github.com/smitpi/XDHealthCheck https://smitpi.github.io/XDHealthCheck/","title":"XDHealthCheck"},{"location":"about_XDHealthCheck/#xdhealthcheck","text":"","title":"XDHealthCheck"},{"location":"about_XDHealthCheck/#about_xdhealthcheck","text":"","title":"about_XDHealthCheck"},{"location":"about_XDHealthCheck/#short-description","text":"Creates daily health check, and config reports for your on-premise Citrix farm.","title":"SHORT DESCRIPTION"},{"location":"about_XDHealthCheck/#long-description","text":"Creates daily health check, and config reports for your on-premise Citrix farm. - To get started, you need to run Install-ParametersFile. - This will capture and save needed farm details, to allow scripts to run automatically.","title":"LONG DESCRIPTION"},{"location":"about_XDHealthCheck/#notes","text":"Get-CitrixConfigurationChange -- Show the changes that was made to the farm Get-CitrixFarmDetail -- Get needed Farm details. Get-CitrixLicenseInformation -- Show Citrix License details Get-CitrixObjects -- Get details of citrix objects Get-CitrixServerEventLog -- Get windows event log details Get-CitrixServerPerformance -- Combine perfmon of multiple servers for reporting. Get-CitrixSingleServerPerformance -- Get perfmon statistics Get-CitrixWebsiteStatus -- Get the status of a website Get-RDSLicenseInformation -- Report on RDS License Useage Get-StoreFrontDetail -- Report on Storefront status. Import-ParametersFile -- Import the config file and creates the needed variables Install-CTXPSModule -- Checks and installs needed modules Install-ParametersFile -- Create a json config file with all needed farm details. Set-XDHealthReportColors -- Set the color and logo for HTML Reports Start-CitrixAudit -- Creates and distributes a report on catalog, groups and published app config. Start-CitrixHealthCheck -- Creates and distributes a report on citrix farm health.","title":"NOTES"},{"location":"about_XDHealthCheck/#see-also","text":"https://github.com/smitpi/XDHealthCheck https://smitpi.github.io/XDHealthCheck/","title":"SEE ALSO"}]}
|