Get-OctopusDashboard

NAME Get-OctopusDashboard



SYNOPSIS

Returns the Octopus Dashboard





SYNTAX

Get-OctopusDashboard [-DeploymentStatus <string[]>] [-EnvironmentName <string[]>] [-ProjectName <string[]>]

[<CommonParameters>]





DESCRIPTION

Returns the Octopus Dashboard





PARAMETERS

-ProjectName <string[]>

Name of the Project to filter for.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EnvironmentName <string[]>

Name of the Project to filter for.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DeploymentStatus <string[]>

Target communication style to filter by



Required? false

Position? named

Default value

Accept pipeline input? false

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



OUTPUTS

System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusDashboardEntry, Octoposh, Version=1.0.0.0,

Culture=neutral, PublicKeyToken=null]]





---------- EXAMPLE 1 ----------



PS C:\\> Get-OctopusDashboard



Gets the entire Octopus dashboard

---------- EXAMPLE 2 ----------



PS C:\\> Get-OctopusDashboard -ProjectName MyWebApp



Gets the dashboard info for the project MyWebApp

---------- EXAMPLE 3 ----------



PS C:\\> Get-OctopusDashboard -EnvironmentName Production



Gets the dashboard info for all the projects that have a release deployed to the "Production" environment.

---------- EXAMPLE 4 ----------



PS C:\\> Get-OctopusDashboard -DeploymentStatus Success



Gets all the deployments in "Success" status on the dashboard



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