Skip to main content

ax settings get

Get settings from an ActyxOS node
ax settings get [FLAGS] <SCOPE> <NODE>
-h, --help Prints help information
-l, --local Process over local network
--no-defaults Only return settings explicitly set by the user and
skip default values
-V, --version Prints version information
-v Verbosity level. Add more v for higher verbosity
(-v, -vv, -vvv, etc.)
<SCOPE> Scope from which you want to get the settings
<NODE> Node ID or, if using `--local`, the IP address of the node to
perform the operation on
Null or schema conformant

The return value of this command will always be either null or schema conformant, unless the --no-defaults flag is used.

Here are some examples of using the ax settings get command:

Example Usage
# Get the settings for the node with settings scope com.actyx at
ax settings get --local com.actyx.os
# Just get the displayName setting
ax settings get --local com.actyx.os/general/displayName