Add-MonitorNotificationPolicyCondition

Last published : Oct 31, 2026

Add conditions to the existing policy specified and returns the updated policy.

Syntax

Add-MonitorNotificationPolicyCondition
    [-LoggingId <Guid>]
    [-SkipCertificateValidation]
    [<CitrixCommonParameters>]
    [<CommonParameters>]

Add-MonitorNotificationPolicyCondition
    -InputObject <MonitorNotificationPolicy>
    [-AlertThreshold <Int32>]
    [-AlarmThreshold <Int32>]
    [-AlertRenotification <TimeSpan>]
    [-AlarmRenotification <TimeSpan>]
    [-SearchWindow <TimeSpan>]
    [-AlertConditionPersistenceInterval <TimeSpan>]
    [-AlarmConditionPersistenceInterval <TimeSpan>]
    [-Granularity <TimeSpan>]
    [-AlertSampleCount <Int32>]
    [-AlarmSampleCount <Int32>]
    [-AlertSamplePercent <Int32>]
    [-AlarmSamplePercent <Int32>]
    [-DataSource <Int32>]
    [-UptimeHoursThreshold <Int32>]
    [-UptimePeriodType <MachineUptimePeriodType>]
    [-NextRunAt <DateTime>]
    [-AlertTriggeredBy <PowerActionTriggeredBy>]
    [-AlertReasonOfFailure <PowerActionFailureReasonCode>]
    [-AlarmTriggeredBy <PowerActionTriggeredBy>]
    [-AlarmReasonOfFailure <PowerActionFailureReasonCode>]
    [-LoggingId <Guid>]
    [-SkipCertificateValidation]
    [<CitrixCommonParameters>]
    [<CommonParameters>]

Add-MonitorNotificationPolicyCondition
    -Uid <Int64>
    -ConditionType <ConditionType>
    [-AlertThreshold <Int32>]
    [-AlarmThreshold <Int32>]
    [-AlertRenotification <TimeSpan>]
    [-AlarmRenotification <TimeSpan>]
    [-SearchWindow <TimeSpan>]
    [-AlertConditionPersistenceInterval <TimeSpan>]
    [-AlarmConditionPersistenceInterval <TimeSpan>]
    [-Granularity <TimeSpan>]
    [-AlertSampleCount <Int32>]
    [-AlarmSampleCount <Int32>]
    [-AlertSamplePercent <Int32>]
    [-AlarmSamplePercent <Int32>]
    [-DataSource <Int32>]
    [-UptimeHoursThreshold <Int32>]
    [-UptimePeriodType <MachineUptimePeriodType>]
    [-NextRunAt <DateTime>]
    [-AlertTriggeredBy <PowerActionTriggeredBy>]
    [-AlertReasonOfFailure <PowerActionFailureReasonCode>]
    [-AlarmTriggeredBy <PowerActionTriggeredBy>]
    [-AlarmReasonOfFailure <PowerActionFailureReasonCode>]
    [-LoggingId <Guid>]
    [-SkipCertificateValidation]
    [<CitrixCommonParameters>]
    [<CommonParameters>]

Description

Add conditions to the existing policy specified and returns the updated policy.

Examples

EXAMPLE 1

Add SessionsConcurrentCount condition to the policy matching the id 100

$timeSpan = New-TimeSpan -Seconds 30
 $alertThreshold = 10
 $alarmThreshold = 20
 
 Add-MonitorNotificationPolicyCondition -Uid 100 -ConditionType SessionsConcurrentCount -AlertThreshold $alertThreshold -AlarmThreshold $alarmThreshold  -AlertRenotification $timeSpan -AlarmRenotification $timeSpan

Parameters

-InputObject

Specifies the policy object to which the conditions to be added

Type:	MonitorNotificationPolicy
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-Uid

Specifies the unique identifier of the policy to which the conditions to be added

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

-ConditionType

Type of the condition using a text string converted to an enum value Possible values are

SessionsConcurrentCount
SessionsPeakconnectedCount
SessionsPeakDisconnectedCount
AverageLogonDuration
RDSLoadEvaluator
ConnectionFailuresRate
ConnectionFailuresCount
FailedServerMachineCount
FailedDesktopMachineCount
LogonDuration
IcaRoundtripTime
IcaRoundtripTimeAverage
IcaRoundtripTimeSessionCount
IcaRoundtripTimeSessionPercent
MemoryUsage
CpuUsage
FailedMachinePercentage
UnregisteredMachinesPercentage
CCAgentDiscovery
CCAgentLogger
CCCredentialProvider
CCWebRelayProvider
CCNetScalerCloudGateway
CCADProvider
CCCDFCaptureService
CCConnectionLeaseExchangeService
CCHeartbeatFailure
MachineUptime
FailedPowerOnAction
FailedPowerOffAction

