2.2.27 spacecopy

Owned by Jenni Wallin
Last updated: Dec 27, 2021
2 min read
usage: spacecopy [ -c, --clear ] [-f, --force ] [-s, --stop-workflows <timeout>] [-sf, --stop-workflows-force <timeout>] 
<source space name | source filename.zip> <destination space name | destination filename.zip>

You can only execute this command in non-interactive mode.

This command copies the content of one space to another. This allows you to make changes to configurations in a passive space without affecting the configurations running in the active space.

You can use spacecopy with files in order to transfer configurations from one system to another.

Note!

In order to avoid compatibility issues, the source and destination system must be identical in terms of version and installed packages. 

If the contents of a source file was created with a different version of , a message is displayed:

Caution! - Space archive file <source> was created using <version>, running version is <version>. Do you want to continue? [Y/N]

Note!

Since you duplicate the content of a space during a spacecopy operation, you must ensure that you have enough extra disk space available. 

Before the content of the source space is copied to a space or an existing file, a message is displayed:

Caution! - '<destination>' will be overwritten. Do you want to continue? [Y/N]

[-c, --clear]

Use this option if you wish to empty the source space when you execute a spacecopy. You cannot use this option if you are copying from or to a zip file.

Hint

By using the --clear option, you lose a copy of the content you have copied, but it makes the spacecopy operation faster as the space contents are moved from one location to another.

[-f, --force]

Use this option to force a spacecopy. A spacecopy is then executed without issuing the questions above.

[-s, --stop-workflows <timeout>]

Use this option to stop your workflows before the space is switched in the spacecopy operation. If the timeout expires, the spacecopy is cancelled. Timeout is in minutes.

Note

The workflows causing timeout might be stopped later by the pending stop action. However, scheduled workflows are only stopped until the next scheduling period.

[-sf, --stop-workflows-force <timeout>]Use this option to stop your workflows before the space is switched in the spacecopy operation. If the timeout expires, an attempt is made to immediately stop the workflows. The timeout is reused for the 'stop immediate' attempt. Timeout is in minutes.

Note!

You cannot execute this command if an import to the source space is in progress, or if workflows are running in the destination space. 

During a spacecopy, any destination space activity, e.g. a running desktop or mzsh command), is rejected. For further information about managing configuration spaces, see the Configuration Spaces documentation.

Return Codes

Listed below are the different return codes for the spacecopy command:

CodeDescription

0

Will be returned if the command was successful. 

1

Will be returned when a general error occurs.

2

Will be returned if interactive mode has been enabled.

3

Will be returned if the parameters are incorrect. 

4

Will be returned if the source space does not exist.

5

Will be returned if the destination space does not exist.

6Will be returned if the source space was not copied.Â