The CLI: Configuration Level Commands
The following section provides a list of configuration level commands you can reference when using the CLI.
Table 8: Configuration Level CLI Commands
Command | Syntax | Description |
---|---|---|
commit | commit | Commits any outstanding changes to the configuration settings. If running within a cluster, this command will also publish the new configuration settings out to all nodes in the cluster. Example: config> set engine.enabled false config> commit 1 parameter changed |
export | export | Exports the current saved configuration to a time-stamped file in the user's home directory. The exported file is in the correct format for later re-importing the file back into the configuration system. Example: config> export Configuration exported to /home/mykonos/jwas-2014-04-03-19:37:00.839423.cfg |
info | info <parameter> | Display information about the given parameter, such as the level within the configuration it can be set at, whether it inherits from other levels of config, and possible suggested values for the parameter. Example: config> info logging.audit.local - - - - - - - - - - - - - - Log Audit Locally - - - - - - - - - - - - - - Whether to log audit log entries locally Parameter: logging.audit.local Contexts: global Inheritable: True Suggestions: (1) True - Turn on local logging Value: true (2) False - Turn off local logging Value: false |
init | init <parameter> | Initializes configuration setting values. If a parameter name is given, then only the value of that parameter is initialized. Available Flag:
Example: config> set engine.enabled false config> show engine.enabled false config> init engine.enabled config> show engine.enabled true |
set | set <parameter> <value> | Sets the value of the given configuration parameter to the value provided. Available Flags:
Example: config> set processors.block.response | suggestion 3 config> show processors.block.response processors.block.response config> show processors.block.response.status 403 |
show | show <parameter> | Show the value of the given parameter and any parameters below it. If no parameter is given, then the entire configuration structure is returned. The default format returned is json. Available Flag:
Example: config> show engine.enabled true |
unset | unset <parameter> | Remove a parameter from configuration. Available Flag:
Example: config> set foo.bar baz config> show foo.bar baz config> unset foo.bar Are you sure you want to unset "foo.bar"? [y|N]: y config> show foo.bar config> _ |