< Back
Resume-Object
Post
NAME Resume-Object
SYNOPSIS
Resumes a PRTG object from a paused or simulated error state.
SYNTAX
Resume-Object -Object <SensorOrDeviceOrGroupOrProbe> [-Batch <SwitchParameter>] [-PassThru <SwitchParameter>]
[<CommonParameters>]
Resume-Object -Id <int[]> [-Batch <SwitchParameter>] [-PassThru <SwitchParameter>] [<CommonParameters>]
DESCRIPTION
The Resume-Object cmdlet resumes monitoring an object that has previously been stopped due to manually pausing or
simulating an error state on the object.
By default, Resume-Object will operate in Batch Mode. In Batch Mode, Resume-Object will not execute a request for
each individual object, but will rather store each item in a queue to resume all objects at once, via a single
request. This allows PrtgAPI to be extremely performant in performing operations against a large number of objects.
If the pipeline is cancelled (either due to a cmdlet throwing an exception or the user pressing Ctrl-C) before
fully completing, Resume-Object will not generate a request against PRTG. If you wish to disable Batch Mode and
fully process objects individually one at a time, this can be achieved by specifying -Batch:$false.
PARAMETERS
-Object <SensorOrDeviceOrGroupOrProbe>
The object to resume.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Id <int[]>
ID of the object to resume.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Batch <SwitchParameter>
Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request
against PRTG for processing all objects. By default this value is true.
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-PassThru <SwitchParameter>
Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be
further piped into additional cmdlets.
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PrtgAPI.SensorOrDeviceOrGroupOrProbe
The object to resume.
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Get-Sensor -Status PausedByUser | Resume-Object
Resume all sensors that have been paused by the user. Note: if parent object has been manually paused, child
objects will appear PausedByUser but will not be able to be unpaused.
---------- EXAMPLE 2 ----------
C:\\> Resume-Object -Id 1001
Resumes the object with ID 1001.
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... n#resume-1
Get-Sensor
Get-Device
Get-Group
Get-Probe
SYNOPSIS
Resumes a PRTG object from a paused or simulated error state.
SYNTAX
Resume-Object -Object <SensorOrDeviceOrGroupOrProbe> [-Batch <SwitchParameter>] [-PassThru <SwitchParameter>]
[<CommonParameters>]
Resume-Object -Id <int[]> [-Batch <SwitchParameter>] [-PassThru <SwitchParameter>] [<CommonParameters>]
DESCRIPTION
The Resume-Object cmdlet resumes monitoring an object that has previously been stopped due to manually pausing or
simulating an error state on the object.
By default, Resume-Object will operate in Batch Mode. In Batch Mode, Resume-Object will not execute a request for
each individual object, but will rather store each item in a queue to resume all objects at once, via a single
request. This allows PrtgAPI to be extremely performant in performing operations against a large number of objects.
If the pipeline is cancelled (either due to a cmdlet throwing an exception or the user pressing Ctrl-C) before
fully completing, Resume-Object will not generate a request against PRTG. If you wish to disable Batch Mode and
fully process objects individually one at a time, this can be achieved by specifying -Batch:$false.
PARAMETERS
-Object <SensorOrDeviceOrGroupOrProbe>
The object to resume.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Id <int[]>
ID of the object to resume.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Batch <SwitchParameter>
Specifies whether this cmdlet should queue all objects piped to this cmdlet to execute a single request
against PRTG for processing all objects. By default this value is true.
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-PassThru <SwitchParameter>
Specifies whether to return the original PrtgObject that was passed to this cmdlet, allowing the object to be
further piped into additional cmdlets.
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PrtgAPI.SensorOrDeviceOrGroupOrProbe
The object to resume.
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Get-Sensor -Status PausedByUser | Resume-Object
Resume all sensors that have been paused by the user. Note: if parent object has been manually paused, child
objects will appear PausedByUser but will not be able to be unpaused.
---------- EXAMPLE 2 ----------
C:\\> Resume-Object -Id 1001
Resumes the object with ID 1001.
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... n#resume-1
Get-Sensor
Get-Device
Get-Group
Get-Probe