Using the Data Grid Command Line Interface

Procedure

1. Open a terminal in $RHDG_HOME.

2. Create an admin user with the user create command.

   bin/cli.sh user create admin -p changeme

   Copy to Clipboard Toggle word wrap
   Tip

   Run help user from a CLI session to get complete command details.

Procedure

1. Open a terminal in $RHDG_HOME.

2. Start the CLI.

   • Linux:

     bin/cli.sh

     Copy to Clipboard Toggle word wrap

   • Microsoft Windows:

     bin\cli.bat

     Copy to Clipboard Toggle word wrap

3. Run the connect command and enter your username and password when prompted.

   • Data Grid Server on the default port of 11222:

     [disconnected]> connect

     Copy to Clipboard Toggle word wrap

   • Data Grid Server with a port offset of 100:

     [disconnected]> connect 127.0.0.1:11322

     Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Shut down Data Grid Server in one of the following ways:

   • Stop all nodes in a cluster with the shutdown cluster command, for example:

     shutdown cluster

     Copy to Clipboard Toggle word wrap

     This command saves cluster state to the data folder for each node in the cluster. If you use a cache store, the shutdown cluster command also persists all data in the cache.

   • Stop individual server instances with the shutdown server command and the server hostname, for example:

     shutdown server <my_server01>

     Copy to Clipboard Toggle word wrap

Procedure

1. Start the CLI.

   bin/cli.sh

   Copy to Clipboard Toggle word wrap
2. Run the connect command and enter your username and password when prompted.

3. Use the create cache command to create remote caches.

   For example, create a cache named "mycache" from a file named mycache.xml as follows:

   create cache --file=mycache.xml mycache

   Copy to Clipboard Toggle word wrap

Verification

1. List all remote caches with the ls command.

   ls caches
   mycache

   Copy to Clipboard Toggle word wrap

2. View cache configuration with the describe command.

   describe caches/mycache

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Modify the cache configuration with the alter command in one of the following ways:

   • Use the --file option to specify a configuration file with one or more attribute modifications.

   • Use the --attribute and --value option to modify a specific configuration attribute.

     Tip

     For more information and examples, run the help alter command.

3. Verify your changes with the describe command, for example:

   describe caches/mycache

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Add entries into your cache as follows:

   • Use the --cache= with the put command:

     put --cache=mycache hello world

     Copy to Clipboard Toggle word wrap

   • Use the put command from the context of a cache:

     [//containers/default/caches/mycache]> put hello world

     Copy to Clipboard Toggle word wrap

3. Use the get command to verify entries.

   [//containers/default/caches/mycache]> get hello
   world

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Do one of the following:

   • Delete all entries with the clearcache command.

     clearcache mycache

     Copy to Clipboard Toggle word wrap

   • Remove specific entries with the remove command.

     remove --cache=mycache hello

     Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Remove caches with the drop command.

   drop cache mycache

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Disable automatic rebalancing for all caches with the rebalance disable command.

   rebalance disable

   Copy to Clipboard Toggle word wrap

3. Enable automatic rebalancing for a specific cache with the rebalance enable command.

   The following example enables rebalancing for the cache named "mycache" only.

   rebalance enable caches/mycache

   Copy to Clipboard Toggle word wrap

4. Re-enable automatic rebalancing for all caches.

   rebalance enable

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Do one of the following:

   • Set the current topology as stable for the given cache.

     topology set-stable cacheName

     Copy to Clipboard Toggle word wrap

   • If the current topology is missing more nodes than the number of owners, the force flag is necessary to confirm the operation.

     topology set-stable cacheName -f

     Copy to Clipboard Toggle word wrap

Procedure

1. Create a file that contains a set of operations.

   For example, create a file named batch that creates a cache named mybatch, adds two entries to the cache, and disconnects from the CLI.

   connect --username=<username> --password=<password> <hostname>:11222
   create cache --template=org.infinispan.DIST_SYNC mybatch
   put --cache=mybatch hello world
   put --cache=mybatch hola mundo
   ls caches/mybatch
   disconnect

   Copy to Clipboard Toggle word wrap
   Tip

   Configure the CLI with the autoconnect-url property instead of using the connect command directly in your batch files.

2. Run the CLI and specify the file as input.

   bin/cli.sh -f batch

   Copy to Clipboard Toggle word wrap

Procedure

1. Start the Data Grid CLI in interactive mode.

   bin/cli.sh -c localhost:11222 -f -

   Copy to Clipboard Toggle word wrap
   Tip

   You can configure the CLI connection with the autoconnect-url property instead of using the -c argument.

2. Run batch operations, for example:

   create cache --template=org.infinispan.DIST_SYNC mybatch
   put --cache=mybatch hello world
   put --cache=mybatch hola mundo
   disconnect
   quit

   Copy to Clipboard Toggle word wrap

Procedure

1. 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 ...

     Copy to Clipboard Toggle word wrap

   • Using the ISPN_CLI_DIR environment variable:

     export ISPN_CLI_DIR=/path/to/cli/storage
     bin/cli.sh ...

     Copy to Clipboard Toggle word wrap

2. 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.

   Note

   For 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

   Copy to Clipboard Toggle word wrap

3. Verify configuration properties with the config get command.

   Tip

   Run help config to review available configuration properties and get example usage.

Procedure

1. Create aliases with the alias <alias>=<command> command.

   For example, set q as an alias for the quit command:

   alias q=quit

   Copy to Clipboard Toggle word wrap

2. Run the alias command to check the defined aliases.

   alias
   alias q='quit'

   Copy to Clipboard Toggle word wrap

3. Delete aliases with the unalias command, for example:

   unalias q

   Copy to Clipboard Toggle word wrap

Procedure

1. 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

   Copy to Clipboard Toggle word wrap

2. Optional: Define a trust store password. The following example sets secret as the trust store password:

   bin/cli.sh config set truststore-password secret

   Copy to Clipboard Toggle word wrap

3. Optional: If you require client certificate authentication for your server, specify the location of the client key store. Considering the following example, replace <path> with the absolute directory path to your key store file, and replace <key_store_file> with the name of your key store file:

   bin/cli.sh config set keystore /<emphasis><path></emphasis>/<emphasis><key_store_file></emphasis>

   Copy to Clipboard Toggle word wrap

4. Optional: Define a key store password. The following example sets secret as the key store password:

   bin/cli.sh config set keystore-password secret

   Copy to Clipboard Toggle word wrap

5. Verify your CLI configuration.

   bin/cli.sh config get truststore

   Copy to Clipboard Toggle word wrap

   bin/cli.sh config get truststore-password

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Run the create counter command with the appropriate arguments.

   1. Create my-weak-counter.

      create counter --concurrency-level=1 --initial-value=5 --storage=PERSISTENT --type=weak my-weak-counter

      Copy to Clipboard Toggle word wrap

   2. Create my-strong-counter.

      create counter --initial-value=3 --storage=PERSISTENT --type=strong my-strong-counter

      Copy to Clipboard Toggle word wrap

3. List available counters.

   ls counters

   Copy to Clipboard Toggle word wrap

4. Verify counter configurations.

   1. Describe my-weak-counter.

      describe counters/my-weak-counter

      Copy to Clipboard Toggle word wrap

      {
          "weak-counter":{
              "initial-value":5,
              "storage":"PERSISTENT",
              "concurrency-level":1
          }
      }

      Copy to Clipboard Toggle word wrap

   2. Describe my-strong-counter.

      describe counters/my-strong-counter

      Copy to Clipboard Toggle word wrap

      {
          "strong-counter":{
              "initial-value":3,
              "storage":"PERSISTENT",
              "upper-bound":5
          }
      }

      Copy to Clipboard Toggle word wrap

Procedure

1. Select a counter.

   counter my-weak-counter

   Copy to Clipboard Toggle word wrap

2. List the current count.

   [//containers/default/counters/my-weak-counter]> ls
   5

   Copy to Clipboard Toggle word wrap

3. Increment the counter value by 2.

   [//containers/default/counters/my-weak-counter]> add --delta=2

   Copy to Clipboard Toggle word wrap

4. Decrement the counter value by -4.

   [//containers/default/counters/my-weak-counter]> add --delta=-4

   Copy to Clipboard Toggle word wrap

Procedure

1. Check if backup locations are online or offline with the site status command:

   site status --cache=cacheName --site=NYC

   Copy to Clipboard Toggle word wrap
   Note

   --site is an optional argument. If not set, the CLI returns all backup locations.

   Tip

   Use the --all-caches option to get the backup location status for all caches.

2. Manage backup locations as follows:

   • Bring backup locations online with the bring-online command:

     site bring-online --cache=customers --site=NYC

     Copy to Clipboard Toggle word wrap

   • Take backup locations offline with the take-offline command:

     site take-offline --cache=customers --site=NYC

     Copy to Clipboard Toggle word wrap

Procedure

1. Use the site command to configure state transfer modes, as in the following examples:

   • Retrieve the current state transfer mode.

     site state-transfer-mode get --cache=cacheName --site=NYC

     Copy to Clipboard Toggle word wrap

   • Configure automatic state transfer operations for a cache and backup location.

     site state-transfer-mode set --cache=cacheName --site=NYC --mode=AUTO

     Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Run the backup create command with the appropriate options, for example:

   • Back up all resources with an automatically generated name.

     backup create

     Copy to Clipboard Toggle word wrap

   • Back up all resources in a backup archive named example-backup.

     backup create -n example-backup

     Copy to Clipboard Toggle word wrap

   • Back up all resources to the /some/server/dir path on the server.

     backup create -d /some/server/dir

     Copy to Clipboard Toggle word wrap

   • Back up only caches and cache templates.

     backup create --caches=* --templates=*

     Copy to Clipboard Toggle word wrap

   • Back up named Protobuf schemas only.

     backup create --proto-schemas=schema1,schema2

     Copy to Clipboard Toggle word wrap

3. List available backup archives on the server.

   backup ls

   Copy to Clipboard Toggle word wrap

4. Download the example-backup archive from the server.

   If the backup operation is still in progress, the command waits for it to complete.

   backup get example-backup

   Copy to Clipboard Toggle word wrap

5. Optionally delete the example-backup archive from the server.

   backup delete example-backup

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a CLI connection to Data Grid.

2. Run the backup restore command with the appropriate options.

   • Restore all content from a backup archive accessible on the server.

     backup restore /some/path/on/the/server

     Copy to Clipboard Toggle word wrap

   • Restore all content from a local backup archive.

     backup restore -u /some/local/path

     Copy to Clipboard Toggle word wrap

   • Restore only cache content from a backup archive on the server.

     backup restore /some/path/on/the/server --caches=*

     Copy to Clipboard Toggle word wrap