Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ML1 and version 9.2

...

Info

If you receive this message, Using cached node details, clx is leveraging relying on cached information that may not reflect the current state of your cluster. Contact Clustrix Support if this is unexpected or raises concerns.

...

OptionDescription
-C, --use-cacheUse cached cluster information, do not attempt to query the database for this information. Functions which rely on database information will not work normally.
-h, --helpShow this help message and exit.
-n NODE, --node=NODE

Run on a specific node, not the entire cluster. May be specified more than once to select multiple nodes. Accepts nodeid or hostname.

(Not presently supported for clx slave and clx cache)

-U DB_USER, --db-user=DB_USERLogin user for SQL connections to the local node. [default: rootlogged in OS user]
-X EXCLUDE, --exclude=EXCLUDE 

Exclude a specific node from this command. May be specified more than once to exclude multiple nodes. Accepts nodeid or hostname.
Supersedes the -n option, if the same node is specified for both.

(Not presently supported for clx slave and clx cache)

...

Table of Contents
maxLevel2
minLevel2
typeflat

Anchor
alters
alters
alters

Provides the status of ALTER statements in progress based on system.alter_progress

Anchor
cache
cache
cache

Immediately updates the filesystem cache with node information. Providing this command is typically not necessary as the filesystem cache is saved automatically each time clx connects to a database with all nodes in quorum.

shell> clx [options] cache

Command-Specific Option Exceptions

...

clx cmd date
clx cmd 'df -h | grep clustrix clx cmd 'ls -l /data/clustrix | df -h'

CommandCommand-Specific Options

-i SSH_KEY, --ssh-key=SSH_KEY

SSH Key file to use for private-key auth to other nodes. Uses environment variable $CLX_SSH_KEY, if specified. [default: /root~/.ssh/id_rsa]

-l SSH_USER, --ssh-user=SSH_USER

Login account for SSH connections to other nodes.
Note: non-root users cannot currently use SSH Hostbased Authentication. [default: rootcurrent user]

-P, --parallelExecute on all nodes simultaneously.
-p SSH_PORT, --ssh-port=SSH_PORTPort to use for SSH connections to other nodes. Uses environment variable $CLX_SSH_PORT, if specified. [default: 22]
-S, --skip-down-nodes  Skip nodes that are offline or unavailable instead of aborting when one or more nodes does not respond.
-w, --no-passwdDo not attempt password SSH authentication.

...

logdump also allows ClustrixDB messages file to be selected. If no log file is specified, logdump defaults to clustrix.log. ( The .log suffix is optional.)

shell> clx [options] logdump [log files]

...

-a, --archive                      Collect individual logfiles into one stdout or logfile, then tar and compressa tar file. This option disables the --limit value and captures everything between --start and --end.
-e END, --end=END Specify log end time offset in hours after --start (decimals accepted,) or a timestamp string like '2016-02-14 22:51:48' or '2016-02-14 22' (units left off will be zeroed.)

Use a value of 0 (default) to use no end time boundary and read until the end of file. [default: 0 hours]

-i SSH_KEY, --ssh-key=SSH_KEY SSH Key file to use for private-key auth to other nodes. Uses environment variable $CLX_SSH_KEY, if specified. [default: /root~/.ssh/id_rsa]
-l SSH_USER, --ssh-user=SSH_USERLogin account for SSH connections to other nodes.
Note: non-root users cannot currently use SSH Hostbased Authentication. [default: rootcurrent user]
-L LIMIT, --limit=LIMIT

Specify the maximum amount (in kB) to collect from each log file. If any file hits this size limit before the specified --start time, the first line from that log will be used in place of the start time, so all logs will be collected from the same time range.

