1. Getting Started with the Infinispan CLI
The command line interface (CLI) lets you remotely connect to Infinispan servers to access data and perform administrative functions.
1.1. Creating and Modifying Users
Infinispan Server requires users to authenticate against a default property realm. Before you can access Infinispan 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.
-
Open a terminal in
$ISPN_HOME
. -
Create and modify Infinispan users with the
user
command.
Run |
-
Linux
$ bin/cli.sh user create myuser -p "qwer1234!"
-
Microsoft Windows
$ bin\cli.bat user create myuser -p "qwer1234!"
-
Linux
$ bin/cli.sh user create myuser -p "qwer1234!" -g supervisor,reader,writer
-
Microsoft Windows
$ bin\cli.bat user create myuser -p "qwer1234!" -g supervisor,reader,writer
1.2. Connecting to Infinispan Servers
Establish CLI connections to Infinispan.
Add user credentials and have at least one running Infinispan server instance.
-
Open a terminal in
$ISPN_HOME
. -
Start the CLI.
-
Linux:
$ bin/cli.sh
-
Microsoft Windows:
$ bin\cli.bat
-
-
Run the
connect
command and enter your username and password when prompted.-
Infinispan Server on the default port of
11222
:[disconnected]> connect
-
Infinispan Server with a port offset of
100
:[disconnected]> connect 127.0.0.1:11322
-
1.3. Navigating CLI Resources
The Infinispan CLI exposes a navigable tree that allows you to list, describe, and manipulate Infinispan cluster resources.
Press the tab key to display available commands and options. Use the |
When you connect to a Infinispan cluster, it opens in the context of the default cache container.
[//containers/default]>
-
Use
ls
to list resources.
[//containers/default]> ls caches counters configurations schemas tasks
-
Use
cd
to navigate the resource tree.
[//containers/default]> cd caches
-
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 } ] }
1.3.1. CLI Resources
The Infinispan CLI exposes different resources to:
-
create, modify, and manage local or clustered caches.
-
perform administrative operations for Infinispan clusters.
[//containers/default]> ls caches counters configurations schemas
caches
-
Infinispan cache instances. The default cache container is empty. Use the CLI to create caches from templates or
infinispan.xml
files. counters
-
Strong
orWeak
counters that record the count of objects. configurations
-
Infinispan configurations.
schemas
-
Protocol Buffers (Protobuf) schemas that structure data in the cache.
tasks
-
Remote tasks creating and managing Infinispan cache definitions.
[hostname@cluster/]> ls containers cluster server
containers
-
Cache containers on the Infinispan cluster.
cluster
-
Lists Infinispan servers joined to the cluster.
server
-
Resources for managing and monitoring Infinispan servers.
1.4. Shutting Down Infinispan Server
Stop individually running servers or bring down clusters gracefully.
-
Create a CLI connection to Infinispan.
-
Shut down Infinispan Server in one of the following ways:
-
Stop all nodes in a cluster with the
shutdown cluster
command, for example:[//containers/default]> shutdown cluster
This command saves cluster state to the
data
folder for each node in the cluster. If you use a cache store, theshutdown 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>
-
The |
Run |
Infinispan logs the following messages when you shut down servers:
ISPN080002: Infinispan Server stopping
ISPN000080: Disconnecting JGroups channel cluster
ISPN000390: Persisted state, version=<$version> timestamp=YYYY-MM-DDTHH:MM:SS
ISPN080003: Infinispan Server stopped
1.4.1. Restarting Infinispan Clusters
When you bring Infinispan 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.
2. Performing Cache Operations with the Infinispan CLI
The command line interface (CLI) lets you remotely connect to Infinispan servers to access data and perform administrative functions.
2.1. Creating Caches with the Infinispan Command Line Interface (CLI)
Use the Infinispan CLI to add caches from templates or configuration files in XML or JSON format.
Create a user and start at least one Infinispan server instance.
-
Create a CLI connection to Infinispan.
-
Add cache definitions with the
create cache
command.-
Add a cache definition from an XML or JSON file with the
--file
option.[//containers/default]> create cache --file=configuration.xml mycache
-
Add a cache definition from a template with the
--template
option.[//containers/default]> create cache --template=org.infinispan.DIST_SYNC mycache
Press the tab key after the
--template=
argument to list available cache templates.
-
-
Verify the cache exists with the
ls
command.[//containers/default]> ls caches mycache
-
Retrieve the cache configuration with the
describe
command.[//containers/default]> describe caches/mycache
2.1.1. XML Configuration
Infinispan configuration in XML format must conform to the schema and include:
-
<infinispan>
root element. -
<cache-container>
definition.
<infinispan>
<cache-container>
<distributed-cache name="myCache" mode="SYNC">
<encoding media-type="application/x-protostream"/>
<memory max-count="1000000" when-full="REMOVE"/>
</distributed-cache>
</cache-container>
</infinispan>
2.1.2. JSON Configuration
Infinispan configuration in JSON format:
-
Requires the cache definition only.
-
Must follow the structure of an XML configuration.
-
XML elements become JSON objects.
-
XML attributes become JSON fields.
-
{
"distributed-cache": {
"name": "myCache",
"mode": "SYNC",
"encoding": {
"media-type": "application/x-protostream"
},
"memory": {
"max-count": 1000000,
"when-full": "REMOVE"
}
}
}
2.2. Adding Cache Entries
Create key:value
pair entries in the data container.
Create a Infinispan cache that can store your data.
-
Create a CLI connection to Infinispan.
-
Add entries into your cache as follows:
-
Use the
put
command from the context of a cache:[//containers/default/caches/mycache]> put hello world
-
Use the
--cache=
with theput
command:[//containers/default]> put --cache=mycache hello world
-
-
Use the
get
command to verify entries.[//containers/default/caches/mycache]> get hello world
2.3. Clearing Caches and Deleting Entries
Remove data from caches with the Infinispan CLI.
-
Create a CLI connection to Infinispan.
-
Do one of the following:
-
Delete all entries with the
clearcache
command.[//containers/default]> clearcache mycache
-
Remove specific entries with the
remove
command.[//containers/default]> remove --cache=mycache hello
-
3. Performing Batch Operations
Process operations in groups, either interactively or using batch files.
-
A running Infinispan cluster.
3.1. Performing Batch Operations with Files
Create files that contain a set of operations and then pass them to the Infinispan CLI.
-
Create a file that contains a set of operations.
For example, create a file named
batch
that creates a cache namedmybatch
, adds two entries to the cache, and disconnects from the CLI.$ cat > batch<<EOF create cache --template=org.infinispan.DIST_SYNC mybatch put --cache=mybatch hello world put --cache=mybatch hola mundo disconnect EOF
-
Run the CLI and specify the file as input.
$ bin/cli.sh -c localhost:11222 -f batch
-
Create a new Infinispan CLI connection and verify
mybatch
.[//containers/default]> ls caches ___protobuf_metadata mybatch [//containers/default]> ls caches/mybatch hola hello [//containers/default]> disconnect [disconnected]>
CLI batch files support system property expansion. Strings that use the
|
3.2. Performing Batch Operations Interactively
Use the standard input stream, stdin, to perform batch operations interactively.
-
Start the Infinispan CLI in interactive mode.
$ bin/cli.sh -c localhost:11222 -f -
If you do not use the
-c
flag, you must run theconnect
command.$ bin/cli.sh -f - connect
-
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
Use |
The following example shows how to use echo describe
to get cluster information:
$ echo describe|bin/cli.sh -c localhost:11222 -f - { "name" : "default", "version" : "10.0.0-SNAPSHOT", "coordinator" : false, "cache_configuration_names" : [ "org.infinispan.REPL_ASYNC", "___protobuf_metadata", "org.infinispan.DIST_SYNC", "qcache", "org.infinispan.LOCAL", "dist_cache_01", "org.infinispan.INVALIDATION_SYNC", "org.infinispan.REPL_SYNC", "org.infinispan.SCATTERED_SYNC", "mycache", "org.infinispan.INVALIDATION_ASYNC", "mybatch", "org.infinispan.DIST_ASYNC" ], "cluster_name" : "cluster", "physical_addresses" : "[192.168.1.7:7800]", "coordinator_address" : "thundercat-34689", "cache_manager_status" : "RUNNING", "created_cache_count" : "4", "running_cache_count" : "4", "node_address" : "thundercat-47082", "cluster_members" : [ "thundercat-34689", "thundercat-47082" ], "cluster_members_physical_addresses" : [ "10.36.118.25:7801", "192.168.1.7:7800" ], "cluster_size" : 2, "defined_caches" : [ { "name" : "___protobuf_metadata", "started" : true }, { "name" : "mybatch", "started" : true } ] }
4. Configuring the Infinispan CLI
Define configuration properties for the Infinispan CLI.
4.1. Setting Infinispan CLI Properties and Persistent Storage
Configure Infinispan CLI startup operations and customize the location for persistent storage.
Create at least one Infinispan user.
-
Optionally set a custom path to the Infinispan CLI storage directory in one of the following ways:
-
Using the
cli.dir
system property:$ bin/cli.sh -Dcli.dir=/path/to/cli/storage ...
-
Using the
ISPN_CLI_DIR
environment variable:export ISPN_CLI_DIR=/path/to/cli/storage $ bin/cli.sh ...
-
-
Set values for configuration properties with the
config set
command. -
Verify configuration properties with the
config get
command.Run
help config
to review available configuration properties and get example usage.
4.2. Creating Command Aliases
Create aliases for Infinispan CLI commands to define custom shortcuts.
-
Create aliases with the
alias <alias>=<command>
command.For example, set
q
as an alias for thequit
command:[//containers/default]> alias q=quit
-
Run the
alias
command to check the defined aliases.[//containers/default]> alias alias q='quit'
-
Delete aliases with the
unalias
command, for example:[//containers/default]> unalias q
4.3. Trusting Infinispan Server Connections
Secure Infinispan CLI connections to Infinispan Server with SSL/TLS certificates. If you create a key store as an SSL identity for Infinispan Server, the CLI can validate server certificates to verify the identity.
-
Set up an SSL identity for Infinispan Server.
-
Create at least one Infinispan user.
-
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
-
Define the key store password, if necessary, as follows:
$ bin/cli.sh config set truststore-password secret
-
Verify your CLI configuration.
$ bin/cli.sh config get truststore truststore=/home/user/my-trust-store.jks $ bin/cli.sh config get truststore-password truststore-password=secret
4.4. Infinispan CLI Storage Directory
Infinispan CLI stores configuration in the following default directory:
Operating System | Default Path |
---|---|
Linux/Unix |
|
Microsoft Windows |
|
Mac OS |
|
This directory contains the following files:
cli.properties
-
Stores values for CLI configuration properties.
aliases
-
Stores command aliases.
history
-
Stores CLI history.
5. Working with Counters
Counters provide atomic increment and decrement operations that record the count of objects.
-
Start the Infinispan CLI.
-
Connect to a running Infinispan cluster.
5.1. Creating Counters
Create strong and weak counters with the Infinispan CLI.
-
Create a CLI connection to Infinispan.
-
Run the
create counter
command with the appropriate arguments.-
Create
my-weak-counter
.[//containers/default]> create counter --concurrency-level=1 --initial-value=5 --storage=PERSISTENT --type=weak my-weak-counter
-
Create
my-strong-counter
.[//containers/default]> create counter --initial-value=3 --storage=PERSISTENT --type=strong my-strong-counter
-
-
List available counters.
[//containers/default]> ls counters my-strong-counter my-weak-counter
-
Verify counter configurations.
-
Describe
my-weak-counter
.[//containers/default]> describe counters/my-weak-counter { "weak-counter":{ "initial-value":5, "storage":"PERSISTENT", "concurrency-level":1 } }
-
Describe
my-strong-counter
.[//containers/default]> describe counters/my-strong-counter { "strong-counter":{ "initial-value":3, "storage":"PERSISTENT", "upper-bound":5 } }
-
5.2. Adding Deltas to Counters
Increment or decrement counters with arbitrary values.
-
Select a counter.
[//containers/default]> counter my-weak-counter
-
List the current count.
[//containers/default/counters/my-weak-counter]> ls 5
-
Increment the counter value by
2
.[//containers/default/counters/my-weak-counter]> add --delta=2
-
Decrement the counter value by
-4
.[//containers/default/counters/my-weak-counter]> add --delta=-4
Strong counters return values after the operation is applied. Use
For example, Weak counters return empty responses. |
6. Querying Caches with Protobuf Metadata
Infinispan supports using Protocol Buffers (Protobuf) to structure data in the cache so that you can query it.
-
Start the Infinispan CLI.
-
Connect to a running Infinispan cluster.
6.1. Configuring Media Types
Encode cache entries with different media types to store data in a format that best suits your requirements.
For example, the following procedure shows you how to configure the application/x-protostream
media type.
-
Create a Infinispan configuration file that adds a distributed cache named
qcache
and configures the media type, for example:<infinispan> <cache-container> <distributed-cache name="qcache"> <encoding> <key media-type="application/x-protostream"/> <value media-type="application/x-protostream"/> </encoding> </distributed-cache> </cache-container> </infinispan>
-
Create
qcache
frompcache.xml
with the--file=
option.[//containers/default]> create cache --file=pcache.xml pcache
-
Verify
pcache
.[//containers/default]> ls caches pcache ___protobuf_metadata [//containers/default]> describe caches/pcache { "distributed-cache" : { "mode" : "SYNC", "encoding" : { "key" : { "media-type" : "application/x-protostream" }, "value" : { "media-type" : "application/x-protostream" } }, "transaction" : { "mode" : "NONE" } } }
-
Add an entry to
pcache
and check the encoding.[//containers/default]> put --cache=pcache good morning [//containers/default]> cd caches/pcache [//containers/default/caches/pcache]> get good { "_type" : "string", "_value" : "morning" }
6.2. Registering Protobuf Schemas
Protobuf schemas contain data structures known as messages in .proto
definition files.
-
Create a schema file named
person.proto
with the following messages:package org.infinispan.rest.search.entity; message Address { required string street = 1; required string postCode = 2; } message PhoneNumber { required string number = 1; } message Person { optional int32 id = 1; required string name = 2; required string surname = 3; optional Address address = 4; repeated PhoneNumber phoneNumbers = 5; optional uint32 age = 6; enum Gender { MALE = 0; FEMALE = 1; } optional Gender gender = 7; }
-
Register
person.proto
.[//containers/default]> schema --upload=person.proto person.proto
-
Verify
person.proto
.[//containers/default]> cd caches/___protobuf_metadata [//containers/default/caches/___protobuf_metadata]> ls person.proto [//containers/default/caches/___protobuf_metadata]> get person.proto
6.3. Querying Caches with Protobuf Schemas
Infinispan automatically converts JSON to Protobuf so that you can read and write cache entries in JSON format and use Protobuf schemas to query them.
For example, consider the following JSON documents:
lukecage.json
{ "_type":"org.infinispan.rest.search.entity.Person", "id":2, "name":"Luke", "surname":"Cage", "gender":"MALE", "address":{"street":"38th St","postCode":"NY 11221"}, "phoneNumbers":[{"number":4444},{"number":5555}] }
jessicajones.json
{ "_type":"org.infinispan.rest.search.entity.Person", "id":1, "name":"Jessica", "surname":"Jones", "gender":"FEMALE", "address":{"street":"46th St","postCode":"NY 10036"}, "phoneNumbers":[{"number":1111},{"number":2222},{"number":3333}] }
matthewmurdock.json
{ "_type":"org.infinispan.rest.search.entity.Person", "id":3, "name":"Matthew", "surname":"Murdock", "gender":"MALE", "address":{"street":"57th St","postCode":"NY 10019"}, "phoneNumbers":[] }
Each of the preceding JSON documents contains:
-
A
_type
field that identifies the Protobuf message to which the JSON document corresponds. -
Several fields that correspond to datatypes in the
person.proto
schema.
-
Navigate to the
pcache
cache.[//containers/default/caches]> cd pcache
-
Add each JSON document as an entry to the cache, for example:
[//containers/default/caches/pcache]> put --encoding=application/json --file=jessicajones.json jessicajones [//containers/default/caches/pcache]> put --encoding=application/json --file=matthewmurdock.json matthewmurdock [//containers/default/caches/pcache]> put --encoding=application/json --file=lukecage.json lukecage
-
Verify that the entries exist.
[//containers/default/caches/pcache]> ls lukecage matthewmurdock jessicajones
-
Query the cache to return entries from the Protobuf
Person
entity where the gender datatype isMALE
.[//containers/default/caches/pcache]> query "from org.infinispan.rest.search.entity.Person p where p.gender = 'MALE'" { "total_results" : 2, "hits" : [ { "hit" : { "_type" : "org.infinispan.rest.search.entity.Person", "id" : 2, "name" : "Luke", "surname" : "Cage", "gender" : "MALE", "address" : { "street" : "38th St", "postCode" : "NY 11221" }, "phoneNumbers" : [ { "number" : "4444" }, { "number" : "5555" } ] } }, { "hit" : { "_type" : "org.infinispan.rest.search.entity.Person", "id" : 3, "name" : "Matthew", "surname" : "Murdock", "gender" : "MALE", "address" : { "street" : "57th St", "postCode" : "NY 10019" } } } ] }
7. Performing Cross-Site Replication Operations
Infinispan clusters running in different locations can discover and communicate with each other to backup data.
-
Start the Infinispan CLI.
-
Connect to a running Infinispan cluster.
7.1. Bringing Backup Locations Offline and Online
Take backup locations offline manually and bring them back online.
-
Create a CLI connection to Infinispan.
-
Check if backup locations are online or offline with the
site status
command://containers/default]> site status --cache=cacheName --site=NYC
--site
is an optional argument. If not set, the CLI returns all backup locations. -
Manage backup locations as follows:
-
Bring backup locations online with the
bring-online
command://containers/default]> site bring-online --cache=customers --site=NYC
-
Take backup locations offline with the
take-offline
command://containers/default]> site take-offline --cache=customers --site=NYC
-
For more information and examples, run the help site
command.
7.2. Pushing State to Backup Locations
Transfer cache state to remote backup locations.
-
Create a CLI connection to Infinispan.
-
Use the
site
command to push state transfer, as in the following example://containers/default]> site push-site-state --cache=cacheName --site=NYC
For more information and examples, run the help site
command.
8. Command Reference
Review manual pages for Infinispan CLI commands.
Use For example, to view the manual page for the $ help get |
8.1. ADD(1)
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.2. ALIAS(1)
8.3. CACHE(1)
8.4. CAS(1)
8.4.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.5. CD(1)
8.7. CONFIG(1)
8.7.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.
8.7.5. COMMON OPTIONS
These options apply to all commands:
- -h, --help
-
Displays a help page for the command or sub-command.
8.7.6. 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) andtrue
. - truststore
-
Defines the path to a keystore that contains a certificate chain that verifies server identity.
- truststore-password
-
Specifies a password to access the keystore.
8.7.7. 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.
8.8. CONNECT(1)
8.8.2. DESCRIPTION
Defaults to http://localhost:11222
and prompts for credentials if
authentication is required.
8.8.4. OPTIONS
- -u, --username='USERNAME'
-
Specifies a username to authenticate with ${infinispan.brand.name} servers.
- -p, --password='PASSWORD'
-
Specifies passwords.
8.9. CONTAINER(1)
8.10. COUNTER(1)
8.11. CREATE(1)
8.11.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.
8.11.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.12. DESCRIBE(1)
8.12.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.14. DROP(1)
8.15. ENCODING(1)
8.15.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.16. GET(1)
8.18. LOGGING(1)
8.18.1. NAME
logging - inspects and manipulates the ${infinispan.brand.name} server runtime logging configuration.
8.18.2. SYNOPSIS
logging list-loggers
logging list-appenders
logging set ['OPTIONS'] [LOGGER_NAME
]
logging remove LOGGER_NAME
8.18.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.
calling logging set without a logger name will modify the root logger. |
8.20. MIGRATE(1)
8.20.3. DESCRIPTION
Use the migrate
command to migrate data from one version of ${infinispan.brand.name} to another.
8.20.4. COMMAND SYNOPSIS
Migrate clusters
- migrate cluster synchronize
-
Synchronize data between the source cluster and the target cluster.
- migrate cluster disconnect
-
Disconnects the target cluster from the source cluster.
8.20.5. COMMON OPTIONS
These options apply to all commands:
- -h, --help
-
Displays a help page for the command or sub-command.
8.21. PATCH(1)
8.21.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.21.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.21.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.21.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.21.6. PATCH DESCRIBE OPTIONS
- -v, --verbose
-
Shows the content of the patch, including information about individual files
8.21.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.21.8. PATCH CREATE OPTIONS
- -q, --qualifier='name'
-
Specifies a descriptive qualifier string for the patch; for example, 'one-off for issue nnnn'.
8.21.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.
8.22. PUT(1)
8.22.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 if0
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 if0
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.23. QUERY(1)
8.23.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 isFETCH
.
8.25. REMOVE(1)
8.28. SHUTDOWN(1)
8.29. SITE(1)
8.29.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']
8.29.3. OPTIONS
- --cache='CACHE_NAME'
-
Specifies a cache.
- --site='SITE_NAME'
-
Specifies a backup location.
8.29.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
.
8.30. STATS(1)
8.31. TASK(1)
8.31.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.33. USER(1)
8.33.2. SYNOPSIS
user ls
user create 'username'
user describe 'username'
user remove 'username'
user password 'username'
user groups 'username'
user encrypt-all
8.33.3. DESCRIPTION
Manage (list, create, describe, remove, modify) users stored in a property security realm. Note: You can use this command only with property realms.
8.33.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.
8.33.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.33.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).