Octopus.Server.exe Command Line

Last updated

Octopus.Server.exe is the executable that runs the Octopus Server instance. It includes many helpful commands that allow you to manage the instance, including; authentication, configuration, diagnostics and running the service.

Commands

Octopus.Server.exe supports the following commands:

  • admin: Reset admin user passwords, re-enable them, and ensure they are in the admin group.
  • builtin-worker: Configure the built-in worker used to run deployment actions and scripts on the Octopus Server. Available in Octopus 2018.1.0 and later.
  • checkservices: Checks the Octopus instances are running.
  • configure: Configure this Octopus instance.
  • create-instance: Registers a new instance of the Octopus service.
  • database: Create or drop the Octopus database.
  • delete-instance: Deletes an instance of the Octopus service.
  • export-certificate: Exports the certificate that Octopus Server can use to authenticate itself with its Tentacles.
  • external-worker: Configure the external worker used to run deployment actions and scripts on the Octopus Server. Available in Octopus 2018.2.0 and later.
  • help: Prints this help text.
  • import-certificate: Replace the certificate that Octopus Server uses to authenticate itself with its Tentacles.
  • license: Import a license key.
  • list-instances: Lists all installed Octopus instances.
  • new-certificate: Creates a new certificate that Octopus Server can use to authenticate itself with its Tentacles.
  • path: Set the file paths that Octopus will use for storage.
  • proxy: Configure the HTTP proxy used by Octopus.
  • regenerate-certificate: Regenerate one or more of the certificates that Octopus uses.
  • run: Starts the Octopus Server in debug mode.
  • service: Start, stop, install and configure the Octopus service.
  • show-configuration: Outputs the server configuration.
  • show-master-key: Print the server's Master Encryption Key, so that it can be backed up.
  • show-thumbprint: Shows the squid and thumbprint of the server instance.
  • version: Show the Octopus Server version information.
  • watchdog: Configure a scheduled task to monitor the Octopus service(s).

General Usage

All commands take the form of:

Octopus.Server <command> [<options>]

To get help for a specific command use:

Octopus.Server help <command>
Octopus.Server <command> --help

In This Section

The following topics are explained further in this section: