New-RASNotificationResource

NAME

New-RASNotificationResource

SYNOPSIS

Creates new resource notification.

SYNTAX

New-RASNotificationResource [-Type] <RASNotificationResourceType> {CPUEvent | MemoryEvent | ConnectedSessionEvent | DisconnectSessionEvent | RDSHConnectSessionEvent | RDSHDisconnectSessionEvent | TunneledSess} [-Direction <ThresholdDirection> {RisesAbove | LowersBelow}] [-EnableGracePeriod <bool>] [-EnableInterval <SwitchParameter>] [-ExecuteScript <SwitchParameter>] [-GracePeriod <uint>] [-Interval <uint>] [-Recipients <string[]>] [-ScriptId <uint>] [-ScriptObject <RASNotificationScript>] [-SendEmail <bool>] [-SiteId <uint>] [-Threshold <uint>] [-UseDefaults <bool>] [-WaitUntilRecovered <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

Creates a resource notification, such as high/low RAM/CPU usage etc.

PARAMETERS


-Type <RASNotificationResourceType>
Resource notification type.

Possible values: CPUEvent, MemoryEvent, ConnectedSessionEvent, DisconnectSessionEvent, RDSHConnectSessionEvent, RDSHDisconnectSessionEvent, TunneledSess

        Required?                    true
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Threshold <uint>
Tolerance value which triggers notification.

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Direction <ThresholdDirection>
Threshold direction.

Possible values: RisesAbove, LowersBelow

        Required?                    false
        Position?                    named
        Default value                RisesAbove
        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.

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableGracePeriod <bool>
Enable/Disable grace period.

        Required?                    false
        Position?                    named
        Default value                False
        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                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ScriptObject <RASNotificationScript>
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

-EnableScripts <SwitchParameter>
This is an alias of the ExecuteScript parameter.

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false

-UseDefaults <bool>
Use default settings

        Required?                    false
        Position?                    named
        Default value                True
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Interval <uint>
Invocation interval (minutes).

        Required?                    false
        Position?                    named
        Default value                
        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

<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

RASNotificationResource

EXAMPLES


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

New-RASNotificationResource -Type ConnectedSessionEvent -Threshold 22

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

RELATED LINKS