< Back
Install-GoPrtgServer
Post
NAME Install-GoPrtgServer
SYNOPSIS
Installs the active PRTG Network Monitor server as a GoPrtg server in the current PowerShell Profile.
SYNTAX
Install-GoPrtgServer [[-Alias] <string>] [<CommonParameters>]
DESCRIPTION
The Install-GoPrtgServer cmdlet installs the active PRTG Network Monitor server as a GoPrtg server in the current
PowerShell Profile. GoPrtg servers provide a means of securely connecting to PRTG servers without having to
re-enter your PRTG server and authentication details every time you open a new PowerShell Session or wish to
switch to another server.
When installing a new GoPrtg server, you may optionally specify an -Alias for your connection to use a shorthand
when using the GoPrtg command to toggle between servers. Multiple records may lack an alias as long as they are
for different servers. Otherwise, each record stored by Install-GoPrtgServer MUST have a unique alias. The alias
for the currently active GoPrtg server can be updated via the Update-GoPrtgCredential cmdlet.
When storing your connection details, Install-GoPrtgServer encrypts your PassHash as a SecureString, which is then
converted to an Encrypted String and stored alongside your server, username and alias (if applicable). When stored
as an Encrypted String, your PassHash can only be decrypted under your user account on the computer on which it
was created.
When GoPrtg servers have been installed, special code will be inserted into your PowerShell Profile, demarcated by
a special header and footer indicating the bounds of GoPrtg's configuration data. Great care should be taken when
manipulating your PowerShell Profile. If any key markings (including the GoPrtg headers and footers themselves)
are removed from the PowerShell Profile, GoPrtg may be unable to continue parsing its configuration without manual
intervention. If worst comes to worst, you can repair your corrupted GoPrtg configuration by simply removing the
entire GoPrtg section (including headers and footers) and reinstalling your GoPrtg servers.
PARAMETERS
-Alias <string>
An optional alias to associate with the server. An alias must be specified if an existing record exists for
the currently active server.
Required? false
Position? 0
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:\\> Install-GoPrtg
Installs the currently active server without an alias.
---------- EXAMPLE 2 ----------
C:\\> Install-GoPrtg dev
Installs the currently active server with the alias "dev"
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... stallation
Connect-GoPrtgServer
Get-GoPrtgServer
Set-GoPrtgAlias
Uninstall-GoPrtgServer
Update-GoPrtgCredential
Connect-PrtgServer
SYNOPSIS
Installs the active PRTG Network Monitor server as a GoPrtg server in the current PowerShell Profile.
SYNTAX
Install-GoPrtgServer [[-Alias] <string>] [<CommonParameters>]
DESCRIPTION
The Install-GoPrtgServer cmdlet installs the active PRTG Network Monitor server as a GoPrtg server in the current
PowerShell Profile. GoPrtg servers provide a means of securely connecting to PRTG servers without having to
re-enter your PRTG server and authentication details every time you open a new PowerShell Session or wish to
switch to another server.
When installing a new GoPrtg server, you may optionally specify an -Alias for your connection to use a shorthand
when using the GoPrtg command to toggle between servers. Multiple records may lack an alias as long as they are
for different servers. Otherwise, each record stored by Install-GoPrtgServer MUST have a unique alias. The alias
for the currently active GoPrtg server can be updated via the Update-GoPrtgCredential cmdlet.
When storing your connection details, Install-GoPrtgServer encrypts your PassHash as a SecureString, which is then
converted to an Encrypted String and stored alongside your server, username and alias (if applicable). When stored
as an Encrypted String, your PassHash can only be decrypted under your user account on the computer on which it
was created.
When GoPrtg servers have been installed, special code will be inserted into your PowerShell Profile, demarcated by
a special header and footer indicating the bounds of GoPrtg's configuration data. Great care should be taken when
manipulating your PowerShell Profile. If any key markings (including the GoPrtg headers and footers themselves)
are removed from the PowerShell Profile, GoPrtg may be unable to continue parsing its configuration without manual
intervention. If worst comes to worst, you can repair your corrupted GoPrtg configuration by simply removing the
entire GoPrtg section (including headers and footers) and reinstalling your GoPrtg servers.
PARAMETERS
-Alias <string>
An optional alias to associate with the server. An alias must be specified if an existing record exists for
the currently active server.
Required? false
Position? 0
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:\\> Install-GoPrtg
Installs the currently active server without an alias.
---------- EXAMPLE 2 ----------
C:\\> Install-GoPrtg dev
Installs the currently active server with the alias "dev"
RELATED LINKS
Online version: https://github.com/lordmilko/PrtgAPI/wi ... stallation
Connect-GoPrtgServer
Get-GoPrtgServer
Set-GoPrtgAlias
Uninstall-GoPrtgServer
Update-GoPrtgCredential
Connect-PrtgServer