Set-RASNotificationEvent

NAME

Set-RASNotificationEvent

SYNOPSIS

Update event notification.

SYNTAX

Set-RASNotificationEvent [-Id] <uint> [-AllServers <bool>] [-Enabled <bool>] [-EnableGracePeriod <bool>] [-EnableInterval <bool>] [-ExecuteScript <bool>] [-GracePeriod <uint>] [-Interval <uint>] [-Recipients <string[]>] [-ScriptId <uint>] [-ScriptObject <NotificationScript>] [-SendEmail <bool>] [-TargetIds <List`1>] [-TargetType {AllServers | RDSHostPools | RDSHGroups | VDIHostPools | VDIPools | AVDHostPools | RemotePCs | SecureGateways | Gateways | Brokers | PublishingAgents | EnrollmentServers | ForceAllAgents}] [-WaitUntilRecovered <bool>] [<CommonParameters>]

Set-RASNotificationEvent [-InputObject] <NotificationEvent> [-AllServers <bool>] [-Enabled <bool>] [-EnableGracePeriod <bool>] [-EnableInterval <bool>] [-ExecuteScript <bool>] [-GracePeriod <uint>] [-Interval <uint>] [-Recipients <string[]>] [-ScriptId <uint>] [-ScriptObject <NotificationScript>] [-SendEmail <bool>] [-TargetIds <List`1>] [-TargetType {AllServers | RDSHostPools | RDSHGroups | VDIHostPools | VDIPools | AVDHostPools | RemotePCs | SecureGateways | Gateways | Brokers | PublishingAgents | EnrollmentServers | ForceAllAgents}] [-WaitUntilRecovered <bool>] [<CommonParameters>]

DESCRIPTION

Updates the selected event notification with new settings.

PARAMETERS

-InputObject <NotificationEvent> InputObject from pipeline or by parameter.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-Id <uint> Notification ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Enabled <bool> Enable/Disable notification.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-GracePeriod <uint> Notification grace period (minutes).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-EnableGracePeriod <bool> Enable/Disable grace period.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Recipients <string[]> Notification recipients.

        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                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ScriptId <uint> Use script of given ID.

        Required?                    false

        Position?                    named

        Default value                

        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 <bool> Enable/Disable notification scripts.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Interval <uint> Notification interval (minutes).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-EnableInterval <bool> Enable/Disable notification intervals.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WaitUntilRecovered <bool> Wait until recovered.

        Required?                    false

        Position?                    named

        Default value                

        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

NotificationEvent

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Set-RASNotificationEvent -Id 1 -Type License -Enabled $true -GracePeriod 22

Changes event notification of Id 1 to be a License event notification with grace period of 22min.

Last updated

© 2024 Parallels International GmbH. All rights reserved.