Skip to content

Get OctopusDashboard

dalmiro grañas edited this page Mar 19, 2017 · 13 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
ProjectName System.Collections.Generic.List`1System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 Name of the Project to filter for.
EnvironmentName System.Collections.Generic.List`1System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 Name of the Project to filter for.
DeploymentStatus System.Collections.Generic.List`1System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 Target communication style to filter by

Syntax

Get-OctopusDashboard [-DeploymentStatus <List`1>] [-EnvironmentName <List`1>] [-ProjectName 
<List`1>] [<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"
Clone this wiki locally