Chapter 8. Command Reference
Chapter 8. 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: 8.1. ADD(1) 8.1.1. NAME add - increments and decrements counters with arbitrary values. 8.1.2. SYNOPSIS add ['OPTIONS'] ['COUNTER_NAME'] 8.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 . 8.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 . 8.1.5. SEE ALSO cas(1), reset(1) 8.2. ALIAS(1) 8.2.1. NAME alias - creates or displays aliases. 8.2.2. SYNOPSIS alias ['ALIAS-NAME'='COMMAND'] 8.2.3. EXAMPLES alias q=quit Creates q as an alias for the quit command. alias Lists all defined aliases. 8.2.4. SEE ALSO config(1), unalias(1) 8.3. ALTER(1) 8.3.1. NAME alter - modifies the configuration of caches on Data Grid Server. 8.3.2. SYNOPSIS alter cache ['OPTIONS'] CACHE_NAME You can modify a cache with the alter command only if the changes are compatible with the existing configuration. For example you cannot use a replicated cache configuration to modify a distributed cache. Likewise if you create a cache configuration with a specific attribute, you cannot modify the configuration to use a different attribute instead. For example, attempting to modify cache configuration by specifying a value for the max-count attribute results in invalid configuration if the max-size is already set. 8.3.3. ALTER CACHE OPTIONS -f, --file ='FILE' Specifies a configuration file in XML, JSON or YAML format that modifies an existing configuration. Mutually exclusive with the --attribute option. --attribute ='ATTRIBUTE' Specifies an attribute to modify in an existing configuration. Press the tab key to display a list of attributes. Must be used in combination with the --value option. Mutually exclusive with the --file option. --value ='VALUE' Specifies one or more new values for a configuration attribute. Separate multiple values with a comma. Must be used in combination with the --attribute option. 8.3.4. EXAMPLES alter cache mycache --file=/path/to/mycache.json Modifies the configuration of a cache named mycache with the mycache.json file. alter cache mycache --attribute=clustering.remote-timeout --value=5000 Modifies the configuration of a cache named mycache so that the clustering.remote-timeout attribute has a value of '5000'. 8.3.5. SEE ALSO create(1), drop(1) 8.4. AVAILABILITY(1) 8.4.1. NAME availability - manage availability of clustered caches in network partitions. 8.4.2. SYNOPSIS availability ['OPTIONS'] ['CACHE_NAME'] 8.4.3. OPTIONS --mode ='[AVAILABLE|DEGRADED_MODE]' Sets cache availability to AVAILABLE or DEGRADED_MODE when using either the DENY_READ_WRITES or ALLOW_READS partition handling strategy. AVAILABLE makes caches available to all nodes in a network partition. DEGRADED_MODE prevents read and write operations on caches when network partitions occur. 8.4.4. EXAMPLES availability cache1 Gets the current availability of the cache 'cache1'. availability --mode=AVAILABLE cache1 Sets the availability of the cache 'cache1' to AVAILABLE. 8.5. BACKUP(1) 8.5.1. NAME backup - manage container backup creation and restoration. 8.5.2. SYNOPSIS backup create ['OPTIONS'] backup delete ['OPTIONS'] BACKUP_NAME backup get ['OPTIONS'] BACKUP_NAME backup ls backup restore ['OPTIONS'] BACKUP_PATH 8.5.3. BACKUP CREATE OPTIONS -d, --dir ='PATH' Specifies a directory on the server to create and store the backup archive. -n, --name ='NAME' Defines a name for the backup archive. --caches ='cache1,cache2,... ' Lists caches to back up. Use '*' to back up all caches. --templates ='template1,template2,... ' Lists cache templates to back up. Use '*' to back up all templates. --counters ='counter1,counter2,... ' Lists of counters to back up. Use '*' to back up all counters. --proto-schemas ='schema1,schema2,... ' Lists Protobuf schemas to back up. Use '*' to back up all schemas. --tasks ='task1,task2,... ' Lists server tasks to back up. Use '*' to back up all tasks. 8.5.4. BACKUP GET OPTIONS --no-content Does not download content. The command returns only when the backup operation is complete. 8.5.5. BACKUP RESTORE OPTIONS -u, --upload Defines the path to a local backup archive that is uploaded to the server. -n, --name ='NAME' Defines a name for the restore request. --caches ='cache1,cache2,... ' Lists caches to restore. Use '*' to restore all caches from the backup archive. --templates ='template1,template2,... ' Lists cache templates to restore. Use '*' to restore all templates from the backup archive. --counters ='counter1,counter2,... ' Lists counters to restore. Use '*' to restore all counters from the backup archive. --proto-schemas ='schema1,schema2,... ' Lists Protobuf schemas to restore. Use '*' to restore all schemas from the backup archive. --tasks ='task1,task2,... ' Lists server tasks to restore. Use '*' to restore all tasks from the backup archive. 8.5.6. EXAMPLES 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. 8.5.7. SEE ALSO drop(1) 8.6. BENCHMARK(1) 8.6.1. NAME 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. 8.6.2. SYNOPSIS benchmark ['OPTIONS'] [ uri ] 8.6.3. BENCHMARK OPTIONS -t, --threads ='num' Specifies the number of threads to create. Defaults to 10 . --cache ='cache' Names the cache against which the benchmark is performed. Defaults to benchmark . You must create the cache before running the benchmark if it does not already exist. *--key-size ='num' Sets the size, in bytes, of the key. Defaults to 16 bytes. *--value-size ='num' Sets the size, in bytes, of the value. Defaults to 1000 bytes. *--keyset-size ='num' Defines the size, in bytes, of the test key set. Defaults to 1000 . --verbosity =['SILENT', 'NORMAL', 'EXTRA'] Specifies the verbosity level of the output. Possible values, from least to most verbose, are SILENT , NORMAL , and EXTRA . The default is NORMAL . -c, --count ='num' Specifies how many measurement iterations to perform. Defaults to 5 . --time ='time' Sets the amount of time, in seconds, that each iteration takes. Defaults to 10 . --warmup-count ='num' Specifies how many warmup iterations to perform. Defaults to 5 . --warmup-time ='time' Sets the amount of time, in seconds, that each warmup iteration takes. Defaults to 1 . --mode ='mode' Specifies the benchmark mode. Possible values are Throughput , AverageTime , SampleTime , SingleShotTime , and All . The default is Throughput . --time-unit ='unit' Specifies the time unit for results in the benchmark report. Possible values are NANOSECONDS , MICROSECONDS , MILLISECONDS , and SECONDS . The default is MICROSECONDS . 8.6.4. EXAMPLES 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. 8.7. CACHE(1) 8.7.1. NAME cache - selects the default cache for subsequent commands. 8.7.2. SYNOPSIS cache ['CACHE_NAME'] 8.7.3. EXAMPLE cache mycache Selects mycache and is the same as navigating the resource tree using cd caches/mycache . 8.7.4. SEE ALSO cd(1), clear(1), container(1), get(1), put(1), remove(1) 8.8. CAS(1) 8.8.1. NAME cas - performs 'compare-and-swap' operations on strong counters. 8.8.2. SYNOPSIS cas ['OPTIONS'] ['COUNTER_NAME'] 8.8.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. 8.8.4. EXAMPLE cas --expect=10 --value=20 cnt_a Sets the value of cnt_a to 20 only if the current value is 10 8.8.5. SEE ALSO add(1), cas(1), reset(1) 8.9. CD(1) 8.9.1. NAME cd - navigates the server resource tree. 8.9.2. DESCRIPTION PATH can be absolute or relative to the current resource. ../ specifies parent resources. 8.9.3. SYNOPSIS cd ['PATH'] 8.9.4. EXAMPLE cd caches Changes to the caches path in the resource tree. 8.9.5. SEE ALSO cache(1), ls(1), container(1) 8.10. CLEARCACHE(1) 8.10.1. NAME clearcache - removes all entries from a cache. 8.10.2. SYNOPSIS clearcache ['CACHE_NAME'] 8.10.3. EXAMPLES clearcache mycache Removes all entries from mycache . 8.10.4. SEE ALSO cache(1), drop(1), remove(1) 8.11. CONFIG(1) 8.11.1. NAME config - manages CLI configuration properties. 8.11.2. SYNOPSIS config config set 'name' 'value' config get 'name' config convert --outputFormat=[xml|json|yaml] [-o outputFile] [inputFile] 8.11.3. DESCRIPTION Manage (list, set, get) CLI configuration properties and provide configuration conversion between the different formats (XML, JSON, YAML) 8.11.4. COMMAND SYNOPSIS config Lists all configuration properties that are set. config set 'name' ['value'] Sets the value of a specific property. If you do not specify a value, the property is not set. config get 'name' Retrieves the value of a specific property. config reset Resets all properties to their default values. config convert --format=[xml|json|yaml] [-o outputFile] [inputFile] Converts a configuration file to a different format. 8.11.5. COMMON OPTIONS These options apply to all commands: -h, --help Displays a help page for the command or sub-command. 8.11.6. CONVERT OPTIONS The following options apply to the convert command: -f, --format ='xml|json|yaml' Specifies the format for the conversion. -o, --output ='path' Specifies the path to the output file. Uses standard output ( stdout ) if you do not specify a path. 8.11.7. PROPERTIES autoconnect-url Specifies the URL to which the CLI automatically connects on startup. autoexec Specifies the path of a CLI batch file to execute on startup. trustall Specifies whether to trust all server certificates. Values are false (default) and true . truststore Defines the path to a keystore that contains a certificate chain that verifies server identity. truststore-password Specifies a password to access the truststore. keystore Defines a path to the keystore, which contains a certificate. The certificate identifies the client. Use the keystore property when the server requires client certificate authentication. keystore-password Specifies a password to access the keystore. 8.11.8. EXAMPLES 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. config convert -f yaml -o infinispan.yaml infinispan.xml Converts the infinispan.xml file to YAML and writes the output to the infinispan.yaml file. config convert -f json Converts the configuration from standard input to JSON, and writes the output to standard output. 8.11.9. SEE ALSO alias(1), unalias(1) 8.12. CONNECT(1) 8.12.1. NAME connect - connects to running Data Grid servers. 8.12.2. DESCRIPTION Defaults to http://localhost:11222 and prompts for credentials if authentication is required. 8.12.3. SYNOPSIS connect ['OPTIONS'] ['SERVER_LOCATION'] 8.12.4. OPTIONS -u, --username ='USERNAME' Specifies a username to authenticate with Data Grid servers. -p, --password ='PASSWORD' Specifies passwords. -t, --truststore ='PATH' Specifies a truststore. -s, --truststore-password ='PASSWORD' Specifies a password for the truststore. -k, --keystore ='PATH' Specifies a keystore that contains a client certificate. -w, --keystore-password ='PASSWORD' Specifies a password for the keystore. --hostname-verifier ='REGEX' A regular expression that matches hostnames during a connection to an SSL/TLS-enabled server. --trustall Trusts all certificates. --context-path ='PATH' The context path for the server REST connector. If unspecified, defaults to /rest . 8.12.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. 8.12.6. SEE ALSO disconnect(1) 8.13. CONTAINER(1) 8.13.1. NAME container - selects the container for running subsequent commands. 8.13.2. SYNOPSIS container ['CONTAINER_NAME'] 8.13.3. EXAMPLE container default Selects the default container and is the same as navigating the resource tree using cd containers/default . 8.13.4. SEE ALSO cd(1), clear(1), container(1), get(1), put(1), remove(1) 8.14. COUNTER(1) 8.14.1. NAME counter - selects the default counter for subsequent commands. 8.14.2. SYNOPSIS counter ['COUNTER_NAME'] 8.14.3. EXAMPLE counter cnt_a Selects cnt_a and is the same as navigating the resource tree using cd counters/cnt_a . 8.14.4. SEE ALSO add(1), cas(1) 8.15. CREATE(1) 8.15.1. NAME create - creates caches and counters on Data Grid servers. 8.15.2. SYNOPSIS create cache ['OPTIONS'] CACHE_NAME create counter ['OPTIONS'] COUNTER_NAME 8.15.3. CREATE CACHE OPTIONS -f, --file ='FILE' Specifies a configuration file in XML, JSON or YAML 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. 8.15.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. 8.15.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 . 8.15.6. SEE ALSO drop(1) 8.16. CREDENTIALS(1) 8.16.1. NAME credentials - manages keystores that contain Data Grid Server credentials 8.16.2. SYNOPSIS credentials ls credentials add 'alias' credentials remove 'alias' credentials mask -i iterations -s salt secret 8.16.3. DESCRIPTION List, create, and remove credentials inside a keystore and mask keystore passwords. By default, commands manage the credentials.pfx keystore in the server configuration directory. 8.16.4. SYNOPSIS credentials ls Lists credential aliases stored in the keystore. Add a credential credentials add 'alias' Adds an alias and corresponding credential to the keystore. Remove a credential credentials remove 'alias' Deletes an alias and corresponding credential from the keystore. credentials mask -i iterations -s salt 'secret' Obscure the keystore password with a mask for additional security. 8.16.5. OPTIONS -h, --help Prints command help. -s, --server-root ='path-to-server-root' Specifies the path to the server root directory. Defaults to server . --path ='credentials.pfx' Specifies the path to the credential keystore. Defaults to the server configuration directory, server/conf . -p, --password ='password' Specifies a password for the credential keystore. -t, --type ='PKCS12' Specifies the type of keystore that contains credentials. Supported types are PKCS12 or JCEKS . Defaults to PKCS12 . 8.16.6. CREDENTIALS ADD OPTIONS -c, --credential ='credential' Specifies the credential to store. 8.16.7. CREDENTIALS MASK OPTIONS -i, --iteration ='n' Sets the number of iterations. -s, --salt ='salt' Sets the salt and must be of length 8. 8.16.8. EXAMPLES 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. credentials mask "secret1234!" -i 100 -s pepper99 Creates a masked representation of the credential "secret1234!" using 100 iterations using the string pepper99 as salt. 8.17. DESCRIBE(1) 8.17.1. NAME describe - displays information about resources. 8.17.2. SYNOPSIS describe ['PATH'] 8.17.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. 8.17.4. SEE ALSO cd(1), ls(1) 8.18. DISCONNECT(1) 8.18.1. NAME disconnect - ends CLI sessions with Data Grid servers. 8.18.2. SYNOPSIS disconnect 8.18.3. EXAMPLE disconnect Ends the current CLI session. 8.18.4. SEE ALSO connect(1) 8.19. DROP(1) 8.19.1. NAME drop - deletes caches and counters. 8.19.2. SYNOPSIS drop cache CACHE_NAME drop counter COUNTER_NAME 8.19.3. EXAMPLES drop cache mycache Deletes the mycache cache. drop counter cnt_a Deletes the cnt_a counter. 8.19.4. SEE ALSO create(1), clearcache(1) 8.20. ENCODING(1) 8.20.1. NAME encoding - displays and sets the encoding for cache entries. 8.20.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 8.20.3. SYNOPSIS encoding ['ENCODING'] 8.20.4. EXAMPLE encoding application/json Configures the currently selected cache to encode entries as application/json . 8.20.5. SEE ALSO get(1), put(1) 8.21. GET(1) 8.21.1. NAME get - retrieves entries from a cache. 8.21.2. SYNOPSIS get ['OPTIONS'] KEY 8.21.3. OPTIONS -c, --cache ='NAME' Specifies the cache from which to retrieve entries. Defaults to the currently selected cache. -x, --extended Retrieves extended information about the entry (such as cluster ownership) 8.21.4. EXAMPLE get hello -c mycache Retrieves the value of the key named hello from mycache . 8.21.5. SEE ALSO query(1), put(1) 8.22. HELP(1) 8.22.1. NAME help - prints manual pages for commands. 8.22.2. SYNOPSIS help ['COMMAND'] 8.22.3. EXAMPLE help get Prints the manual page for the get command. 8.22.4. SEE ALSO version(1) 8.23. INDEX(1) 8.23.1. NAME index - manages cache indexes. 8.23.2. SYNOPSIS index reindex 'cache-name' index clear 'cache-name' index update-schema 'cache-name' index stats 'cache-name' index clear-stats 'cache-name' 8.23.3. EXAMPLES index reindex mycache Reindexes a cache. index clear mycache Clears a cache index. index update-schema mycache Updates the index schema for a cache. index stats mycache Shows indexing and search statistics for a cache. index clear-stats mycache Clears indexing and search statistics for a cache. 8.23.4. SEE ALSO query(1) 8.24. INSTALL(1) 8.24.1. NAME install - download and install artifacts for Data Grid Server. 8.24.2. DESCRIPTION Download and install artifacts to the server/lib directory. You can specify the download location for artifacts as Maven artifact coordinates, a URL, or a local file path. When downloading Maven artifacts, an optional Maven settings.xml file determines the location of the remote and local repositories as well as credentials and proxy configuration. If you download artifacts as zip , tar.gz , or tgz archives, the content is extracted. 8.24.3. SYNOPSIS install 'artifact-1[[|algorithm]|checksum]' ['artifact-2[[|algorithm]|checksum]'... ] 8.24.4. ARTIFACT NAMES Artifact names can be any of the following: Maven coordinates using the groupId:artifactId:version format, for example org.postgresql:postgresql:42.3.1 . HTTP, HTTPS, or FTP URLs Local paths 8.24.5. CHECKSUM VALIDATION You can validate the checksum of an artifact after download. The algorithm defaults to SHA-256 but it can also be MD-5 , SHA-1 , SHA-256 , SHA-384 , or `SHA-512'. 8.24.6. PATCH LIST OPTIONS --server-home ='path/to/server' Sets the path of the server installation. --server-root ='server' Sets the server root directory relative to the server home. *--maven-settings='USDHOME/.m2/maven-settings.xml' Sets the path of a Maven settings.xml file and uses the default location, if not specified. -o, --overwrite Forces overwriting of artifacts in the server/lib directory. By default artifacts are not overwritten, which causes the installation to fail if an artifact already exists. -v, --verbose Shows verbose information about artifact downloads. -f, --force Forces download of remote artifacts, even if they are already present locally. -r, --retries=num The number of retries in case the downloaded artifacts do not match the supplied checksums. --clean Deletes all the contents of the server/lib directory before downloading artifacts. 8.24.7. EXAMPLES install -o org.postgresql:postgresql:42.3.1 Installs the PostgreSQL JDBC driver JAR and overwrites if it already exists. install https://example.org/artifact.zip Downloads the artifact.zip and extracts the contents. install https://example.org/artifact.zip|52d73f9b3611610ebbb4dca7c2ac1171218eb09891c1faba10f5f54c1d2acc13 Downloads the artifact.zip , verifies its SHA-256 checksum, and extracts the contents. install https://example.org/artifact.zip|MD5|2b48d1871ee26f969d8481db94e103c2 Downloads the artifact.zip , verifies its MD-5 checksum, and extracts the contents. 8.25. LOGGING(1) 8.25.1. NAME logging - inspects and manipulates the Data Grid server runtime logging configuration. 8.25.2. SYNOPSIS logging list-loggers logging list-appenders logging set ['OPTIONS'] [ LOGGER_NAME ] logging remove LOGGER_NAME 8.25.3. LOGGING SET OPTIONS -l, --level ='OFF|TRACE|DEBUG|INFO|WARN|ERROR|ALL' Specifies the logging level for the specific logger. -a, --appender ='APPENDER' Specifies an appenders to set on the specific logger. The option can be repeated for multiple appenders. Note calling logging set without a logger name will modify the root logger. 8.25.4. EXAMPLES 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. 8.26. LS(1) 8.26.1. NAME ls - lists resources for the current path or a given path. 8.26.2. SYNOPSIS ls ['PATH'] 8.26.3. OPTIONS -f, --format ='[NAMES|VALUES|FULL]' This option currently only applies when listing caches. NAMES : only show the keys VALUES : show the keys and values FULL : show keys, values and metadata -l This option only applies when listing caches. Shortcut for -f FULL . -p, --pretty-print ='[TABLE|CSV|JSON]' Prints the output using one of the following layouts: TABLE : tabular format. The column sizes are determined by the terminal width. This is the default. CSV : comma-separated values. JSON : JSON format. -m, --max-items ='num' This option only applies when listing caches. The maximum number of items to show. Defaults to -1 (unlimited). 8.26.4. EXAMPLES ls caches Lists the available caches. ls ../ Lists parent resources. ls -l --pretty-print=CSV /containers/default/caches/mycache > mycache.csv Lists the content of a cache, including keys, values and metadata and redirects the contents to a file. 8.26.5. SEE ALSO cd(1) 8.27. MIGRATE(1) 8.27.1. NAME migrate - migrates data from one version of Data Grid to another. 8.27.2. SYNOPSIS migrate cluster connect migrate cluster synchronize migrate cluster disconnect migrate cluster source-connection migrate store 8.27.3. DESCRIPTION Use the migrate command to migrate data from one version of Data Grid to another. 8.27.4. COMMAND SYNOPSIS Migrate clusters migrate cluster connect Connects the target cluster to the source cluster. migrate cluster synchronize Synchronize data between the source cluster and the target cluster. migrate cluster disconnect Disconnects the target cluster from the source cluster. migrate cluster source-connection Gets connection configuration of the target cluster. The command will print "Not Found" if the connections hasn't been established. Migrate stores migrate store Migrates store data. 8.27.5. COMMON OPTIONS These options apply to all commands: -h, --help Displays a help page for the command or sub-command. CLUSTER CONNECT OPTIONS -c, --cache ='name' The name of the cache to disconnect from the source. 8.27.6. CLUSTER CONNECTION OPTIONS -c, --cache ='name' The name of the cache to obtain the connection configuration. 8.27.7. STORE OPTIONS *-P -p, --properties ='FILE' The path to a properties file containing the migration configuration. -v, --verbose Displays verbose information about the migration process. 8.28. PATCH(1) 8.28.1. NAME patch - manages server patches. 8.28.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. 8.28.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'... ] 8.28.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. 8.28.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. 8.28.6. PATCH DESCRIBE OPTIONS -v, --verbose Shows the content of the patch, including information about individual files 8.28.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. 8.28.8. PATCH CREATE OPTIONS -q, --qualifier ='name' Specifies a descriptive qualifier string for the patch; for example, 'one-off for issue nnnn'. 8.28.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 version. 8.29. PUT(1) 8.29.1. NAME put - adds or updates cache entries. 8.29.2. DESCRIPTION Creates entries for new keys. Replaces values for existing keys. 8.29.3. SYNOPSIS put ['OPTIONS'] KEY [ VALUE ] 8.29.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. 8.29.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. 8.29.6. SEE ALSO get(1), remove(1) 8.30. QUERY(1) 8.30.1. NAME query - performs Ickle queries to match entries in remote caches. 8.30.2. SYNOPSIS query ['OPTIONS'] QUERY_STRING 8.30.3. OPTIONS -c, --cache ='NAME' Specifies the cache to query. Defaults to the currently selected cache. --max-results ='MAX_RESULTS' Sets the maximum 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 . 8.30.4. EXAMPLES query "from org.infinispan.example.Person p where p.gender = 'MALE'" Queries values in a remote cache to find entries from a Protobuf Person entity where the gender datatype is MALE . 8.30.5. SEE ALSO index(1) schema(1) 8.31. QUIT(1) 8.31.1. NAME quit - exits the command line interface. 8.31.2. SYNOPSIS quit exit and bye are command aliases. 8.31.3. EXAMPLE quit Ends the CLI session. exit Ends the CLI session. bye Ends the CLI session. 8.31.4. SEE ALSO disconnect(1), shutdown(1) 8.32. REBALANCE(1) 8.32.1. NAME rebalance - manages automatic rebalancing for caches 8.32.2. SYNOPSIS rebalance enable ['PATH'] rebalance disable ['PATH'] 8.32.3. EXAMPLES rebalance enable Enables automatic rebalancing in the current context. Running this command in the root context enables rebalancing for all caches. rebalance enable caches/mycache Enables automatic rebalancing for the cache named mycache . rebalance disable Disables automatic rebalancing in the current context. Running this command in the root context disables rebalancing for all caches. rebalance disable caches/mycache Disables automatic rebalancing for the cache named mycache . 8.33. REMOVE(1) 8.33.1. NAME remove - deletes entries from a cache. 8.33.2. SYNOPSIS remove KEY ['OPTIONS'] 8.33.3. OPTIONS --cache ='NAME' Specifies the cache from which to remove entries. Defaults to the currently selected cache. 8.33.4. EXAMPLE remove --cache=mycache hola Deletes the hola entry from the mycache cache. 8.33.5. SEE ALSO cache(1), drop(1), clearcache(1) 8.34. RESET(1) 8.34.1. NAME reset - restores the initial values of counters. 8.34.2. SYNOPSIS reset ['COUNTER_NAME'] 8.34.3. EXAMPLE reset cnt_a Resets the cnt_a counter. 8.34.4. SEE ALSO add(1), cas(1), drop(1) 8.35. SCHEMA(1) 8.35.1. NAME schema - manipulates Protobuf schemas. 8.35.2. SYNOPSIS schema ls schema upload --file=/path/to/schema.proto schema.proto schema remove schema.proto schema get schema.proto 8.35.3. DESCRIPTION Manage schemas with the ls , upload , get , remove subcommands. 8.35.4. COMMAND SYNOPSIS schema ls Lists the schemas installed in the server. schema upload --file='/path/to/schema.proto' 'schema.proto' Uploads a ProtoBuf schema file to the server. schema get 'schema.proto' Shows the content of the specified schema. schema remove 'schema.proto' Removes the specified schema from the server. 8.35.5. UPLOAD OPTIONS -f, --file ='FILE' Uploads a file as a protobuf schema with the given name. 8.35.6. EXAMPLE schema upload --file=person.proto person.proto Registers a person.proto Protobuf schema. 8.35.7. SEE ALSO query(1) 8.36. SERVER(1) 8.36.1. NAME server - server configuration and state management. 8.36.2. DESCRIPTION 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. 8.36.3. SYNOPSIS server report server heap-dump [--live] server connections ls [--global] 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 principals ls server aclcache flush 8.36.4. SERVER CONNECTOR IPFILTER OPTIONS --rules ='[ACCEPT|REJECT]/cidr',... One or more IP filtering rules. 8.36.5. EXAMPLES server report Obtains a server report, including information about network, threads, memory, etc. server heap-dump Generates a JVM heap dump in the server data directory, returning the name of the generated file. server connections ls Lists all active client connections to the server. The --global argument will return connections from all cluster members. 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. server principals ls Lists principals known by the server. server aclcache flush Flushes the security caches cluster-wide. 8.37. SHUTDOWN(1) 8.37.1. NAME shutdown - stops server instances and clusters. 8.37.2. SYNOPSIS shutdown server ['SERVERS'] shutdown cluster shutdown container 8.37.3. EXAMPLES shutdown server Stops the server to which the CLI is connected. shutdown server my_server01 Stops the server with hostname my_server01 . shutdown cluster Stops all nodes in the cluster after storing cluster state and persisting entries if there is a cache store. shutdown container Stops the data container without terminating the server process. Stores cluster state and persists entries if there is a cache store. Server instances remain running with active endpoints and clustering. REST calls to container resources will result in a 503 Service Unavailable response. The shutdown container command is intended for environments, such as Kubernetes, that automate resource lifecycle management. For self-managed environments you should use the shutdown server or shutdown cluster commands to stop servers. 8.37.4. SEE ALSO connect(1), disconnect(1), quit(1) 8.38. SITE(1) 8.38.1. NAME site - manages backup locations and performs cross-site replication operations. 8.38.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'] site state-transfer-mode get|set ['OPTIONS'] site name site view site is-relay-node site relay-nodes 8.38.3. OPTIONS -c, --cache ='CACHE_NAME' Specifies a cache. -a, --all-caches Applies the command to all caches. -s, --site ='SITE_NAME' Specifies a backup location. 8.38.4. STATE TRANSFER MODE OPTIONS --mode ='MODE' Sets the state transfer mode. Values are MANUAL (default) or AUTO . 8.38.5. EXAMPLES site status --cache=mycache Returns the status of all backup locations for mycache . site status --all-caches Returns the status of each backup location for all caches with backups. 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. site is-relay-node Returns true if the node handles RELAY messages between clusters. site relay-nodes Returns a list of relay nodes by their logical names. 8.39. STATS(1) 8.39.1. NAME stats - displays statistics about resources. 8.39.2. SYNOPSIS stats ['PATH'] 8.39.3. EXAMPLES stats //containers/default Displays statistics about the default container. stats //containers/default/caches/mycache Displays statistics about the mycache cache. 8.39.4. SEE ALSO cd(1), ls(1), describe(1) 8.40. TASK(1) 8.40.1. NAME task - executes and uploads server-side tasks and scripts 8.40.2. SYNOPSIS task upload --file='script' 'TASK_NAME' task exec ['TASK_NAME'] 8.40.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 . 8.40.4. OPTIONS -P, --parameters ='PARAMETERS' Passes parameter values to tasks and scripts. -f, --file ='FILE' Uploads script files with the given names. 8.40.5. SEE ALSO ls(1) 8.41. UNALIAS(1) 8.41.1. NAME unalias - deletes aliases. 8.41.2. SYNOPSIS unalias 'ALIAS-NAME' 8.41.3. EXAMPLES unalias q Deletes the q alias. 8.41.4. SEE ALSO config(1), alias(1) 8.42. USER(1) 8.42.1. NAME user - manages Data Grid users in property security realms. 8.42.2. SYNOPSIS 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' user roles create --description='custom description' --permissions='perm1'[,'perm2'... ] 'role' user roles update --permissions='perm1'[,'perm2'... ] --description='updated description' 'role' user roles remove 'role' user roles describe 'role' 8.42.3. DESCRIPTION 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. 8.42.4. COMMAND SYNOPSIS user ls Lists the users or groups which are present in the property file. user create 'username' Creates a user after prompting for a password. user describe 'username' Describes a user, including its username, realm and any groups it belongs to. user remove 'username' Removes the specified user from the property file. user password 'username' Changes the password for a user. user groups 'username' Sets the groups to which a user belongs. user encrypt-all Encrypt all passwords in a plain-text user property file. user roles ls 'principal' Lists all roles of the specified principal (user or group). user roles grant --roles='role1'[,'role2'... ] 'principal' Grants one or more roles to a principal. user roles deny --roles='role1'[,'role2'... ] 'principal' Denies one or more roles to a principal. user roles create --permissions='perm1'[,'perm2'... ] 'role' Creates a new role with the specified permissions. user roles remove 'role' Deletes an existing role. user roles describe 'role' Describes an existing role. 8.42.5. COMMON OPTIONS These options apply to all commands: -h, --help Displays a help page for the command or sub-command. -s, --server-root ='path-to-server-root' The path to the server root. Defaults to server . -f, --users-file ='users.properties' The name of the property file which contains the user passwords. Defaults to users.properties . -w, --groups-file ='groups.properties' The name of the property file which contains the user to groups mapping. Defaults to groups.properties . 8.42.6. USER CREATE/MODIFY OPTIONS -a, --algorithms Specifies the algorithms used to hash the password. -g, --groups ='group1,group2,... ' Specifies the groups to which the user belongs. -p, --password ='password' Specifies the user's password. -r, --realm ='realm' Specifies the realm name. --plain-text Whether passwords should be stored in plain-text (not recommended). 8.42.7. USER LS OPTIONS --groups Shows a list of groups instead of the users. 8.42.8. USER ENCRYPT-ALL OPTIONS -a, --algorithms Specifies the algorithms used to hash the password. 8.42.9. USER ROLES OPTIONS -p, --permissions Specifies one or more of the following permissions: LIFECYCLE , READ , WRITE , EXEC , LISTEN , BULK_READ , BULK_WRITE , ADMIN , CREATE , MONITOR , ALL , ALL_READ , ALL_WRITE 8.43. VERSION(1) 8.43.1. NAME version - displays the server version and CLI version. 8.43.2. SYNOPSIS version 8.43.3. EXAMPLE version Returns the version for the server and the CLI. 8.43.4. SEE ALSO help(1)
help get *-c, --cache*='name':: The name of the cache to connect to the source. *-f, --file*='FILE':: Specifies a configuration file in JSON format, containing a single 'remote-store' element. CLUSTER SYNCHRONIZE OPTIONS --------------------------- *-c, --cache*='name':: The name of the cache to synchronize. *-b, --read-batch*='num':: The amount of entries to process in a batch. Defaults to 10000. *-t, --threads*='num':: The number of threads to use. Defaults to the number of cores on the server. CLUSTER DISCONNECT OPTIONS