< Back
Set-OctopusConnectionInfo
Post
NAME Set-OctopusConnectionInfo
SYNOPSIS
Sets the current Octopus connection info (URL and API Key). Highly recommended to call this function from $profile
to avoid having to re-configure this on every session.
SYNTAX
Set-OctopusConnectionInfo [-Server] <string> [-ApiKey] <string> [<CommonParameters>]
DESCRIPTION
Sets the current Octopus connection info (URL and API Key). Highly recommended to call this function from $profile
to avoid having to re-configure this on every session.
PARAMETERS
-Server <string>
URL of the server you want to connect to
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-URL <string>
URL of the server you want to connect to
This is an alias of the Server parameter.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ApiKey <string>
API Key you'll use to authenticate with the Octopus Server
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
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
System.String
URL of the server you want to connect to
System.String
API Key you'll use to authenticate with the Octopus Server
OUTPUTS
---------- EXAMPLE 1 ----------
PS C:\\> Set-OctopusConnectionInfo -Server "http://MyOctopus.AwesomeCompany.com" -API
"API-7CH6XN0HHOU7DDEEUGKUFUR1K"
Set connection info with a specific API Key for an Octopus instance
RELATED LINKS
WebSite: http://Octoposh.net
Github Project: https://github.com/Dalmirog/OctoPosh/
Wiki: http://octoposh.readthedocs.io
QA and Feature requests: https://gitter.im/Dalmirog/OctoPosh#initial
SYNOPSIS
Sets the current Octopus connection info (URL and API Key). Highly recommended to call this function from $profile
to avoid having to re-configure this on every session.
SYNTAX
Set-OctopusConnectionInfo [-Server] <string> [-ApiKey] <string> [<CommonParameters>]
DESCRIPTION
Sets the current Octopus connection info (URL and API Key). Highly recommended to call this function from $profile
to avoid having to re-configure this on every session.
PARAMETERS
-Server <string>
URL of the server you want to connect to
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-URL <string>
URL of the server you want to connect to
This is an alias of the Server parameter.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ApiKey <string>
API Key you'll use to authenticate with the Octopus Server
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
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
System.String
URL of the server you want to connect to
System.String
API Key you'll use to authenticate with the Octopus Server
OUTPUTS
---------- EXAMPLE 1 ----------
PS C:\\> Set-OctopusConnectionInfo -Server "http://MyOctopus.AwesomeCompany.com" -API
"API-7CH6XN0HHOU7DDEEUGKUFUR1K"
Set connection info with a specific API Key for an Octopus instance
RELATED LINKS
WebSite: http://Octoposh.net
Github Project: https://github.com/Dalmirog/OctoPosh/
Wiki: http://octoposh.readthedocs.io
QA and Feature requests: https://gitter.im/Dalmirog/OctoPosh#initial