Specify a value of 0 to disable this limit. [default: 10,240 kB. [default: 10 MiB]. Disabling this limit or setting it too high can starve other processes.

-N, --no-sortDisable sorting log files together by time, print just one at a time.
-p SSH_PORT, --ssh-port=SSH_PORTPort to use for SSH connections to other nodes. Uses environment variable $CLX_SSH_PORT, if specified. [default: 22]
-s START, --start=STARTSpecify log start time offset in hours (decimals accepted,) or a timestamp string like '2016-02-14 22:51:48' or '2016-02-14 22' (units left off will be zeroed.)

Use a value of 0 to use no start time boundary and just use the -L size limit. [default: 3 hours]

-S, --skip-down-nodes  Skip nodes that are offline or unavailable instead of aborting when one or more nodes does not respond.
-w, --no-passwdDo not attempt password SSH authentication.

Anchor
logfreq
logfreq
logfreq

Prints a count of matching log lines from the cluster.

shell> clx [options] logfreq search_string [log files]

If no log files are specific, this will default to clustrix.log.

command-specific options

--case-sensitiveInclude this option for case sensitive matching.
-e END, --end=END Specify log end time offset in hours after --start (decimals accepted,) or a timestamp string like '2016-02-14 22:51:48' or '2016-02-14 22' (units left off will be zeroed.)

Use a value of 0 (default) to use no end time boundary and read until the end of file. [default: 0 hours]

-i SSH_KEY, --ssh-key=SSH_KEY SSH Key file to use for private-key auth to other nodes. Uses environment variable $CLX_SSH_KEY, if specified. [default: ~/.ssh/id_rsa]
-l SSH_USER, --ssh-user=SSH_USERLogin account for SSH connections to other nodes.
Note: non-root users cannot currently use SSH Hostbased Authentication. [default: current user]
-N, --no-sortDisable sorting log files together by time, print just one at a time.
-p SSH_PORT, --ssh-port=SSH_PORTPort to use for SSH connections to other nodes. Uses environment variable $CLX_SSH_PORT, if specified. [default: 22]
-s START, --start=STARTSpecify log start time offset in hours (decimals accepted,) or a timestamp string like '2016-02-14 22:51:48' or '2016-02-14 22' (units left off will be zeroed.)

Use a value of 0 to use no start time boundary and just use the -L size limit. [default: 3 hours]

-S, --skip-down-nodes  Skip nodes that are offline or unavailable instead of aborting when one or more nodes does not respond.
-w, --no-passwdDo not attempt password SSH authentication.


Anchor
logsearch
logsearch
logsearch

Search log files from the cluster.

shell> clx [options] logsearch search_string [log files]

If no log files are specific, this will default to clustrix.log.

command-specific options

--case-sensitiveInclude this option for case sensitive matching.
-e END, --end=END Specify log end time offset in hours after --start (decimals accepted,) or a timestamp string like '2016-02-14 22:51:48' or '2016-02-14 22' (units left off will be zeroed.)

Use a value of 0 (default) to use no end time boundary and read until the end of file. [default: 0 hours]

-i SSH_KEY, --ssh-key=SSH_KEY SSH Key file to use for private-key auth to other nodes. Uses environment variable $CLX_SSH_KEY, if specified. [default: ~/.ssh/id_rsa]
-l SSH_USER, --ssh-user=SSH_USERLogin account for SSH connections to other nodes.
Note: non-root users cannot currently use SSH Hostbased Authentication. [default: current user]
-N, --no-sortDisable sorting log files together by time, print just one at a time.
-p SSH_PORT, --ssh-port=SSH_PORTPort to use for SSH connections to other nodes. Uses environment variable $CLX_SSH_PORT, if specified. [default: 22]
-s START, --start=STARTSpecify log start time offset in hours (decimals accepted,) or a timestamp string like '2016-02-14 22:51:48' or '2016-02-14 22' (units left off will be zeroed.)

Use a value of 0 to use no start time boundary and just use the -L size limit. [default: 3 hours]

-S, --skip-down-nodes  Skip nodes that are offline or unavailable instead of aborting when one or more nodes does not respond.
-w, --no-passwdDo not attempt password SSH authentication.

Anchor
nanny
nanny
nanny

Executes a nanny command on nodes. For the description of the nanny process and the individual nanny commands available, please see the Overview of Nanny.

...

-P, --parallelExecute on all nodes simultaneously.
-S, --skip-down-nodes  Skip nodes that are offline or unavailable instead of aborting when one or more nodes does not respond.
-T TIMEOUT, --timeout=TIMEOUTSpecify the timeout before failing a Telnet connection (in seconds).

Anchor
pubkeyinstall
pubkeyinstall
pubkeyinstall

Uses password auth to generate public keypairs on each node and add them to each node's authorized_keys file. For more information, see Configure SSH Authentication.

Anchor
pull
pull
pull

Copies files from nodes to local. This command is only available to root users. If no destination is specified, the current directory name will be used. The nodeid or hostname is appended to the retrieved name.

...

-i SSH_KEY, --ssh-key=SSH_KEYSSH Key file to use for private-key auth to other nodes. Uses environment variable $CLX_SSH_KEY, if specified. [default: ~/root/.ssh/id_rsa]
-l SSH_USER, --ssh-user=SSH_USERLogin account for SSH connections to other nodes.
Note: non-root users cannot currently use SSH Hostbased Authentication. [default: rootcurrent user]
-p SSH_PORT, --ssh-port=SSH_PORTPort to use for SSH connections to other nodes. [default: 22]
-S, --skip-down-nodes  Skip nodes that are offline or unavailable instead of aborting when one or more nodes does not respond.
-w, --no-passwdDo not attempt password SSH authentication.

...

-i SSH_KEY, --ssh-key=SSH_KEYSSH Key file to use for private-key auth to other nodes. Uses environment variable $CLX_SSH_KEY, if specified. [default: /root~/.ssh/id_rsa]
-l SSH_USER, --ssh-user=SSH_USERLogin account for SSH connections to other nodes.
Note: non-root users cannot currently use SSH Hostbased Authentication. [default: rootcurrent user]
-p SSH_PORT, --ssh-port=SSH_PORTPort to use for SSH connections to other nodes. [default: 22]
-S, --skip-down-nodes  Skip nodes that are offline or unavailable instead of aborting when one or more nodes does not respond.
-w, --no-passwdDo not attempt password SSH authentication.

...