Basic Usage

Get

List all the Actions for a Project:

Get-OctoAction [-Project] <string> [[-Name] <string[]>]  [<CommonParameters>]

Get-OctoAction [-Project] <string> -Id <string[]>  [<CommonParameters>]

List Deployments for a Project or Release:

Get-OctoDeployment [-Project] <string> [-Release] <string>  [<CommonParameters>]

Get-OctoDeployment [-ReleaseId] <string>  [<CommonParameters>]

List the Details of a Proejct's deployment process:

Get-OctoDeploymentProcess [-DeploymentProcessId] <string[]>  [<CommonParameters>]

Get-OctoDeploymentProcess -ProjectName <string[]>  [<CommonParameters>]

List the environments defined on the octopus server:

Get-OctoEnvironment [[-Name] <string[]>] [-Cache]  [<CommonParameters>]

Get-OctoEnvironment -EnvironmentId <string[]> [-Cache]  [<CommonParameters>]

Get-OctoEnvironment -ScopeValue <ScopeValue> [-Cache]  [<CommonParameters>]

List all the external feeds:

Get-OctoExternalFeed [[-Name] <string[]>]  [<CommonParameters>]

Get a list of the Machines:

Get-OctoMachine [[-Name] <string[]>]  [<CommonParameters>]

Get-OctoMachine -Id <string[]>  [<CommonParameters>]

List the project groups defined on the octopus server:

Get-OctoProjectGroup [[-Name] <string[]>]  [<CommonParameters>]

List all the machine roles:

Get-OctoMachineRole [[-Name] <string[]>]  [<CommonParameters>]

Lists all the projects defined on the server:

Get-OctoProject [[-Name] <string[]>]  [<CommonParameters>]

Get a list of releases for a project:

Get-OctoRelease [-Project] <string> [[-Version] <string[]>]  [<CommonParameters>]

Get-OctoRelease [-ProjectId] <string> [[-Version] <string[]>]  [<CommonParameters>]

Get-OctoRelease -ReleaseId <string[]>  [<CommonParameters>]

Lists all the variables in a given project

Get-OctoVariable [-Project] <string> [[-Name] <string[]>]  [<CommonParameters>]

Get-OctoVariable [-VariableSet] <string[]> [[-Name] <string[]>]  [<CommonParameters>]

Get-OctoVariable [-VariableSetId] <string[]> [[-Name] <string[]>]  [<CommonParameters>]

List library variable sets:

Get-OctoVariableSet [[-Name] <string[]>] [-Cache]  [<CommonParameters>]

Get-OctoVariableSet -Id <string[]> [-Cache]  [<CommonParameters>]

Add

Add a new project to a project group:

Add-OctoProject [-ProjectGroupId] <string> [-Name] <string>  [<CommonParameters>]

Add a variable to a project's VariableSet:

Add-OctoVariable [-Project] <string> [-Name] <string> [-Value] <string> 
[[-Environments] <string[]>] [[-Sensitive] <bool>]  [<CommonParameters>]

Add-OctoVariable [-Project] <string> [-InputObject] <VariableResource[]>  
[<CommonParameters>]

Removes the first variable with a given name:

Remove-OctoVariable [-Project] <string> [-Name] <string>  [<CommonParameters>]