Data Grid Command Line Interface

You need an admin user for the Data Grid Console and full control over your Data Grid environment. For this reason you should create a user with admin permissions the first time you add credentials.

Assign roles to users so they have the correct permissions to access data and modify Data Grid resources.

Groups let you change permissions for multiple users. You assign a role to a group and then add users to that group. Users inherit permissions from the group role.

Data Grid includes a default set of roles that grant users with permissions to access data and interact with Data Grid resources.

ClusterRoleMapper is the default mechanism that Data Grid uses to associate security principals to authorization roles.

The Data Grid CLI exposes different resources to:

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

[hostname@cluster/]> ls
containers
cluster
server

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.

You can provide cache configuration in XML or JSON format.

<distributed-cache name="myCache" mode="SYNC">
  <encoding media-type="application/x-protostream"/>
  <memory max-count="1000000" when-full="REMOVE"/>
</distributed-cache>

{
  "distributed-cache": {
    "name": "myCache",
    "mode": "SYNC",
    "encoding": {
      "media-type": "application/x-protostream"
      },
    "memory": {
      "max-count": 1000000,
      "when-full": "REMOVE"
    }
  }
}

JSON format

Cache configuration in JSON format must follow the structure of an XML configuration. * XML elements become JSON objects. * XML attributes become JSON fields.

add - increments and decrements counters with arbitrary values.

add ['OPTIONS'] ['COUNTER_NAME']

add --delta=10 cnt_a
Increments the value of cnt_a by 10.

add --delta=-5 cnt_a
Decrements the value of cnt_a by 5.

cas(1), reset(1)

alias - creates or displays aliases.

alias ['ALIAS-NAME'='COMMAND']

alias q=quit
Creates q as an alias for the quit command.

alias
Lists all defined aliases.

config(1), unalias(1)

backup - manage container backup creation and restoration.

backup create ['OPTIONS']

backup delete ['OPTIONS'] BACKUP_NAME

backup get ['OPTIONS'] BACKUP_NAME

backup ls

backup restore ['OPTIONS'] BACKUP_PATH

backup create -n example-backup
Initiates a backup of all container content with name example-backup.

backup create -d /some/server/dir
Initiates a backup of all container content and stores it on the server at path /some/server/dir.

backup create --caches=* --templates=*
Initiates a backup that contains only cache and cache configuration resources.

backup create --proto-schemas=schema1,schema2
Initiates a backup that contains the named schema resources only.

backup ls
Lists all backups available on the server.

backup get example-backup
Downloads the example-backup archive from the server. If the backup operation is in progress, the command waits for it to complete.

backup restore /some/path/on/the/server
Restores all content from a backup archive on the server.

backup restore -u /some/local/path
Restores all content from a local backup archive that is uploaded to the server.

backup restore /some/path/on/the/server --caches=*
Restores only cache content from a backup archive on the server.

backup restore /some/path/on/the/server --proto-schemas=schema1,schema2
Restores only the named schema resources from a backup archive on the server.

backup delete example-backup
Deletes the example-backup archive from the server.

drop(1)

benchmark - runs a performance benchmark against a cache.

You can run performance benchmarks for the following HTTP and Hot Rod protocols: http, https, hotrod, and hotrods. You specify the protocol for the benchmark with a URI. If you do not specify a protocol, the benchmark uses the URI of the current CLI connection.

Benchmarks for Hot Rod URIs connect to the entire cluster. For HTTP URIs, benchmarks connect to a single node only.

Benchmarks test performance against an existing cache. Before you run a benchmark, you should create a cache with the capabilities you want to measure. For example, if you want to evaluate the performance of cross-site replication, you should create a cache that has backup locations. If you want to test the performance of persistence, create a cache that uses an appropriate cache store.

benchmark ['OPTIONS'] [uri]

benchmark hotrod://localhost:11222
Performs a benchmark test with the Hot Rod protocol.

benchmark --value-size=10000 --cache=largecache hotrod://localhost:11222
Performs a benchmark test with the Hot Rod protocol against the largecache cache using test values that are 10000 bytes in size.

benchmark --mode=All --threads=20 https://user:password@server:11222
Performs a benchmark test with the HTTPS protocol using 20 threads and includes all modes in the report.

cache - selects the default cache for subsequent commands.

cache ['CACHE_NAME']

cache mycache
Selects mycache and is the same as navigating the resource tree using cd caches/mycache.

