Check if given .NET framework version (or greater) is installed.

Check if given .NET Core framework version (or greater) is installed.

Check if given .NET Core framework version (or greater) is installed.

This step retrieves one or more secrets from 1Password Connect Server and creates sensitive output variables for each value retrieved.

Create a new azure load balancer rule. With the default frontend ip configuration and default backend address pool.

Uses Service Principal to Add Server to Azure Load Balancer.

Add a secondary cluster certificate to a service fabric cluster using an existing azure key vault certificate.

Allows to purge content using the Content Control Utility (CCU) v3 REST API.

Allows to purge content using the Content Control Utility (CCU) v2 REST API.

Allows to purge CP codes using the Content Control Utility (CCU) v3 REST API.

Posts a message to a Chime chat room using webhooks.

Invalidate AWS Cloudfront cache. This template uses the AWS CLI tool. ALL step fields need to be populated for this template to work.

Upload files and folders to an S3 bucket from a specified location.

Run a workflow or job template in Ansible Tower

This step will execute schema and data synchronization scripts created as deployment resource after comparison is done.

The step will compare the database from a deployment package with the target database to create a schema synchronization script deployment resource

The step will compare database from a deployment package with target database to create data synchronization script deployment resource.

Check subgraph schema against Apollo Studio. This should be run before deploying the subgraph service when promoting to higher environments.

Publish subgraph schema to Apollo Studio. This should be run after successfully deploying a subgraph service.

Marks a release point in Application Insights.

Marks a release point in Application Insights. This step template uses Azure CLI and Role-Based Access Control instead of an API Key. Used application-insights-annotate-release.json as inspiration.

Get an Argo Application details using the argocd app get CLI command

Set application parameters using the argocd app set CLI command.

Set application parameters using the argocd app set CLI command.

Sync an application to its target state using the argocd app sync CLI command

Wait for an application to reach a synced and healthy state using the argocd app wait CLI command

Gets the status of an Argo Rollout.

Set the rollout paused state to 'true'

Promotes an Argo Rollout.

Sets a new image tag on an Argo Rollout.

Gets the status of an Argo Rollout.

Rollback to the previous rollout.

Collect artifacts easily and safely.

ASP.NET Core allows you specify environment variables in web.config - https://docs.microsoft.com/en-us/aspnet/core/hosting/aspnet-core-module#set-environment-variables

Set environment variables in IIS config (no web.config)

This uses the .Net framework aspnet_regsql tool to create an ASPState database using the credentials provided. If the username and password are both empty then it will attempt a trusted connection.

This template will search for deployments that have been paused due to Manual Intervention or Guided Failure and automate the response.

Add or Remove the current instance from an ELBv2 Target Group.

This step will Add or Remove Tags from an EC2 instance.

This step can Start, Stop or Terminate an EC2 instance.

Configures an AWS Lambda Alias. Allows you to specify how much traffic is routed to a specific version of the Lambda.

Configures an API v2 Gateway to connect to and invoke a Lambda Function. That includes:

Creates or updates a lambda function using code from an S3 bucket or an container image in the Amazon ECR registry.

This step will Update, Create or Delete a Resource Record from an Route 53 hosted Domain Name.

This step will Create a Security Group within a Virtual Private Cloud (VPC).

Creates a Amazon Cloud Formation Stack with the template specified.

Creates a AWS Lambda Function from the specified zip.

Deploys an image to an AWS Lambda function.

Deploys a Zip file to an AWS Lambda function.

Deploys a Zip file to an AWS Lambda function using the IAM role configured on the machine.

Removes the current instance from the ELB

Gets the public hostname from http://instance-data/latest/meta-data/public-hostname on the EC2 instance and stores it in the Hostname variable.

Return the name of the online and offline blue and green Auto Scaling Groups

Find the online and offline target groups for a blue-green deployment

Initiates an instance refresh for an Auto Scaling group and waits for it to complete.

This step will launch an EC2 instance, or start an instance previously created by this step.

Registers an instance with an ELB

Sets 100% of traffic to the online target group, and 0% to the offline target group

Update the AMI used by a launch template, create a new launch template version, and set the new version as the default.

Deploy a .Net WebApp build to AWS Elastic Beanstalk. This template uses the awsdeploy tool. ALL step fields need to be populated for this template to work.

This step template will install the latest tentacle on an AWS hosted, Linux virtual machine. This will also open the firewall for inbound traffic on port 10933 on the Security Group.

Will create a database user using an existing server user if that database user does not exist without using SMO.

Will restore a database backup from an S3 bucket

This step retrieves one or more secrets from AWS Secrets Manager and creates sensitive output variables for each value retrieved. The step supports creating a variable for each key-value in a secret that's retrieved, or you can specify individual keys. These values can be used in other steps in your deployment or runbook process.

This step template will install the latest tentacle on an AWS hosted, Windows virtual machine. This will also open the firewall for inbound traffic on port 10933 on the Security Group.

This script allow to backup the specified azure table storage into the specified blob.

Prepares an AzureRM Virtual Machine (Managed Disk or Storage Account based) and captures a Managed Image or Image VHD:

Copy blobs between specified containers across two different storage accounts

Copies Storage Account containers, from a source storage account to destination. It copies the containers with the same names.

Creates a Container App Environment if it doesn't exist. An output variable called ManagedEnvironmentId is created which holds the Id.

Deploys a container to an Azure Container App Environment

There is a cap in Azure that prevents having more than 800 deployments in the history at any given time: link to microsoft docs

Configures the SSL binding for an Azure Web App to use an Octopus-managed certificate

This step template is useful when you want to have the instance count matched just before the VIP swap. It takes the source slot (usually Production slot) and match with the current deployment slot (normally Staging). Note: This will be helpful in scenario when 15 instances in Production and 4 instance in staging. This step template should only be used when a production slot already exists.

Uploads files and folders to an Azure container from a specified location.

