Set-MonitorConfiguration
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>]
[-GroomEndpointMetricsDataRetentionDays <Int32>]
[-GroomMachineMetricDataRetentionDays <Int32>]
[-GroomMachineMetricDaySummaryDataRetentionDays <Int32>]
[-EnableDayLevelGranularityProcessUtilization <Boolean>]
[-GroomApplicationProbeLogsRetentionDays <Int32>]
[-EnableHourLevelGranularityProcessUtilization <Boolean>]
[-EnableMinLevelGranularityProcessUtilization <Boolean>]
[-GroomSessionAutoReconnectsRetentionDays <Int32>]
[-DisableHypervisorMonitoring <Boolean>]
[-SendProcessDataToCASAndDatabase <Boolean>]
[-SendProcessDataToCASAndSkipDatabase <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>]
[-GroomDevicePostureAnalysisRetentionDays <Int32>]
[-GroomApplicationNameIdRetentionDays <Int32>]
[-GroomApplicationIdDesktopGroupIdMappingRetentionDays <Int32>]
[-GroomHistoricalApplicationLaunchRetentionDays <Int32>]
[-GroomApplicationUsageSummaryRetentionDays <Int32>]
[-GroomActiveApplicationLaunchRetentionDays <Int32>]
[-GroomProcessGUIDCacheRetentionDays <Int32>]
[-GroomSpaConnectorApplianceMetricsRetentionDays <Int32>]
[-GroomSpaLatencyMetricsRetentionDays <Int32>]
[-GroomSpaConnectorApplianceAppServerMetricsRetentionDays <Int32>]
[-GroomSpaActiveUserSummaryHourlyRetentionDays <Int32>]
[-GroomSpaActiveUserSummaryDailyRetentionDays <Int32>]
[-GroomUCAppsOptimizationSummaryRetentionDays <Int32>]
[-GroomSessionPerformanceSummaryRetentionDays <Int32>]
[-GroomSessionScoreMetricsRetentionDays <Int32>]
[-GroomSessionScoreMetricsFrequencyDays <Int32>]
[-GroomSessionPerformanceSummaryFrequencyDays <Int32>]
[-GroomLogServerTelemetryDataRetentionDays <Int32>]
[-GroomEndpointSecurityEventsRetentionDays <Int32>]
[-GroomApplicationPerformanceMetricsRetentionDays <Int32>]
[-GroomApplicationPerformanceMetricsSummaryHourDataRetentionDays <Int32>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2003 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2212 |
-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: | 7 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 |
-GroomEndpointMetricsDataRetentionDays
Determines how many days to keep EndpointMetrics data.
| Type: | Int32 |
| Position: | Named |
| Default value: | 7 for non-platinum and platinum. |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2206 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2203 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2203 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2308 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2308 |
-GroomProcessDataLimitedMachinesRetentionDays
Delete all the table entry
| Type: | Int32 |
| Position: | Named |
| Default value: | 7 Days |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2308 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2308 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2311 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2407 |
-GroomMachineCostSavingsSummaryHourlyRetentionDays
Determines how many days to keep MachineCostSavingsSummary data at hour level
| Type: | Int32 |
| Position: | Named |
| Default value: | 93 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2407 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2407 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2407 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2402 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2407 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2407 |
-DirectorAgentDefaultPollIntervalInSeconds
Determines the Director Agent polling interval.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2407 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2407 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2407 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2407 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2411 |
-GroomDevicePostureAnalysisRetentionDays
Determines how many days to device posture data
| Type: | Int32 |
| Position: | Named |
| Default value: | 7 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-GroomApplicationNameIdRetentionDays
Determines how many days to keep ApplicationNameId data
| Type: | Int32 |
| Position: | Named |
| Default value: | 120 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-GroomApplicationIdDesktopGroupIdMappingRetentionDays
Determines how many days to keep ApplicationIdDesktopGroupIdMapping data
| Type: | Int32 |
| Position: | Named |
| Default value: | 120 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-GroomHistoricalApplicationLaunchRetentionDays
Determines how many days to keep HistoricalApplicationLaunch data
| Type: | Int32 |
| Position: | Named |
| Default value: | 30 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-GroomApplicationUsageSummaryRetentionDays
Determines how many days to keep ApplicationUsageSummary data
| Type: | Int32 |
| Position: | Named |
| Default value: | 90 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-GroomActiveApplicationLaunchRetentionDays
Determines how many days to keep ActiveApplicationLaunch data
| Type: | Int32 |
| Position: | Named |
| Default value: | 30 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-GroomProcessGUIDCacheRetentionDays
Determines how many days to keep ProcessGUIDCache data
| Type: | Int32 |
| Position: | Named |
| Default value: | 1 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-GroomSpaConnectorApplianceMetricsRetentionDays
Determines how many days to keep SpaConnectorApplianceMetrics data
| Type: | Int32 |
| Position: | Named |
| Default value: | 7 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
-GroomSpaLatencyMetricsRetentionDays
Determines how many days to keep SpaLatencyMetrics data
| Type: | Int32 |
| Position: | Named |
| Default value: | 3 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
-GroomSpaConnectorApplianceAppServerMetricsRetentionDays
Determines how many days to keep SpaConnectorApplianceAppServerMetrics data
| Type: | Int32 |
| Position: | Named |
| Default value: | 3 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2603 |
-GroomSpaActiveUserSummaryHourlyRetentionDays
Determines how many days to keep SpaActiveUserSummary data at hour level
| Type: | Int32 |
| Position: | Named |
| Default value: | 7 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
-GroomSpaActiveUserSummaryDailyRetentionDays
Determines how many days to keep SpaActiveUserSummary data at daily level
| Type: | Int32 |
| Position: | Named |
| Default value: | 365 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
-GroomUCAppsOptimizationSummaryRetentionDays
Determines how many days to keep UCAppsOptimizationSummary data
| Type: | Int32 |
| Position: | Named |
| Default value: | 7 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
-GroomSessionPerformanceSummaryRetentionDays
Determines how many days to keep SessionPerformanceSummary data
| Type: | Int32 |
| Position: | Named |
| Default value: | 7 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2603 |
-GroomSessionScoreMetricsRetentionDays
Determines how many days to keep SessionScoreMetrics data
| Type: | Int32 |
| Position: | Named |
| Default value: | 1 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2603 |
-GroomSessionScoreMetricsFrequencyDays
Determines how often (in days) the SessionScoreMetrics grooming task is run
| Type: | Int32 |
| Position: | Named |
| Default value: | 1 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2603 |
-GroomSessionPerformanceSummaryFrequencyDays
Determines how often (in days) the Session Performance Summary grooming task is run
| Type: | Int32 |
| Position: | Named |
| Default value: | 1 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2603 |
-GroomLogServerTelemetryDataRetentionDays
Determines how many days to keep LogServerTelemetryData data in the database
| Type: | Int32 |
| Position: | Named |
| Default value: | 90 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2603 |
-GroomEndpointSecurityEventsRetentionDays
Determines how many days to keep EndpointSecurityEvents data in the database
| Type: | Int32 |
| Position: | Named |
| Default value: | 32 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2603 |
-GroomApplicationPerformanceMetricsRetentionDays
Determines how many days to keep ApplicationPerformanceMetrics data in the database
| Type: | Int32 |
| Position: | Named |
| Default value: | 7 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2603 |
-GroomApplicationPerformanceMetricsSummaryHourDataRetentionDays
Determines how many days to keep hour-level ApplicationPerformanceMetricsSummary data in the database
| Type: | Int32 |
| Position: | Named |
| Default value: | 7 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2603 |
-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 |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
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.
Removed Parameters
Parameters in this section were available in older releases, and have been removed or replaced due to changes in functionality.
-DisablePendoTrackEvents
Disable Pendo Track Events
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2308 |
| Removed in: | Citrix Virtual Apps and Desktop 7 2503 |
Inputs
None
You can’t pipe objects to this cmdlet.
Outputs
None
By default, this cmdlet returns no output.