< Back
Set-PrtgClient
Post
NAME Set-PrtgClient
SYNOPSIS
Modifies settings on the current session's PrtgClient.
SYNTAX
Set-PrtgClient [-IgnoreSSL <SwitchParameter>] [-LogLevel {None | Trace | Request | Response | All}] [-PassThru
<SwitchParameter>] [-Progress <SwitchParameter>] [-RetryCount <int>] [-RetryDelay <int>] [<CommonParameters>]
DESCRIPTION
The Set-PrtgClient cmdlet modifies settings present on the current session's PrtgClient. Typically these settings
are specified when establishing a PRTG session with Connect-PrtgServer. This cmdlet allows you to modify these
settings after the session has already been created, such as when you've connected to a GoPrtg Server.
PARAMETERS
-RetryCount <int>
The number of times to retry a request that times out while communicating with PRTG.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RetryDelay <int>
The base delay (in seconds) between retrying a timed out request. Each successive failure of a given request
will wait an additional multiple of this value.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogLevel <LogLevel[]>
The type of events to log when -Verbose is specified.
Possible values: None, Trace, Request, Response, All
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Progress <SwitchParameter>
Enable or disable PowerShell Progress when piping between cmdlets. By default, if Connect-PrtgServer is being
called from within a script or the PowerShell ISE this value is false. Otherwise, true.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IgnoreSSL <SwitchParameter>
Ignore any SSL validation when communicating with PRTG. Modifying this property will regenerate the current
session's PrtgClient.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-PassThru <SwitchParameter>
Specifies whether to return the PrtgClient that will be used by this session after processing all parameters.
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
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Set-PrtgClient -RetryCount 5 -LogLevel Trace,Response
Update the RetryCount and LogLevel on the current session's PrtgClient.
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... nagement-1
Connect-PrtgServer
Get-PrtgClient
Connect-GoPrtgServer
SYNOPSIS
Modifies settings on the current session's PrtgClient.
SYNTAX
Set-PrtgClient [-IgnoreSSL <SwitchParameter>] [-LogLevel {None | Trace | Request | Response | All}] [-PassThru
<SwitchParameter>] [-Progress <SwitchParameter>] [-RetryCount <int>] [-RetryDelay <int>] [<CommonParameters>]
DESCRIPTION
The Set-PrtgClient cmdlet modifies settings present on the current session's PrtgClient. Typically these settings
are specified when establishing a PRTG session with Connect-PrtgServer. This cmdlet allows you to modify these
settings after the session has already been created, such as when you've connected to a GoPrtg Server.
PARAMETERS
-RetryCount <int>
The number of times to retry a request that times out while communicating with PRTG.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RetryDelay <int>
The base delay (in seconds) between retrying a timed out request. Each successive failure of a given request
will wait an additional multiple of this value.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogLevel <LogLevel[]>
The type of events to log when -Verbose is specified.
Possible values: None, Trace, Request, Response, All
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Progress <SwitchParameter>
Enable or disable PowerShell Progress when piping between cmdlets. By default, if Connect-PrtgServer is being
called from within a script or the PowerShell ISE this value is false. Otherwise, true.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IgnoreSSL <SwitchParameter>
Ignore any SSL validation when communicating with PRTG. Modifying this property will regenerate the current
session's PrtgClient.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-PassThru <SwitchParameter>
Specifies whether to return the PrtgClient that will be used by this session after processing all parameters.
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
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Set-PrtgClient -RetryCount 5 -LogLevel Trace,Response
Update the RetryCount and LogLevel on the current session's PrtgClient.
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... nagement-1
Connect-PrtgServer
Get-PrtgClient
Connect-GoPrtgServer