Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    The CLI: Configuration Level Commands

    The following section provides a list of configuration level commands you can reference when using the CLI.

    Table 1: 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:

    • ifempty - Only initialize parameter if the current value is not set or null.

    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:

    • edit - Opens a text editor to change the value. This is useful when setting parameters that can take large values such as response bodies.
    • suggestion # - Sets the value of the parameter to the given suggestion number. Use the info command to lookup what the available suggestions are and the number associated with them.
    • null - Sets the value of the parameter to null if allowed.
    • ifempty - Only sets the value of the parameter if its current value is not set or null.
    • json - Parse the given value as json. Useful for setting multiple attributes at one time on a parameter.

    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:

    • flat - Returned data is in dot notation format rather than json.

    Example:

    config> show engine.enabled true

    unset

    unset <parameter>

    Remove a parameter from configuration.

    Available Flag:

    • match(<attribute>=”<value>”) - Remove all parameters from a collection that have an attribute of the given name that matches the given value.

    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> _

    Published: 2015-02-04