1 of 1

New-RASNotificationResource

NAME

SYNOPSIS

Creates new resource notification.

SYNTAX

New-RASNotificationResource [-Type] {CPUEvent | MemoryEvent | RDSHConnectedSessionEvent | ConnectedSessionEvent | RDSHDisconnectedSessionEvent | DisconnectSessionEvent | RDSHConnectedSessionEventPerc | RDSHConnectSessionEvent | RDSHDisconnectedSessionEventPerc | RDSHDisconnectSessionEvent | TunneledSess} [-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 | RDSHGroups | VDIHostPools | VDIPools | AVDHostPools | RemotePCs | SecureGateways | Gateways | Brokers | PublishingAgents | EnrollmentServers | ForceAllAgents}] [-Threshold <uint>] [-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, RDSHConnectedSessionEvent, ConnectedSessionEvent, RDSHDisconnectedSessionEvent, DisconnectSessionEvent, RDSHConnectedSessionEventPerc, RDSHConnectSessionEvent, RDSHDisconnectedSessionEventPerc, 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 (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

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see

        about_CommonParameters .

INPUTS

-none-

OUTPUTS

NotificationResource

EXAMPLES

---------- EXAMPLE 1 ---------- New-RASNotificationResource -Type ConnectedSessionEvent -Threshold 22 Creates new resouce notification which notifies if the number of session exceeds 22.

New-RASNotificationResource

NAME

New-RASNotificationResource

SYNOPSIS

Creates new resource notification.

SYNTAX

DESCRIPTION

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

PARAMETERS

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

        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

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see

        about_CommonParameters .

INPUTS

-none-

OUTPUTS

NotificationResource

EXAMPLES

---------- EXAMPLE 1 ---------- New-RASNotificationResource -Type ConnectedSessionEvent -Threshold 22 Creates new resouce notification which notifies if the number of session exceeds 22.