Type:	ConditionType
Accepted values:	Unknown, SessionsConcurrentCount, SessionsPeakconnectedCount, SessionsPeakDisconnectedCount, AverageLogonDuration, RDSLoadEvaluator, ConnectionFailuresRate, ConnectionFailuresCount, FailedServerMachineCount, FailedDesktopMachineCount, LogonDuration, IcaRoundtripTime, IcaRoundtripTimeAverage, IcaRoundtripTimeSessionCount, IcaRoundtripTimeSessionPercent, MemoryUsage, CpuUsage, FailedMachinePercentage, LocalHostCacheNotification, LocalHostCacheConfigSyncFailure, LocalHostCacheConfigSyncServiceFailure, UnregisteredMachinesPercentage, CCAgentWatchDog, CCAgentDiscovery, CCAgentLogger, CCCredentialProvider, CCWebRelayProvider, CCNetScalerCloudGateway, CCADProvider, CCCDFCaptureService, CCConnectionLeaseExchangeService, CCHeartbeatFailure, CCHighAvailabilityService, CCRemoteHCLServer, CCRemoteBrokerProvider, CCConfigSyncService, DDCSiteDatabaseConnectivityFailure, DDCMonitorDatabaseConnectivityFailure, DDCLicenseServerConnectivityFailure, DDCHeartbeatFailure, DDCLicenseServerNotConnected, DDCLicenseServerNotConfigured, DDCLicenseServerIncompatible, DDCNoLicenseInstalled, DDCLicenseGracePeriodActive, DDCLicenseGracePeriodExpired, DDCIisCertChainValidity, DDCIisCertValidityExpired, DDCIisCertValidityExpiring, PVSStreamServiceFailure, PVSSoapServiceFailure, PVSPxeServiceFailure, PVSTftpServiceFailure, PVSDatabaseConnectivityFailure, PVSLicenseServerConnectivityFailure, PVSHeartBeatFailure, PVSRejectedLogins, SFHeartBeatFailure, SFDomainServiceFailure, SFCredentialWalletServiceFailure, SFPeerResolutionServiceFailure, SFIcaCertChainValidity, SFIcaCertValidityExpired, SFIcaCertValidityExpiring, SFIisCertChainValidity, SFIisCertValidityExpired, SFIisCertValidityExpiring, SFW3ServiceFailure, SFBaseURLStatusFailure, CAStatus, CAActiveDirectoryService, CAAppLayeringProvider, CAForwardProxyService, CAGatewayServiceProvider, CACoreConnectorServices, DiskUsage, MachineUptime, FailedPowerOnAction, FailedPowerOffAction, SPAAppConfigFailures, SPAPolicyConfigFailures, SPAAppServerFailures, SPADNSResolutionFailures, SPASystemFailures, SPAPolicyEvaluationDenied, SPAAppPolicyConfigDenied, SPASystemDenied, SPASessionRevocationDenied, BlackholeMachines, ZombieMachines, OverloadedMachines, DiskIO, DiskLatency, SPAPerformanceMetricsCDNLatency, SPAPerformanceMetricsGatewayLatency, SPAPerformanceMetricsConnectorApplianceLatency
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-AlertThreshold

Threshold value at which the warning notification will be triggered

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

-AlarmThreshold

Threshold value at which the critical notification will be triggered

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

-AlertRenotification

Duration after which the warning notification will be re-triggered

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

-AlarmRenotification

Duration after which the critical notification will be re-triggered

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

-SearchWindow

The amount of time the condition query will look back for the matching record when it examines the data.

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

-AlertConditionPersistenceInterval

The amount of time the condition query will look back to check if the alert condition was persisted.

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

-AlarmConditionPersistenceInterval

The amount of time the condition query will look back to check if the alarm condition was persisted.

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

-Granularity

Defines the granularity of the rate in seconds. This value is applicable for 'ConnectionFailuresRate' condition.

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

-AlertSampleCount

Defines the count of instances to measure before raising the warning notification. This value is applicable for ICA RTT (Session Count) condition.

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

-AlarmSampleCount

Defines the count of instances to measure before raising the critical notification. This value is applicable for ICA RTT (Session Count) condition.

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

-AlertSamplePercent

Defines the percentage of instances to measure before raising the warning notification. This value is applicable for ICA RTT (Session Percent) condition.

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

-AlarmSamplePercent

Defines the percentage of instances to measure before raising the critical notification. This value is applicable for ICA RTT (Session Percent) condition.

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

-DataSource

Defines the data source type of condition.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2407

-UptimeHoursThreshold

Defines the threshold hours for machine uptime. This value is applicable for 'MachineUptime' condition.

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

-UptimePeriodType

Defines the threshold period - hours/day, hours/week or hours/month for machine uptime. This value is applicable for 'MachineUptime' condition.

Type:	MachineUptimePeriodType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2407

-NextRunAt

Defines the next evaluation time for machine uptime alert. This value is applicable for 'MachineUptime' condition.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2407

-AlertTriggeredBy

Defines the source of power action that cases alert. Applicable for 'FailedPowerOnAction' and 'FailedPowerOffAction' alerts. Possible values are

Any
Administrator
Autoscale
EndUser
Schedule

Type:	PowerActionTriggeredBy
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2407

-AlertReasonOfFailure

Defines the reason of power action failure. Applicable for 'FailedPowerOnAction' and 'FailedPowerOffAction' alerts. Possible values are

Any
HypervisorRateLimitExceeded
HypervisorReportedFailure

Type:	PowerActionFailureReasonCode
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2407

-AlarmTriggeredBy

Defines the source of power action that cases alarms. Applicable for 'FailedPowerOnAction' and 'FailedPowerOffAction' alerts. Possible values are

Any
Administrator
Autoscale
EndUser
Schedule

Type:	PowerActionTriggeredBy
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2407

-AlarmReasonOfFailure

Defines the reason of power action failure. Applicable for 'FailedPowerOnAction' and 'FailedPowerOffAction' alerts. Possible values are

Any
HypervisorRateLimitExceeded
HypervisorReportedFailure

Type:	PowerActionFailureReasonCode
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2407

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

Citrix Virtual Apps Desktops Sdk