cd(1), clear(1), container(1), get(1), put(1), remove(1)

cas - performs 'compare-and-swap' operations on strong counters.

cas ['OPTIONS'] ['COUNTER_NAME']

cas --expect=10 --value=20 cnt_a
Sets the value of cnt_a to 20 only if the current value is 10

add(1), cas(1), reset(1)

cd - navigates the server resource tree.

PATH can be absolute or relative to the current resource. ../ specifies parent resources.

cd ['PATH']

cd caches
Changes to the caches path in the resource tree.

cache(1), ls(1), container(1)

clearcache - removes all entries from a cache.

clearcache ['CACHE_NAME']

clearcache mycache
Removes all entries from mycache.

cache(1), drop(1), remove(1)

config - manages CLI configuration properties.

config

config set 'name' 'value'

config get 'name'

Manage (list, set, get) CLI configuration properties.

These options apply to all commands:

config set autoconnect-url http://192.0.2.0:11222
Connects to a server at a custom IP address when you start the CLI.

config get autoconnect-url
Returns the value for the autoconnect-url configuration property.

config set autoexec /path/to/mybatchfile
Runs a batch file named "mybatchfile" when you start the CLI.

config set trustall true
Trusts all server certificates.

config set truststore /home/user/my-trust-store.jks
Specifies the path of a keystore named "my-trust-store.jks".

config set truststore-password secret
Sets the keystore password, if required.

alias(1), unalias(1)

connect - connects to running Data Grid servers.

Defaults to http://localhost:11222 and prompts for credentials if authentication is required.

connect ['OPTIONS'] ['SERVER_LOCATION']

connect 127.0.0.1:11322 -u test -p changeme
Connects to a locally running server using a port offset of 100 and example credentials.

disconnect(1)

container - selects the container for running subsequent commands.

container ['CONTAINER_NAME']

container default
Selects the default container and is the same as navigating the resource tree using cd containers/default.

cd(1), clear(1), container(1), get(1), put(1), remove(1)

counter - selects the default counter for subsequent commands.

counter ['COUNTER_NAME']

counter cnt_a
Selects cnt_a and is the same as navigating the resource tree using cd counters/cnt_a.

add(1), cas(1)

create - creates caches and counters on Data Grid servers.

create cache ['OPTIONS'] CACHE_NAME

create counter ['OPTIONS'] COUNTER_NAME

create cache --template=org.infinispan.DIST_SYNC mycache
Creates a cache named mycache from the DIST_SYNC template.

create counter --initial-value=3 --storage=PERSISTENT --type=strong cnt_a
Creates a strong counter named cnt_a.

drop(1)

credentials - manages keystores that contain Data Grid Server credentials

credentials ls

credentials add 'alias'

credentials remove 'alias'

List, create, and remove credentials inside a keystore. By default, commands manage the credentials.pfx keystore in the server configuration directory.

Add a credential

Remove a credential

credentials add dbpassword -c changeme -p "secret1234!"
Creates a new default credential keystore, if does not already exist, and adds an alias of "dbpassword" for a password of "changeme". This command also sets "secret1234!" as the password for the credential keystore, which must match the password in the server configuration: <clear-text-credential clear-text="secret1234!"/>

credentials ls -p "secret1234!"
Lists all aliases in the default credential keystore.

credentials add ldappassword -t JCEKS -p "secret1234!"
Creates a credential keystore in JCEKS format and adds an alias "ldappassword". This command prompts you to specify the password that corresponds to the alias.

describe - displays information about resources.

describe ['PATH']

describe //containers/default
Displays information about the default container.

describe //containers/default/caches/mycache
Displays information about the mycache cache.

describe //containers/default/caches/mycache/k1
Displays information about the k1 key.

describe //containers/default/counters/cnt1
Displays information about the cnt1 counter.

cd(1), ls(1)

disconnect - ends CLI sessions with Data Grid servers.

disconnect

disconnect
Ends the current CLI session.

connect(1)

drop - deletes caches and counters.

drop cache CACHE_NAME

drop counter COUNTER_NAME

drop cache mycache
Deletes the mycache cache.

drop counter cnt_a
Deletes the cnt_a counter.

create(1), clearcache(1)

encoding - displays and sets the encoding for cache entries.

Sets a default encoding for put and get operations on a cache. If no argument is specified, the encoding command displays the current encoding.

