Skip to content

Set OctopusConnectionInfo

Dalmiro edited this page Mar 19, 2016 · 20 revisions

###Summary 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

Name DataType Description
URL String Octopus URL
APIKey String Octopus API Key

###Syntax

Set-OctopusConnectionInfo [-URL] <String> [-APIKey] <String> [<CommonParameters>]


###Examples EXAMPLE 1

Set connection info with a specific API Key for an Octopus instance

PS C:\>Set-OctopusConnectionInfo -URL "http://MyOctopus.AwesomeCompany.com" -API "API-7CH6XN0HHOU7DDEEUGKUFUR1K"
Clone this wiki locally