< Back
Get-Probe
Post
NAME Get-Probe
SYNOPSIS
Retrieves probes from a PRTG Server.
SYNTAX
Get-Probe [[-Name] <string[]>] [[-Filter] <SearchFilter[]>] [-Access {Inherited | None | Read | Write | Full |
Admin}] [-Active <bool[]>] [-BaseType {Sensor | Device | Group | Probe}] [-Collapsed <bool[]>] [-Comments
<string[]>] [-Count <int>] [-Dependency <string[]>] [-DownAcknowledgedSensors <int[]>] [-DownSensors <int[]>] [-Id
<int[]>] [-Interval <TimeSpan[]>] [-Message <string[]>] [-ParentId <int[]>] [-PartialDownSensors <int[]>]
[-PausedSensors <int[]>] [-Position <int[]>] [-Priority {None | One | Two | Three | Four | Five}] [-ProbeStatus
{Disconnected | Connected}] [-Schedule <string[]>] [-Status {None | Unknown | Collecting | Up | Warning | Down |
NoProbe | PausedByUser | PausedByDependency | PausedBySchedule | Unusual | PausedByLicense | PausedUntil |
DownAcknowledged | DownPartial | Paused}] [-Tags <string[]>] [-TotalDevices <int[]>] [-TotalGroups <int[]>]
[-TotalSensors <int[]>] [-Type <StringEnum`1[]>] [-UnknownSensors <int[]>] [-UnusualSensors <int[]>] [-UpSensors
<int[]>] [-Url <string[]>] [-WarningSensors <int[]>] [<CommonParameters>]
Get-Probe [[-Name] <string[]>] [[-Filter] <SearchFilter[]>] [-Access {Inherited | None | Read | Write | Full |
Admin}] [-Active <bool[]>] [-BaseType {Sensor | Device | Group | Probe}] [-Collapsed <bool[]>] [-Comments
<string[]>] [-Count <int>] [-Dependency <string[]>] [-DownAcknowledgedSensors <int[]>] [-DownSensors <int[]>] [-Id
<int[]>] [-Interval <TimeSpan[]>] [-Message <string[]>] [-ParentId <int[]>] [-PartialDownSensors <int[]>]
[-PausedSensors <int[]>] [-Position <int[]>] [-Priority {None | One | Two | Three | Four | Five}] [-ProbeStatus
{Disconnected | Connected}] [-Schedule <string[]>] [-Status {None | Unknown | Collecting | Up | Warning | Down |
NoProbe | PausedByUser | PausedByDependency | PausedBySchedule | Unusual | PausedByLicense | PausedUntil |
DownAcknowledged | DownPartial | Paused}] [-Tag <string[]>] [-TotalDevices <int[]>] [-TotalGroups <int[]>]
[-TotalSensors <int[]>] [-Type <StringEnum`1[]>] [-UnknownSensors <int[]>] [-UnusualSensors <int[]>] [-UpSensors
<int[]>] [-Url <string[]>] [-WarningSensors <int[]>] [<CommonParameters>]
DESCRIPTION
The Get-Probe cmdlet retrieves probes from a PRTG Server. Probes represent sites where the PRTG Probe Service has
been installed. Each PRTG Server has a single Core Probe. Additional probes may be installed with the PRTG Remote
Probe installer for monitoring of remote sites.
Get-Probe provides a variety of methods of filtering the probes requested from PRTG, including by probe name,
probe status (Connected / Disconnected), ID and tags. Multiple filters can be used in conjunction to further limit
the number of results returned. Probe properties that do not contain explicitly defined parameters on Get-Group
can be specified as dynamic parameters, allowing one or more values to be specified of the specified type. All
string parameters support the use of wildcards.
For scenarios in which you wish to exert finer grained control over search filters, a custom SearchFilter object
can be created by specifying the field name, condition and value to filter upon. For information on properties
that can be filtered upon, see New-SearchFilter
Get-Probe provides two parameter sets for filtering objects by tags. When filtering for probes 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 probes containing ALL specified tags, the -Tags parameter can be used,
performing a logical AND between all specified operands.
The Probe objects returned from Get-Probe can be piped to a variety of other cmdlets for further processing,
including Get-Group, Get-Device and Get-Sensor, where the ID or name of the probe will be used to filter for child
objects of the specified type.
PARAMETERS
-ProbeStatus <ProbeStatus[]>
Only retrieve probes that match a specified connection state.
Possible values: Disconnected, Connected
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Status <Status[]>
Only retrieve objects that match a specific status.
Possible values: None, Unknown, Collecting, Up, Warning, Down, NoProbe, PausedByUser, PausedByDependency,
PausedBySchedule, Unusual, PausedByLicense, PausedUntil, DownAcknowledged, DownPartial, Paused
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-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
-Type <StringEnum`1[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Active <bool[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Interval <TimeSpan[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Access <Access[]>
Possible values: Inherited, None, Read, Write, Full, Admin
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Dependency <string[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Message <string[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Priority <Priority[]>
Possible values: None, One, Two, Three, Four, Five
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UpSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DownSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DownAcknowledgedSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PartialDownSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WarningSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PausedSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UnusualSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UnknownSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TotalSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Schedule <string[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Comments <string[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BaseType <BaseType[]>
Possible values: Sensor, Device, Group, Probe
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Url <string[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ParentId <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Collapsed <bool[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TotalGroups <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TotalDevices <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Position <int[]>
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.Probe
---------- EXAMPLE 1 ----------
C:\\> Get-Probe contoso
Get all probes named "contoso" (case insensitive)
---------- EXAMPLE 2 ----------
C:\\> Get-Probe *office*
Get all probes whose name contains "office" (case insensitive)
---------- EXAMPLE 3 ----------
C:\\> Get-Probe -Id 1
Get the probe with ID 1
---------- EXAMPLE 4 ----------
C:\\> Get-Probe -TotalGroups 10
Get all probes that contain exactly 10 child groups using dynamic parameters.
---------- EXAMPLE 5 ----------
C:\\> flt totalgroups eq 10 | Get-Probe
Get all probes that contain exactly 10 child groups using a SearchFilter.
---------- EXAMPLE 6 ----------
C:\\> Get-Probe -Count 1
Get only 1 probe from PRTG.
---------- EXAMPLE 7 ----------
C:\\> flt totalsens greaterthan 100 | Get-Probe
Get all probes that contain more than 100 sensors.
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... powershell
Get-Sensor
Get-Device
Get-Group
New-SearchFilter
Approve-Probe
SYNOPSIS
Retrieves probes from a PRTG Server.
SYNTAX
Get-Probe [[-Name] <string[]>] [[-Filter] <SearchFilter[]>] [-Access {Inherited | None | Read | Write | Full |
Admin}] [-Active <bool[]>] [-BaseType {Sensor | Device | Group | Probe}] [-Collapsed <bool[]>] [-Comments
<string[]>] [-Count <int>] [-Dependency <string[]>] [-DownAcknowledgedSensors <int[]>] [-DownSensors <int[]>] [-Id
<int[]>] [-Interval <TimeSpan[]>] [-Message <string[]>] [-ParentId <int[]>] [-PartialDownSensors <int[]>]
[-PausedSensors <int[]>] [-Position <int[]>] [-Priority {None | One | Two | Three | Four | Five}] [-ProbeStatus
{Disconnected | Connected}] [-Schedule <string[]>] [-Status {None | Unknown | Collecting | Up | Warning | Down |
NoProbe | PausedByUser | PausedByDependency | PausedBySchedule | Unusual | PausedByLicense | PausedUntil |
DownAcknowledged | DownPartial | Paused}] [-Tags <string[]>] [-TotalDevices <int[]>] [-TotalGroups <int[]>]
[-TotalSensors <int[]>] [-Type <StringEnum`1[]>] [-UnknownSensors <int[]>] [-UnusualSensors <int[]>] [-UpSensors
<int[]>] [-Url <string[]>] [-WarningSensors <int[]>] [<CommonParameters>]
Get-Probe [[-Name] <string[]>] [[-Filter] <SearchFilter[]>] [-Access {Inherited | None | Read | Write | Full |
Admin}] [-Active <bool[]>] [-BaseType {Sensor | Device | Group | Probe}] [-Collapsed <bool[]>] [-Comments
<string[]>] [-Count <int>] [-Dependency <string[]>] [-DownAcknowledgedSensors <int[]>] [-DownSensors <int[]>] [-Id
<int[]>] [-Interval <TimeSpan[]>] [-Message <string[]>] [-ParentId <int[]>] [-PartialDownSensors <int[]>]
[-PausedSensors <int[]>] [-Position <int[]>] [-Priority {None | One | Two | Three | Four | Five}] [-ProbeStatus
{Disconnected | Connected}] [-Schedule <string[]>] [-Status {None | Unknown | Collecting | Up | Warning | Down |
NoProbe | PausedByUser | PausedByDependency | PausedBySchedule | Unusual | PausedByLicense | PausedUntil |
DownAcknowledged | DownPartial | Paused}] [-Tag <string[]>] [-TotalDevices <int[]>] [-TotalGroups <int[]>]
[-TotalSensors <int[]>] [-Type <StringEnum`1[]>] [-UnknownSensors <int[]>] [-UnusualSensors <int[]>] [-UpSensors
<int[]>] [-Url <string[]>] [-WarningSensors <int[]>] [<CommonParameters>]
DESCRIPTION
The Get-Probe cmdlet retrieves probes from a PRTG Server. Probes represent sites where the PRTG Probe Service has
been installed. Each PRTG Server has a single Core Probe. Additional probes may be installed with the PRTG Remote
Probe installer for monitoring of remote sites.
Get-Probe provides a variety of methods of filtering the probes requested from PRTG, including by probe name,
probe status (Connected / Disconnected), ID and tags. Multiple filters can be used in conjunction to further limit
the number of results returned. Probe properties that do not contain explicitly defined parameters on Get-Group
can be specified as dynamic parameters, allowing one or more values to be specified of the specified type. All
string parameters support the use of wildcards.
For scenarios in which you wish to exert finer grained control over search filters, a custom SearchFilter object
can be created by specifying the field name, condition and value to filter upon. For information on properties
that can be filtered upon, see New-SearchFilter
Get-Probe provides two parameter sets for filtering objects by tags. When filtering for probes 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 probes containing ALL specified tags, the -Tags parameter can be used,
performing a logical AND between all specified operands.
The Probe objects returned from Get-Probe can be piped to a variety of other cmdlets for further processing,
including Get-Group, Get-Device and Get-Sensor, where the ID or name of the probe will be used to filter for child
objects of the specified type.
PARAMETERS
-ProbeStatus <ProbeStatus[]>
Only retrieve probes that match a specified connection state.
Possible values: Disconnected, Connected
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Status <Status[]>
Only retrieve objects that match a specific status.
Possible values: None, Unknown, Collecting, Up, Warning, Down, NoProbe, PausedByUser, PausedByDependency,
PausedBySchedule, Unusual, PausedByLicense, PausedUntil, DownAcknowledged, DownPartial, Paused
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-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
-Type <StringEnum`1[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Active <bool[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Interval <TimeSpan[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Access <Access[]>
Possible values: Inherited, None, Read, Write, Full, Admin
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Dependency <string[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Message <string[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Priority <Priority[]>
Possible values: None, One, Two, Three, Four, Five
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UpSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DownSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DownAcknowledgedSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PartialDownSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WarningSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PausedSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UnusualSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UnknownSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TotalSensors <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Schedule <string[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Comments <string[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BaseType <BaseType[]>
Possible values: Sensor, Device, Group, Probe
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Url <string[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ParentId <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Collapsed <bool[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TotalGroups <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TotalDevices <int[]>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Position <int[]>
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.Probe
---------- EXAMPLE 1 ----------
C:\\> Get-Probe contoso
Get all probes named "contoso" (case insensitive)
---------- EXAMPLE 2 ----------
C:\\> Get-Probe *office*
Get all probes whose name contains "office" (case insensitive)
---------- EXAMPLE 3 ----------
C:\\> Get-Probe -Id 1
Get the probe with ID 1
---------- EXAMPLE 4 ----------
C:\\> Get-Probe -TotalGroups 10
Get all probes that contain exactly 10 child groups using dynamic parameters.
---------- EXAMPLE 5 ----------
C:\\> flt totalgroups eq 10 | Get-Probe
Get all probes that contain exactly 10 child groups using a SearchFilter.
---------- EXAMPLE 6 ----------
C:\\> Get-Probe -Count 1
Get only 1 probe from PRTG.
---------- EXAMPLE 7 ----------
C:\\> flt totalsens greaterthan 100 | Get-Probe
Get all probes that contain more than 100 sensors.
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... powershell
Get-Sensor
Get-Device
Get-Group
New-SearchFilter
Approve-Probe