OctopusDeploy
2.2.0
A comprehensive PowerShell module for managing Octopus Deploy. Provides 80+ cmdlets wrapping the Octopus.Client API with PowerShell-native features including pipeline support, tab-completion, and automatic type transformation. Manage tenants, deployments, releases, runbooks, machines, variables, and more from the command line.
Installation Options
Owners
Copyright
(c) 2026 Emrys MacInally. All rights reserved.
Package Details
Author(s)
- Emrys MacInally
Tags
octopusdeploy octopus devops deployment
Functions
Add-ProjectToTenant Add-RoleToMachine Add-TagToTenant Add-TenantToTrigger Compare-EnvironmentScope Confirm-Intervention Connect-Octopus Copy-MachinePolicy Get-Artifact Get-ArtifactContent Get-Channel Get-CommonTenantVariable Get-CommonVariable Get-ConnectionConfiguration Get-CurrentDeployment Get-CurrentSpace Get-CurrentTenantDeployment Get-Deployment Get-DeploymentPreview Get-DeploymentProcess Get-DeploymentProcessSteps Get-Environment Get-GitBranch Get-GitReference Get-Lifecycle Get-Machine Get-MachineConnectionStatus Get-MachinePolicy Get-MachineRole Get-OctopusRepositoryObject Get-OpenIntervention Get-PackageVersion Get-Project Get-ProjectGroup Get-ProjectTenant Get-ProjectTenantVariable Get-ProjectTrigger Get-ProjectVariable Get-Release Get-ReleasePackageVersion Get-ReleaseTemplate Get-Runbook Get-RunbookProcess Get-RunbookProcessStep Get-RunbookRun Get-RunbookRunPreview Get-RunbookSnapshot Get-ScriptModule Get-SourceScriptsInGit Get-Space Get-TagSet Get-Task Get-TaskResult Get-TaskStatus Get-TaskType Get-Tenant Get-TenantMachineCount Get-TenantProject Get-VariableSet Get-VariableSnapshot GetCommonTenantVariable Invoke-Deployment Invoke-RunbookRun Invoke-TaskScript New-Release New-Tenant Remove-Artifact Remove-Project Remove-ProjectFromTenant Remove-Release Remove-RoleFromMachine Remove-TagFromTenant Remove-Tenant Remove-TenantFromTrigger Save-Artifact Set-CommonTenantVariable Set-ConnectionConfiguration Set-Machine Set-ProjectTenantVariable Set-ReleaseChannel Set-RunbookSettings Set-Space Stop-Task Test-OctopusConnection
Dependencies
This module has no dependencies.
FileList
- OctopusDeploy.nuspec
- Classes.psm1
- Public\Add-ProjectToTenant.ps1
- Public\Get-MachineRole.ps1
- Public\Get-TenantMachineCount.ps1
- CurrentTenantDeployment.Format.ps1xml
- Public\Add-RoleToMachine.ps1
- Public\Get-OctopusRepositoryObject.ps1
- Public\Get-TenantProject.ps1
- Public\Add-TagToTenant.ps1
- Public\Get-OpenIntervention.ps1
- Public\Get-VariableSet.ps1
- OctopusDeploy.psd1
- Public\Add-TenantToTrigger.ps1
- Public\Get-PackageVersion.ps1
- Public\Get-VariableSnapshot.ps1
- OctopusDeploy.psm1
- Public\Compare-EnvironmentScope.ps1
- Public\Get-Project.ps1
- Public\GetCommonTenantVariable.ps1
- ProjectDeploymentObject.Format.ps1xml
- Public\Confirm-Intervention.ps1
- Public\Get-ProjectGroup.ps1
- Public\Invoke-Deployment.ps1
- startup.ps1
- Public\Connect-Octopus.ps1
- Public\Get-ProjectTenant.ps1
- Public\Invoke-RunbookRun.ps1
- TaskresultClass.Format.ps1xml
- Public\Copy-MachinePolicy.ps1
- Public\Get-ProjectTenantVariable.ps1
- Public\Invoke-TaskScript.ps1
- TransformerClasses.psm1
- Public\Get-Artifact.ps1
- Public\Get-ProjectTrigger.ps1
- Public\New-Release.ps1
- Classes\Classes.psm1
- Public\Get-ArtifactContent.ps1
- Public\Get-ProjectVariable.ps1
- Public\New-Tenant.ps1
- Classes\TransformerClasses.psm1
- Public\Get-Channel.ps1
- Public\Get-Release.ps1
- Public\Remove-Artifact.ps1
- en-US\OctopusDeploy-help.xml
- Public\Get-CommonTenantVariable.ps1
- Public\Get-ReleasePackageVersion.ps1
- Public\Remove-Project.ps1
- Formats\CurrentTenantDeployment.Format.ps1xml
- Public\Get-CommonVariable.ps1
- Public\Get-ReleaseTemplate.ps1
- Public\Remove-ProjectFromTenant.ps1
- Formats\ProjectDeploymentObject.Format.ps1xml
- Public\Get-ConnectionConfiguration.ps1
- Public\Get-Runbook.ps1
- Public\Remove-Release.ps1
- Formats\TaskresultClass.Format.ps1xml
- Public\Get-CurrentDeployment.ps1
- Public\Get-RunbookProcess.ps1
- Public\Remove-RoleFromMachine.ps1
- Lib\Core\empty.file
- Public\Get-CurrentSpace.ps1
- Public\Get-RunbookProcessStep.ps1
- Public\Remove-TagFromTenant.ps1
- Lib\Core\Octopus.Client.dll
- Public\Get-CurrentTenantDeployment.ps1
- Public\Get-RunbookRun.ps1
- Public\Remove-Tenant.ps1
- Lib\Desktop\empty.file
- Public\Get-Deployment.ps1
- Public\Get-RunbookRunPreview.ps1
- Public\Remove-TenantFromTrigger.ps1
- Lib\Desktop\Octopus.Client.dll
- Public\Get-DeploymentPreview.ps1
- Public\Get-RunbookSnapshot.ps1
- Public\Save-Artifact.ps1
- Private\ArgumentCompleters.ps1
- Public\Get-DeploymentProcess.ps1
- Public\Get-ScriptModule.ps1
- Public\Set-CommonTenantVariable.ps1
- Private\Get-CustomError.ps1
- Public\Get-DeploymentProcessSteps.ps1
- Public\Get-SourceScriptsInGit.ps1
- Public\Set-ConnectionConfiguration.ps1
- Private\Get-VariableTemplate.ps1
- Public\Get-Environment.ps1
- Public\Get-Space.ps1
- Public\Set-Machine.ps1
- Private\Import-OctopusclientDll.ps1
- Public\Get-GitBranch.ps1
- Public\Get-TagSet.ps1
- Public\Set-ProjectTenantVariable.ps1
- Private\New-TenantCommonVariablePayload.ps1
- Public\Get-GitReference.ps1
- Public\Get-Task.ps1
- Public\Set-ReleaseChannel.ps1
- Private\Read-ConfigFile.ps1
- Public\Get-Lifecycle.ps1
- Public\Get-TaskResult.ps1
- Public\Set-RunbookSettings.ps1
- Private\SetSpace.ps1
- Public\Get-Machine.ps1
- Public\Get-TaskStatus.ps1
- Public\Set-Space.ps1
- Private\Test-CanonicalName.ps1
- Public\Get-MachineConnectionStatus.ps1
- Public\Get-TaskType.ps1
- Public\Stop-Task.ps1
- Private\ValidateConnection.ps1
- Public\Get-MachinePolicy.ps1
- Public\Get-Tenant.ps1
- Public\Test-OctopusConnection.ps1
- Private\Write-ConfigFile.ps1
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 2.2.0 (current version) | 36 | 1/9/2026 |
| 2.1.0 | 66 | 12/19/2025 |
| 2.0.1 | 263 | 11/13/2025 |
| 1.11.0 | 201 | 9/12/2025 |
| 1.10.0 | 9 | 9/11/2025 |
| 1.9.0 | 10 | 9/8/2025 |
| 1.7.0 | 119 | 5/14/2025 |
| 1.6.0 | 20 | 4/25/2025 |
| 1.4.0 | 14 | 4/14/2025 |
| 1.3.0 | 27 | 3/20/2025 |
| 1.2.4 | 154 | 2/17/2025 |
| 1.2.2 | 6 | 2/17/2025 |
| 1.2.1 | 14 | 2/6/2025 |
| 1.2.0 | 51 | 12/13/2024 |
| 1.1.7 | 20 | 12/3/2024 |
| 1.1.5 | 19 | 11/21/2024 |
| 1.1.3 | 47 | 10/29/2024 |
| 1.1.2 | 108 | 10/27/2024 |
| 1.1.1 | 10 | 10/27/2024 |