Chapter 4. Configuring the Data Grid CLI
Define configuration properties for the Data Grid CLI.
4.1. Setting Data Grid CLI Properties and Persistent Storage
Configure Data Grid CLI startup operations and customize the location for persistent storage.
Prerequisites
Create at least one Data Grid user.
Procedure
Optionally set a custom path to the Data Grid CLI storage directory in one of the following ways:
Using the
cli.dir
system property:bin/cli.sh -Dcli.dir=/path/to/cli/storage ...
Using the
ISPN_CLI_DIR
environment variable:export ISPN_CLI_DIR=/path/to/cli/storage bin/cli.sh ...
Set values for configuration properties with the
config set
command.For example, set the
autoconnect-url
property so that the CLI automatically connects to that URL.NoteFor remote connections, specify the URL and provide credentials:
-
http[s]://<username>:<password>@<hostname>:<port>
for basic authentication. -
http[s]://<token>@<hostname>:<port>
for OAuth authentication.
bin/cli.sh config set autoconnect-url http://<username>:<password>@<hostname>:11222
-
Verify configuration properties with the
config get
command.TipRun
help config
to review available configuration properties and get example usage.
4.2. Creating Command Aliases
Create aliases for Data Grid CLI commands to define custom shortcuts.
Procedure
Create aliases with the
alias <alias>=<command>
command.For example, set
q
as an alias for thequit
command:alias q=quit
Run the
alias
command to check the defined aliases.alias alias q='quit'
Delete aliases with the
unalias
command, for example:unalias q
4.3. Trusting Data Grid Server Connections
Secure Data Grid CLI connections to Data Grid Server with SSL/TLS certificates. If you create a key store as an SSL identity for Data Grid Server, the CLI can validate server certificates to verify the identity.
Prerequisites
- Set up an SSL identity for Data Grid Server.
- Create at least one Data Grid user.
Procedure
Specify the location of the server key store, as in the following example:
bin/cli.sh config set truststore /home/user/my-trust-store.jks
Define the key store password, if necessary, as follows:
bin/cli.sh config set truststore-password secret
Verify your CLI configuration.
bin/cli.sh config get truststore
bin/cli.sh config get truststore-password
Additional resources
4.4. Data Grid CLI Storage Directory
Data Grid CLI stores configuration in the following default directory:
Operating System | Default Path |
---|---|
Linux/Unix |
|
Microsoft Windows |
|
Mac OS |
|
This directory contains the following files:
cli.properties
- Stores values for CLI configuration properties.
aliases
- Stores command aliases.
history
- Stores CLI history.