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.
-
At least one running Infinispan server.
1.1. Starting the Infinispan CLI
Start the Infinispan CLI as follows:
-
Open a terminal in
$ISPN_HOME
. -
Run the CLI.
$ bin/cli.sh [disconnected]>
1.2. Connecting to Infinispan Servers
Do one of the following:
-
Run the
connect
command to connect to a Infinispan server on the default port of11222
:[disconnected]> connect [hostname1@cluster//containers/default]>
-
Specify the location of a Infinispan server. For example, connect to a local server that has a port offset of 100:
[disconnected]> connect 127.0.0.1:11322 [hostname2@cluster//containers/default]>
Press the tab key to display available commands and options. Use the |
1.3. Navigating CLI Resources
The Infinispan CLI exposes a navigable tree that allows you to list, describe, and manipulate Infinispan cluster resources.
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
-
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
-
Configuration files.
schemas
-
Protocol Buffers (Protobuf) schemas that structure data in the cache.
[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. Resource statistics
You can inspect server-collected statistics for some of the resources within a Infinispan server using the stats
command.
Use the stats
command either from the context of a resource which collects statistics (containers, caches) or with a path to such a resource:
[//containers/default]> stats { "statistics_enabled" : true, "number_of_entries" : 0, "hit_ratio" : 0.0, "read_write_ratio" : 0.0, "time_since_start" : 0, "time_since_reset" : 49, "current_number_of_entries" : 0, "current_number_of_entries_in_memory" : 0, "total_number_of_entries" : 0, "off_heap_memory_used" : 0, "data_memory_used" : 0, "stores" : 0, "retrievals" : 0, "hits" : 0, "misses" : 0, "remove_hits" : 0, "remove_misses" : 0, "evictions" : 0, "average_read_time" : 0, "average_read_time_nanos" : 0, "average_write_time" : 0, "average_write_time_nanos" : 0, "average_remove_time" : 0, "average_remove_time_nanos" : 0, "required_minimum_number_of_nodes" : -1 }
[//containers/default]> stats /containers/default/caches/mycache { "time_since_start" : -1, "time_since_reset" : -1, "current_number_of_entries" : -1, "current_number_of_entries_in_memory" : -1, "total_number_of_entries" : -1, "off_heap_memory_used" : -1, "data_memory_used" : -1, "stores" : -1, "retrievals" : -1, "hits" : -1, "misses" : -1, "remove_hits" : -1, "remove_misses" : -1, "evictions" : -1, "average_read_time" : -1, "average_read_time_nanos" : -1, "average_write_time" : -1, "average_write_time_nanos" : -1, "average_remove_time" : -1, "average_remove_time_nanos" : -1, "required_minimum_number_of_nodes" : -1 }
1.5. Shutting Down Infinispan Servers
Use the CLI to gracefully shutdown running servers. This ensures that Infinispan passivates all entries to disk and persists state.
-
Use the
shutdown server
command to stop individual servers, for example:[//containers/default]> shutdown server server_hostname
-
Use the
shutdown cluster
command to stop all servers joined to the cluster, for example:[//containers/default]> shutdown cluster
Infinispan servers log the following shutdown messages:
INFO [org.infinispan.SERVER] (pool-3-thread-1) ISPN080002: Infinispan Server stopping
INFO [org.infinispan.CONTAINER] (pool-3-thread-1) ISPN000029: Passivating all entries to disk
INFO [org.infinispan.CONTAINER] (pool-3-thread-1) ISPN000030: Passivated 28 entries in 46 milliseconds
INFO [org.infinispan.CLUSTER] (pool-3-thread-1) ISPN000080: Disconnecting JGroups channel cluster
INFO [org.infinispan.CONTAINER] (pool-3-thread-1) ISPN000390: Persisted state, version=<Infinispan version> timestamp=YYYY-MM-DDTHH:MM:SS
INFO [org.infinispan.SERVER] (pool-3-thread-1) ISPN080003: Infinispan Server stopped
INFO [org.infinispan.SERVER] (Thread-0) ISPN080002: Infinispan Server stopping
INFO [org.infinispan.SERVER] (Thread-0) ISPN080003: Infinispan Server stopped
When you shutdown Infinispan clusters, the shutdown messages include:
INFO [org.infinispan.SERVER] (pool-3-thread-1) ISPN080029: Cluster shutdown
INFO [org.infinispan.CLUSTER] (pool-3-thread-1) ISPN000080: Disconnecting JGroups channel cluster
1.6. Changing the runtime logging configuration of Infinispan Servers
Use the command line interface to change the logging configuration of Infinispan servers at runtime. Use this functionality to temporarily make modifications to the logging configuration, for example while investigating a problem.
Modifying the logging configuration via the CLI is a runtime-only operation:
-
any changes will not be persisted to the
log4j2.xml
file. Restarting any individual server or the entire cluster will cause the logging configuration to be reset to that defined in thelog4j2.xml
file. -
the changes only apply to the nodes that are present in the cluster at invocation time. Any nodes that are started after the modifications will be using their default logging configuration.
List all appenders defined on the server:
[//containers/default]> logging list-appenders
The above command will return:
{
"STDOUT" : {
"name" : "STDOUT"
},
"JSON-FILE" : {
"name" : "JSON-FILE"
},
"HR-ACCESS-FILE" : {
"name" : "HR-ACCESS-FILE"
},
"FILE" : {
"name" : "FILE"
},
"REST-ACCESS-FILE" : {
"name" : "REST-ACCESS-FILE"
}
}
List all logger configurations defined on the server:
[//containers/default]> logging list-loggers
The above command will return:
[ {
"name" : "",
"level" : "INFO",
"appenders" : [ "STDOUT", "FILE" ]
}, {
"name" : "org.infinispan.HOTROD_ACCESS_LOG",
"level" : "INFO",
"appenders" : [ "HR-ACCESS-FILE" ]
}, {
"name" : "com.arjuna",
"level" : "WARN",
"appenders" : [ ]
}, {
"name" : "org.infinispan.REST_ACCESS_LOG",
"level" : "INFO",
"appenders" : [ "REST-ACCESS-FILE" ]
} ]
You can add/modify logger configurations via the set
subcommand, by specifying the logger name and the level.
For example, the following command will set the logging level for the org.infinispan
package to DEBUG
.
[//containers/default]> logging set --level=DEBUG org.infinispan
You can remove existing logger configurations via the remove
subcommand.
For example, the following command will remove the org.infinispan
logger configuration, meaning that the root configuration will be used instead:
[//containers/default]> logging remove org.infinispan
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.
-
Start the Infinispan CLI.
-
Connect to a running Infinispan cluster.
2.1. Creating Caches from Templates
Use Infinispan cache templates to add caches with recommended default settings.
-
Create a distributed, synchronous cache from a template and name it "mycache".
[//containers/default]> create cache --template=org.infinispan.DIST_SYNC mycache
Press the tab key after the
--template=
argument to list available cache templates. -
Retrieve the cache configuration.
[//containers/default]> describe caches/mycache { "distributed-cache" : { "mode" : "SYNC", "remote-timeout" : 17500, "state-transfer" : { "timeout" : 60000 }, "transaction" : { "mode" : "NONE" }, "locking" : { "concurrency-level" : 1000, "acquire-timeout" : 15000, "striping" : false } } }
2.2. Adding Cache Entries
Add data to caches with the Infinispan CLI.
-
Create a cache named "mycache".
-
Add a key/value pair to
mycache
.[//containers/default]> put --cache=mycache hello world
If the CLI is in the context of a cache, do
put k1 v1
for example:[//containers/default]> cd caches/mycache [//containers/default/caches/mycache]> put hello world
-
List keys in the cache.
[//containers/default]> ls caches/mycache hello
-
Get the value for the
hello
key.-
Navigate to the cache.
[//containers/default]> cd caches/mycache
-
Use the
get
command to retrieve the key value.[//containers/default/caches/mycache]> get hello world
-
2.3. Deleting Cache Entries
Remove data from caches with the Infinispan CLI.
-
Create a cache named "mycache" and add entries.
Either delete all entries or remove specific entries as follows:
-
Delete all entries from a cache.
[//containers/default]> clearcache mycache
-
Remove specific entries from a cache.
[//containers/default]> remove --cache=mycache hello
2.4. Creating Custom Caches
Add caches with custom Infinispan configuration files in XML or JSON format.
-
Add the path to your configuration file with the
--file=
option as follows:
[//containers/default]> create cache --file=prod_dist_cache.xml dist_cache_01
2.4.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="cacheName" mode="SYNC">
<memory>
<object size="20"/>
</memory>
</distributed-cache>
</cache-container>
</infinispan>
2.4.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": {
"mode": "SYNC",
"memory": {
"object": {
"size": 20
}
}
}
}
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
-
Open a new CLI connection to Infinispan and verify
mybatch
.[//containers/default]> ls caches ___protobuf_metadata mybatch [//containers/default]> ls caches/mybatch hola hello [//containers/default]> disconnect [disconnected]>
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. 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.
4.1. Creating Counters
Create strong and weak counters with the Infinispan CLI.
-
Run
create counter
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 } }
-
4.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. |
5. 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.
5.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" }
5.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
5.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" } } } ] }
6. Command Reference
Review manual pages for Infinispan CLI commands.
Use For example, to view the manual page for the $ help get |
6.1. ADD(1)
6.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
.
6.2. CACHE(1)
6.3. CAS(1)
6.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.
6.4. CD(1)
6.6. CONNECT(1)
6.6.2. DESCRIPTION
Defaults to http://localhost:11222
and prompts for credentials if
authentication is required.
6.6.4. OPTIONS
- -u, --username='USERNAME'
-
Specifies a username to authenticate with ${infinispan.brand.name} servers.
- -p, --password='PASSWORD'
-
Specifies passwords.
6.7. CONTAINER(1)
6.8. COUNTER(1)
6.9. CREATE(1)
6.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.
6.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.
6.10. DESCRIBE(1)
6.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.
6.12. DROP(1)
6.13. ENCODING(1)
6.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
6.14. GET(1)
6.17. PUT(1)
6.17.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.
6.18. QUERY(1)
6.18.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
.
6.20. REMOVE(1)
6.23. SHUTDOWN(1)
6.24. SITE(1)
6.24.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']
6.24.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 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 the mycache
cache to NYC
.
site push-site-status --cache=mycache
Displays the status of the backup operation for the mycache
cache to all backup locations.
site cancel-push-state --cache=mycache --site=NYC
Cancels the backup operation for the mycache
cache to NYC
.
site cancel-receive-state --cache=mycache --site=NYC
Cancels the operation to receive state from a remote location.
site clear-push-state-status --cache=myCache
Clears the push state status for mycache
.
6.25. TASK(1)
6.25.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
.