Product Documentation

Set-MonitorConfiguration

Sep 10, 2014

Sets configuration settings that are used by the Monitor Service.

Syntax

Set-MonitorConfiguration [-GroomSessionsRetentionDays <Int32>] [-GroomFailuresRetentionDays <Int32>] [-GroomLoadIndexesRetentionDays <Int32>] [-GroomDeletedRetentionDays <Int32>] [-GroomSummariesRetentionDays <Int32>] [-GroomMachineHotfixLogRetentionDays <Int32>] [-GroomMinuteRetentionDays <Int32>] [-DataCollectionEnabled <Boolean>] [-FullPollStartHour <Int32>] [-ResolutionPollTimeHours <Int32>] [-SyncPollTimeHours <Int32>] [-DetailedSqlOutputEnabled <Boolean>] [-CollectHotfixDataEnabled <Boolean>] [-GroomApplicationInstanceRetentionDays <Int32>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Sets the configuration settings used by the Monitor Service. Use these settings to modify the behavior of the service.

A database connection need not be configured for this command to be used.

Note

For parameters whose default values depend on the product edition, as noted here, the values of these parameters are set to the new default values when the edition is changed. 

Related topics

Get-MonitorConfiguration

Parameters

-GroomSessionsRetentionDays<Int32>

Determines how many days to keep Session and Connection records after the Session is terminated.

Required? false
Default Value 7 for non-platinum, 90 for platinum.
Accept Pipeline Input? false

-GroomFailuresRetentionDays<Int32>

Determines how many days to keep MachineFailureLog and ConnectionFailureLog records after these are created.

Required? false
Default Value 7 for non-platinum, 90 for platinum.
Accept Pipeline Input? false

-GroomLoadIndexesRetentionDays<Int32>

Determines how many days to keep LoadIndex records after these are created.

Required? false
Default Value 7 for non-platinum, 90 for platinum.
Accept Pipeline Input? false

-GroomDeletedRetentionDays<Int32>

Determines how many days to keep Machine, Catalog, DesktopGroup and Hypervisor entities around that have a LifecycleState of ‘Deleted’. This also deletes any related Session, Connection, Summary, Failure or LoadIndex records.

Required? false
Default Value 7 for non-platinum, 90 for platinum.
Accept Pipeline Input? false

-GroomSummariesRetentionDays<Int32>

Determines how many days to keep DesktopGroupSummary, FailureLogSummary and LoadIndexSummary records at the daily granularity.

Required? false
Default Value 7 for non-platinum, 90 for platinum.
Accept Pipeline Input? false

-GroomMachineHotfixLogRetentionDays<Int32>

Determines how many days to keep Machine-Hotfix history records at the daily granularity.

Required? false
Default Value 90
Accept Pipeline Input? false

-GroomMinuteRetentionDays<Int32>

Determines how many days to keep minute data.

Required? false
Default Value 3
Accept Pipeline Input? false

-DataCollectionEnabled<Boolean>

Starts / stops data collection. Stopping data collection turns off polling, and does not persist operational event data to the database.

Required? false
Default Value True
Accept Pipeline Input? false

-FullPollStartHour<Int32>

Hour of day when Full Poll should begin.

Required? false
Default Value  
Accept Pipeline Input? false

-ResolutionPollTimeHours<Int32>

Start time for the Resolution Poll worker.

Required? false
Default Value  
Accept Pipeline Input? false

-SyncPollTimeHours<Int32>

Start time for Sync Poll worker.

Required? false
Default Value  
Accept Pipeline Input? false

-DetailedSqlOutputEnabled<Boolean>

Determines if the SqlLog should be enabled to send SQL statements to the CDF Trace

Required? false
Default Value False
Accept Pipeline Input? false

-CollectHotfixDataEnabled<Boolean>

This setting determines if the hotfix inventory data should be collected and stored in the database or if it should be thrown away.

Required? false
Default Value  
Accept Pipeline Input? false

-GroomApplicationInstanceRetentionDays<Int32>

Required? false
Default Value  
Accept Pipeline Input? false

-LoggingId<Guid>

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>Set-MonitorConfiguration -GroomSessionsRetentionDays 5 -GroomFailuresRetentionDays 4 ...

Updates the settings in the site database with the newly specified values.