Chapter 9. Command Reference

Review manual pages for Data Grid CLI commands.

Tip

Use help command to access manual pages directly from your CLI session.

For example, to view the manual page for the get command do the following: 

$ help get

9.1. ADD(1)

9.1.1. NAME

add - increments and decrements counters with arbitrary values.

9.1.2. SYNOPSIS

add ['OPTIONS'] ['COUNTER_NAME']

9.1.3. OPTIONS

--delta='nnn'
Sets a delta to increment or decrement the counter value. Defaults to 1.
-q, --quiet='[true|false]'
Hides return values for strong counters. The default is false.

9.1.4. EXAMPLES

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.

9.1.5. SEE ALSO

cas(1), reset(1)

9.2. CACHE(1)

9.2.1. NAME

cache - selects the default cache for subsequent commands.

9.2.2. SYNOPSIS

cache ['CACHE_NAME']

9.2.3. EXAMPLE

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

9.2.4. SEE ALSO

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

9.3. CAS(1)

9.3.1. NAME

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

9.3.2. SYNOPSIS

cas ['OPTIONS'] ['COUNTER_NAME']

9.3.3. OPTIONS

--expect='nnn'
Specifies the expected value of the counter.
--value='nnn'
Sets a new value for the counter.
-q, --quiet='[true|false]'
Hides return values. The default is false.

9.3.4. EXAMPLE

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

9.3.5. SEE ALSO

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

9.4. CD(1)

9.4.1. NAME

cd - navigates the server resource tree.

9.4.2. DESCRIPTION

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

9.4.3. SYNOPSIS

cd ['PATH']

9.4.4. EXAMPLE

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

9.4.5. SEE ALSO

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

9.5. CLEARCACHE(1)

9.5.1. NAME

clearcache - removes all entries from a cache.

9.5.2. SYNOPSIS

clearcache ['CACHE_NAME']

9.5.3. EXAMPLES

clearcache mycache
Removes all entries from mycache.

9.5.4. SEE ALSO

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

9.6. CONNECT(1)

9.6.1. NAME

connect - connects to running ${infinispan.brand.name} servers.

9.6.2. DESCRIPTION

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

9.6.3. SYNOPSIS

connect ['OPTIONS'] ['SERVER_LOCATION']

9.6.4. OPTIONS

-u, --username='USERNAME'
Specifies a username to authenticate with ${infinispan.brand.name} servers.
-p, --password='PASSWORD'
Specifies passwords.

9.6.5. EXAMPLE

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.

9.6.6. SEE ALSO

disconnect(1)

9.7. CONTAINER(1)

9.7.1. NAME

container - selects the container for running subsequent commands.

9.7.2. SYNOPSIS

container ['CONTAINER_NAME']

9.7.3. EXAMPLE

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

9.7.4. SEE ALSO

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

9.8. COUNTER(1)

9.8.1. NAME

counter - selects the default counter for subsequent commands.

9.8.2. SYNOPSIS

counter ['COUNTER_NAME']

9.8.3. EXAMPLE

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

9.8.4. SEE ALSO

add(1), cas(1)

9.9. CREATE(1)

9.9.1. NAME

create - creates caches and counters on ${infinispan.brand.name} servers.

9.9.2. SYNOPSIS

create cache ['OPTIONS'] CACHE_NAME

create counter ['OPTIONS'] COUNTER_NAME

9.9.3. CREATE CACHE OPTIONS

-f, --file='FILE'
Specifies a configuration file in JSON or XML format.
-t, --template='TEMPLATE'
Specifies a configuration template. Use tab autocompletion to see available templates.
-v, --volatile='[true|false]'
Specifies whether the cache is persistent or volatile. The default is false.

9.9.4. CREATE COUNTER OPTIONS

-t, --type='[weak|strong]'
Specifies if the counter is weak or strong.
-s, --storage='[PERSISTENT|VOLATILE]'
Specifies whether the counter is persistent or volatile.
-c, --concurrency-level='nnn'
Sets the concurrency level of the counter.
-i, --initial-value='nnn'
Sets the initial value of the counter.
-l, --lower-bound='nnn'
Sets the lower bound of a strong counter.
-u, --upper-bound='nnn'
Sets the upper bound of a strong counter.

