New-RASNotificationEvent
NAME
New-RASNotificationEvent
SYNOPSIS
Creates new event notification.
SYNTAX
New-RASNotificationEvent [-Type] {Agent | VDI | PubItem | License | Authentication | Tenant | FailedTunneledSess} [AllServers (bool)] [EnableGracePeriod (bool)] [EnableInterval (SwitchParameter)] [ExecuteScript (SwitchParameter)] [GracePeriod (uint)] [Interval (uint)] [-Recipients (string[])] [ScriptId (uint)] [-ScriptObject (NotificationScript)] [SendEmail (bool)] [SiteId (uint)] [-TargetIds (List`1)] [-TargetType {AllServers | RDSHostPools | RDSHGroups | VDIHostPools | VDIPools | AVDHostPools | RemotePCs | SecureGateways | Gateways | Brokers | PublishingAgents | EnrollmentServers | ForceAllAgents}] [WaitUntilRecovered (SwitchParameter)] [(CommonParameters)]
DESCRIPTION
Creates notifications for events such as license activation, agent disconect/connect etc.
PARAMETERS
Type
(RASNotificationEventType) Notification type.
Possible values: Agent, VDI, PubItem, License, Authentication, Tenant, FailedTunneledSess
Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
SiteId (uint)
Site ID where notification event is setup.
Current site ID is used if siteId is omitted.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
GracePeriod (uint)
Grace period after the notification was done (minutes).
Required? false
Position? named
Default value 5
Accept pipeline input? false
Accept wildcard characters? false
EnableGracePeriod (bool)
Enable/Disable grace period.
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
Recipients (string[])
Recipients to notify of the event.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
SendEmail (bool)
Enable/Disable email notification.
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
ScriptId (uint)
Script to execute which has this ID.
Required? false
Position? named
Default value 4294967295
Accept pipeline input? false
Accept wildcard characters? false
ScriptObject
(NotificationScript) Script Object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
ExecuteScript (SwitchParameter)
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
Interval (uint)
Invocation interval (minutes).
Required? false
Position? named
Default value 10
Accept pipeline input? false
Accept wildcard characters? false
EnableInterval (SwitchParameter)
Enable/Disable notification intervals.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
WaitUntilRecovered (SwitchParameter)
Wait until recovered.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
AllServers (bool)
All servers in site.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
TargetType (TargetType)
Target type.
Possible values: AllServers, RDSHostPools, RDSHGroups, VDIHostPools, VDIPools, AVDHostPools, RemotePCs, SecureGateways, Gateways, Brokers, PublishingAgents, EnrollmentServers, ForceAllAgents
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
TargetIds (List`1)
Target Ids.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
(CommonParameters)
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation.
INPUTS
-none-
OUTPUTS
EXAMPLES
**---------- EXAMPLE 1 ----------
New-RASNotificationEvent -Type Agent
Creates a new notification for agent events.
RELATED LINKS
Last updated