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.
info
Asadm's help output was shortened and improved in Aerospike Tools package version 8.5.0 (asadm 2.16.0) and later.
Admin> help
A tool for interacting with your Aerospike cluster.
Usage: COMMAND
Commands:
Default Print this help message
asinfo Provides raw access to the info protocol
collectinfo Collects cluster info, system stats, and aerospike conf file for local node
disable Exits privileged mode
enable Enters privileged mode
exit Terminate session
features Lists the features in use in a running Aerospike cluster
info Provides summary tables for various aspects of Aerospike functionality
manage Administrative tasks like managing users, roles, udf, and sindexes
pager Turn terminal pager on or off
show A collection of commands used to display information about the Aerospike cluster
summary Displays summary of Aerospike cluster
watch Runs a command for a specified pause and iterations
Run 'help COMMAND' for more information on a command.