Octopus Deploy Documentation

Create Worker pool

Last updated

The Octopus CLIΒ can be used to create a worker pool.

Creates a pool for workers.

Usage: octo create-workerpool [<options>]

Where [<options>] is any of:

WorkerPool creation:

      --name=VALUE           The name of the worker pool
      --ignoreIfExists       If the pool already exists, an error will be
                             returned. Set this flag to ignore the error.

Common options:

      --help                 [Optional] Print help for a command
      --helpOutputFormat=VALUE
                             [Optional] Output format for help, valid options
                             are Default or Json
      --outputFormat=VALUE   [Optional] Output format, valid options are
                             Default or Json
      --server=VALUE         [Optional] The base URL for your Octopus Server,
                             e.g., 'https://octopus.example.com/'. This URL
                             can also be set in the OCTOPUS_CLI_SERVER
                             environment variable.
      --apiKey=VALUE         [Optional] Your API key. Get this from the user
                             profile page. You must provide an apiKey or
                             username and password. If the guest account is
                             enabled, a key of API-GUEST can be used. This
                             key can also be set in the OCTOPUS_CLI_API_KEY
                             environment variable.
      --user=VALUE           [Optional] Username to use when authenticating
                             with the server. You must provide an apiKey or
                             username and password. This Username can also be
                             set in the OCTOPUS_CLI_USERNAME environment
                             variable.
      --pass=VALUE           [Optional] Password to use when authenticating
                             with the server. This Password can also be set
                             in the OCTOPUS_CLI_PASSWORD environment variable.
      --configFile=VALUE     [Optional] Text file of default values, with one
                             'key = value' per line.
      --debug                [Optional] Enable debug logging
      --ignoreSslErrors      [Optional] Set this flag if your Octopus Server
                             uses HTTPS but the certificate is not trusted on
                             this machine. Any certificate errors will be
                             ignored. WARNING: this option may create a
                             security vulnerability.
      --enableServiceMessages
                             [Optional] Enable TeamCity or Team Foundation
                             Build service messages when logging.
      --timeout=VALUE        [Optional] Timeout in seconds for network
                             operations. Default is 600.
      --proxy=VALUE          [Optional] The URL of the proxy to use, e.g.,
                             'https://proxy.example.com'.
      --proxyUser=VALUE      [Optional] The username for the proxy.
      --proxyPass=VALUE      [Optional] The password for the proxy. If both
                             the username and password are omitted and
                             proxyAddress is specified, the default
                             credentials are used.
      --space=VALUE          [Optional] The name or ID of a space within
                             which this command will be executed. The default
                             space will be used if it is omitted.
      --logLevel=VALUE       [Optional] The log level. Valid options are
                             verbose, debug, information, warning, error and
                             fatal. Defaults to 'debug'.

Basic examples

Octopus Samples instance

Many of the examples we use, reference the samples instance of Octopus Deploy. If you'd like to explore the samples instance, you can log in as a guest.

This example creates a worker pool named Docker Worker Pool in the Pattern - Rolling space:

octo create-workerpool --name="Docker Worker Pool" --space="Pattern - Rolling" --server="https://samples.octopus.app/" --apiKey="MyApiKey"

This example creates a worker pool named Docker Worker Pool in the Pattern - Rolling space, and ignore any errors if the pool already exists:

octo create-workerpool --name="Docker Worker Pool" --ignoreIfExists --space="Pattern - Rolling"  --server="https://samples.octopus.app/" --apiKey="MyApiKey"

Learn more

Need support? We're here to help.