9.9.5. EXAMPLES

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.

9.9.6. SEE ALSO

drop(1)

9.10. DESCRIBE(1)

9.10.1. NAME

describe - displays information about resources.

9.10.2. SYNOPSIS

describe ['PATH']

9.10.3. EXAMPLES

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.

9.10.4. SEE ALSO

cd(1), ls(1)

9.11. DISCONNECT(1)

9.11.1. NAME

disconnect - ends CLI sessions with ${infinispan.brand.name} servers.

9.11.2. SYNOPSIS

disconnect

9.11.3. EXAMPLE

disconnect
Ends the current CLI session.

9.11.4. SEE ALSO

connect(1)

9.12. DROP(1)

9.12.1. NAME

drop - deletes caches and counters.

9.12.2. SYNOPSIS

drop cache CACHE_NAME

drop counter COUNTER_NAME

9.12.3. EXAMPLES

drop cache mycache
Deletes the mycache cache.

drop counter cnt_a
Deletes the cnt_a counter.

9.12.4. SEE ALSO

create(1), clearcache(1)

9.13. ENCODING(1)

9.13.1. NAME

encoding - displays and sets the encoding for cache entries.

9.13.2. DESCRIPTION

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:

  • text/plain
  • application/json
  • application/xml
  • application/octet-stream

9.13.3. SYNOPSIS

encoding ['ENCODING']

9.13.4. EXAMPLE

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

9.13.5. SEE ALSO

get(1), put(1)

9.14. GET(1)

9.14.1. NAME

get - retrieves entries from a cache.

9.14.2. SYNOPSIS

get ['OPTIONS'] KEY

9.14.3. OPTIONS

-c, --cache='NAME'
Specifies the cache from which to retrieve entries. Defaults to the currently selected cache.

9.14.4. EXAMPLE

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

9.14.5. SEE ALSO

query(1), put(1)

9.15. HELP(1)

9.15.1. NAME

help - prints manual pages for commands.

9.15.2. SYNOPSIS

help ['COMMAND']

9.15.3. EXAMPLE

help get
Prints the manual page for the get command.

9.15.4. SEE ALSO

version(1)

9.16. LS(1)

9.16.1. NAME

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

9.16.2. SYNOPSIS

ls ['PATH']

9.16.3. EXAMPLES

ls caches
Lists the available caches.

ls ../
Lists parent resources.

9.16.4. SEE ALSO

cd(1)

9.17. PATCH(1)

9.17.1. NAME

patch - manages server patches.

9.17.2. DESCRIPTION

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.

9.17.3. SYNOPSIS

patch ls

patch install 'patch-file'

patch describe 'patch-file'

patch rollback

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

9.17.4. PATCH LIST OPTIONS

--server='path/to/server'
Sets the path to a target server outside the current server home directory.
-v, --verbose
Shows the content of each installed patch, including information about individual files.

9.17.5. PATCH INSTALL OPTIONS

--dry-run
Shows the operations that the patch peforms without applying any changes.
--server='path/to/server'
Sets the path to a target server outside the current server home directory.

9.17.6. PATCH DESCRIBE OPTIONS

-v, --verbose
Shows the content of the patch, including information about individual files

9.17.7. PATCH ROLLBACK OPTIONS

--dry-run
Shows the operations that the patch peforms without applying any changes.
--server='path/to/server'
Sets the path to a target server outside the current server home directory.

9.17.8. PATCH CREATE OPTIONS

-q, --qualifier='name'
Specifies a descriptive qualifier string for the patch; for example, 'one-off for issue nnnn'.

9.17.9. EXAMPLES

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.

9.18. PUT(1)

9.18.1. NAME

put - adds or updates cache entries.

9.18.2. DESCRIPTION

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

9.18.3. SYNOPSIS

put ['OPTIONS'] KEY [VALUE]

9.18.4. OPTIONS

