< Back
New-AMConnectionStoreItem
Post
NAME New-AMConnectionStoreItem
SYNOPSIS
Save the connection for the specified AutoMate Enterprise server
SYNTAX
New-AMConnectionStoreItem [-Server] <String> -Port <Int32> [-ConnectionAlias <String>] [-Credential
<PSCredential>] [-FilePath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
New-AMConnectionStoreItem [-Server] <String> -Port <Int32> [-ConnectionAlias <String>] [-UserName <String>]
[-Password <SecureString>] [-FilePath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
New-AMConnectionStoreItem stores a server and credential object together in a credential store file.
PARAMETERS
-Server <String>
The AutoMate Enterprise management server.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
The TCP port for the management API.
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ConnectionAlias <String>
The alias to save with the stored connection.
Required? false
Position? named
Default value
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
-FilePath <String>
The file to store the server/credential combinations in. It is stored in the user profile by default.
Required? false
Position? named
Default value "$($env:APPDATA)\\AutomatePS\\connstore.xml"
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
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 --------------------------
PS C:\\>New-AMConnectionStoreItem -Connection server01 -Credential (Get-Credential)
RELATED LINKS
https://github.com/AutomatePS/AutomatePS
SYNOPSIS
Save the connection for the specified AutoMate Enterprise server
SYNTAX
New-AMConnectionStoreItem [-Server] <String> -Port <Int32> [-ConnectionAlias <String>] [-Credential
<PSCredential>] [-FilePath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
New-AMConnectionStoreItem [-Server] <String> -Port <Int32> [-ConnectionAlias <String>] [-UserName <String>]
[-Password <SecureString>] [-FilePath <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
New-AMConnectionStoreItem stores a server and credential object together in a credential store file.
PARAMETERS
-Server <String>
The AutoMate Enterprise management server.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
The TCP port for the management API.
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ConnectionAlias <String>
The alias to save with the stored connection.
Required? false
Position? named
Default value
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
-FilePath <String>
The file to store the server/credential combinations in. It is stored in the user profile by default.
Required? false
Position? named
Default value "$($env:APPDATA)\\AutomatePS\\connstore.xml"
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
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 --------------------------
PS C:\\>New-AMConnectionStoreItem -Connection server01 -Credential (Get-Credential)
RELATED LINKS
https://github.com/AutomatePS/AutomatePS