New-RASNotification

NAME

New-RASNotification

SYNOPSIS

Creates new notification.

SYNTAX

New-RASNotification [-Type] {Unknown | CPUEvent | MemoryEvent | RDSHConnectedSessionEvent | RDSHDisconnectedSessionEvent | RDSHConnectedSessionEventPerc | RDSHDisconnectedSessionEventPerc | AVDActiveSessionsUtilization | AVDDisconnectedSessionsUtilization | TunneledSess | FailedTunneledSess | FailedTunneledSessTenantBroker | Agent | License | Authentication | PubItem | Template | VDI | Tenant} [-AllServers (bool)] [-Direction {RisesAbove | LowersBelow}] [-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 | VDIHostPools | AVDHostPools | RemotePCs | SecureGateways | Brokers | EnrollmentServers | ForceAllAgents}] [-Threshold (uint)] [-WaitUntilRecovered (SwitchParameter)] [(CommonParameters)] **

DESCRIPTION

Creates notifications such as license activation, agent disconect/connect etc.

PARAMETERS

Type (NotificationType)

Notification type.

Possible values: Unknown, CPUEvent, MemoryEvent, RDSHConnectedSessionEvent, RDSHDisconnectedSessionEvent, RDSHConnectedSessionEventPerc, RDSHDisconnectedSessionEventPerc, AVDActiveSessionsUtilization, AVDDisconnectedSessionsUtilization, TunneledSess, FailedTunneledSess, FailedTunneledSessTenantBroker, Agent, License, Authentication, PubItem, Template, VDI, Tenant

        Required?                    true

        Position?                    0

        Default value                Unknown

        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, VDIHostPools, AVDHostPools, RemotePCs, SecureGateways, Brokers, 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

Threshold (uint)

Tolerance value which triggers notification.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Direction (ThresholdDirection)

Threshold direction.

Possible values: RisesAbove, LowersBelow

        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

Notification

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

New-RASNotification -Type Agent

Creates a new notification for agent events. ---------- EXAMPLE 2 ----------

New-RASNotification -Type RDSHConnectedSessionEvent -Threshold 22

Creates new notification which notifies if the number of session exceeds 22.

RELATED LINKS

• Get-RASNotification

• Set-RASNotification

• Remove-RASNotification