-c, --cache='NAME'
Specifies the name of the cache. Defaults to the currently selected cache.
-e, --encoding='ENCODING'
Sets the media type for the value.
-f, --file='FILE'
Specifies a file that contains the value for the entry.
-l, --ttl='TTL'
Sets the number of seconds before the entry is automatically deleted (time-to-live). Defaults to the value for lifespan in the cache configuration if 0 or not specified. If you set a negative value, the entry is never deleted.
-i, --max-idle='MAXIDLE'
Sets the number of seconds that the entry can be idle. If a read or write operation does not occur for an entry after the maximum idle time elapses, the entry is automatically deleted. Defaults to the value for maxIdle in the cache configuration if 0 or not specified. If you set a negative value, the entry is never deleted.
-a, --if-absent=[true|false]
Puts an entry only if it does not exist.

9.18.5. EXAMPLES

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.

9.18.6. SEE ALSO

get(1), remove(1)

9.19. QUERY(1)

9.19.1. NAME

query - retrieves entries that match Ickle query strings.

9.19.2. SYNOPSIS

query ['OPTIONS'] QUERY_STRING

9.19.3. OPTIONS

-c, --cache='NAME'
Specifies the cache to query. Defaults to the currently selected cache.
--max-results='MAX_RESULTS'
Sets the number of results to return. The default is 10.
-o, --offset='OFFSET'
Specifies the index of the first result to return. The default is 0.
--query-mode='QUERY_MODE'
Specifies how the server executes the query. Values are FETCH and BROADCAST. The default is FETCH.

9.19.4. EXAMPLES

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.

9.19.5. SEE ALSO

schema(1)

9.20. QUIT(1)

9.20.1. NAME

quit - exits the command line interface.

9.20.2. SYNOPSIS

quit

9.20.3. EXAMPLE

quit
Exits the CLI.

9.20.4. SEE ALSO

disconnect(1), shutdown(1)

9.21. REMOVE(1)

9.21.1. NAME

remove - deletes entries from a cache.

9.21.2. SYNOPSIS

remove KEY ['OPTIONS']

9.21.3. OPTIONS

--cache='NAME'
Specifies the cache from which to remove entries. Defaults to the currently selected cache.

9.21.4. EXAMPLE

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

9.21.5. SEE ALSO

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

9.22. RESET(1)

9.22.1. NAME

reset - restores the initial values of counters.

9.22.2. SYNOPSIS

reset ['COUNTER_NAME']

9.22.3. EXAMPLE

reset cnt_a
Resets the cnt_a counter.

9.22.4. SEE ALSO

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

9.23. SCHEMA(1)

9.23.1. NAME

schema - uploads and registers protobuf schemas.

9.23.2. SYNOPSIS

schema ['OPTIONS'] SCHEMA_NAME

9.23.3. OPTIONS

-u, --upload='FILE'
Uploads a file as a protobuf schema with the given name.

9.23.4. EXAMPLE

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

9.23.5. SEE ALSO

query(1)

9.24. SHUTDOWN(1)

9.24.1. NAME

shutdown - stops individual servers or performs orderly shutdowns for entire clusters.

9.24.2. SYNOPSIS

shutdown server ['SERVERS']

shutdown cluster

9.24.3. EXAMPLES

shutdown server my_server01
Stops the server with hostname my_server01.

shutdown cluster
Performs an orderly shutdown of all servers joined to the cluster.

9.24.4. SEE ALSO

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

9.25. SITE(1)

9.25.1. NAME

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

9.25.2. SYNOPSIS

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']

9.25.3. OPTIONS

--cache='CACHE_NAME'
Specifies a cache.
--site='SITE_NAME'
Specifies a backup location.

9.25.4. EXAMPLES

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.

9.26. TASK(1)

9.26.1. NAME

task - executes and uploads server-side tasks and scripts

9.26.2. SYNOPSIS

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

task exec ['TASK_NAME']

9.26.3. EXAMPLES

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.

9.26.4. OPTIONS

-P, --parameters='PARAMETERS'
Passes parameter values to tasks and scripts.
-f, --file='FILE'
Uploads script files with the given names.

9.26.5. SEE ALSO

ls(1)

9.27. VERSION(1)

9.27.1. NAME

version - displays the server version and CLI version.

9.27.2. SYNOPSIS

version

9.27.3. EXAMPLE

version
Returns the version for the server and the CLI.

9.27.4. SEE ALSO

help(1)