These are the docs for 13.8, an old version of SpatialOS. The docs for this version are frozen: we do not correct, update or republish them. 14.5 is the newest →

spatial project deployment worker replace

Replaces a managed worker instance with an unmanaged instance.


Issues a request to replace a worker instance in the load balancing system of the cloud-running deployment.

If you supply the ID of a 'replacing' worker instance that you want to take over some work, and the ID of an 'existing' worker instance whose work the replacing worker instance should take over, the load balancer will internally remap existing authority from the existing worker instance to the replacing worker instance.

If the ‘replacing’ worker is already connected, it will be assigned the ‘existing’ worker’s authority immediately. If the ‘replacing’ worker is not connected, it will receive the authority of the ‘existing’ worker upon connection to the deployment, but the ‘existing’ worker will lose authority immediately.

spatial project deployment worker replace [flags]


      --deployment_name string       The name of the cloud-running deployment.
      --existing_worker_id string    The worker ID of a worker instance already connected to the deployment, whose load-balancing assignments should be taken over by the replacing worker instance.
      --replacing_worker_id string   The worker ID of the worker instance that should take over from the existing worker. The replacing worker instance can be connected to the deployment already, but it doesn't have to be.

Options inherited from parent commands

      --json_output            Print output in JSON format. Useful when you need to parse the Spatial CLI output.
      --log_directory string   Sets the directory log files will be created in. If not specified, this is set to <project_root>/logs when inside a project directory and logging is disabled when outside a project directory.
      --log_level string       Sets the log level. Available log levels: debug, info, warning, error, fatal, or panic.
      --main_config string     The path to your project's main configuration file (usually called spatialos.json)
      --no_animation           Disable dynamic output elements such as the spinner, progress bars, etc.
      --project_name string    This flag overrides the project name given in the spatialos.json file of the current SpatialOS project (if there is one).

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums