Connect-AMServer

NAME Connect-AMServer



SYNOPSIS

Connect to an AutoMate Enterprise management server





SYNTAX

Connect-AMServer [-Server] <String[]> [-Port <Int32>] [-ConnectionAlias <String>] [-ConnectionStoreFilePath

<String>] [-SaveConnection] [<CommonParameters>]



Connect-AMServer [-Server] <String[]> [-Port <Int32>] [-Credential <PSCredential>] [-ConnectionAlias <String>]

[-SaveConnection] [<CommonParameters>]



Connect-AMServer [-Server] <String[]> [-Port <Int32>] [-UserName <String>] [-Password <SecureString>]

[-ConnectionAlias <String>] [-SaveConnection] [<CommonParameters>]





DESCRIPTION

Connect-AMServer gathers connection information for AutoMate Enterprise, and tests authentication.

This module supports connecting to multiple servers at once.





PARAMETERS

-Server <String[]>

The AutoMate Enterprise management server. One or more can be provided. The same credentials are used for

all servers.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Port <Int32>

The TCP port for the management API.



Required? false

Position? named

Default value 9708

Accept pipeline input? false

Accept wildcard characters? false



-Credential <PSCredential>

The credentials use during authentication.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UserName <String>

The username to use during authentication.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Password <SecureString>

The password to use during authentication.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ConnectionAlias <String>

The alias to assign to this connection.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ConnectionStoreFilePath <String>

The file that connections are stored in.



Required? false

Position? named

Default value "$($env:APPDATA)\\AutomatePS\\connstore.xml"

Accept pipeline input? false

Accept wildcard characters? false



-SaveConnection [<SwitchParameter>]

Saves the new connection to the connection store.



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

Connection





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



PS C:\\>Connect-AMServer -Connection "automate01" -Credential (Get-Credential)















RELATED LINKS

https://github.com/AutomatePS/AutomatePS