Start, Stop, or Delete a WebJob from the Azure Web App

This step retrieves one or more key/values from an Azure App Configuration store and creates output variables for each value retrieved. These values can be used in other deployment or runbook process steps.

Set a given CORS rule on the specified Azure storage blob container

Upload files in a directory to a specified Azure Storage blob container.

Exports a database to a bacpac

Imports a bacpac file into an existing database.

restores a bacpac to a new database

Restores a bacpac to a new database

Runs a sql command against an Azure SQL Server database.

This step retrieves one or more key/values from an Azure App Configuration store and adds them to an Azure App Function's AppSettings.

Deploys Azure Functions via the Kudu API to an Azure Function App.

This step retrieves one or more secrets from an Azure Key Vault and creates sensitive output variables for each value retrieved. These values can be used in other steps in your deployment or runbook process.

This step template will install the latest tentacle on an Azure hosted, Linux virtual machine. This will also open the firewall for inbound traffic on port 10933 on the NSG.

This template can start, stop, or delete a web job

Installs an Azure site extension in your Azure web app.

Provides the ability to delete files and folders from an Azure Web App through the kudu API.

This step template will remove an app_offline file from an Azure WebApp to safely bring the app domain online following a deployment.

This step template will take a provided app_offline file from a package and upload it to an Azure Web App to enable a way to safely bring down the app domain for a subsequent deployment.

This step template will retrieve a set of deployment credentials for an Azure Web App.

Restarts an azure web app.

Performs a delayed rolling restart of all instances within an Azure Web App

Sets the Azure web app settings of a targeted Azure web app deployment target. Will use the deployment slot if defined.

Sets the traffic distribution between multiple web app slots.

Swaps an azure web app slot. Defaults to the deployment slot defined in the web app target.

Starts an azure web app.

Stops an azure web app.

Loads app settings from a json file (e.g. local.settings.json) which is also json-transformed to inject environment-specific values.

This step template will install the latest tentacle on an Azure hosted, Windows virtual machine. This will also open the firewall for inbound traffic on port 10933 on both the NSG and the the vm.

Create a backup of SQL Azure Database and store it in Azure Blob Storage. Requires Azure PowerShell to be installed on Tentacle machine.

This step retrieves one or more secrets from Bitwarden Secrets Manager, and creates sensitive output variables for each value retrieved. These values can be used in other steps in your deployment or runbook process.

Step template to block the release progression of an Octopus Deploy release so it cannot be promoted beyond the current environment.

This step uses Octopus System Variables to calculate the deployment mode.

This template creates a keyspace on a Cassandra server if it doesn't already exist. Note this template is written in Python and requires that pip is installed to function correctly.,

Triggers a deployment of another project in Octopus

Checks if Server is pending a reboot, and reboots if it needs it.

Checks for SQL Node currently being serving as primary on high availability group and sets Octopus variable : SQLIsOnSecondary to true if secondary is active in High Availability Group

Use this step when leveraging Azure Virtual Machines Scale Sets (VMSS) with Octopus Deploy Deployment Targets.

Runs a chef cookbook using chef-client.

Ensures that the Chocolatey package manager is installed on the system. The installer is downloaded from https://chocolatey.org if required.

Installs or upgrades a package using the Chocolatey package manager.

Allows managing Chocolatey config.

Allows enabling and disabling of Chocolatey features.

Allows managing Chocolatey Package sources.

Allows pinning versions of packages using the Chocolatey package manager.

This step will clear (purge) the EdgeCast CDN Cache

Clears the Jasper web cache

Create binaries manifest & CO application and sign them with given code sign certificate ... using mage.exe.

Sign file with given code sign certificate using mage.exe.

Update .application file after updating the manifest file.

Update manifest file after changing the configuration files of the ClickOnce application.

This Template will help to re-sign the .application and manifest files. Finally add .deploy extenstion to the files

Clone an Octopus tenant. The project connections and tenant tags will be cloned and the non-sensitive variables can optionally be cloned.

Uses regsvr32.exe to register com components

Encrypts a configuration section for the specified executable.

Encrypts configuration sections for the specified executable.

Encrypts several configuration sections for the specified file in a given directory.

This Step Template will Configure the SPM Client for Solr and Zookeeper

Consolidates all Release Notes between the last successful release in the current Environment and this one by merging or concatenating them.

The New-AzureRmResourceGroup cmdlet creates an Azure resource group

The New-AzureRmAppServicePlan cmdlet creates a new app service plan.

This template will create an azure deployment slot. This step template should be placed before the "Deploy an Azure App" Octopus Deploy template and be used with its sister step "Switch Azure RM Deployment Slot"

Creates a staging slot for Azure Website.

This step uses the new az modules to create a resource group if it doesn't exist.

This will create a schedule task based on exported xml. See https://msdn.microsoft.com/en-us/library/windows/desktop/bb736357%28v=vs.85%29.aspx for instructions on how to export scheduled tasks as xml.

Create an Octopus tenant with optional tenant tags and project connections.

This step reads a secret from CyberArk Conjur and makes them available as an Output Variable. Rest API is used and the details can be found at https://docs.conjur.org/Latest/en/Content/Developer/Conjur_API_Retrieve_Secret.htm

This step retrieves one or more secrets from CyberArk Conjur and creates sensitive output variables for each value retrieved. These values can be used in other steps in your deployment or runbook process.

This step retrieves one or more secrets from CyberArk Secrets Manager and creates sensitive output variables for each value retrieved. It uses the JWT authenticator in Secrets Manager in combination with a Generic OIDC Account configured in Octopus to authenticate the workload.

Datadog is cloud monitoring service which allows you to push arbitrary events into via an api. This task allows you to create an event to correlate with other data.

Log details of a task to Datadog, including error detail.

Datadog is cloud monitoring service which allows you to push arbitrary events into via an api. This task allows you to schedule a downtime event to prevent error alerts during a deployment.