Valid encodings use standard MIME type (IANA media types) naming conventions, such as the following:

encoding ['ENCODING']

encoding application/json
Configures the currently selected cache to encode entries as application/json.

get(1), put(1)

get - retrieves entries from a cache.

get ['OPTIONS'] KEY

get hello -c mycache
Retrieves the value of the key named hello from mycache.

query(1), put(1)

help - prints manual pages for commands.

help ['COMMAND']

help get
Prints the manual page for the get command.

version(1)

logging - inspects and manipulates the Data Grid server runtime logging configuration.

logging list-loggers

logging list-appenders

logging set ['OPTIONS'] [LOGGER_NAME]

logging remove LOGGER_NAME

logging list-loggers
Lists all available loggers

logging set --level=DEBUG --appenders=FILE org.infinispan
Sets the log level for the org.infinispan logger to DEBUG and configures it to use the FILE appender.

ls - lists resources for the current path or a given path.

ls ['PATH']

ls caches
Lists the available caches.

ls ../
Lists parent resources.

cd(1)

migrate - migrates data from one version of Data Grid to another.

migrate cluster synchronize

migrate cluster disconnect

Use the migrate command to migrate data from one version of Data Grid to another.

Migrate clusters

These options apply to all commands:

patch - manages server patches.

List, describe, install, rollback, and create server patches.

Patches are zip archive files that contain artifacts to upgrade servers and resolve issues or add new features. Patches can apply target versions to multiple server installations with different versions.

patch ls

patch install 'patch-file'

patch describe 'patch-file'

patch rollback

patch create 'patch-file' 'target-server' 'source-server-1' ['source-server-2'…​]

patch ls
Lists the patches currently installed on a server in order of installation.

patch install mypatch.zip
Installs "mypatch.zip" on a server in the current directory.

patch install mypatch.zip --server=/path/to/server/home
Installs "mypatch.zip" on a server in a different directory.

patch describe mypatch.zip
Displays the target version and list of source versions for "mypatch.zip".

patch create mypatch.zip 'target-server' 'source-server-1' ['source-server-2'…​]
Creates a patch file named "mypatch.zip" that uses the version of the target server and applies to the source server versions.

patch rollback
Rolls back the last patch that was applied to a server and restores the previous version.

put - adds or updates cache entries.

Creates entries for new keys. Replaces values for existing keys.

put ['OPTIONS'] KEY [VALUE]

put -c mycache hello world
Adds the hello key with a value of world to the mycache cache.

put -c mycache -f myfile -i 500 hola
Adds the hola key with the value from the contents of myfile. Also sets a maximum idle of 500 seconds.

get(1), remove(1)

query - retrieves entries that match Ickle query strings.

query ['OPTIONS'] QUERY_STRING

query "from org.infinispan.rest.search.entity.Person p where p.gender = 'MALE'"
Queries the currently selected cache to return entries from a Protobuf Person entity where the gender datatype is MALE.

schema(1)

quit - exits the command line interface.

quit

exit and bye are command aliases.

quit
Ends the CLI session.

exit
Ends the CLI session.

bye
Ends the CLI session.

disconnect(1), shutdown(1)

remove - deletes entries from a cache.

remove KEY ['OPTIONS']

remove --cache=mycache hola
Deletes the hola entry from the mycache cache.

cache(1), drop(1), clearcache(1)

reset - restores the initial values of counters.

reset ['COUNTER_NAME']

reset cnt_a
Resets the cnt_a counter.

add(1), cas(1), drop(1)

schema - uploads and registers protobuf schemas.

schema ['OPTIONS'] SCHEMA_NAME

schema --upload=person.proto person.proto
Registers a person.proto Protobuf schema.

query(1)

server - server configuration and state management.

The server command describes and manages server endpoint connectors and datasources and retrieves aggregated diagnostic reports about both the server and host.

Reports provide details about CPU, memory, open files, network sockets and routing, threads, in addition to configuration and log files.

server report

server connector ls

server connector describe 'connector-name'

server connector start 'connector-name'

server connector stop 'connector-name'

server connector ipfilter ls 'connector-name'

server connector ipfilter set 'connector-name' --rules='[ACCEPT|REJECT]/cidr',…​

server connector ipfilter clear 'connector-name'

server datasource ls

server datasource test 'datasource-name'

server report
Obtains a server report, including information about network, threads, memory, etc.

