3. Commands Configuration Spaces

Owned by Jenni Wallin
Last updated: May 15, 2023 by Former user (Deleted)
4 min read

All mzsh commands are supported when using configuration spaces. However, it is not possible to run commands that affect the execution of workflows or workflow groups for passive spaces. This is only possible for those executed in the active space.

To execute a command in a specific space in non-interactive mode, you can specify the space name in the command line:

$ mzsh mzadmin/<password> @<name of space> <command>

  • You can copy the complete set of configurations in one space to another space, or to a zip file. Similarly, spaces in zip files can be copied to a space. Copying a space is a fast operation (minutes for large installations). The copy command overwrites all configurations in the destination space.

  • A passive space can be deleted. When a space is deleted all the configurations in the space are also deleted.
  • A list of all the available spaces can be generated.
  • You can enable or disable a workflow or workflow group in space activation mode in a passive space and perform a spacecopy to the active space.

To log into a specific space, you can specify the space name in the command line:

$ mzsh mzadmin/<password> @<space name>

The Commands Used

  • The configuration space commands can only be executed in non-interactive mode.

  • The execution options, e.g. workflow monitor and execution manager are unavailable in passive spaces and are greyed out on the Desktop. You cannot start or stop workflows in a passive space.

spacecopy

This command copies the content of a space. You can copy the content between two spaces or between a space and a file. Use a .zip extension in the name to indicate a file source or destination. 

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 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 flag if you wish to empty the source space when you execute a spacecopy. You cannot use this flag 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 flag to force a spacecopy. A spacecopy is then executed without issuing the questions above.
[-s, --stop-workflows <timeout>]

Use this flag 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 flag 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.

During a spacecopy, any destination space activity, e.g. a running desktop or mzsh command, is rejected.

spacecreate

This command creates a space which only contains the mandatory system tasks. You must create a destination space before you copy an existing space.

  usage: spacecreate [-o, --offline] <space name>

[-o, --offline]

Use this flag if you wish to create a space that does not have any running service instances.

Offline spaces cannot be used for viewing or changing configurations.

spacelist

This command returns a list of all the spaces in the system. If you have not created any spaces, the only space on the list is the active (default space). When you log in, you automatically log into the active space, which is the default space.

  usage: spacelist

spaceremove

This command deletes a space.

  usage: spaceremove [-f, --force] <space to be removed>

Before the space is deleted, a message is displayed:

Caution!! The spaceremove operation will remove space '<space to be removed>'. Do you want to continue? [Y/N]

[-f, --force]

Use this flag to force a spaceremove. A spaceremove is then executed without issuing the question above.

When this command is executed, if there is a user working in the space to be removed, they receive a message informing them that a spaceremove has been executed, and they are rejected from the system.

Note!

You cannot remove the active space. You can only remove passive spaces.

spaceactivation

This command allows you to enable or disable workflows and/or workflow groups for space activation in a passive space. When you then use the spacecopy command to copy your passive space to the active space, the workflows and/or workflow groups in space activation are run automatically. The spaceactivation command can only be used in passive spaces.  This allows you to control the activation mode of workflows and/or workflow groups when executing a spacecopy.

usage: spaceactivation <passive space name> [-list [-format data-only|full]] [-set <name of workflow or workflow group> <ENABLE|DISABLE>] [-unset <name of workflow or workflow group>]  [-setdefault <name of workflow or workflow group> <ENABLE|DISABLE>] 

The command accepts the following options:

[-list [-format data only|full]]

This option displays all of the workflows and workflow groups in the passive space for space activation.

You can also select the format of the list between data only or full.

This option supports regular expression.

[-set <name of workflow or workflow group> <ENABLE|DISABLE>]

Use this option to set a workflow or workflow group for space activation, and select ENABLE or DISABLE. Using this option, adds the workflow or workflow group to the list for space activation.

This option supports regular expression.

[-unset <name of workflow or workflow group>]

Use this option to remove a workflow or workflow group from the space activation list.

This option supports regular expression.

[-setdefault <name of workflow or workflow group> <ENABLE|DISABLE>] 

Set the default activation mode for a new workflow or workflow group by selecting ENABLE or DISABLE.

Hint!

To display which workflows and or workflow groups are in a space, use the wflist command. See 2.2.58 wflist.

Next chapter:

4. Best Practice Configuration Spaces