Step to delete an Azure Resource Group using the bundled AzureRM cmdlets with Octopus Deploy. It will first check to see if the resource group exists, and if it does exist, it will delete it.

This step uses the new az modules to delete a resource group if it exist.

Step that will attempt to delete a target or worker from Octopus Deploy using the API. If it cannot delete the target or worker it will disable the target and rename it.

This step will find the latest release in a source environment matching your criteria and deploy it.

This step template will deploy SSIS ispac projects to SQL Server Integration Services Catalog

This step template will deploy SSIS ispac projects to SQL Server Integration Services Catalog. The template uses a referenced package and is Worker compatible.

This step template will deploy SSIS ispac projects to SQL Server Integration Services Catalog. The template uses a referenced package and is Worker compatible.

Deploys SSAS packages using Microsoft.AnalysisServices.Deployment.exe.

Uploads SSRS reports to an SSRS server from a package.

Uploads SSRS reports to an SSRS server from a package.

Determine Window Size for Rolling Deploy.

Creates and pushes an Docker Image.

Downloads a file from the internet to the local machine.

Starts/stops one or more services asynchronously, and then waits for them to align to the specified state

Creates an A record in the specified zone with the specified details.

Uses eksctl to create an EKS cluster and register it as a kubernetes target in Octopus.

Step template for notifying elmah.io about deployments on Octopus.

Step template for uploading a source map and a minified JavaScript file to elmah.io.

Registers an ETW manifest

Unregisters an ETW manifest

This combines two previous library templates of checking for Chocolatey being installed, and installing something via Chocolatey, in this case awstools.powershell, and then adds on a third piece of running a custom Powershell script using AWS Powershell tools

Run a custom terraform script using a package and an Azure Account.

Run xUnit tests with dotnet and vstest and some filters.

Clears the WindowsAuthentication Providers, and explicitly adds the ones provided.

F5 - Enable, Disable, or Force Offline multiple pools with optional wait for connections to drop

F5 - Enable, Disable, or Force Offline Member with optional wait for connections to drop

Enable, Disable and to Force Offline F5 pool member via API.

Enables or disables pools in the F5 GTM

F5-LTM-REST - Enable, Disable, or Force Offline Member with optional wait for connections to drop

Adds an entry to etc/hosts file with the specified host name and optional ip address

Uses Robocopy to backup directories and files from a source to a destination.

Checks all or specified fixed drives for free space, either as an absolute number (GB) or relative (%).

Most ASP.NET websites today make use of dynamic compilation.

Clean out configuration transform files from the installation directory after a deployment (e.g. Web.Release.config, YourApp.Production.config, etc.).

Clean out unwanted files from the installation directory after a deployment.

This step template will take all the files in a single directory, sort them alphabetically, and combine them into a single file.

Copies a file in the file system.

Creates a file, using the full path that is provided.

Creates a folder structure that is passed in.

Ensure/Create multiple folders separated by ;

Creates a Symbolic Link

Find and replace text in one or more files.

Grant read, write and modify permissions to folders or files

Runs rclone on a target or worker.

Find and replace text matching a regular expression in one or more files. Now with working $ replacement.

Renames a file on the file system.

Restores a folder and it's contents (files and sub-folders).

Run rsync on a target or worker.

Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression level, and optionally includes the base directory.

Deploys the contents of a package to a Firebase project using the Firebase CLI deploy command.

Step template to leverage Flyway to deploy migration scripts. This is the latest and greatest Flyway step template that leverages all the newest features of both Flyway and Octopus Deploy.

Step template to leverage Flyway to deploy migration scripts. This is the latest and greatest Flyway step template that leverages all the newest features of both Flyway and Octopus Deploy.

gcloud run deploy - deploy a container to Cloud Run

This step retrieves one or more secrets from Secret Manager on Google Cloud Platform (GCP), and creates sensitive output variables for each value retrieved. These values can be used in other steps in your deployment or runbook process.

This step retrieves one or more secrets from Secret Manager on Google Cloud Platform (GCP), and creates sensitive output variables for each value retrieved. These values can be used in other deployment or runbook process steps.

Gets the publishing credentials for an Azure Web App. They are exported as variables from this step under the names PublishingUsername and PublishingPassword.

Step template to gather Octopus usage details across spaces. The results will be output to the log and also as a downloadable artifact.

Clones a repository, copies files from the Source Path to the Destination Path then commits to the repository.

Clones a repository, copies files from the Source Package to the Destination Path then commits to the repository.

Clones both a source and destination repository, copies files from the Source Path to the Destination Path then commits to the destination repository.

Create a Pull or Merge Request for the repository

Gets the latest source for a Git repository.

Deploy a package using Git to a HTTPS server. Performs a clone, overwrites the repository with the files from your package, then pushes. Great for deploying to AppHarbor and Windows Azure websites.

Tags a git repository with the specified tag

Create a release for a Github Repository.

This step creates a secret in a GitHub repo.

This step creates a new GitHub repository if it does not exist.

Forks a repo in GitHub and returns the new repo URL in the output variable NewRepo. If the new repo already exists, it is not modified.

Clones a GitHub repo, runs Yeoman in the cloned directory, and pushes the changes. Note that the Yeoman generators can only use arguments or options, as prompts can not be provided.

Creates or updates a deployment using GitHub Deployments API

Create an annotated tag in Gitlab repository.

Send a message to a Google Chat space using a configured chat webhook.

Grants SeServiceLogonRight to Windows account

Database migrations using grate.

This step generates a response-wrapped Secret ID for an AppRole from a HashiCorp Vault server.

This step logs into a HashiCorp Vault server with the AppRole auth method.

This step retrieves (and unwraps) a Secret ID for an AppRole using a wrapped auth token from a HashiCorp Vault server.

This step combines two Vault operations into one:

This step template generates a Json Web Token (JWT) for use with HashiCorp Vault.

This step logs into a HashiCorp Vault server using the JWT auth method.

This step retrieves one or more secrets in a v1 Key/Value secrets engine stored within a HashiCorp Vault server using a previously obtained authentication token.

This step retrieves one or more secrets in a v2 Key/Value secrets engine stored within a HashiCorp Vault server.

This step logs into a HashiCorp Vault server using the LDAP auth method.

Generate exact changelog from Mercurial commit history. It is stored in the output variable "Changelog".

Notifies a HipChat room of a deployment outcome.

Send a success notification when this step is executed.

This script uploads a new version of an existing app package to the HockeyApp services.

Invoke HTTP Get request using provided url. Doesn't throw exception when request fails.

Execute a simple form POST via HTTP. The script will construct a body in "application/x-www-form-urlencoded" format by extracting Octopus variables with a specified prefix (from the "HTTP.PostForm.Prefix" parameter). Variable names and values are encoded accordingly.

Makes a GET request to a HTTP(S) end point and verifies that a particular status code and (optional) response is returned within a specified period of time.

Makes a GET request to a HTTP(S) end point and verifies that a particular status code is returned within a specified period of time

Performs an automatic update for a 2.6 Tentacle to a 3.0 Tentacle.

Adds an IIS Server Allow exception to the ISAPI/CGI Restrictions in IIS 7 and above.

Add IIS Centralized Certificate Store (CCS) SSL bindings to a website based on HTTP bindings (binds to same IP and hostname but different port and protocol).

Adds HTTP and HTTPS bindings to a website using the specified host name, port numbers, Certificate Location, and SSL Thumbprint

This backs up the entire IIS configuration for the server (does not include website files). Note that all prior configurations on that IIS server will be cleared out.

Applies a https binding, with SNI enabled.

Change the an app_offline file to app_online vice versa to turn the maintenance page on and off.

Configures the MIME types used in static and dynamic compression e.g. The application/json MIME type can be configured to be served using GZIP compression.

Step template to set the desired IIS Authentication (Anonymous, Windows, Digest) State for IIS site(s)

List sites on the server.

Starts, stops, or resets IIS using iisreset

Configure a redirect for an IIS Site or Web Application

Updates property for specified application

Create an IIS virtual application (a virtual directory with an application pool)

Removes an IIS virtual application (a virtual directory with an application pool)

Sets the credential for the Connect As of an IIS application

Creates or Reconfigures an IIS Application Pool

Deletes an IIS Application Pool.

Starts or Restarts an IIS Application Pool

Sets an IIS Application Pool's Managed Pipeline Mode.

Starts an IIS Application Pool

Stops an IIS Application Pool

Updates property for specified AppPool, useful for example to change startMode to AlwaysRunning.

Update the worker process and app pool timeout/recycle times.

Add autostartprovider entry so type can be used to warm up applicaiton. Final changes in applicationHost.config look like that:

Backs up IIS bindings for a given site so they can be restored in later steps. This is very useful if we we have any existing bindings on IIS server since Octopus wipes all existing bindings when create new ones.

This step will restore IIS bindings from backup taken in IIS Bindings - Backup step. Only bindings which doesn't exist will be restored.

Create an IIS virtual directory.

Adds the Octopus Deploy Release number to the IIS response header. When you browse your site you can look at the response header to verify the build number that is running.

Creates a new website in IIS

Deletes a website in IIS.

Adds either a global or site specific rule which redirects from http to https

Restarts a website in IIS.

Takes a list of ip/mask and allow them in ipsecurity

Sets fields included in IIS logging. Uses named checkboxes where the names are identical to the naming scheme in IIS Manager.

Starts a website in IIS.

Stops a website in IIS.

Updates the IIS Log Path if needed.

Updates property for specified WebSite

Starts an AppFabric application in IIS.

Stops an AppFabric application in IIS.

Imports a certificate from Azure Key Vault to the tentacle

Import Databricks workbooks (current supported files .ipynb and .scala) to a databricks instance

Installs the latest Docker Engine - Community from the stable channel, as per https://docs.docker.com/engine/install/ubuntu/#install-using-the-convenience-script

Automates the steps from here.

Trigger a job in Jenkins

Transitions JIRA issues as the code they are associated with gets deployed.

Update version to Jira tickets based on release number being deployed

Merge JSON files

Validates the consistency of an input JSON object against provided JSON schema

Generates a Json Web Token (JWT) for use with applications that require a JWT token. The resulting JWT will be stored as a sensitive output variable called JWT.

This step retrieves one or more secrets from a Keeper Vault and creates sensitive output variables for each value retrieved. These values can be used in other steps in your deployment or runbook process.

Create a service account with a role granting full access to everything in the namespace, and create a Kubernetes target with the new account in Octopus

Apply a Horizontal Pod Autoscaler monitoring external metrics to a Kubernetes cluster.

Apply a Horizontal Pod Autoscaler monitoring object metrics to a Kubernetes cluster.

Apply a Horizontal Pod Autoscaler monitoring pod metrics to a Kubernetes cluster.

Apply a Horizontal Pod Autoscaler monitoring resource metrics to a Kubernetes cluster.

Inspect K8S resources with common actions like get, describe and logs. Optionally create artifacts containing the output.

Load package with kubernetes configuration and deploy to cluster with kustomize evaluation.

Toggle a LaunchDarkly feature flag on or off

Request (or renew) a X.509 SSL Certificate from the Let's Encrypt Certificate Authority.

Request (or renew) a X.509 SSL Certificate from the Let's Encrypt Certificate Authority.

Request (or renew) a X.509 SSL Certificate from the Let's Encrypt Certificate Authority.

Request (or renew) a X.509 SSL Certificate from the Let's Encrypt Certificate Authority.

Request (or renew) a X.509 SSL Certificate from the Let's Encrypt Certificate Authority.

Request (or renew) an X.509 SSL Certificate from the Let's Encrypt Certificate Authority using the Self-hosted HTTP Challenge Listener provided by the Posh-ACME PowerShell Module.

