< Back
Get-NotificationAction
Post
NAME Get-NotificationAction
SYNOPSIS
Retrieves all Notification Actions from a PRTG Server.
Get-NotificationAction supports filtering returned actions by a number of parameters, including by -Name, -Id,
-Tags or a custom SearchFilter. When filtering by tags, the -Tag parameter can be used, performing a logical OR
between all specified operands. For scenarios in which you wish to filter for notification actions containing ALL
specified tags, the -Tags parameter can be used, performing a logical AND between all specified operands.
SYNTAX
Get-NotificationAction [[-Name] <string[]>] [[-Filter] <SearchFilter[]>] [-Count <int>] [-Id <int[]>] [-Tags
<string[]>] [<CommonParameters>]
Get-NotificationAction [[-Name] <string[]>] [[-Filter] <SearchFilter[]>] [-Count <int>] [-Id <int[]>] [-Tag
<string[]>] [<CommonParameters>]
DESCRIPTION
The Get-NotificationAction retrieves notification actions present on a PRTG Server. Notification actions can be
triggered under various circumstances via notification triggers. For more information on notification triggers,
see Get-NotificationTrigger.
Get-NotificationAction provides two parameter sets for filtering objects by tags. When filtering for notification
actions that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all
specified operands. For scenarios in which you wish to filter for notification actions containing ALL specified
tags, the -Tags parameter can be used, performing a logical AND between all specified operands.
If you are currently signed in as a read only user, you may not be able to see all notification actions or
notification action properties.
PARAMETERS
-Tags <string[]>
Filter the response to objects with all specified tags. Can include wildcards.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tag <string[]>
Filter the response to objects with one of several tags. Can include wildcards.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Id <int[]>
Retrieve an object with a specified ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <string[]>
Filter the response to objects with a certain name. Can include wildcards.
Required? false
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Filter <SearchFilter[]>
Filter the response to objects that match one or more criteria.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Count <int>
Maximum number of results to return. Note: when this parameter is specified wildcard filters such as Name may
behave unexpectedly when wildcard characters are not used and records are being filtered by an additional
property other than ParentId.
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PrtgAPI.SearchFilter[]
Filter the response to objects that match one or more criteria.
OUTPUTS
PrtgAPI.NotificationAction
---------- EXAMPLE 1 ----------
C:\\> Get-NotificationTrigger
Get all notification actions.
---------- EXAMPLE 2 ----------
C:\\> Get-NotificationTrigger *pager*
Get all notification actions whose name contains "pager"
---------- EXAMPLE 3 ----------
C:\\> Get-NotificationTrigger -Id 301,302
Get the notification actions with IDs 301 and 302.
---------- EXAMPLE 4 ----------
C:\\> Get-NotificationTrigger -Tags PagerDuty
Get all notification actions tagged with "PagerDuty"
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... powershell
Get-NotificationTrigger
New-TriggerParameters
SYNOPSIS
Retrieves all Notification Actions from a PRTG Server.
Get-NotificationAction supports filtering returned actions by a number of parameters, including by -Name, -Id,
-Tags or a custom SearchFilter. When filtering by tags, the -Tag parameter can be used, performing a logical OR
between all specified operands. For scenarios in which you wish to filter for notification actions containing ALL
specified tags, the -Tags parameter can be used, performing a logical AND between all specified operands.
SYNTAX
Get-NotificationAction [[-Name] <string[]>] [[-Filter] <SearchFilter[]>] [-Count <int>] [-Id <int[]>] [-Tags
<string[]>] [<CommonParameters>]
Get-NotificationAction [[-Name] <string[]>] [[-Filter] <SearchFilter[]>] [-Count <int>] [-Id <int[]>] [-Tag
<string[]>] [<CommonParameters>]
DESCRIPTION
The Get-NotificationAction retrieves notification actions present on a PRTG Server. Notification actions can be
triggered under various circumstances via notification triggers. For more information on notification triggers,
see Get-NotificationTrigger.
Get-NotificationAction provides two parameter sets for filtering objects by tags. When filtering for notification
actions that contain one of several tags, the -Tag parameter can be used, performing a logical OR between all
specified operands. For scenarios in which you wish to filter for notification actions containing ALL specified
tags, the -Tags parameter can be used, performing a logical AND between all specified operands.
If you are currently signed in as a read only user, you may not be able to see all notification actions or
notification action properties.
PARAMETERS
-Tags <string[]>
Filter the response to objects with all specified tags. Can include wildcards.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tag <string[]>
Filter the response to objects with one of several tags. Can include wildcards.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Id <int[]>
Retrieve an object with a specified ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <string[]>
Filter the response to objects with a certain name. Can include wildcards.
Required? false
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Filter <SearchFilter[]>
Filter the response to objects that match one or more criteria.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Count <int>
Maximum number of results to return. Note: when this parameter is specified wildcard filters such as Name may
behave unexpectedly when wildcard characters are not used and records are being filtered by an additional
property other than ParentId.
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PrtgAPI.SearchFilter[]
Filter the response to objects that match one or more criteria.
OUTPUTS
PrtgAPI.NotificationAction
---------- EXAMPLE 1 ----------
C:\\> Get-NotificationTrigger
Get all notification actions.
---------- EXAMPLE 2 ----------
C:\\> Get-NotificationTrigger *pager*
Get all notification actions whose name contains "pager"
---------- EXAMPLE 3 ----------
C:\\> Get-NotificationTrigger -Id 301,302
Get the notification actions with IDs 301 and 302.
---------- EXAMPLE 4 ----------
C:\\> Get-NotificationTrigger -Tags PagerDuty
Get all notification actions tagged with "PagerDuty"
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... powershell
Get-NotificationTrigger
New-TriggerParameters