-
Notifications
You must be signed in to change notification settings - Fork 46
Set OctopusConnectionInfo
dalmiro grañas edited this page Mar 19, 2017
·
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 |
|---|---|---|
| Server | System.String | URL of the server you want to connect to |
| URL | System.String | URL of the server you want to connect to This is an alias of the Server parameter. |
| ApiKey | System.String | API Key you'll use to authenticate with the Octopus Server |
###Syntax
Set-OctopusConnectionInfo [-Server] <string> [-ApiKey] <string> [<CommonParameters>]
###Examples EXAMPLE 1
Set connection info with a specific API Key for an Octopus instance
PS C:\>PS C:\> Set-OctopusConnectionInfo -Server "http://MyOctopus.AwesomeCompany.com" -API "API-7CH6XN0HHOU7DDEEUGKUFUR1K"Getting Started
Cmdlets & Examples
- Get-OctopusChannel
- Get-OctopusConnectionInfo
- Get-OctopusDashboard
- Get-OctopusDeployment
- Get-OctopusEnvironment
- Get-OctopusFeed
- Get-OctopusLifecycle
- Get-OctopusMachine
- Get-OctopusProject
- Get-OctopusProjectGroup
- Get-OctopusRelease
- Get-OctopusResourceModel
- Get-OctopusServerThumbprint
- Get-OctopusTagSet
- Get-OctopusTeam
- Get-OctopusTenant
- Get-OctopusToolPath
- Get-OctopusToolsFolder
- Get-OctopusToolVersion
- Get-OctopusUser
- Get-OctopusVariableSet
- Install-OctopusTool
- New-OctopusConnection
- New-OctopusResource
- Remove-OctopusResource
- Set-OctopusConnectionInfo
- Set-OctopusReleaseStatus
- Set-OctopusToolPath
- Set-OctopusToolsFolder
- Update-OctopusResource
Advanced Examples
Real Life Scenarios
Release Notes