Deploy database updates using Liquibase. You can include Liquibase in the package itself or choose Download to download it during runtime. Use the Report only? option to output the SQL it will run and upload it as an Artifact. NOTE: Report only? does not work with NoSQL databases such as MongoDB

Run Liqbuibase commands against a database. You can include Liquibase in the package itself or choose Download to download it during runtime.

Updates the web/app config files' WIF TrustedIssuer thumbprints based on a realtime metadata request.

A step template that logs a given message to the Splunk Event Collector along with related Octopus Deploy variables.

Use directly after a Manual Intervention step to enforce additional restrictions.

Adds a database user to a role

Creates a MariaDB database if it doesn't already exist.

Creates a new user account on a MariaDB database server

Allows to purge content using Medianova CDN Purge App

Send an SMS using MessageBird API.

Posts a message to Microsoft Teams using Microsoft Power Automate webhook.

No longer functional due to Microsoft's webhook deprecation with Office 365 / MS Teams in Jan 2025. Please use the Microsoft Power Automate - Post AdaptiveCard step instead.

Adds roles to an existing user in a MongoDB database.

Creates a new database on a MongoDB server with an initial collection.

Creates a new database user on a MongoDB server.

Takes one on-demand snapshot for the specified cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

Allow the user to pause/resume the asked cluster.

Allow the user to restore a cluster from the latest snapshot.

Create one or more MSMQ transactional queues and configure permissions.

Deploys a Mulesoft API to Cloudhub

Adds a database user to a role

Backs up a MySQL database on a windows instance hosting MySQL.

Creates a MySQL database if it doesn't already exist. This template is also compatible with MariaDB.

Creates a new user account on a MySQL database server

Enables ad-hoc command execution on a MySQL server

Enables or disables a load balancing service i Citrix NetScaler ADC. For documentation, see https://github.com/jnus/NetScalerPSLib

Creates (replaces) an SSL certificate binding to a specific hostname and port using NETSH.

Creates an HTTP URL reservation (ACL) using NETSH.

Notifies New Relic of a deployment.

Send a message to Spark user or room

Create Windows Service using NSSM and powershell script.

Run the octolint tool against a Space to get a usage recommendation report.

This step exposes the fields required to deploy a runbook serialized with octoterra using Terraform to a project.

This step exposes the fields required to deploy a runbook serialized with octoterra using Terraform to a project.

This step requires Octopus 2025.3.12525 or later.

This step checks to ensure that deployments to blue/green environments alternate. The output variable SequentialDeploy is set to True if two deployments are done to the same environment, and False if they are alternating.

Checks for certificates stored in the Octopus Certificate library which are due to expire within N days.

Checks to see if there are any Argo CD instances registered to the space.

Checks that the SMTP server has been configured.

Checks for the presence of targets with the specified tag. If no targets are found, the deployment will fail with the provided message.

This step exposes the fields required to create the initial blank space serialized with octoterra using Terraform. The new space is then populated using the Octopus - Populate Octoterra Space (Azure Backend) step.

This step exposes the fields required to create the initial blank space serialized with octoterra using Terraform. The new space is then populated using the Octopus - Populate Octoterra Space (S3 Backend) step.

This step populates an Octopus space with the environments, feeds, accounts, lifecycles, projects, and runbooks required to deploy a sample application to an AWS EKS Kubernetes cluster. These resources combine to form a reference architecture teams can use to bootstrap an Octopus space with best practices and example projects. It is recommended that you run this step with the octopuslabs/terraform-workertools container image.

This step queries each workspace in the Terraform state for downstream Octopus CaC enabled projects, extracts the Git repo associated with the CaC project, and determines if there are any changes to merge into the downstream project from the upstream project.

Create or replace an Octopus Certificate from a certificate file

This step queries an Octopus server to return the ID of a named space. The ID is captured in an output variables called SpaceID.

This step queries each workspace in the Terraform state for downstream Octopus CaC enabled projects, extracts the Git repo associated with the CaC project, and merges any changes so long as there are no merge conflicts.

This step exposes the fields required to deploy a project or space serialized with octoterra using Terraform.

This step exposes the fields required to deploy a project or space serialized with octoterra using Terraform.

Prompt the Octopus AI service with a message and store the result in a variable. See https://octopus.com/docs/administration/copilot for more information.

Re-deploy the previous version of a project.

Serialize an Octopus project as a Terraform module and upload the resulting package to the Octopus built in feed.

Serialize an Octopus runbook as a Terraform module and upload the resulting package to the Octopus built in feed.

Serialize an Octopus space, excluding all projects, as a Terraform module and upload the resulting package to the Octopus built in feed.

This step template will take an already exported project on your server and do the following:

Verifies current deploying user didn't deploy previously to specified environment.

This step will poll Octopus Deploy until it detects that the expected Deployment Target has been registered.

This step populates an Octopus space with the environments, feeds, accounts, lifecycles, projects, and runbooks required to deploy a sample application to an Azure Web App. These resources combine to form a reference architecture teams can use to bootstrap an Octopus space with best practices and example projects. It is recommended that you run this step with the octopuslabs/terraform-workertools container image.

Track deploys to your services across different environments in OpsLevel.

Track deploys to your services across different environments in OpsLevel.

Adds database user to a role

Creates a new user account on a Oracle database server

Closes a maintenance window by Id.

Creates an Incident against a PagerDuty Service.

Open a new maintenance window for the specified services, using the PagerDuty v2 API.

Try to pin the TeamCity build version. (Requires Octopus version to match TeamCity version)

Try to pin the TeamCity build version and dependencies

Creates Pingdom http check using Create New Check API method.

Modifies Pingdom http check using Modify Check API method.

Adds database user to a role.

Creates a Postgres database if it doesn't already exist.

Creates a Postgres database if it doesn't already exist.

