Skip to content

Get OctopusDashboard

dalmiro grañas edited this page Apr 1, 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.String[] Name of the Project to filter for.
EnvironmentName System.String[] Name of the Project to filter for.
DeploymentStatus System.String[] Target communication style to filter by

Syntax

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