Versions Compared

Old Version 2

changes.mady.by.user Jenni Wallin

Saved on

compared with

New Version Current

changes.mady.by.user Jenni Wallin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Usage

Usage
Code Block
title
configuration [-de <passphrase>] | [ -d ] | [ -e ] | [ -en <passphrase> ] | [ -l ] | [ -s ] | [-o] [-t <type>] [-n <name>]
  Options:
    -de, --decrypt
      Decrypt the configurations with passphrase
      Default: <empty string>
    -d, --disable
      Disable configurations.
      Default: false
    -e, --enable
      Enable configurations.
      Default: false
    -en, --encrypt
      Encrypt the configurations with passphrase
      Default: <empty string>
    -l, --list
      List configurations.
      Default: false
    -o, --locked
      Match only locked configurations.
      Default: false
    -n, --name
      Name to match configurations against.
      Default: .*
    -s, --status
      Status of configurations.
      Default: false
    -t, --type
      Type of configurations.

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

Options

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
title

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
title

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.

Return Codes

The different return codes for the configuration command are listed below:

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.