Citrix Virtual Apps and Desktops SDK

Set-MonitorConfiguration

March 11, 2024

Contributed by:

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>] [-GroomHourlyRetentionDays <Int32>] [-DataCollectionEnabled <Boolean>] [-FullPollStartHour <Int32>] [-GroomStartHour <Int32>] [-GroomStartMinuteOffsetEarliest <Int32>] [-GroomStartMinuteOffsetLatest <Int32>] [-SyncDataToCasStartHour <Int32>] [-ResolutionPollTimeHours <Int32>] [-SyncPollTimeHours <Int32>] [-DetailedSqlOutputEnabled <Boolean>] [-MonitorQueryTimeoutSeconds <Int32>] [-CollectHotfixDataEnabled <Boolean>] [-GroomApplicationInstanceRetentionDays <Int32>] [-GroomApplicationErrorsRetentionDays <Int32>] [-GroomApplicationFaultsRetentionDays <Int32>] [-GroomNotificationLogRetentionDays <Int32>] [-GroomResourceUsageRawDataRetentionDays <Int32>] [-GroomResourceUsageMinuteDataRetentionDays <Int32>] [-GroomResourceUsageHourDataRetentionDays <Int32>] [-GroomResourceUsageDayDataRetentionDays <Int32>] [-GroomProcessUsageHourDataRetentionDays <Int32>] [-GroomProcessUsageDayDataRetentionDays <Int32>] [-GroomSessionMetricsDataRetentionDays <Int32>] [-GroomMachineMetricDataRetentionDays <Int32>] [-GroomMachineMetricDaySummaryDataRetentionDays <Int32>] [-EnableDayLevelGranularityProcessUtilization <Boolean>] [-GroomApplicationProbeLogsRetentionDays <Int32>] [-EnableHourLevelGranularityProcessUtilization <Boolean>] [-EnableMinLevelGranularityProcessUtilization <Boolean>] [-GroomSessionAutoReconnectsRetentionDays <Int32>] [-DisableHypervisorMonitoring <Boolean>] [-SendProcessDataToCASAndDatabase <Boolean>] [-SendProcessDataToCASAndSkipDatabase <Boolean>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

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.

Get-MonitorConfiguration

Parameters

Name	Description	Required?	Pipeline Input	Default Value
GroomSessionsRetentionDays	Determines how many days to keep Session and Connection records after the Session is terminated.	false	false	7 for non-platinum, 90 for platinum.
GroomFailuresRetentionDays	Determines how many days to keep MachineFailureLog and ConnectionFailureLog records after these are created.	false	false	7 for non-platinum, 90 for platinum.
GroomLoadIndexesRetentionDays	Determines how many days to keep LoadIndex records after these are created.	false	false	7 for non-platinum, 90 for platinum.
GroomDeletedRetentionDays	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.	false	false	7 for non-platinum, 90 for platinum.
GroomSummariesRetentionDays	Determines how many days to keep DesktopGroupSummary, FailureLogSummary and LoadIndexSummary records at the daily granularity.	false	false	7 for non-platinum, 90 for platinum.
GroomMachineHotfixLogRetentionDays	Determines how many days to keep Machine-Hotfix history records at the daily granularity.	false	false	90
GroomMinuteRetentionDays	Determines how many days to keep minute data.	false	false	3
GroomHourlyRetentionDays	Determines how many days to keep hourly data.	false	false	7 for non-platinum, 32 for platinum.
DataCollectionEnabled	Starts / stops data collection. Stopping data collection turns off polling, and does not persist operational event data to the database.	false	false	True
FullPollStartHour	Hour of day when Full Poll should begin.	false	false
GroomStartHour	Hour of day when Grooming should begin. Time with respect to UTC. Expected Values 0-23.	false	false
GroomStartMinuteOffsetEarliest	Earliest minute of day when Grooming should begin. Time with respect to UTC. Expected Values 0-1439.	false	false
GroomStartMinuteOffsetLatest	Latest minute of day when Grooming should begin. Time with respect to UTC. Expected Values 0-1439.	false	false
SyncDataToCasStartHour	Hour of the day when sync to CAS via blob path should start. Default is 1 AM	false	false
ResolutionPollTimeHours	Start time for the Resolution Poll worker.	false	false
SyncPollTimeHours	Start time for Sync Poll worker.	false	false
DetailedSqlOutputEnabled	Determines if the SqlLog should be enabled to send SQL statements to the CDF Trace	false	false	False
MonitorQueryTimeoutSeconds	Determines the maximum time Monitoring Service will wait for the database query execution	false	false	300
CollectHotfixDataEnabled	This setting determines if the hotfix inventory data should be collected and stored in the database or if it should be thrown away.	false	false
GroomApplicationInstanceRetentionDays	Determines how many days to keep the history of application instances.	false	false	0 for non-platinum, 90 for platinum.
GroomApplicationErrorsRetentionDays	Determines how many days to keep the history of application errors.	false	false	1 for Platinum, Enterprise and Non-Platinum licenses
GroomApplicationFaultsRetentionDays	Determines how many days to keep the history of application faults.	false	false	1 for Platinum, Enterprise and Non-Platinum licenses
GroomNotificationLogRetentionDays	FIXME	false	false
GroomResourceUsageRawDataRetentionDays	Determines how many days to keep Resource Utilization data.	false	false	1 for non-platinum and platinum.
GroomResourceUsageMinuteDataRetentionDays	Determines how many days to keep Resource Utilization summary minute data.	false	false	7 for non-platinum and platinum.
GroomResourceUsageHourDataRetentionDays	Determines how many days to keep Resource Utilization summary hour data.	false	false	7 for non-platinum and 30 for platinum.
GroomResourceUsageDayDataRetentionDays	Determines how many days to keep Resource Utilization summary day data.	false	false	7 for non-platinum and 90 for platinum.
GroomProcessUsageHourDataRetentionDays	Determines how many days to keep Process Utilization summary hour data.	false	false	7 for non-platinum and platinum.
GroomProcessUsageDayDataRetentionDays	Determines how many days to keep Process Utilization summary day data.	false	false	7 for non-platinum and 30 for platinum.
GroomSessionMetricsDataRetentionDays	Determines how many days to keep SessionMetrics data.	false	false	7 for non-platinum and platinum.
GroomMachineMetricDataRetentionDays	Determines how many days to keep MachineMetrics data.	false	false	3 for non-platinum and platinum.
GroomMachineMetricDaySummaryDataRetentionDays	Determines how many days to keep MachineMetricsSummary data.	false	false	7 for non-platinum and 90 for platinum.
EnableDayLevelGranularityProcessUtilization	This setting is used to determine to enable or disable Day Level granularity for Process Data.	false	false
GroomApplicationProbeLogsRetentionDays	Determines how many days to keep the history of application probe logs.	false	false	7 for Platinum, Enterprise and Non-Platinum licenses
EnableHourLevelGranularityProcessUtilization	This setting is used to determine to enable or disable Hour Level granularity for Process Data.	false	false
EnableMinLevelGranularityProcessUtilization	This setting is used to determine to enable or disable Minute Level granularity for Process Data.	false	false
GroomSessionAutoReconnectsRetentionDays	Determines how many days to keep SessionAutoReconnects data	false	false	7 for non-platinum, 31 for platinum.
DisableHypervisorMonitoring	Disable Hypervisor Monitoring for Cloud	false	false	false
SendProcessDataToCASAndDatabase	This setting is useful for sending VDA Process data to CAS and Database	false	false	False
SendProcessDataToCASAndSkipDatabase	This setting is useful for sending VDA Process data to CAS and skip Database	false	false	False
LoggingId	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.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the Client IP of the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	Specifies the address of a Citrix Virtual Apps and Desktops 7 controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

Examples

Example 1

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

<!--NeedCopy-->

Description

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-MonitorConfiguration

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Set-MonitorConfiguration

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Examples

Example 1

Description

In this article