Developer Documentation
Citrix Daas SDK

Set-MonitorConfiguration

November 26, 2024
Contributed by: 
C C

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>]
   [-DisablePendoTrackEvents <Boolean>]
   [-EnableProcessDataLimitedMachines <Boolean>]
   [-SessionRecordingDataProcessing <Boolean>]
   [-GroomProcessDataLimitedMachinesRetentionDays <Int32>]
   [-ProcessDataLimitedMachinesCount <Int32>]
   [-GroomLhcReportRetentionDays <Int32>]
   [-GroomMachinePowerActionLogRetentionDays <Int32>]
   [-GroomMachineCostSavingsSummaryHourlyRetentionDays <Int32>]
   [-GroomMachineCostSavingsSummaryDailyRetentionDays <Int32>]
   [-GroomMachineCostSavingsSummaryMonthlyRetentionDays <Int32>]
   [-GroomMachineCostAllocationSummaryHourlyRetentionDays <Int32>]
   [-GroomMachineCostAllocationSummaryDailyRetentionDays <Int32>]
   [-GroomMachineCostAllocationSummaryMonthlyRetentionDays <Int32>]
   [-GroomUserMachineLogSummaryRetentionDays <Int32>]
   [-GroomMonthlyCostSummaryRetentionDays <Int32>]
   [-EnableVdaDataCollection <Boolean>]
   [-GroomComponentMetricsRetentionDays <Int32>]
   [-GroomComponentResourceUtilizationRetentionDays <Int32>]
   [-DirectorAgentDefaultPollIntervalInSeconds <Int32>]
   [-DirectorAgentDefaultPollStartupDelayMinutes <Int32>]
   [-DirectorAgentEnableHttps <Boolean>]
   [-GroomAutoScalePredictionRetentionDays <Int32>]
   [-GroomUserResourceUtilizationSummaryRetentionDays <Int32>]
   [-GroomSessionIdleTimeRetentionDays <Int32>]
   [-GroomOldSpaSessionsRetentionDays <Int32>]
   [-GroomOldSpaEnumerationsRetentionDays <Int32>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

Set-MonitorConfiguration -GroomSessionsRetentionDays 5 -GroomFailuresRetentionDays 4 ...
<!--NeedCopy-->

Parameters

-GroomSessionsRetentionDays

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

Type: Int32
Position: Named
Default value: 7 for non-platinum, 90 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomFailuresRetentionDays

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

Type: Int32
Position: Named
Default value: 7 for non-platinum, 90 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomLoadIndexesRetentionDays

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

Type: Int32
Position: Named
Default value: 7 for non-platinum, 90 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-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.

Type: Int32
Position: Named
Default value: 7 for non-platinum, 90 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomSummariesRetentionDays

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

Type: Int32
Position: Named
Default value: 7 for non-platinum, 90 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMachineHotfixLogRetentionDays

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

Type: Int32
Position: Named
Default value: 90
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMinuteRetentionDays

Determines how many days to keep minute data.

Type: Int32
Position: Named
Default value: 3
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomHourlyRetentionDays

Determines how many days to keep hourly data.

Type: Int32
Position: Named
Default value: 7 for non-platinum, 32 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DataCollectionEnabled

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

Type: Boolean
Position: Named
Default value: True
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-FullPollStartHour

Hour of day when Full Poll should begin.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomStartHour

Hour of day when Grooming should begin. Time with respect to UTC. Expected Values 0-23.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomStartMinuteOffsetEarliest

Earliest minute of day when Grooming should begin. Time with respect to UTC. Expected Values 0-1439.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomStartMinuteOffsetLatest

Latest minute of day when Grooming should begin. Time with respect to UTC. Expected Values 0-1439.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SyncDataToCasStartHour

Hour of the day when sync to CAS via blob path should start. Default is 1 AM

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ResolutionPollTimeHours

Start time for the Resolution Poll worker.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SyncPollTimeHours

Start time for Sync Poll worker.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DetailedSqlOutputEnabled

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

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MonitorQueryTimeoutSeconds

Determines the maximum time Monitoring Service will wait for the database query execution

Type: Int32
Position: Named
Default value: 300
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-CollectHotfixDataEnabled

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

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomApplicationInstanceRetentionDays

Determines how many days to keep the history of application instances.

Type: Int32
Position: Named
Default value: 0 for non-platinum, 90 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomApplicationErrorsRetentionDays

Determines how many days to keep the history of application errors.

Type: Int32
Position: Named
Default value: 1 for Platinum, Enterprise and Non-Platinum licenses
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomApplicationFaultsRetentionDays

Determines how many days to keep the history of application faults.

Type: Int32
Position: Named
Default value: 1 for Platinum, Enterprise and Non-Platinum licenses
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomNotificationLogRetentionDays

FIXME

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomResourceUsageRawDataRetentionDays

Determines how many days to keep Resource Utilization data.

Type: Int32
Position: Named
Default value: 1 for non-platinum and platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomResourceUsageMinuteDataRetentionDays

Determines how many days to keep Resource Utilization summary minute data.

Type: Int32
Position: Named
Default value: 7 for non-platinum and platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomResourceUsageHourDataRetentionDays

Determines how many days to keep Resource Utilization summary hour data.

Type: Int32
Position: Named
Default value: 7 for non-platinum and 30 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomResourceUsageDayDataRetentionDays

Determines how many days to keep Resource Utilization summary day data.

Type: Int32
Position: Named
Default value: 7 for non-platinum and 90 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomProcessUsageHourDataRetentionDays

Determines how many days to keep Process Utilization summary hour data.

Type: Int32
Position: Named
Default value: 7 for non-platinum and platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomProcessUsageDayDataRetentionDays

Determines how many days to keep Process Utilization summary day data.

Type: Int32
Position: Named
Default value: 7 for non-platinum and 30 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomSessionMetricsDataRetentionDays

Determines how many days to keep SessionMetrics data.

Type: Int32
Position: Named
Default value: 7 for non-platinum and platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMachineMetricDataRetentionDays

Determines how many days to keep MachineMetrics data.

Type: Int32
Position: Named
Default value: 3 for non-platinum and platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMachineMetricDaySummaryDataRetentionDays

Determines how many days to keep MachineMetricsSummary data.

Type: Int32
Position: Named
Default value: 7 for non-platinum and 90 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-EnableDayLevelGranularityProcessUtilization

This setting is used to determine to enable or disable Day Level granularity for Process Data.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomApplicationProbeLogsRetentionDays

Determines how many days to keep the history of application probe logs.

Type: Int32
Position: Named
Default value: 7 for Platinum, Enterprise and Non-Platinum licenses
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-EnableHourLevelGranularityProcessUtilization

This setting is used to determine to enable or disable Hour Level granularity for Process Data.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-EnableMinLevelGranularityProcessUtilization

This setting is used to determine to enable or disable Minute Level granularity for Process Data.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomSessionAutoReconnectsRetentionDays

Determines how many days to keep SessionAutoReconnects data

Type: Int32
Position: Named
Default value: 7 for non-platinum, 31 for platinum.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DisableHypervisorMonitoring

Disable Hypervisor Monitoring for Cloud

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SendProcessDataToCASAndDatabase

This setting is useful for sending VDA Process data to CAS and Database

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SendProcessDataToCASAndSkipDatabase

This setting is useful for sending VDA Process data to CAS and skip Database

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DisablePendoTrackEvents

Disable Pendo Track Events

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-EnableProcessDataLimitedMachines

Enable Process Data to be sent for 5000 Machines when number of VDAs is greater than 5k

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SessionRecordingDataProcessing

This setting is useful for Processing Session Recording Events that are coming from VDA

Type: Boolean
Position: Named
Default value: True
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomProcessDataLimitedMachinesRetentionDays

Delete all the table entry

Type: Int32
Position: Named
Default value: 7 Days
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ProcessDataLimitedMachinesCount

Number of Machines to be allowed for sending the Process Data

Type: Int32
Position: Named
Default value: 5000
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomLhcReportRetentionDays

Determines how many days to keep LhcReport data

Type: Int32
Position: Named
Default value: 90
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMachinePowerActionLogRetentionDays

Determines how many days to keep MachinePowerActionLog data

Type: Int32
Position: Named
Default value: 1
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMachineCostSavingsSummaryHourlyRetentionDays

Determines how many days to keep MachineCostSavingsSummary data at hour level

Type: Int32
Position: Named
Default value: 45
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMachineCostSavingsSummaryDailyRetentionDays

Determines how many days to keep MachineCostSavingsSummary data at day level

Type: Int32
Position: Named
Default value: 32
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMachineCostSavingsSummaryMonthlyRetentionDays

Determines how many days to keep MachineCostSavingsSummary data at month level

Type: Int32
Position: Named
Default value: 1825
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMachineCostAllocationSummaryHourlyRetentionDays

Determines how many days to keep MachineCostAllocationSummary data at hour level

Type: Int32
Position: Named
Default value: 2
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMachineCostAllocationSummaryDailyRetentionDays

Determines how many days to keep MachineCostAllocationSummary data at day level

Type: Int32
Position: Named
Default value: 32
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMachineCostAllocationSummaryMonthlyRetentionDays

Determines how many days to keep MachineCostAllocationSummary data at month level

Type: Int32
Position: Named
Default value: 279
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomUserMachineLogSummaryRetentionDays

Determines how many days to keep UserMachineLogSummary data

Type: Int32
Position: Named
Default value: 95
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomMonthlyCostSummaryRetentionDays

Determines how many days to keep MonthlyCostSummary data

Type: Int32
Position: Named
Default value: 279
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-EnableVdaDataCollection

Enable the VDA Data Collection feature for pushing the config to VDA and send events to CAS EH

Type: Boolean
Position: Named
Default value: True
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomComponentMetricsRetentionDays

Determines how many days to keep ComponentMetrics data

Type: Int32
Position: Named
Default value: 7
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomComponentResourceUtilizationRetentionDays

Determines how many days to keep ComponentResourceUtilization data

Type: Int32
Position: Named
Default value: 3
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DirectorAgentDefaultPollIntervalInSeconds

Determines the Director Agent polling interval.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DirectorAgentDefaultPollStartupDelayMinutes

Determines delay of the Director Agent polling start after service startup.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DirectorAgentEnableHttps

Determines Whether HTTPS is enabled on Director Agent or not.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomAutoScalePredictionRetentionDays

Determines how many days to keep AutoScalePrediction data

Type: Int32
Position: Named
Default value: 45
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomUserResourceUtilizationSummaryRetentionDays

Determines how many days to keep UserResourceUtilizationSummary data at day level

Type: Int32
Position: Named
Default value: 32
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomSessionIdleTimeRetentionDays

Determines how many days to keep SessionIdleTime data

Type: Int32
Position: Named
Default value: 2
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomOldSpaSessionsRetentionDays

Determines how many days to keep Spa sessions data

Type: Int32
Position: Named
Default value: 7
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-GroomOldSpaEnumerationsRetentionDays

Determines how many days to keep Spa enumerations data

Type: Int32
Position: Named
Default value: 7
Required: False
Accept pipeline input: False
Accept wildcard characters: 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.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

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

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Set-MonitorConfiguration
November 26, 2024
Contributed by: 
C C
November 26, 2024
Contributed by: 
C C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.