Chapter 1. Getting Started with the Data Grid CLI

1.1. Creating and Modifying Users
Copier lien

Data Grid Server requires users to authenticate against a default property realm. Before you can access Data Grid Server, you must add credentials by creating at least one user and a password. You can also add and modify the security authorization groups to which users belong.

Procedure

Open a terminal in $RHDG_HOME.
Create and modify Data Grid users with the user command.

Tip

Run help user for more details about using the command.

Creating users and passwords

Linux

bin/cli.sh user create myuser -p "qwer1234!"

$ bin/cli.sh user create myuser -p "qwer1234!"

Copy to Clipboard

Toggle word wrap

Microsoft Windows

bin\cli.bat user create myuser -p "qwer1234!"

$ bin\cli.bat user create myuser -p "qwer1234!"

Copy to Clipboard

Toggle word wrap

Creating users with group membership

Linux

bin/cli.sh user create myuser -p "qwer1234!" -g supervisor,reader,writer

$ bin/cli.sh user create myuser -p "qwer1234!" -g supervisor,reader,writer

Copy to Clipboard

Toggle word wrap

Microsoft Windows

bin\cli.bat user create myuser -p "qwer1234!" -g supervisor,reader,writer

$ bin\cli.bat user create myuser -p "qwer1234!" -g supervisor,reader,writer

Copy to Clipboard

Toggle word wrap

1.2. Connecting to Data Grid Servers
Copier lien

Establish CLI connections to Data Grid.

Prerequisites

Add user credentials and have at least one running Data Grid server instance.

Procedure

Open a terminal in $RHDG_HOME.
Start the CLI.
- Linux:
  $ bin/cli.sh
  Copy to Clipboard Toggle word wrap
- Microsoft Windows:
  $ bin\cli.bat
  Copy to Clipboard Toggle word wrap
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

1.3. Navigating CLI Resources
Copier lien

The Data Grid CLI exposes a navigable tree that allows you to list, describe, and manipulate Data Grid cluster resources.

Tip

Press the tab key to display available commands and options. Use the -h option to display help text.

When you connect to a Data Grid cluster, it opens in the context of the default cache container.

