Set-GoPrtgAlias

NAME Set-GoPrtgAlias



SYNOPSIS

Updates the server alias of the currently active GoPrtg Server.





SYNTAX

Set-GoPrtgAlias [[-Alias] <string>] [<CommonParameters>]





DESCRIPTION

The Set-GoPrtgAlias updates the alias of the currently active GoPrtg Server. GoPrtg aliases provide a shorthand

for connecting to specific GoPrtg servers when multiple servers are installed in your PowerShell profile. Multiple

GoPrtg records may lack aliases as long as they connect to different servers. Otherwise, each GoPrtg server must

have a unique alias. If no alias is specified, the alias of the specified server will be removed.





PARAMETERS

-Alias <string>

The alias to assign to the currently active GoPrtg server. If this value is null or empty, the active server's

alias will be removed. If multiple records exist for the active server, a unique alias must be specified.



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:\\> Set-GoPrtgAlias dev



Sets the alias of the currently active GoPrtg server to "dev".



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



C:\\> Set-GoPrtgAlias



Removes the alias of the currently active GoPrtg server.



RELATED LINKS

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

Connect-GoPrtgServer

Get-GoPrtgServer

Install-GoPrtgServer

Uninstall-GoPrtgServer

Update-GoPrtgCredential