Octopus.Migrator.exe command line

Octopus.Migrator.exe is a command line tool that provides the ability to back-up and restore parts of an Octopus Deploy instance as well as migrate data from Octopus 2.6 builds.

For more in depth information about applicable data migration scenarios and tips, please reference the data migration documentation.

The latest version of Octopus.Migrator.exe is available in the Octopus Deploy installation directory and is usually located in:

C:\Program Files\Octopus Deploy\Octopus

Commands

octopus.migrator.exe supports the following commands:

• export: Exports all configuration data to a directory.
• import: Imports data from an Octopus 3.0+ export directory.
• migrate: Imports data from an Octopus 2.6 backup.
• partial-export: Exports configuration data to a directory filtered by projects.
• version: Shows the version information for this release of the Octopus Migrator.

General usage

All commands take the form of:

Octopus.Migrator <command> [<options>]

You can see a list of commands using:

Octopus.Migrator help

And you can get help for a specific command using:

Octopus.Migrator help <command>

Arguments are not case sensitive and can take the following forms:

--project OctoFX                # Space between argument name and value
--project=OctoFX                # Equal sign between argument name and value
--project "OctoFX Web Site"     # Argument values with spaces need to be quoted
"--project=OctoFX Web Site"     # If using equals, quote both the name and value, not just the value

All commands assume that you are running on the server where the Octopus Server is installed which has access to the relevant database.

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Sunday, January 1, 2023