[//containers/default]>

[//containers/default]>

Copy to Clipboard

Toggle word wrap

Use ls to list resources.

[//containers/default]> ls
caches
counters
configurations
schemas
tasks

[//containers/default]> ls
caches
counters
configurations
schemas
tasks

Copy to Clipboard

Toggle word wrap

Use cd to navigate the resource tree.

[//containers/default]> cd caches

[//containers/default]> cd caches

Copy to Clipboard

Toggle word wrap

Use describe to view information about resources.

[//containers/default]> describe
{
  "name" : "default",
  "version" : "xx.x.x-FINAL",
  "cluster_name" : "cluster",
  "coordinator" : true,
  "cache_configuration_names" : [ "org.infinispan.REPL_ASYNC", "___protobuf_metadata", "org.infinispan.DIST_SYNC", "org.infinispan.LOCAL", "org.infinispan.INVALIDATION_SYNC", "org.infinispan.REPL_SYNC", "org.infinispan.SCATTERED_SYNC", "org.infinispan.INVALIDATION_ASYNC", "org.infinispan.DIST_ASYNC" ],
  "physical_addresses" : "[192.0.2.0:7800]",
  "coordinator_address" : "<hostname>",
  "cache_manager_status" : "RUNNING",
  "created_cache_count" : "1",
  "running_cache_count" : "1",
  "node_address" : "<hostname>",
  "cluster_members" : [ "<hostname1>", "<hostname2>" ],
  "cluster_members_physical_addresses" : [ "192.0.2.0:7800", "192.0.2.0:7801" ],
  "cluster_size" : 2,
  "defined_caches" : [ {
    "name" : "mycache",
    "started" : true
  }, {
    "name" : "___protobuf_metadata",
    "started" : true
  } ]
}

[//containers/default]> describe
{
  "name" : "default",
  "version" : "xx.x.x-FINAL",
  "cluster_name" : "cluster",
  "coordinator" : true,
  "cache_configuration_names" : [ "org.infinispan.REPL_ASYNC", "___protobuf_metadata", "org.infinispan.DIST_SYNC", "org.infinispan.LOCAL", "org.infinispan.INVALIDATION_SYNC", "org.infinispan.REPL_SYNC", "org.infinispan.SCATTERED_SYNC", "org.infinispan.INVALIDATION_ASYNC", "org.infinispan.DIST_ASYNC" ],
  "physical_addresses" : "[192.0.2.0:7800]",
  "coordinator_address" : "<hostname>",
  "cache_manager_status" : "RUNNING",
  "created_cache_count" : "1",
  "running_cache_count" : "1",
  "node_address" : "<hostname>",
  "cluster_members" : [ "<hostname1>", "<hostname2>" ],
  "cluster_members_physical_addresses" : [ "192.0.2.0:7800", "192.0.2.0:7801" ],
  "cluster_size" : 2,
  "defined_caches" : [ {
    "name" : "mycache",
    "started" : true
  }, {
    "name" : "___protobuf_metadata",
    "started" : true
  } ]
}

Copy to Clipboard

Toggle word wrap

1.3.1. CLI Resources
Copier lien

The Data Grid CLI exposes different resources to:

create, modify, and manage local or clustered caches.
perform administrative operations for Data Grid clusters.

Cache Resources

[//containers/default]> ls
caches
counters
configurations
schemas

[//containers/default]> ls
caches
counters
configurations
schemas

Copy to Clipboard

Toggle word wrap

caches: Data Grid cache instances. The default cache container is empty. Use the CLI to create caches from templates or infinispan.xml files.
counters: Strong or Weak counters that record the count of objects.
configurations: Data Grid configurations.
schemas: Protocol Buffers (Protobuf) schemas that structure data in the cache.
tasks: Remote tasks creating and managing Data Grid cache definitions.

Cluster Resources

[hostname@cluster/]> ls
containers
cluster
server

[hostname@cluster/]> ls
containers
cluster
server

Copy to Clipboard

Toggle word wrap

containers: Cache containers on the Data Grid cluster.
cluster: Lists Data Grid servers joined to the cluster.
server: Resources for managing and monitoring Data Grid servers.

1.4. Shutting Down Data Grid Server
Copier lien

Stop individually running servers or bring down clusters gracefully.

Procedure

Create a CLI connection to Data Grid.
Shut down Data Grid Server in one of the following ways:
- Stop all nodes in a cluster with the shutdown cluster command, for example:
  [//containers/default]> 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:
  [//containers/default]> shutdown server <my_server01>
  Copy to Clipboard Toggle word wrap

Important

The shutdown server command does not wait for rebalancing operations to complete, which can lead to data loss if you specify multiple hostnames at the same time.

Tip

Run help shutdown for more details about using the command.

Verification

Data Grid logs the following messages when you shut down servers:

ISPN080002: Data Grid Server stopping
ISPN000080: Disconnecting JGroups channel cluster
ISPN000390: Persisted state, version=<$version> timestamp=YYYY-MM-DDTHH:MM:SS
ISPN080003: Data Grid Server stopped

ISPN080002: Data Grid Server stopping
ISPN000080: Disconnecting JGroups channel cluster
ISPN000390: Persisted state, version=<$version> timestamp=YYYY-MM-DDTHH:MM:SS
ISPN080003: Data Grid Server stopped

Copy to Clipboard

Toggle word wrap

1.4.1. Restarting Data Grid Clusters
Copier lien

When you bring Data Grid clusters back online after shutting them down, you should wait for the cluster to be available before adding or removing nodes or modifying cluster state.

If you shutdown clustered nodes with the shutdown server command, you must restart each server in reverse order.
For example, if you shutdown server1 and then shutdown server2, you should first start server2 and then start server1.

If you shutdown a cluster with the shutdown cluster command, clusters become fully operational only after all nodes rejoin.
You can restart nodes in any order but the cluster remains in DEGRADED state until all nodes that were joined before shutdown are running.

Ce contenu n'est pas disponible dans la langue sélectionnée.

1.1. Creating and Modifying Users
Copier lien

1.2. Connecting to Data Grid Servers
Copier lien

1.3. Navigating CLI Resources
Copier lien

1.3.1. CLI Resources
Copier lien

1.4. Shutting Down Data Grid Server
Copier lien

1.4.1. Restarting Data Grid Clusters
Copier lien

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Rendre l’open source plus inclusif

À propos de Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Ce contenu n'est pas disponible dans la langue sélectionnée.

Chapter 1. Getting Started with the Data Grid CLI

1.1. Creating and Modifying UsersCopier lienLien copié sur presse-papiers!

1.2. Connecting to Data Grid ServersCopier lienLien copié sur presse-papiers!

1.3. Navigating CLI ResourcesCopier lienLien copié sur presse-papiers!

1.3.1. CLI ResourcesCopier lienLien copié sur presse-papiers!

1.4. Shutting Down Data Grid ServerCopier lienLien copié sur presse-papiers!

1.4.1. Restarting Data Grid ClustersCopier lienLien copié sur presse-papiers!

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Rendre l’open source plus inclusif

À propos de Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

1.1. Creating and Modifying Users
Copier lien

1.2. Connecting to Data Grid Servers
Copier lien

1.3. Navigating CLI Resources
Copier lien

1.3.1. CLI Resources
Copier lien

1.4. Shutting Down Data Grid Server
Copier lien

1.4.1. Restarting Data Grid Clusters
Copier lien