Command line syntax - Deployment Manager

You specify DeploymentManager.exe syntax as a command, followed by a number of options:

deploymentmanager <command> <option> <option>

Commands

You can use the following commands with DeploymentManager.exe:

• create-release

  Creates and optionally deploys a release

• deploy-release

  Deploys a release

• list-environments

  Lists the environments you can deploy to

Note that:

• you can specify any number of the available options with each command
• each command has a number of required options

Options

--server=<server URL> (required)

The URL of your Deployment Manager server.

Example: --server=http://localhost:99/

The create-release, deploy-release and list-environments commands require this option.

--apiKey=<API key> (required)

The API key of your Deployment Manager user account.

Example: --apikey=JBIKPFSAH2BZEC8TTZYSLNBEU

The create-release, deploy-release and list-environments commands require this option.

--project=<project name> (required)

The name of the Deployment Manager project you want to use.

Example: --project="Widget Shop"

The create-release and deploy-release commands require this option.

--deployto=<environment> (required with deploy-release)

The environment you want to deploy to.

Example: --deployto=Staging

The deploy-release command requires this option, but it is optional with create-release.

--releaseversion=<version> (required with deploy-release)

The version number for the new release.

Example: --releaseversion=1.0 or --releaseversion=1.%build.number%

If you don't specify this option, the highest version number of all the packages you're deploying is used as the release version.

If you want to use the build number from a continous integration server (for example TeamCity), you can specify a variable or parameter.

The deploy-release command requires this option, but it is optional with create-release.

--user=<username> (optional)

Your Deployment Manager account username.

Example: --user=administrator

You can specify this option with the create-release, deploy-release and list-environments commands.

--pass=<password> (optional)

Your Deployment Manager account passowrd.

Example: --pass=password

You can specify this option with the create-release, deploy-release and list-environments commands.

--packageversion=<package name>=<version> (optional)

The version number for a package you want to deploy.

Examples: --packageversion="Widget Shop"=1.1 or --packageversion=1.1

You can use --packageversion=<version> to set a version number for all packages that you have not specified a version for.

If you do not specify this option, the latest available version of a package will be used.

You can specify this option with the create-release command.

--releasenotes=<notes> (optional)

The release notes for the new release.

Example: --releasenotes="Patch to fix bug BG-399"

You can specify this option with the create-release command.

--releasenotesfile=<path> (optional)

The path to a file that contains release notes for the new release.

Example: --releasenotesfile="C:\Deployments\Release notes\release_notes.txt"

You can specify this option with the create-release command.

--deploymenttimeout=<time> (optional)

The maxiumum time a deployment can take.

Example: --deploymenttimeout=00:30:00

Specify the value in the format hh:mm:ss. The default value is 00:10:00.

You can specify this option with the create-release and deploy-release commands.

--deploymentchecksleepcycle=<time> (optional)

The amount of time between deployment status checks.

Example: --deploymentchecksleepcycle=00:00:30

Specify the value in the format hh:mm:ss. The default value is 00:00:10.

You can specify this option with the create-release and deploy-release commands.

--waitfordeployment (or -w) (optional)

If specified, the command will wait for the deployment to complete before returning.

You can specify this option with the create-release and deploy-release commands.