Loading
Aerospike Admin Console Help
asadm --help
Usage: asadm [OPTIONS]
---------------------------------------------------------------------------------------
-V --version Show the version of asadm and exit
-E --help Show program usage.
-e --execute Execute one or more asadm commands and exit.
The input value is either string of ';' separated asadm
commands or path of file which has asadm commands (ends with ';').
--enable Run commands in privileged mode. Must be used with the
--execute option. Not allowed in interactive mode.
-o --out-file Path of file to write output of -e command[s].
--no-color Disable colored output.
--single-node Enable asadm mode to connect only seed node.
By default asadm connects to all nodes in cluster.
--collectinfo Start asadm to run against offline collectinfo files.
--pmap Include partition map analysis in collectinfo files.
--log-analyser Start asadm in log-analyser mode and analyse data from log files.
-f --log-path=path Path of cluster collectinfo file or directory
containing collectinfo and system info files.
-j --json Output as JSON (experimental).
Configuration File Allowed Options
----------------------------------
[cluster]
-h, --host=HOST HOST is "<host1>[:<tlsname1>][:<port1>],..."
Server seed hostnames or IP addresses. The tlsname is
only used when connecting with a secure TLS enabled
server. Default: localhost:3000
Examples:
host1
host1:3000,host2:3000
192.168.1.10:cert1:3000,192.168.1.20:cert2:3000
--services-alternate Enable use of services-alternate instead of services in
info request during cluster tending
-p, --port=PORT Server default port. Default: 3000
-U, --user=USER User name used to authenticate with cluster. Default: none
-P, --password Password used to authenticate with cluster. Default: none
User will be prompted on command line if -P specified and no
password is given.
--auth=AUTHENTICATION_MODE
Authentication mode. Values: ['EXTERNAL', 'INTERNAL', 'EXTERNAL_INSECURE', 'PKI'].
Default: INTERNAL
--tls-enable Enable TLS on connections. By default TLS is disabled.
-t --tls-name=name Default TLS name of host to verify for TLS connection,
if not specified in host string. It is required if tls-enable
is set.
--tls-cafile=path Path to a trusted CA certificate file.
--tls-capath=path Path to a directory of trusted CA certificates.
--tls-protocols=TLS_PROTOCOLS
Set the TLS protocol selection criteria. This format
is the same as Apache's SSLProtocol documented at http
s://httpd.apache.org/docs/current/mod/mod_ssl.html#ssl
protocol . If not specified the asadm will use ' -all
+TLSv1.2' if has support for TLSv1.2,otherwise it will
be ' -all +TLSv1'.
--tls-cipher-suite=TLS_CIPHER_SUITE
Set the TLS cipher selection criteria. The format is
the same as Open_sSL's Cipher List Format documented
at https://www.openssl.org/docs/man1.0.1/apps/ciphers.
html
--tls-keyfile=path Path to the key for mutual authentication (if Aerospike
Cluster is supporting it).
--tls-keyfile-password=password
Password to load protected tls-keyfile.
It can be one of the following:
1) Environment varaible: 'env:<VAR>'
2) File: 'file:<PATH>'
3) String: 'PASSWORD'
Default: none
User will be prompted on command line if --tls-keyfile-password specified and no
password is given.
--tls-certfile=path Path to the chain file for mutual authentication (if
Aerospike Cluster is supporting it).
--tls-cert-blacklist=path (DEPRECATED)
Path to a certificate blacklist file. The file should
contain one line for each blacklisted certificate.
Each line starts with the certificate serial number
expressed in hex. Each entry may optionally specify
the issuer name of the certificate (serial numbers are
only required to be unique per issuer).Example:
867EC87482B2
/C=US/ST=CA/O=Acme/OU=Engineering/CN=TestChainCA
--tls-crl-check Enable CRL checking for leaf certificate. An error
occurs if a valid CRL files cannot be found in
tls_capath.
--tls-crl-check-all Enable CRL checking for entire certificate chain. An
error occurs if a valid CRL files cannot be found in
tls_capath.
[asadm]
-s --services-alumni
Enable use of services-alumni-list instead of services-list
--timeout=value Set timeout value in seconds for node level operations.
TLS connection does not support timeout. Default: 1 seconds
--enable Run commands in privileged mode. Must be used with the
--execute option. Not allowed in interactive mode.
Default configuration files are read from the following files in the given order:
/etc/aerospike/astools.conf ~/.aerospike/astools.conf
The following sections are read: (cluster asadm include)
The following options effect configuration file behavior
--no-config-file
Do not read any config file. Default: disabled
--instance=name
Section with these instance is read. e.g in case instance
`a` is specified sections cluster_a, asadm_a is read.
--config-file=path
Read this file after default configuration file.
--only-config-file=path
Read only this configuration file.
After executing asadm you will receive an 'Admin>' prompt, type help and press return for a list of commands and descriptions.
Seed: [('127.0.0.1', 3000, None)]
Config_file: /home/jesseschmidt/.aerospike/astools.conf, /etc/aerospike/astools.conf
Aerospike Admin
- enable:
Enters privileged mode, which allows a you to issue manage
and asinfo commands.
Options:
--warn: Use this option to receive a prompt to confirm
that you want to run the command.
- exit:
Terminate session
- help:
Displays the documentation for the specified command.
For example, to see the documentation for the 'info' command,
use the command 'help info'.
- watch:
Runs a command for a specified pause and iterations.
Usage: watch [pause] [iterations] [--no-diff] command
pause: The duration between executions.
[default: 2 seconds]
iterations: Number of iterations to execute command.
[default: until keyboard interrupt]
Options:
--no-diff: Do not highlight differences
Example 1: Show 'info network' 3 times and pause for 1 second each time.
watch 1 3 info network
Example 2: Show "info namespace" with 5 seconds pause until
interrupted
watch 5 info namespace
- summary:
Displays summary of Aerospike cluster.
Options:
-l - Enable to display namespace output in List view. Default: Table view
--enable-ssh - Enables the collection of system statistics from a remote server.
--ssh-user <string> - Default user ID for remote servers. This is the ID of a user of the
system, not the ID of an Aerospike user.
--ssh-pwd <string> - Default password or passphrase for key for remote servers. This is the
user's password for logging into the system, not a password for logging
into Aerospike.
--ssh-port <int> - Default SSH port for remote servers. Default: 22
--ssh-key <string> - Default SSH key (file path) for remote servers.
--ssh-cf <string> - Remote System Credentials file path.
If the server credentials are not in the credentials file, then
authentication is attempted with the default credentials.
File format : each line should contain <IP[:PORT]>,<USER_ID>,
<PASSWORD or PASSPHRASE>,<SSH_KEY>
Example: 1.2.3.4,uid,pwd
1.2.3.4:3232,uid,pwd
1.2.3.4:3232,uid,,key_path
1.2.3.4:3232,uid,passphrase,key_path
[2001::1234:10],uid,pwd
[2001::1234:10]:3232,uid,,key_path
--agent-host <host> - Host IP of the Unique-Data-Agent (UDA) to collect license data usage.
--agent-port <int> - Port of the UDA. Default: 8080
--agent-unstable - When processing UDA entries allow instances where the cluster is unstable.
Modifiers: with
- features:
Lists the features in use in a running Aerospike cluster.
Modifiers: like, with
- pager:
Set pager for output
- off:
Removes pager and prints output normally
- on:
Displays output with vertical and horizontal paging for each output table same as linux 'less'
command.
Use arrow keys to scroll output and 'q' to end page for table.
All linux less commands can work in this pager option.
- scroll:
Display output in scrolling mode
- collectinfo:
"collectinfo" is used to collect cluster info, aerospike conf file and system stats.
Modifiers: with
Default: Collects cluster info, aerospike conf file for local node and system stats from all nodes if
remote server credentials provided. If credentials are not available then it will collect system
stats from local node only.
Options:
-n <int> - Number of snapshots. Default: 1
-s <int> - Sleep time in seconds between each snapshot. Default: 5 sec
--enable-ssh - Enables the collection of system statistics from the remote server.
--ssh-user <string> - Default user ID for remote servers. This is the ID of a user of the
system not the ID of an Aerospike user.
--ssh-pwd <string> - Default password or passphrase for key for remote servers. This is
the user's password for logging into the system, not a password for
logging into Aerospike.
--ssh-port <int> - Default SSH port for remote servers. Default: 22
--ssh-key <string> - Default SSH key (file path) for remote servers.
--ssh-cf <string> - Remote System Credentials file path.
If the server credentials are not in the credentials file, then
authentication is attempted with the default credentials.
File format : each line must contain <IP[:PORT]>,<USER_ID>
<PASSWORD or PASSPHRASE>,<SSH_KEY>
Example: 1.2.3.4,uid,pwd
1.2.3.4:3232,uid,pwd
1.2.3.4:3232,uid,,key_path
1.2.3.4:3232,uid,passphrase,key_path
[2001::1234:10],uid,pwd
[2001::1234:10]:3232,uid,,key_path
--agent-host <host> - Host IP of the Unique Data Agent (UDA) to collect license data usage.
--agent-port <int> - Port of the UDA. Default: 8080
--agent-store - Collect the raw datastore of the UDA. --output-prefix <string> - Output directory name prefix.
--asconfig-file <string> - Aerospike config file path to collect.
Default: /etc/aerospike/aerospike.conf
- asinfo:
"asinfo" provides raw access to the info protocol.
Options:
-v <command> - The command to execute
-l - Replace semicolons ";" with newlines. If output does
not contain semicolons "-l" will attempt to use
colons ":" followed by commas ",".
--no_node_name - Force to display output without printing node names.
Modifiers: like, with
Default: Executes an info command.
- manage:
"manage" is used for administrative tasks like managing users, roles, udf, and
sindexes. It should be used in conjunction with the "show users" and "show roles"
command.
- jobs:
- kill:
"manage jobs kill" is used to abort jobs.
- trids:
"manage jobs kill trids" is used to abort jobs using their transaction ids.
Usage: kill trids <trid1> [<trid2> [...]]
trid - The transaction ids of the jobs you would like to kill.
- all:
- queries:
"manage jobs kill all queries" aborts all query jobs. Supported on
server v. 6.0 and later.
Usage: kill all queries
Modifiers: with
- scans:
"manage jobs kill all scans" aborts all scan jobs. Removed in server v.
6.0 and later. Use "manage jobs kill all queries" instead.
Usage: kill all scans
Modifiers: with
- recluster:
"manage recluster" is used to recluster an Aerospike cluster. This is
necessary for certain configuration changes to take effect.
Usage: recluster
- quiesce:
"manage quiesce" causes a node to avoid participating as a replica after the next recluster event.
Usage: quiesce with node1 [node2 [...]] [undo]
with - The node(s) to quiesce. Acceptable values are ip:port, node-id, or FQDN.
undo - Revert the effects of the quiesce on the next recluster event.
[default: false]
Required: with
Modifiers: undo
- revive:
"manage revive" is used to revive dead partitions in a namespace running in strong
consistency mode.
Usage: revive ns <ns>
ns - A namespace with dead partitions.
Required: ns
Modifiers: with
- roster:
"manage roster" is used to modify the clusters roster. It
should be used in conjunction with the "show roster" command
- add:
"manage roster add" is used to add node(s) to the pending-roster. Since the changes
performed by this command are critical "--warn" is on by default.
Usage: add nodes node_id1[@rack_id] [node_id2[@rack_id1] [...]] ns <ns>
nodes - The node(s) to add to the pending-roster.
ns - The namespace of the pending-roster.
Options:
--no-warn - Turn off --warn mode. This is not advised.
Required: nodes, ns
- remove:
"manage roster remove" is used to remove node(s) from the pending-roster. Since the
changes performed by this command are critical "--warn" is on by default.
Usage: remove nodes node_id1[@rack_id] [node_id2[@rack_id1] [...]] ns <ns>
nodes - The node(s) to remove from the pending-roster.
ns - The namespace of the pending-roster..
Options:
--no-warn - Turn off --warn mode. This is not advised.
Required: nodes, ns
- stage:
- nodes:
"manage roster stage nodes" is used to overwrite the nodes in the pending-roster.
Since the changes performed by this command are critical "--warn" is on by default.
Usage: roster stage nodes node_id1[@rack_id1] [node_id2[@rack_id2] [...]] ns <ns>
nodes - The node(s) to include in the new pending-roster.
ns - The namespace of the pending-roster.
Options:
--no-warn - Turn off --warn mode. This is not advised.
Required: ns
- observed:
"manage roster stage observed" automatically adds observed-nodes to the
pending-roster.
Usage: roster stage observed ns <ns>
ns - The namespace of the pending-roster you would like to set.
Required: ns
- truncate:
"manage truncate" is used to delete multiple records in the Aerospike cluster.
Since the changes performed by this command are critical "--warn" is on by default.
Usage: truncate ns <ns> [set <set>] [undo]|[before <iso-8601-or-unix-epoch> iso-8601|unix-epoch]
namespace - The namespace you would like to truncate or undo truncation.
set - The set you would like to truncate or undo truncation
[default: None]
undo - Remove the associated SMD (System Meta Data) files entry and
allow (some) previously truncated records to be resurrected on
the next cold restart.
[default: false]
before - Deletes every record in the given namespace or set whose lut is
older than the given time. Time can be either an iso-8601 formatted
datetime followed by the literal "iso-8601" or unix-epoch
followed by the literal "unix-epoch".
[default: Now]
Options:
--no-warn - Turn off --warn mode. This is not advised.
Required: ns
Modifiers: before, set, undo
- udfs:
"manage udfs" is used to add and remove user defined functions. It should be used
in conjunction with the "show udfs" command.
- add:
Usage: add <module-name> path <module-path>
module-name - Name of module to be stored in the server. Can be different
from file in path but must end with an extension.
path - Path to the udf module. Can be either absolute or relative
to the current working directory.
Required: path
- remove:
Usage: remove <module-name>
module-name - Name of module to remove as stored in the server.
- sindex:
"manage sindex" creates and deletes secondary indexes. Use
in conjunction with the "show sindex" or "info sindex" command.
- create:
Usage: create <bin-type> <index-name> ns <ns> [set <set>] bin <bin-name> [in <index-type>] [ctx <ctx-item> [. . .]]
bin-type - The bin type of the provided <bin-name>. Should be one of the following values:
numeric, string, or geo2dsphere
index-name - Name of the secondary index to be created. Should be 20 characters
or less and not contain ":" or ";".
ns - Name of namespace to create the secondary index on.
set - Name of set to create the secondary index on.
bin - Name of bin to create secondary index on.
in - Specifies how the secondary index is to collect keys:
list: Specifies to use the elements of a list as keys.
mapkeys: Specifies to use the keys of a map as keys.
mapvalues: Specifies to use the values of a map as keys.
[default: Specifies to use the contents of a bin as keys.]
ctx - A list of context items describing how to index into a CDT.
Possible values include: list_index(<int>) list_rank(<int>),
list_value(<value>), map_index(<int>), map_rank(<int>),
map_key(<value>), and map_value(<value>). Where <value> is
<string>, int(<int>), bool(<bool>), or bytes(<base64>) a base64
encoded byte array (no quotes).
Required: bin, ns
Modifiers: ctx, in, set
- delete:
Usage: delete <index-name> ns <ns> [set <set>]
index-name - Name of the secondary index to be deleted.
ns - Namespace where the sindex resides.
set - Set where the sindex resides.
Required: ns
Modifiers: set
- config:
"manage config" is used to change dynamic configuration
- logging:
Usage: logging file <log-file-name> param <parameter> to <value>
file - Name of log file as shown in the aerospike.conf.
param - The logging context.
to - The logging level to assign.
Required: file, param, to
Modifiers: with
- service:
Usage: service param <parameter> to <value>
param - The service configuration parameter.
to - The value to assign to the parameter.
Required: param, to
Modifiers: with
- network:
Usage: network <subcontext> param <parameter> to <value>
subcontext - The network subcontext where the parameter is located.
param - The network configuration parameter.
to - The value to assign to the parameter.
Required: param, to
Modifiers: with
- security:
Usage: security [<subcontext>] param <parameter> to <value>
subcontext - The security subcontext where the parameter is located.
[default: None]
param - The security configuration parameter.
to - The value to assign to the parameter.
Required: param, to
Modifiers: with
- namespace:
Usage: namespace <ns> [<subcontext>] param <parameter> to <value>
ns - The name of the namespace you would like to configure.
subcontext - The namespace subcontext where the parameter is located.
[default: None]
param - The namespace configuration parameter.
to - The value to assign to the parameter.
Required: param, to
Modifiers: with
- set:
Usage: namespace <ns> set <set> param <parameter> to <value>
ns - The namespace you would like to configure.
set - The set subcontext you would like to configure.
param - The namespace configuration parameter.
to - The value to assign to the parameter.
Required: param, to
Modifiers: with
- xdr:
Usage: xdr param <parameter> to <value>
param - The XDR configuration parameter.
to - The value to assign to the parameter.
Required: param, to
Modifiers: with
- dc:
Usage: xdr dc <dc> param <parameter> to <value>
dc - The XDR datacenter you would like to configure.
param - The XDR configuration parameter.
to - The value to assign to the parameter.
- namespace:
Usage: xdr dc <dc> namespace <ns> param <parameter> to <value>
dc - The XDR datacenter you would like to configure.
namespace - The datacenter namespace you would like to configure.
param - The security configuration parameter.
to - The value to assign to the parameter.
Required: param, to
Modifiers: with
- add:
- node:
Usage: xdr dc <dc> add node <ip:port>
dc - The XDR datacenter you would like to configure.
node - The node address to add to the datacenter.
Modifiers: with
- namespace:
Usage: xdr dc <dc> add namespace <ns> [rewind <seconds>|all]
dc - The XDR datacenter you would like to configure.
namespace - The namespace to add to the datacenter.
rewind - Number of seconds to rewind a namespace's shipment of records.
Use 'all' to restart shipment completely.
Note: When you are rewinding, the namespace to rewind must already have been
configured.
Modifiers: rewind, with
- remove:
- node:
Usage: xdr dc <dc> remove node <ip:port>
dc - The XDR datacenter you would like to configure.
node - The node address to remove from the datacenter.
Modifiers: with
- namespace:
Usage: xdr dc <dc> remove namespace <ns>
dc - The XDR datacenter you would like to configure.
namespace - The namespace to remove from the datacenter.
Modifiers: with
- create:
Usage: xdr create dc <dc>
dc - The name of the XDR datacenter you would like to create.
Required: dc
Modifiers: with
- delete:
Usage: xdr delete dc <dc>
dc - The name of the XDR datacenter you would like to delete.
Required: dc
Modifiers: with
- acl:
"manage acl" is used to manage users and roles.
- create:
- user:
Usage: create user <username> [password <password>] [roles <role1> <role2> ...]
username - Name of the new user.
password - Password for the new user. User will be prompted if no
password is provided.
roles - Roles to be granted to the user.
[default: None]
Modifiers: password, roles
- role:
Usage: create role <role-name> priv <privilege> [ns <namespace> [set <set>]] [allow <addr1> [<addr2> [...]]] [read <read-quota>] [write <write-quota>]
role-name - Name of the new role.
priv - Privilege for the new role. Some privileges are not
limited to a global scope. Scopes are either global, per
namespace, or per namespace and set.
[default: None]
ns - Namespace scope of privilege.
[default: None]
set - Set scope of privilege. Namespace scope is required.
[default: None]
allow - Addresses of nodes that a role will be allowed to connect
to a cluster from.
[default: None]
read - Quota for read transaction (TPS).
write - Quota for write transaction (TPS).
Required: priv
Modifiers: allow, ns, read, set, write
- delete:
- user:
Usage: delete user <username>
username - User to delete.
- role:
Usage: delete role <role-name>
role-name - Role to delete.
- grant:
- user:
Usage: grant user <username> roles <role1> [<role2> [...]]
username - User to have roles granted.
roles - Roles to add to the user.
Required: roles
- role:
Usage: grant role <role-name> priv <privilege> [ns <namespace> [set <set>]]>
role-name - Role to have the privilege granted.
priv - Privilege to be added to the role.
ns - Namespace scope of privilege.
[default: None]
set - Set scope of privilege. Namespace scope is required.
[default: None]
Required: priv
Modifiers: ns, set
- revoke:
- user:
Usage: revoke user <username> roles <role1> [<role2> [...]]
username - User to have roles revoked.
roles - Roles to delete from the user.
Required: roles
- role:
Usage: revoke role <role-name> priv <privilege> [ns <namespace> [set <set>]]>
role-name - Role to have privilege revoked.
priv - Privilege to delete from the role.
ns - Namespace scope of privilege
[default: None]
set - Set scope of privilege. Namespace scope is required.
[default: None]
Required: priv
Modifiers: ns, set
- set-password:
Usage: set-password user <username> [password <password>]
username - User to have password set.
password - Password for the user. A prompt will appear if no
password is provided.
Modifiers: password
- change-password:
Usage: change-password user <username> [old <old-password>] [new <new-password>]
username - User that needs a new password.
old - Current password for the user. User will be
prompted if no password is provided.
new - New password for the user. User will be prompted
if no password is provided.
Required: user
Modifiers: new, old
- allowlist:
Usage: allowlist role <role-name> allow <addr1> [<addr2> [...]]
role-name - Role that will have the new allowlist.
allow - Addresses of nodes that a role will be allowed to connect
from. This command erases and re-assigns the allowlist
Usage: allowlist role <role-name> clear
role-name - Role that will have the allowlist cleared.
clear - Clears allowlist from the role. Either 'allow' or 'clear' is
required.
Required: role
Modifiers: allow, clear
- quotas:
Usage: quotas role <role-name> [read <read-quota>]|[write <write-quota>]
role-name - Role to assign a quota
read - Quota for read transaction (TPS). To give a role
an unlimited quota enter 0
write - Quota for write transaction (TPS).
Note: A read or write quota is required. Not providing a quota will
leave it unchanged.
Required: role
Modifiers: read, write
- show:
"show" is used to display Aerospike Statistics configuration.
- distribution:
"show distribution" is used to show the distribution of object sizes
and time to live for node and a namespace.
Modifiers: for, with
Default: Shows the distributions of Time to Live and Object Size
- object_size:
Shows the distribution of Object sizes for namespaces
Options:
-b - Force to show byte wise distribution of Object Sizes.
Default is rblock wise distribution in percentage
-k <buckets> - Maximum number of buckets to show if -b is set.
It distributes objects in same size k buckets and
displays only buckets that have objects in them.
[default is 5].
- time_to_live:
Shows the distribution of TTLs for namespaces
- mapping:
"show mapping" is used to display Aerospike mapping from IP to Node_id and Node_id to IPs
Modifiers: like
Default: Displays mapping IPs to Node_id and Node_id to IPs
- ip:
Displays IP to Node_id mapping
- node:
Displays Node_id to IPs mapping
- pmap:
Displays partition map analysis of the Aerospike cluster.
- best-practices:
Displays any of Aerospike's violated "best-practices".
Modifiers: with
- jobs:
Displays jobs and associated metadata.
Modifiers: like, trid, with
Default: "show jobs" displays jobs from all available modules.
- queries:
Displays query jobs. For easier viewing run "page on" first.
Usage: queries [trid <trid1> [<trid2>]]
trid - List of transaction ids to filter for.
- scans:
Displays scan jobs. For easier viewing run "page on" first.
Removed in server v. 6.0 and later.
Usage: scans [trid <trid1> [<trid2>]]
trid - List of transaction ids to filter for.
- sindex-builder:
Displays sindex-builder jobs. Removed in server v. 5.7 and later.
Usage: sindex-builder [trid <trid1> [<trid2>]]
trid - List of transaction ids to filter for.
- racks:
Displays rack information for a rack-aware cluster.
Modifiers: with
- roster:
Displays roster information per node. Use the "diff" modifier to
to show differences between node rosters. For easier viewing run "page on" first.
Options:
--flip - Flip output table to show nodes on X axis and roster on Y axis.
Modifiers: diff, for, with
- roles:
Displays roles and their assigned privileges, allowlist, and quotas
for the Aerospike cluster.
Usage: roles [role]
role - Display output for a single role.
- users:
Displays users and their assigned roles, connections, and quota metrics
for the Aerospike cluster.
Usage: users [user]
user - Display output for a single user.
- udfs:
Displays UDF modules along with metadata.
Modifiers: for, like
- sindex:
Displays secondary indexes and static metadata.
Modifiers: like
- config:
"show config" is used to display Aerospike configuration settings
Modifiers: diff, for, like, with
Default: Displays security, service, network, and namespace configuration
Options:
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and config on X axis.
- dc:
DEPRECATED: Replaced by 'show config xdr'
Displays datacenter configuration.
Options:
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and config on X axis.
- namespace:
Displays namespace configuration. Use the 'for' modifier to filter by namespace.
Options:
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and config on X axis.
- network:
Displays network configuration
Options:
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and config on X axis.
- security:
Displays security configuration
Options:
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and config on X axis.
- service:
Displays service configuration
Options:
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and config on X axis.
- xdr:
'show config xdr' displays Aerospike XDR configuration settings.
Modifiers: diff, for, like, with
Default: Displays XDR, XDR datacenter, and XDR namespace configuration. Use the 'for' modifier to filter
by dc or by namespace. Use the available sub-commands for more granularity.
Options:
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and config on X axis.
- dc:
Displays XDR datacenter configuration. Use the 'for' modifier to filter by dc.
Options:
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and config on X axis.
- filter:
Displays XDR filters. Use the 'for' modifier to filter by DC and then by namespace.
Options:
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and config on X axis.
- namespace:
Displays XDR namespace configuration. Use the 'for' modifier to filter by namespace and then by DC.
Options:
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and config on X axis.
- latencies:
"show latencies" shows the server latency histograms
Modifiers: for, like, with
Default: Displays latency information for the Aerospike cluster.
Options:
-e - Exponential increment of latency buckets, i.e. 2^0 2^(e) ... 2^(e * i)
[default: 3]
-b - Number of latency buckets to display.
[default: 3]
-v - Set to display verbose output of optionally configured histograms.
- statistics:
"show statistics" displays statistics.
Modifiers: for, like, with
Default: Displays bin, set, service, and namespace statistics
Options:
-t - Set to show total column at the end. It contains node wise sum for statistics.
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and stats on X axis.
- bins:
Displays bin statistics. Use the 'for' modifier to filter by namespace.
Options:
-t - Set to show total column at the end. It contains node wise sum for statistics.
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and stats on X axis.
- dc:
DEPRECATED: Replaced by 'show statistics xdr dc.'
Displays datacenter statistics.
Options:
-t - Set to show total column at the end. It contains node wise sum for statistics.
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and stats on X axis.
- namespace:
Displays namespace statistics. Use the 'for' modifier to filter by namespace.
Options:
-t - Set to show total column at the end. It contains node wise sum for statistics.
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and stats on X axis.
- service:
Displays service statistics.
Options:
-t - Set to show total column at the end. It contains node wise sum for statistics.
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and stats on X axis.
- sets:
Displays set statistics. Use the 'for' modifier to filter by namespace and then by set.
Options:
-t - Set to show total column at the end. It contains node wise sum for statistics.
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and stats on X axis.
- sindex:
Displays sindex statistics. Use the 'for' modifier to filter by namespace and then by sindex.
Options:
-t - Set to show total column at the end. It contains node wise sum for statistics.
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and stats on X axis.
- xdr:
"show statistics xdr" displays XDR statistics for Aerospike components.
Modifiers: diff, for, like, with
Default: Displays XDR, XDR datacenter, and XDR namespace statistics. Use the 'for' modifier to filter by DC
or by namespace.
Options:
-t - Set to show total column at the end. It contains node wise sum for statistics.
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and stats on X axis.
- dc:
Displays XDR datacenter statistics. Use the 'for' modifier to filter by DC.
Options:
-t - Set to show total column at the end. It contains node wise sum for statistics.
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and stats on X axis.
- namespace:
Displays XDR namespace statistics. Use the 'for' modifier to filter by namespace and then by DC.
Options:
-t - Set to show total column at the end. It contains node wise sum for statistics.
-r - Repeat output table title and row header after every <terminal width> columns.
[default: False, no repetition]
--flip - Flip output table to show nodes on Y axis and stats on X axis.
--by-dc - Display each datacenter as a new table rather than each namespace. Makes it easier
to identify issues belonging to a particular namespace
[default: False, by namespace]
- info:
The "info" command provides summary tables for various aspects
of Aerospike functionality.
Modifiers: for, with
Default: Displays network, namespace, and XDR summary information.
- dc:
"info dc" displays summary information for each datacenter.
Replaced by "info xdr" for server >= 5.0.
- network:
"info network" displays network information for Aerospike.
- set:
"info set" displays summary information for each set.
- sindex:
"info sindex" displays summary information for Secondary Indexes (SIndex).
- xdr:
"info xdr" displays summary information for each datacenter.
- namespace:
"info namespace" command provides summary tables for various aspects
of Aerospike namespaces.
Modifiers: with
Default: Displays usage and objects information for namespaces
- object:
Displays object information for each namespace.
- usage:
Displays usage information for each namespace.