Creates a new user account on a Postgres database server.

Waits a set amount of time for a process to close and optionally force closes the process after the timeout expires.

Creates a new Proxmox LXC container using the Proxmox API.

Destroys a Proxmox LXC container using the Proxmox API.

Shutdown or Stop a Proxmox LXC container using the Proxmox API.

Starts or Reboots a Proxmox LXC container using the Proxmox API.

Sends a notification using the Pushalot REST API.

Sends a notification using the Pushover REST API.

Notifies a deploy by sending a message into rabbitMQ. The message contains all octopus variables and these can be used to have some insight on the deploy. The step is very beta, it is advised to improve it to match real case scenarios.

Change the condition of a node in a Rackspace Cloud Load Balancer.

Used to create a new database on a server

Used to create a new file system on a server

Used to delete a database from a server, with a possibility to remove all the data from hard drive.

Used to delete a file system from a server, with a possibility to remove its all data from the hard drive.

To move data directly between two instances (or different databases in the same instance) using the between option introduced in Smuggler version 3.

To move data directly between two instances (or different file systems in the same instance) using the between option introduced in Smuggler version 3.

Retrieves the specified document by a Raven Query, updates selected variables with values from octopus Variables. Replaces the current document with the newly created document with the updated values.

Notifies Raygun of a deployment using their Deployments API.

This step will allow you to re-prioritize tasks in the Octopus Deploy queue.

Deploy database changes packaged with Redgate's ReadyRoll. Requires the Microsoft SQL Command Line Utilities 11 or later to be installed on the tentacle.

Creates the resources (including the SQL update script) to deploy database changes using Redgate's SQL Change Automation, and exports them as Octopus artifacts so you can review the changes before deploying.

Creates the resources (including the SQL update script) to deploy database changes using Redgate's SQL Change Automation, and exports them as Octopus artifacts so you can review the changes before deploying.

This step will use the Redgate Oracle Deployment Suite. It will create a delta sql script and report so you can review it prior to being deployed to the Oracle Server. This step will download a package containing the scripts generated by Redgate Source Control for Oracle.

Uses Redgate's SQL Change Automation to deploy a source schema to a SQL Server database without a review step.

Uses the deployment resources from the 'Redgate - Create Database Release' step to deploy the database changes using Redgate's SQL Change Automation.

Uses the deployment resources from the 'Redgate - Create Database Release' step to deploy the database changes using Redgate's SQL Change Automation.

Uses Redgate's SQL Change Automation to deploy a package containing a database schema to a SQL Server database, without a review step.

Uses Redgate's SQL Change Automation to deploy a package containing a database schema to a SQL Server database, without a review step.

Creates a database clone with Redgate SQL Clone.

Creates a database image with Redgate SQL Clone.

Deletes a database clone with Redgate SQL Clone.

Deletes a database image with Redgate SQL Clone.

Script will make sure that Redis server is installed as a Windows service

This step can be used before unpacking a package with Redis service to stop and remove the previous installation, if there is one.

Step template to Register an AKS Cluster with Octopus Deploy using the Octopus Deploy API

This script registers EPPlus dll to the GAC

This Step Template will Register a Linux Tentacle.

Step template to Register an Listening Deployment Target with Octopus Deploy using the API. Useful when spinning up machines and you want to wait to register until the machine finishes installing all additional software.

Step template to Register an Listening Worker with Octopus Deploy using the API. Useful for when you need to wait to install additional software and a restart when spinning up a new worker.

Replace values in a .reg file (Registry Export) automatically with octopus variables.

ReleaseNotesHub is a B2B\B2C SaaS solution that automates the generation and publication of release notes. With RnHub the creation of Release Notes becomes another step within your CI/CD pipeline. ReleaseNotesHub can pull content from many systems including TFS, Azure Devops, GitHub, Jira and Asana.

ReleaseNotesHub is a B2B\B2C SaaS solution that automates the generation and publication of release notes. With ReleaseNotesHub the creation of Release Notes becomes another step within your CI/CD pipeline. ReleaseNotesHub can pull content from many systems including TFS, Azure Devops, GitHub, Jira and Asana.

Uses Service Principal to Remove Server From Azure Load Balancer.

Applies retention policy for built-in package repository by specified package id. Useful when you are using variables in PackageId parameter of deploy package step and built-in retention policy for package repository is not deleting packages.

Posts a deployment notification to Rollbar.

Updates all rules on an Azure load balancer to point to the next backend pool in a specified list. The current backend pool will be determined and the next pool in a provided list will become the target of all rules. If the current pool doesn't exist in the list, the first pool in the list will be used. This means that a specific pool can be chosen by specifying only a single pool.

Database migrations using RoundhousE.

Step template to run an ansible playbook using bash. Requires Ansible and Ansible-Playbook to run successfully.

Will trigger a build pipeline in Azure DevOps for a specified branch using the Azure DevOps REST API.

Runs Update-Database to update the database to the latest Entity Framework migrations

Runs GhostInspector smoke tests asynchronously, returning immediately

Trigger specific application or environment plans in mabl.

This Step template should be used for running MSTests by passing list of assemblies.

This step will kick off a runbook. The runbook can exist in the same space and project, or it can exist on a different instance altogether.

This step will run a script file on an Oracle database using SQLPlus. This script assumes you have SQLPlus installed and a TNS entry for the database you wish to connect to.

Allows you to run Pulumi commands using the Pulumi CLI. For Pulumi stacks that deploy AWS resources, make sure your Octopus Project contains a variable called AWS of type AWS Account. For Pulumi stacks that deploy Azure resources, set the variable Azure of type Azure Subscriptions (Service Principal).

Allows you to run Pulumi commands using the Pulumi CLI. For Pulumi stacks that deploy AWS resources, make sure your Octopus Project contains a variable called AWS of type AWS Account. For Pulumi stacks that deploy Azure resources, set the variable Azure of type Azure Subscriptions (Service Principal).

