< Back

Connect-GoPrtgServer

Sun Jan 19, 2020 5:40 pm

NAME Connect-GoPrtgServer



SYNOPSIS

Connects to a PRTG Network Monitor server using connection details stored in the current PowerShell Profile.





SYNTAX

Connect-GoPrtgServer [[-Server] <string>] [-LogLevel {None | Trace | Request | Response | All}]

[<CommonParameters>]





DESCRIPTION

GoPrtg allows you to securely store your PRTG Network Monitor server and authentication details inside your

PowerShell profile. Upon opening a new PowerShell Session, by simply executing the GoPrtg command you can be

automatically connected to one of several servers, without needing to enter any credentials.



When invoked without arguments, GoPrtg will attempt to connect to the first server in your GoPrtg servers list.

When multiple records are present, a specific server can be connected to by specifying a wildcard pattern that

corresponds to that connection's Server or Alias property. A full list of installed GoPrtg servers can be viewed

via the Get-GoPrtgServer cmdlet.



Upon connecting to a GoPrtg server, GoPrtg will output a status message to the console indicating whether the

connection succeeded. As GoPrtg depends on the contents of the current user's PowerShell Profile, it is not

recommended to use GoPrtg cmdlets inside scripts. To manage PRTG server connections inside scripts it is

recommended to use the Connect-PrtgServer cmdlet in conjunction with New-Credential / Get-Credential.





PARAMETERS

-Server <string>

A wildcard expression describing the address or alias of the server to connect to.



Required? false

Position? 0

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



<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:\\> goprtg



Connect to the first GoPrtg server installed in the current PowerShell Profile.



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



C:\\> goprtg dev



Connect to the GoPrtg server with alias "dev"



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



C:\\> goprtg prtg.exam*



Connect to the GoPrtg server whose address starts with "prtg.exam".



RELATED LINKS

Online version: https://github.com/lordmilko/PrtgAPI/wi ... connection

Get-GoPrtgServer

Install-GoPrtgServer

Set-GoPrtgAlias

Uninstall-GoPrtgServer

Update-GoPrtgCredential

Connect-PrtgServer

New-Credential