2.2.2 configuration

usage: configuration [options]

This command enables you to handle your configurations in various ways, such as enabling, disabling, checking status, etc.

Option	Description
[-de, --decrypt <passphrase>]	Use this option to decrypt all configurations of the default configuration type, or configurations matching the regular expression stated with the -n option. You must enter the passphrase that you used to encrypt the configuration(s).
[-d, --disable]	Use this option to disable all enabled configurations of the default configuration type, or configurations matching the regular expression stated with the -n option and of the type stated with the -t option. The default value is `false`.
[-e, --enable]	Use this option to enable all disabled configurations of the default configuration type, or configurations matching the regular expression stated with the -n option and of the type stated with the -t option. The default value is `false`.
[-en, --encrypt <passphrase>]	Use this option to encrypt all configurations of the default configuration type, or configurations matching the regular expression stated with the -n option. You must enter a passphrase.
[-l, --list]	Use this option to list all configurations of the default type, or of the type stated with the -t option. The default value is `false`.
[-o, --locked]	Use this option to list only locked configurations. The default value is `false`.
[-n, --name]	Use this option to indicate which configurations you want to perform an action on. Only configurations matching the regular expression stated with the -n option will be affected. The default value is `.*`.
[-s, --status]	Use this option to display the status of all configurations of the default type, or configurations matching the regular expression stated with the -n option and of the type stated with the -t option. The default value is `false`.
[-t, --type]	Use this option to indicate the type of configuration you want to perform an action on. Only configurations matching the stated type will be affected. Note! Currently, Event Notification and Alarm Detection are the only type of configuration supported. When used in combination with -`-decrypt` or `--encrypt`, the `-t` option is ignored.

Note!

The options -d, -e, -l and -s are mutually exclusive, meaning that only one of the options will be applied even if you have stated several.

Examples - Using the configuration command

To list all the configurations in the Default folder:

$ mzsh <username>/<password> configuration -l -n "Default..*"

To list all the configurations in the Default folder with their status:

$ mzsh <username>/<password> configuration -s -n "Default..*"

To list all Alarm Detection configurations with their status:

$ mzsh <username>/<password> configuration -s -t "Alarm Detection"

To enable all Event Notification configurations in all folders beginning with name “event”:

$ mzsh <username>/<password> configuration -e -t "Event Notification" -n "event.*"

To list all locked Event Notification configurations:

$ mzsh <username>/<password> configuration -l -o -t "Event Notification"

To encrypt all configurations in the Default folder which have a name that begins with “test”:

$ mzsh <username>/<password> configuration -en "passphrase123" -n "Default.test.*"

Return Codes

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

Code	Description
0	Will be returned if the command was executed successfully.
1	Will be returned if the input could not be processed.
2	Will be returned if the input did not generate any action.
3	Will be returned if something unexpected happened.
4	Will be returned if one or more configurations were locked, or if the user does not have access to one or more of the configurations.

Next:

2.2.3 db-scripts