Saves an output variable to the given project / library variable set

Saves an output variable to the given project / library variable set with scoping

This step extracts the Docker image, finds any bom.json files, and scans them for vulnerabilities using Trivy.

This step template supports sending an email using the MailKit library, a cross-platform .NET library for IMAP, POP3, and SMTP.

Posts a new release to Sentry, It can optionaly resolve all previous issues.

Posts a new release to Sentry and links it to one or more sentry projects.

Post details of the deployment to a Seq log server. Add this as the last step in a process, and ensure it is set to run always (on success and failure).

Check if any given service or list of services is/are running (uses ps command)

Sets Octopus release notes from TFS query

To ensure a stable and smoothly running umbraco installation, these permissions need to be set correctly.

SharePoint Solution Deployment for 2010 & 2013.

The default Configuration Variables functionality replaces appSettings and connectionStrings entries. This step template extends this functionality to the Sitecore configuration settings and sc.variable nodes within the configuration file(s) that you specify. Variables that are defined for the Octopus project will automatically replace those defined in the target Sitecore configuration file(s).

Syncs all the specified configurations via the Unicorn remote sync PowerShell script. Uses the newer MicroChap security layer. Please see the following post for instructions: http://www.sitecorenutsbolts.net/2016/03/14/Octopus-Deploy-Step-for-Unicorn-Sync/

Step template to deploy Sitecore WDP(Web Deploy Package) package.

Posts deployment status to Slack optionally including additional details (release number, environment name, release notes etc.) as well as error description and link to failure log page.

Posts deployment status to Slack optionally including additional details (release number, environment name, release notes etc.) as well as error description and link to failure log page.

Notifies Slack of deployment status. Uses the Octopus Deploy system variable to determine whether a deployment was successful.

