Versions Compared

Key

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

...

Has to be rendered in HOCON format.

REPL mode

command specdescription
cluster config show [--cluster-url][--selector]

Show connected cluster configuration

non-REPL mode

command specdescription
ignite cluster config show [--cluster-url][--selector]

Show connected cluster configuration

cluster config update

REPL mode

command specdescription
cluster config update [--cluster-url] <config in HOCON format or path to file>

Update the connected cluster configuration with provided HOCON configuration 

non-REPL mode

command specdescription
ignite cluster config update [--cluster-url] <config in HOCON format or path to file>

Update the cluster configuration with provided HOCON configuration

node

node start

Start the Ignite 3 node.

REPL mode

command specdescription
node start [--config] <nodeName>

Start node with the default configuration or reads the config from --config option 

non-REPL mode

command specdescription
ignite node start [--config] <nodeName>

Start node with the default configuration or reads the config from --config option

node stop

Stop the Ignite 3 node.

REPL mode

command specdescription
node stop <nodeName>

Stop node

non-REPL mode

command specdescription
ignite node stop <nodeName>

Stop node

node status

Shows the status of the node. Could be starting, started, stopping, and recovering.

REPL mode

command specdescription
node status [--node-url]

Shows the node status 

non-REPL mode

command specdescription
ignite node status [--node-url]

Shows the node status

node config show

Has to be rendered in HOCON format.

REPL mode

command specdescription
node config show [--node-url][--selector]

Read the local node configuration 

non-REPL mode

command specdescription
ignite node config show [--node-url][--selector]

Read the local node configuration

node config update

REPL mode

command specdescription
node config update [--node-url] <config in HOCON format or path to file>

Update the connected local node configuration with provided HOCON configuration 

non-REPL mode

command specdescription
ignite node config update [--node-url] <config in HOCON format or path to file>

Update the local node configuration with provided HOCON configuration

node list

REPL mode

command specdescription
node list

Show the list of nodes running locally 

non-REPL mode

command specdescription
ignite node list

Show the list of nodes running locally

cli config get

REPL mode

command specaliasdescription
cli config get <config key> [--profile-name -p] cli configs (~ default get without parameters)Show the default config value for the CLI Tool. Displays all default configs if called without parameter. Show property of profile with provided name.

non-REPL mode

command specaliasdescription
ignite cli config get <config key> [--profile-name -p]ignite cli configsShow the default config value for the CLI Tool. Displays all default configs if called without parameter. Show config value of profile with provided name.

cli config set

REPL mode

command specdescription
cli config set <config key-value> [--profile-name -p] Set the default config value for the CLI Tool. Set the config value for profile with provided name.

non-REPL mode

command specdescription
ignite cli config set <config key-value> [--profile-name -p]Set the default config value for the CLI Tool.  Set the config value for profile with provided name.

cli config profile

cli config profile show

REPL mode

command specdescription
cli config profile show  Show current default profile of CLI Tool

non-REPL mode

command specdescription
ignite cli config show Show current default profile

cli config profile use

REPL mode

command specdescription
cli config profile use <profileName> Activate profile as default for CLI Tool

non-REPL mode

command specdescription
ignite cli config profile use <profileName> Activate profile as default for CLI Tool


cli config profile create

REPL mode

command specdescription
cli config profile create [-–name -n] [--copy-from -c] [–-activate -a]  Create new profile and optionally copy content from another profile and optionally activate new profile as default for CLI Tool

non-REPL mode

command specdescription
ignite cli config profile create [-–name -n] [--copy-from -c] [–-activate -a]Create new profile and optionally copy content from another profile and optionally activate new profile as default for CLI Tooll



...