server connector ls
Lists all available connectors on the server.

server connector describe endpoint-default
Shows information about the specified connector, including host, port, local and global connections, IP filtering rules.

server connector stop my-hotrod-connector
Stops a connector dropping all established connections across the cluster. This command will be refused if attempting to stop the connector which is handling the request.

server connector start my-hotrod-connector
Starts a connector so that it can accept connections across the cluster.

server connector ipfilter ls my-hotrod-connector
Lists all IP filtering rules active on a connector across the cluster.

server connector ipfilter set my-hotrod-connector --rules=ACCEPT/192.168.0.0/16,REJECT/10.0.0.0/8 Sets IP filtering rules on a connector across the cluster. Replaces all existing rules. This command will be refused if one of the rejection rules matches the address of the connection on which it is invoked.

server connector ipfilter clear my-hotrod-connector
Removes all IP filtering rules on a connector across the cluster.

server datasource ls
Lists all available datasources on the server.

server datasource test my-datasource
Performs a test connection on the datasource.

shutdown - stops running servers or brings clusters down gracefully.

shutdown server ['SERVERS']

shutdown cluster

shutdown server
Stops the server to which the CLI is connected.

shutdown server my_server01
Stops the server with hostname my_server01.

shutdown cluster
Stores cluster state, persists entries if you use a cache store, and stops all nodes.

connect(1), disconnect(1), quit(1)

site - manages backup locations and performs cross-site replication operations.

site status ['OPTIONS']

site bring-online ['OPTIONS']

site take-offline ['OPTIONS']

site push-site-state ['OPTIONS']

site cancel-push-state ['OPTIONS']

site cancel-receive-state ['OPTIONS']

site push-site-status ['OPTIONS']

site state-transfer-mode get|set ['OPTIONS']

site name

site view

site status --cache=mycache
Returns the status of all backup locations for mycache.

site status --cache=mycache --site=NYC
Returns the status of NYC for mycache.

site bring-online --cache=mycache --site=NYC
Brings the site NYC online for mycache.

site take-offline --cache=mycache --site=NYC
Takes the site NYC offline for mycache.

site push-site-state --cache=mycache --site=NYC
Backs up caches to remote backup locations.

site push-site-status --cache=mycache
Displays the status of the operation to backup mycache.

site cancel-push-state --cache=mycache --site=NYC
Cancels the operation to backup mycache to NYC.

site cancel-receive-state --cache=mycache --site=NYC
Cancels the operation to receive state from NYC.

site clear-push-state-status --cache=myCache
Clears the status of the push state operation for mycache.

site state-transfer-mode get --cache=myCache --site=NYC
Retrieves the state transfer mode for mycache to NYC.

site state-transfer-mode set --cache=myCache --site=NYC --mode=AUTO
Configures automatic state transfer for mycache to NYC.

site name
Returns the name of the local site. If cross-site replication is not configured, the name of the local site is always "local".

site view
Returns a list of names for all sites or an empty list ("[]") if cross-site replication is not configured.

stats - displays statistics about resources.

stats ['PATH']

stats //containers/default
Displays statistics about the default container.

stats //containers/default/caches/mycache
Displays statistics about the mycache cache.

cd(1), ls(1), describe(1)

task - executes and uploads server-side tasks and scripts

task upload --file='script' 'TASK_NAME'

task exec ['TASK_NAME']

task upload --file=hello.js hello
Uploads a script from a hello.js file and names it hello.

task exec @@cache@names
Runs a task that returns available cache names.

task exec hello -Pgreetee=world
Runs a script named hello and specifies the greetee parameter with a value of world.

ls(1)

unalias - deletes aliases.

unalias 'ALIAS-NAME'

unalias q
Deletes the q alias.

config(1), alias(1)

user - manages Data Grid users in property security realms.

user ls

user create 'username'

user describe 'username'

user remove 'username'

user password 'username'

user groups 'username'

user encrypt-all

user roles ls 'principal'

user roles grant --roles='role1'[,'role2'…​] 'principal'

user roles deny --roles='role1'[,'role2'…​] 'principal'

Manage users in property realms with the ls, create, describe, remove, password, groups and encrypt-all subcommands. List and modify principal to role mappings with the roles subcommand when using the cluster role mapper for authorization.

These options apply to all commands:

version - displays the server version and CLI version.

version

version
Returns the version for the server and the CLI.

help(1)