Send a message notification to Slack using the Block Kit formatting. These messages will be limited to more basic formats (e.g., using functions and inputs probably won't work), but you still will be able to make much nicer looking messages this way with the ability to preview them using the Block Kit Builder.

Send a basic message notification to Slack.

Send a basic message notification to Slack.

Snowchange is a Python script that applies migration scripts to Snowflake systems.

Start monitoring for a Solarwinds node, application or both

Stop monitoring for a Solarwinds node, application or both

Configures splunk forwarding for the specified file. (The splunk forwarder service should be installed on the target server)

Adds a database user to a role without using SMO. Please note: this is NOT for server roles or server users.

Backup a MS SQL Server database to the file system.

This uses Sql Management Objects to change user access mode. If the username and password are both empty then it will attempt a trusted connection using integrated security.

Creates a database if the database does not exist without using SMO.

Creates a database if the database does not exist without using SMO.

Requires SMO to be installed on the machine where this step will be run.

Will create a database user using an existing server user if that database user does not exist without using SMO.

This uses Sql Management Objects to create a database. If the username and password are both empty then it will attempt a trusted connection using integrated security.

Creates a SQL Server Job Category

Create a SQL Login if the login doesn't already exist without using SMO.

Deletes a database from the server without using SMO.

Deletes a SQL User from the server without using SMO.

Calls SqlPackage commands such as:

This uses Sql Management Objects to drop a database if it exists. If the username and password are both empty then it will attempt a trusted connection.

Execute a SQL script

Execute a SQL script file

Given a path to a folder containing SQL scripts, this module will execute each script on the database server and catalog provided. It will execute them in order based on their name.

Execute a SQL Agent Job and wait for results.

Executes SQL script file(s) against the specified database using the SQLServer Powershell Module. This template includes an Authentication selector and supports SQL Authentication, Windows Authentication, and Azure Managed Identity.

Executes SQL script file(s) against the specified database using either SQL or Windows authentication. SQL Scripts can be hardcoded value or can be from an extracted NuGet package.

Will fix an orphaned user in the database by re-associating the SID.

This step template will run a fragmentation query on your Octopus database and report the results of the tables.

Restore a MS SQL Server database to the file system.

Tests a SQL Server connection string by attempting to connect to the database.

Updates a MS SQL server job with provided ID to be enabled or disabled

This is to deploy ssis packages using 'project deployment model' (ISPAC file )

To be used with:

To be used with:

Given an existing .bacpac in Azure Storage this template restores a SQL Azure database.

Deploy a SQL Agent Job for SSIS Ispac Deployment. Requires SMO to be installed on the machine where this step will be run.

A Template which will deploy any .ISPAC files from the published package step selected to the SQL Server catalog database.

Disables SSL v2, requires restart.

Export the PEM and Key from an SSL certificate to the File System. This is useful in Linux for securing websites or Docker containers

Installs an SSL certificate on the target machine

Automatically performs a back up of all SSRS reports on an SSRS Server.

Notify Retrace about the status of your deployment via this script.

Creates a maintenance window in Status Cake for a given set of tests.

Creates or updates a scheduled maintenance incident on StatusPage.io

Updates an existing scheduled maintenance incident on StatusPage.io

This steps stops the specified service and in case it does not respond or times out, the service will be killed.

Post your Swagger/OAS to SwaggerHub

This template will warm up your deployment slot then swap it with production. This step template should be placed after ""Deploy an Azure Web App" Octopus Deploy template and be used with its sister step "Create Azure RM Deployment Slot"

This will apply a tag to all AWS Elastic Container Registry images/packages from the ECR feed that are used in the deployment. That way the lifecycle policies in ECR can be configured to not delete images that are in-use by deployments in various environments.

Try to tag the TeamCity build version and dependencies

Downloads the TeamCity artifact from the most recent build of the specified branch.

Trigger a specific Team City build from an Octopus Deploy process and wait for the result. The step will fail if the build fails.

Runs NUnit tests from a list of assemblies.

Run tests in the Testery platform. For more information, visit https://testery.io/.

Reports a deployment to Testery, enabling you to do post-deployment validation and testing. See https://testery.io for more info.

A step template that triggers Multi-Tenant Deployment. It can be used in not-tenanted projects. The step will lookup most recent release for the specified project if a specific version is not provided. Then it will lookup all tenants that are tagged with the specified tag and create a new deployment for each of the tenants. This will result in multiple tasks scheduled in Octopus. The step is not tracking status of deployment tasks execution.

Trigger a specific Team City build from an Octopus Deploy process.

Send an SMS using Twilio's API. This script step is written in PowerShell.

Undeploys the specified application/version from the Tomcat server.

Sync Unicorn items

This step can be used before unpacking a package with your TopShelf service to stop and remove the previous installation, if there is one.

Unzip file

This Step Template will help you to update the Azure PowerShell Module version on any targeted tentacle. [Note: Windows PowerShell 5.0 installed as pre-requisites for this step template to work]

This template will update the value of your HOSTS file to what you define in this step.

This step downloads the latest version of Octopus Server and upgrades an existing instance. Run this step on a tentacle that has privileges to install software and start/stop services on the target server.

Upgrades a list of machines to the latest version of Tentacle. Machines can be targeted by Environment and/or Role or Machine Name.

Upload files to a remote server via File Transfer Protocol (SFTP or FTP) using WinSCP.

Upload files to a remote server via File Transfer Protocol (SFTP or FTP) using WinSCP.

Searches Web.config or App.config files looking for Octopus Deploy variables that have not been replaced. Alternatively, any arbitrary file can be checked.

This step template attempts to replace Octopus variable placeholders in one or more file(s) with their values from the $OctopusParameters Dictionary.

Use this step template after the Deploy API step template to substitute variables in a target json file like appsettings.json with Octopus scoped variables. Currently supported data types are string, boolean, interger, decimal and non-empty string arrays and can replace these types inside nested types as well as long as you name them like prop:subprop:subsubprop (like AppMetrics:GlobalTags:env) in octopus like we do today...this should be enough for most of the needs for files like appsettings.json

This step template will authenticate against a Venafi TPP instance using an existing OAuth access token, and create a new certificate as well as optionally associate and push the new certificate to specified existing application(s). This is achieved using a combination of two functions from the VenafiPS PowerShell module:

This step template will authenticate against a Venafi TPP instance using an existing OAuth access token, and export a certificate using its Distinguished Name (DN). This is the absolute path to the certificate in the TPP instance.

This step template will authenticate against a Venafi TPP instance using an existing OAuth access token, and find a matching certificate based on the certificate subject common name. This is achieved using a combination of two functions from the VenafiPS PowerShell module:

This step template will authenticate against a Venafi TPP instance and generate an OAuth token for specified scope/privileges using the VenafiPS PowerShell module's New-TppToken (an alias of the VdcToken function).

This step template will authenticate against a Venafi TPP instance using an existing OAuth access token, export a certificate by its Distinguished Name (DN), and then import the certificate into the Octopus certificate store.

This step template will authenticate against a Venafi TPP instance using an existing OAuth access token, and retrieve a certificate's details using its Distinguished Name (DN). This is the absolute path to the certificate in the TPP instance.

This step template will revoke an access token obtained through a Venafi TPP instance using the VenafiPS PowerShell module's Revoke-TppToken function.

This step calls the GitHub cli to verify an attestation. It currently supports non-container packages. OCI container images will be added in the future.

Create an alert in VictorOps via the REST integration. See VictorOps docs for details.

Pauses the process for a set duration

Wait for IIS connections to drop to 0 or time expires

Pauses the process until a given time

Ensure that Web Deploy 3.5 is installed on the system. The installer is downloaded from http://www.iis.net/downloads/microsoft/web-deploy if required.

Makes it super simple to deploy websites to different regions inside a single process.

Grant read access to certificate for a specific user

Disables loopback checking for a given host header name, allowing an IIS site running with integrated authentication to be accessed from the same machine, e.g. an MVC application referencing a WebAPI application. See below for more information:

Adds a scheduled task that polls a specified endpoint at a specific interval using the provided HTTP method

Add a list of users to a list of Local Groups

Step template to check for and apply Windows Updates with optional automatic reboot.

Establishes the specified source name as a valid event source for writing entries to a log on the local computer.

Creates or updates a Windows shortcut to point to a target file.

Ensures that a set of Windows Features are installed on the system.

Ensures that the given IP/host name entry exists in the hosts file.

Get pending reboot status from computer.

Get processor load from computer.

Get computer up time.

Runs the Windows Installer to non-interactively install an MSI

Runs the Windows Installer to non-interactively install an MSI

Configures a local user. (If assigning user rights the ntrights.exe file should be installed on the target server and added to the system path variable)

Map a network drive.

Remove given IP/host name entry exists in the hosts file.

Restarts the computer.

Installs Windows Disk Cleanup manager on Windows 2008, 2008-R2 and 2012 Server. Should work on Windows 7 and 8

Configures a firewall rule

Changes the execution path of a Windows Scheduled Task for both 2008 and 2012.

Create Windows scheduled task. If the task exists it will be torn down and re-added to ensure consistency

Disables a Windows Scheduled Task for both 2008 and 2012.

Enables a Windows Scheduled Task for both 2008 and 2012.

Change binary path of existing windows service (changes will be effective after service start/stop)

check Windows service status on target machine or remote host(s).

Create Windows Service

Removes a Windows service.

Restarts a Windows Service.

Set the recovery on failure actions for a particular service.

Sets the Startup Type of a Windows Service

Starts a Windows Service.

Stops a Windows Service if it is running.

Verify that WinSW is installed, if it is not, install it.

Run a health check against a worker.

Uploads a dSYM symbols file to Xamarin Insights, for more readable exceptions.

Executes a Xamarin TestCloud test run for an app contained in a nuget file.

You can use this script to easily transform any XML file using XDT.

Upload YAMS application.

This step template adds single host on Zabbix maintenance.