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.1

...

Table of Contents
maxLevel2
minLevel2

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.

...

-n NODE, --node=NODEOption to run on a specific node has no effect for this command.
-X EXCLUDE, --exclude=EXCLUDE 

Option to exclude a specific node has no effect for this command.

Anchor
cmd
cmd
cmd

Executes shell command(s) on nodes. Multiple commands may be supplied if enclosed in quotation marks and separated by a semicolon (;) or a pipe (|) character.

...

-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: root]

-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.

Anchor
cp
cp
cp

Executes a control port command on nodes.

...

-T TIMEOUT, --timeout=TIMEOUTSpecify the timeout before failing a Telnet connection (in seconds).

Anchor
dbstart
dbstart
dbstart

Starts the database process (clxnode) on nodes.

...

-T TIMEOUT, --timeout=TIMEOUTSpecify the timeout before failing a Telnet connection (in seconds).

Anchor
dbstop
dbstop
dbstop

Stops the database process (clxnode) on nodes. This effectively shuts down the cluster.

...

-T TIMEOUT, --timeout=TIMEOUTSpecify the timeout before failing a Telnet connection (in seconds).

Anchor
debugdump
debugdump
debugdump

Gathers detailed debug information from the cluster to aid troubleshooting by Clustrix Support and Engineering. ClustrixDB assigns an output file if none is specified and displays the name assigned at the end of the process.

...

--cp-threads=CPTHREADSSpecify how many cp commands to dump in parallel [default: 5 threads]
--overwrite=OVERWRITEOverwrite an existing file if one exists at the output path.
-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).
-v, --verboseDisplay more details.

Anchor
disk
disk
disks

Displays disk information for the cluster.

...

shell> clx [options] help [command]

Anchor
logdump
logdump
logdump

Dumps log files from the cluster. Specify  ‘all’  to show clustrix.log, query.log, nanny.log, and debug.log, or list the Clustrix and/or system logs that you’d like to see.

...

-a, --archive                      Collect individual logfiles into one stdout or logfile, then tar and compress. 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: root]
-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]

-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
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: root]
-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.

Anchor
push
push
push

Copies a file from local to nodes. If no destination is specified, the current directory name will be used on all nodes. 

...

-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: root]
-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.

Anchor
slave
slave
slave

Displays replication slave information.

...

-n NODE, --node=NODEOption to run on a specific node has no effect for this command.
-X EXCLUDE, --exclude=EXCLUDE 

Option to exclude a specific node has no effect for this command.

Anchor
space
space
space

Displays storage utilization information for the cluster.

...