Get-PrtgClient

NAME Get-PrtgClient



SYNOPSIS

Retrieves the current session's PrtgClient





SYNTAX

Get-PrtgClient [-Diagnostic <SwitchParameter>] [<CommonParameters>]





DESCRIPTION

The Get-PrtgClient cmdlet allows you to access the PrtgClient of the current session previously created with a

call to Connect-PrtgServer. This allows you to view/edit the properties of the PrtgClient previously defined in

your call to Connect-PrtgServer, as well as access the raw C# PrtgAPI should you wish to bypass or access methods

not in the PowerShell interface.





PARAMETERS

-Diagnostic <SwitchParameter>

Displays diagnostic information to assist when raising a PrtgAPI issue.



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

PrtgAPI.PrtgClient





---------- EXAMPLE 1 ----------



C:\\> Get-PrtgClient



View the settings of the session's PrtgClient. If the session does not have a PrtgClient, the cmdlet returns null



---------- EXAMPLE 2 ----------



C:\\> (Get-PrtgClient).RetryCount = 5



Change the RetryCount of the PrtgClient to 5



---------- EXAMPLE 3 ----------



C:\\> (Get-PrtgClient).GetSensors()



Invoke the GetSensors method of the PrtgClient



RELATED LINKS

Online version: https://github.com/lordmilko/PrtgAPI/wi ... nagement-1

Connect-PrtgServer

Disconnect-PrtgServer

Set-PrtgClient