NuoDB Command Reference

--db-name

the name of the database for the archive

$NUOCMD_DB_NAME (required)

--server-id

the ID of the server for the archive

--is-external

whether this archive will be externally started

--archive-path

the path of the archive directory

(required)

--journal-path

the path of the journal directory

--snapshot-archive-path

the path of the snapshot archive directory

--restored

whether the archive being restored from existing data

--archive-id

if specified, the archive ID of the removed archive

--passive

whether the archive should passively observe all storage groups that it serves

--observes

list of storage groups the archive should observe passively

--archive-id

the ID of the archive to delete

(required)

--purge

whether to remove the archive permanently

--archive-id

The id of the archive

(required)

--active

Promote the specified archive to an active server of all storage groups that it serves

--serves

Promote the specified archive to an active server of the named storage groups

--passive

Demote the specified archive to a passive observer of all storage groups that it serves

--observes

Demote the specified archive to a passive observer of the named storage groups

--db-name

the name of the database to list archives for

$NUOCMD_DB_NAME

--removed

show removed archives

--db-name

the name of the database to list archives for

$NUOCMD_DB_NAME

--removed

show removed archives

--archive-format

format string for archives

$NUOCMD_ARCHIVE_FORMAT / [{id}] {server_id} : {archive_path} @ {db_name} [journal_path = {journal_path::}] [observer_storage_groups = {observer_storage_groups::}] {state}

--removed-archive-format

format string for removed archives

$NUOCMD_REMOVED_ARCHIVE_FORMAT / [{id}] {server_id} : {archive_path} @ {db_name} [journal_path = {journal_path::}] [observer_storage_groups = {observer_storage_groups::}] REMOVED({state})

--process-format

format string for processes

$NUOCMD_PROCESS_FORMAT / [{engine_type}] {address::<UNKNOWN ADDRESS>} [start_id = {start_id}] [server_id = {server_id}] [pid = {pid::}] [node_id = {node_id::}] [last_ack = {last_ack:5.2f:>60}] {durable_state}:{engine_state}

--exited-process-format

format string for exited processes

$NUOCMD_EXITED_PROCESS_FORMAT / [{process.engine_type}] {process.address::<UNKNOWN ADDRESS>} [start_id = {process.start_id}] [server_id = {process.server_id}] [pid = {process.pid::}] [node_id = {process.node_id::}] EXITED({process.durable_state}:{process.engine_state}):{reason} ({exit_code::?})

--keystore

the keystore containing the certificate

(required)

--store-type

the type of the keystore; is derived from --keystore value if not specified (choices: JKS, PKCS12)

--alias

the alias of the certificate; is derived from --keystore value if not specified

--store-password

the password for the keystore; can also be specified via standard input

--truststore

the keystore containing trusted certificates

(required)

--truststore-type

the type of the truststore; is derived from --truststore value if not specified (choices: JKS, PKCS12)

--truststore-password

the password for the truststore; can also be specified via standard input

--for-recovery

store the certificate so that it is protected from truststore updates made using nuocmd add/remove trusted-certificates

--nuokey-cmd

the path to the nuokeymgr executable

$NUOCMD_NUOKEY_CMD / $NUODB_HOME/etc/nuokeymgr

--keystore

the keystore to extract key-pair or certificate from

(required)

--store-type

the type of the keystore; is derived from --keystore value if not specified (choices: JKS, PKCS12)

--alias

the alias of the key-pair or certificate; is derived from --keystore value if not specified

--store-password

the password for the keystore; can also be specified via standard input

--key-password

the password for the private key; if --key-password and --prompt-key-password are not specified, defaults to --store-password value

--prompt-key-password

whether to prompt for private key password if --key-password is not specified

--cert-only

whether to only export the certificate

--nuokey-cmd

the path to the nuokeymgr executable

$NUOCMD_NUOKEY_CMD / $NUODB_HOME/etc/nuokeymgr

--keystore

the keystore containing the certificate to sign

(required)

--store-type

the type of the keystore; is derived from --keystore value if not specified (choices: JKS, PKCS12)

--alias

the alias of the certificate; is derived from --keystore value if not specified

--store-password

the password for the keystore; can also be specified via standard input

--ca-keystore

the keystore containing the CA certificate

(required)

--ca-store-type

the type of the CA keystore; is derived from --ca-keystore value if not specified (choices: JKS, PKCS12)

--ca-alias

the alias of the CA certificate; is derived from --ca-keystore value if not specified

--ca-store-password

the password for the CA keystore; can also be specified via standard input

--update

whether to update the keystore with the signed certificate; if not specified, the certificate chain is written to standard output

--sub-altnames

list of subjectAltNames for the certificate; must be prefixed by type, e.g. dns:hostname

--resolve-san

whether to resolve subjectAltName using DNS, e.g. dns:hostname

--validity

the validity in days of the certificate

365

--start-date

start date of the certificate

--ca

whether the generated certificate should be used as CA

--nuokey-cmd

the path to the nuokeymgr executable

$NUOCMD_NUOKEY_CMD / $NUODB_HOME/etc/nuokeymgr

--start-id

the start ID of the process to get core file for

(required)

--output

the output file or format for output file

$NUOCMD_OUTPUT / core.nuodb.{db_name}.{hostname::}.{start_id}.gz

--output-dir

the directory to store core file in; the actual file path will be resolved relative to this directory

--socket-read-timeout

The maximum time (in seconds) to block waiting for data from an engine

--db-name

the name of the database to check

$NUOCMD_DB_NAME (required)

--password

the storage password to verify and propagate to all admin servers and database processes

(required)

--existing-passwords

any other storage passwords needed to decrypt archives in the specified database

--config-update-timeout

How long (in seconds) to wait for configuration to be updated for each process

--timeout

How long (in seconds) to wait for data encryption check to pass

--wait-forever

Wait forever for data encryption check to pass

--db-name

the name of the database whose storage password to update

$NUOCMD_DB_NAME (required)

--new-password

the new storage password to use with the specified database

(required)

--current-password

the current storage password, used for verification

--is-initial-password

whether the --new-password value is the initial storage password for the database

--existing-passwords

any other storage passwords needed to decrypt archives in the specified database

--config-update-timeout

How long (in seconds) to wait for configuration to be updated for each process

--db-name

the name of the database to capture

$NUOCMD_DB_NAME (required)

--capture-file

the path to the file to write startplan to

(required)

--db-name

The name of the database to check

$NUOCMD_DB_NAME (required)

--timeout

How long (in seconds) to wait for database check to pass

--wait-forever

Wait forever for database check to pass

--check-running

Check that the database is in the RUNNING state

--check-syncing

Check that all processes in the database are in the SYNCING or RUNNING state

--num-processes

Check that the database contains the specified number of processes

--check-liveness

Check that all processes have responded within the specified number of seconds

--wait-for-acks

If specified along with --timeout, wait for messages to be received from all processes while the command is running

--fail-on-process-exit

If specified along with --timeout, fail-fast if a process exits while the command is running

--db-name

the name of the database to connect to

$NUOCMD_DB_NAME (required)

--server-id

the ID of the server to use to obtain SQL connection

--this-server

whether to obtain SQL connection through API server

--user

the database user; alternatively, can be specified using the NUOSQL_USER environment variable

--password

the database password; alternatively, can be specified using the NUOSQL_PASSWORD environment variable, or via standard input

--nuosql-cmd

the command to invoke the NuoSQL executable

$NUOCMD_NUOSQL_CMD / $NUODB_HOME/bin/nuosql

--connection-properties

connection properties for connection request

$NUOCMD_CONNECTION_PROPERTIES

--db-name

the name of the database

$NUOCMD_DB_NAME (required)

--dba-user

the database administrator user

$NUOCMD_DBA_USER (required)

--dba-password

the database administrator password

$NUOCMD_DBA_PASSWORD (required)

--te-server-ids

the IDs of the servers to start TEs on

--capture-file

the path to the file to capture database to

--nuodb-cmd

the command to invoke the NuoDB executable, if starting externally (deprecated)

--no-autostart

do not automatically start database

--is-external

whether database processes will be started externally (deprecated)

--archive-assignment

mapping of archive ID to server ID, for external start (deprecated)

--region-assignment

mapping of server ID to region name (deprecated)

--default-options

default options for database processes; see https://doc.nuodb.com/nuodb/latest/reference-information/database-options

--sms-running-timeout

timeout for SMs to become RUNNING before starting TEs

--db-name

the name of the database to delete

$NUOCMD_DB_NAME (required)

--purge

Removes historical database state data from the Admin Domain.

--db-name

name of the database to diagnose

$NUOCMD_DB_NAME (required)

--output-dir

directory for output files

--timeout

timeout in seconds

action

diagnose action to perform

target

target of diagnose action

arguments

diagnose operation arguments

--capture-file

the path to the capture file to enforce

(required)

--incremental

start the database incrementally based on running state

--unconditional

start any non-running database processes regardless of the database state

--nuodb-cmd

the command to invoke the NuoDB executable, if starting externally (deprecated)

--sms-running-timeout

timeout for SMs to become RUNNING before starting TEs

--db-name

the name of the database

$NUOCMD_DB_NAME (required)

--db-name

The name of the database to hand off

$NUOCMD_DB_NAME (required)

--archive-ids

The archive ids in the passive datacenter being promoted

--all-observer-archive-ids

Use all observers in handoff

--oldest-acceptable

Optional. If provided, handoff will only proceed if the most recent consistent state available, to which the databse state would be reset, is after the provided date/time. Timestamp must be in the form 'YYYY-MM-DDThh:mm:ss'

--timeout

The number of seconds to wait for each step of handoff

300

--db-name

the name of the database to hot-copy

$NUOCMD_DB_NAME (required)

--type

the type of hot-copy to perform; --type simple will produce an archive at the backup location; all other --type values will produce a backup set at the backup location (choices: simple, full, incremental, journal)

(required)

--shared

whether the backup location specified by --default-backup-dir is on shared storage

--default-backup-dir

backup location to use for any archive that does not have a backup location associated with it by --backup-dirs; if --process-filter is used, the --default-backup-dir should be supplied and provides the backup location prefix for filtered archives

--process-filter

if specified, filter database processes to only hot-copy those that match

--backup-dirs

map of archive ID to backup location to use for that archive

--max-rate

maximum I/O rate in MB/sec

--partial-storage-groups

hot copy an archive set that does not include all the storage groups defined in the database; restoring from such a backup could cause data loss or inconsistent data; by default all database storage groups must be included

--timeout

if specified, the time to wait in seconds for the hot-copy to complete; if not specified, the request is issued asynchronously

--db-name

the database name

$NUOCMD_DB_NAME (required)

--num-incarnations

the number of incarnations to show starting from current

1

--all-incarnations

show all incarnations

--skip-exited

skip exited processes

--db-format

format string for databases

$NUOCMD_DB_FORMAT / {name} [state = {state}]

--process-format

format string for processes

$NUOCMD_PROCESS_FORMAT / [{engine_type}] {address::<UNKNOWN ADDRESS>} [start_id = {start_id}] [server_id = {server_id}] [pid = {pid::}] [node_id = {node_id::}] [last_ack = {last_ack:5.2f:>60}] {durable_state}:{engine_state}

--exited-process-format

format string for exited processes

$NUOCMD_EXITED_PROCESS_FORMAT / [{process.engine_type}] {process.address::<UNKNOWN ADDRESS>} [start_id = {process.start_id}] [server_id = {process.server_id}] [pid = {process.pid::}] [node_id = {process.node_id::}] EXITED({process.durable_state}:{process.engine_state}):{reason} ({exit_code::?})

--db-name

the name of the database to shutdown

$NUOCMD_DB_NAME (required)

--db-name

the name of the database to start

$NUOCMD_DB_NAME (required)

--te-server-ids

the IDs of the servers to start additional TEs on

--archive-assignment

mapping of archive ID to server ID, for external start (deprecated)

--incremental

start the database incrementally based on running state

--unconditional

start any non-running database processes regardless of the database state

--nuodb-cmd

the command to invoke the NuoDB executable, if starting externally (deprecated)

--sms-running-timeout

timeout for SMs to become RUNNING before starting TEs

--db-name

the database to get connectivity information for

(required)

--with-node-ids

whether to return connectivity graph with node IDs as keys instead of start IDs

--suppress-errors

whether to suppress errors messages when collecting connectivity information

--db-name

the database to show connectivity graph for

(required)

--with-node-ids

whether to show connectivity graph with node IDs as keys instead of start IDs

--last-ack-threshold

the threshold in seconds to display time since last ack

5

--db-name

the name of the database

$NUOCMD_DB_NAME (required)

--default-options

default options for database processes; see https://doc.nuodb.com/nuodb/latest/reference-information/database-options

--replace-all

whether to completely replace the existing options with the supplied options, rather than merging the two

--db-name

the database upgrade

(required)

--version

the version to upgrade to

--max-version

upgrade to maximum available version

--db-name

the database to show database versions for

(required)

--process-format

format string for processes

$NUOCMD_PROCESS_FORMAT / [{engine_type}] {address::<UNKNOWN ADDRESS>} [start_id = {start_id}] [server_id = {server_id}] [pid = {pid::}] [node_id = {node_id::}] [last_ack = {last_ack:5.2f:>60}] {durable_state}:{engine_state}

--output-dir

the directory to store diagnose info in

<current directory>

--no-pack

if specified, do not pack all diagnose info into a single ZIP file

--print-to-stdout

Print packed zip to stdout

--include-cores

whether to include cores from engine processes; this is shorthand for "--collect-cores --live-cores"

--live-cores

whether to stream live cores from running engine processes

--collect-cores

whether to collect cores created by engine processes

--modified-after

collect files modified after specified date. The value is converted to epoch timestamp using the client time zone. Timestamp must be in the form 'YYYY-MM-DDThh:mm:ss'

--socket-read-timeout

The maximum time (in seconds) that we will block waiting for data from an engine

--include-sensitive-files

whether to include potentially sensitive files, such as audit logs

--group-by-noun

if specified, group generated documentation by noun rather than verb

--command-handler

name of command handler class to generate documentation for

--title

title to use for page

--server-format

format string for servers

$NUOCMD_SERVER_FORMAT / [{id}] {address} [last_ack = {last_ack:.2f:NEVER}] {raft_state} ({role}, Leader={leader}, log={log_term::?}/{commit_index::?}/{log_index::?}) {observed_state}

--db-format

format string for databases

$NUOCMD_DB_FORMAT / {name} [state = {state}]

--process-format

format string for processes

$NUOCMD_PROCESS_FORMAT / [{engine_type}] {address::<UNKNOWN ADDRESS>} [start_id = {start_id}] [server_id = {server_id}] [pid = {pid::}] [node_id = {node_id::}] [last_ack = {last_ack:5.2f:>60}] {durable_state}:{engine_state}

--client-token

message to display in admin log

--include-tombstone-databases

include tombstones for deleted databases

--output

the output file to save captured domain state to

--coordinator-start-id

the start ID of the SM coordinating the hot-copy to cancel

(required)

--hotcopy-id

the ID of the hot-copy request to cancel

(required)

--timeout

if specified, the time to wait in seconds for the cancellation to be processed; it not specified, cancellation is issued asynchronously

--db-name

the name of the database to get hot-copy statuses for

--coordinator-start-id

the start ID of the SM to get hot-copy statuses for

--timeout

the timeout for the management request sent to the SMs to obtain hot-copy statuses

--running-for

if specified, filter hot-copy statuses to only include ones that have been running for the specified amount of time or longer; this value can be specified using d, h, m, or s as a suffix, with seconds (s) being the default if the suffix is omitted

--db-name

the name of the database to show hot-copy statuses for

(required)

--timeout

the timeout for the management request sent to the SMs to obtain hot-copy statuses

--running-for

if specified, filter hot-copy statuses to only include ones that have been running for the specified amount of time or longer; this value can be specified using d, h, m, or s as a suffix, with seconds (s) being the default if the suffix is omitted

--process-format

format string for processes

$NUOCMD_PROCESS_FORMAT / [{engine_type}] {address::<UNKNOWN ADDRESS>} [start_id = {start_id}] [server_id = {server_id}] [pid = {pid::}] [node_id = {node_id::}] [last_ack = {last_ack:5.2f:>60}] {durable_state}:{engine_state}

--hotcopy-format

format string for hot-copy statuses

$NUOCMD_HOTCOPY_FORMAT / {id} [{status}] {timestamp_range} : {message} ({stage})

--coordinator-start-id

the start ID of the SM coordinating the hot-copy

(required)

--hotcopy-id

the ID of the hot-copy request

(required)

--timeout

if specified, the time to wait in seconds for the hot-copy to complete; if not specified, the status is polled without waiting

--keystore

the keystore to store the generated key-pair into, which will be created if it does not exist

(required)

--store-type

the type of the keystore; is derived from --keystore value if not specified (choices: JKS, PKCS12)

--alias

the alias to store the key-pair as; is derived from --keystore value if not specified

--store-password

the password for the keystore; can also be specified via standard input

--key-password

the password for the private key; if --key-password and --prompt-key-password are not specified, defaults to --store-password value

--prompt-key-password

whether to prompt for private key password if --key-password is not specified

--dname

the distinguished name of the certificate

CN=<hostname>

--sub-altnames

list of subjectAltNames for the certificate; must be prefixed by type, e.g. dns:hostname

--resolve-san

whether to resolve subjectAltName using DNS, e.g. dns:hostname

--algorithm

the key algorithm (choices: RSA, DSA, EC)

RSA

--validity

the validity in days of the certificate

365

--start-date

start date of the certificate

--ca

whether the generated certificate should be used as CA

--license-file

the license file to check

(required)

--license-file

the license file to install

(required)

--allow-downgrade

whether to install the license regardless of whether it is a downgrade from the current license

--policy-name

the name of the load-balancer policy to delete

(required)

--policy-name

the name of the load-balancer policy to set

(required)

--lb-query

the load-balancer query to set

(required)

--db-name

the name to register default for

--is-global

whether to register the global default

--default

the default load-balancer to register

--unregister-default

whether to unregister the current default

--prefilter

the prefilter to register

--unregister-prefilter

whether to unregister the current prefilter

--log-options

the log levels and categories to enable

$NUOCMD_LOG_OPTIONS (required)

--db-name

the database to log messages for

--start-id

the running process to log messages for

--engine-file

write logging to this file on engine hosts

--log-options

the log levels and categories to enable

$NUOCMD_LOG_OPTIONS (required)

--db-name

the database to log messages for

--start-id

the running process to log messages for

--log-format

format string for process log messages

$NUOCMD_LOG_FORMAT / {msg[Time]}: [{engine_type}] {address} [start_id = {start_id}] [pid = {pid::}] [node_id = {node_id::}] {durable_state}:{engine_state} =>[{msg[Options]}] {msg[LogMessage]}

--engine-file

write logging to this file on engine hosts

--message

The message to log

(required)

--start-id

the Start ID of the process to check

(required)

--check-running

Check that the process is in the RUNNING state

--check-exited

Check that the process has exited

--check-liveness

Check that the process has responded within the specified number of seconds

--wait-for-ack

If specified along with --timeout, wait for a message to be received from the process while the command is running

--timeout

How long (in seconds) to wait for process check to pass

--wait-forever

Wait forever for process check to pass

--start-id

name of the database to diagnose

(required)

--output-dir

directory for output files

--timeout

timeout in seconds

action

diagnose action to perform

target

target of diagnose action

arguments

diagnose operation arguments

--start-id

the start ID of the process to shutdown

(required)

--evict

evict process from database and remove it from the domain state, even if it is unresponsive or no longer running; this command may not actually cause an unresponsive process to shutdown, in which case it would have to be killed manually by the user

--kill

forcibly kill process

--kill-with-core

forcibly kill process and dump core

--timeout

the timeout in seconds to wait for the process to disconnect from the admin server; if not specified, the shutdown request is issued without waiting

--db-name

the name of the database for the process

$NUOCMD_DB_NAME (required)

--server-id

the ID of the server the process belongs to

--this-server

whether to start process through API server

--engine-type

the engine type (choices: TE, SM, SSM)

--archive-id

the ID of the archive if engine-type is SM or SSM

--expected-incarnation

the expected incarnation for the database in the form '<major>[.<minor>]'

--nuodb-cmd

the command to invoke the NuoDB executable, if starting externally (deprecated)

--options

options for database process; see https://doc.nuodb.com/nuodb/latest/reference-information/database-options

--labels

labels for engine process

--db-name

the name of the database to list processes for

$NUOCMD_DB_NAME

--exited

get exited processes

--nuoadmin-jar

path to nuoadmin.jar

$NUOCMD_NUOADMIN_JAR / $NUODB_HOME/jar/nuoadmin.jar

--raftlog-dir

path to raftlog file

$NUOCMD_RAFTLOG_DIR / $NUODB_VARDIR

--one-line

whether to display the contents of each entry in one line

--name

the name of the region

(required)

--region-id

the ID of the region to delete

(required)

--db-name

the name of the database to add the region mapping for

$NUOCMD_DB_NAME (required)

--region-name

the name of the region to add servers to

--region-id

the ID of the region to add servers to

--server-ids

the IDs of the servers to add to region

(required)

--db-name

the name of the database to remove the region mapping for

$NUOCMD_DB_NAME (required)

--server-ids

the IDs of the servers to remove from region

(required)

--db-name

the database to show regions for

$NUOCMD_DB_NAME (required)

--region-format

format string for regions

$NUOCMD_REGION_FORMAT / [region = {name}]

--process-format

format string for processes

$NUOCMD_PROCESS_FORMAT / [{engine_type}] {address} [start_id = {start_id}] [pid = {pid::}] [node_id = {node_id::}] {durable_state}:{engine_state}

--db-name

The name of the database to hand off

$NUOCMD_DB_NAME (required)

--archive-ids

All archives in the passive datacenter

(required)

--timeout

The number of seconds to wait for all specified archives to be online

10

--db-name

The name of the database to hand off

$NUOCMD_DB_NAME (required)

--commits

The list of commit sequence numbers of the restored state as reported by handoff report-timestamp (in the form x x x …​ with no commas)

(required)

--epoch

The epoch of the restored state as reported by handoff report-timestamp

(required)

--leaders

The mapping of storage groups to leader archives (in the form <storage group id> <archive id> <storage group id> <archive id> …​) as reported by handoff report-timestamp

(required)

--name

the name of the role to create

(required)

--sub-roles

the sub-roles for the role

--any-method

authorize all request methods for role

--method

the request method to authorize for the role (choices: PUT, GET, POST, DELETE)

--url

the URL to authorize for the role, excluding the hostname and port (e.g. /api/1/databases)

--query-param-constraints

constraints to enforce on query parameters

--path-param-constraints

constraints to enforce on path parameters

--payload-param-constraints

constraints to enforce on payload parameters

--name

the name of the role to delete

(required)

--name

the name of the role to update

(required)

--sub-roles

the sub-roles to add

--any-method

authorize all request methods for role

--method

the request method to authorize for the role (choices: PUT, GET, POST, DELETE)

--url

the URL to authorize for the role, excluding the hostname and port (e.g. /api/1/databases)

--query-param-constraints

constraints to enforce on query parameters

--path-param-constraints

constraints to enforce on path parameters

--payload-param-constraints

constraints to enforce on payload parameters

--name

the name of the role to update

(required)

--sub-roles

the sub-roles to remove

--any-method

authorize all request methods for role

--method

the request method to authorize for the role (choices: PUT, GET, POST, DELETE)

--url

the URL to authorize for the role, excluding the hostname and port (e.g. /api/1/databases)

--query-param-constraints

constraints to enforce on query parameters

--path-param-constraints

constraints to enforce on path parameters

--payload-param-constraints

constraints to enforce on payload parameters

--name

the name of the role to update

(required)

--accessor

Add privileges to invoke get and show subcommands

--domain-admin

Add privileges to manage admin layer

--db-admin

Add privileges to manage a database

--hotcopy-admin

Add privileges to invoke hotcopy on a database and view hotcopy status

--name

the name of the role to update

(required)

--accessor

Remove privileges to invoke get and show subcommands

--domain-admin

Remove privileges to manage admin layer

--db-admin

Remove privileges to manage a database

--hotcopy-admin

Remove privileges to invoke hotcopy on a database and view hotcopy status

--timeout

How long (in seconds) to wait for server check to pass

--wait-forever

Wait forever for server check to pass

--check-active

Check that server is ACTIVE

--check-connected

Check that server is CONNECTED, to verify that it is reachable by its advertised address

--check-converged

Check that server has the same commit index as the leader

--server-id

the ID of the server to remove from the membership

(required)

--server-id

the ID of the server to shut down

--this-server

shutdown the server hosting this API server

--evict-local

evict processes local to the server being shutdown; this command may not actually cause an unresponsive process to shutdown, in which case it would have to be killed manually by the user

--server-id

the ID of the NuoAdmin server

--this-server

get the configuration of the API server

--property-key

get only a specific property

--output

the output file or directory to save the ZIP file containing server logs to

--include-core-files

whether to include core files of exited engine processes in the logs ZIP file

--dump-threads

whether to include a thread dump of the admin process in the logs ZIP file

--unpack

whether to unpack the downloaded ZIP file

--modified-after

collect files modified after specified date. The value is converted to epoch timestamp using the client time zone. Timestamp must be in the form 'YYYY-MM-DDThh:mm:ss'

--include-sensitive-files

whether to include potentially sensitive files, such as audit logs

--server-id

shut down all processes connected to the admin server with this server id

(required)

--db-name

only shut down processes if they belong to this database

--evict

evict processes from database and remove them from the domain state, even if they are unresponsive or no longer running; this command may not actually cause an unresponsive process to shutdown, in which case it would have to be killed manually by the user

--kill

forcibly kill processes

--kill-with-core

forcibly kill processes and dump core

--timeout

the timeout in seconds to wait for a process to disconnect from its admin server; if not specified, the shutdown request is issued without waiting

--server-id

the ID of the server to remove from domain state

(required)

--timeout

How long (in seconds) to wait for server check to pass

--wait-forever

Wait forever for server check to pass

--check-active

Check that all servers are ACTIVE

--check-connected

Check that all servers are CONNECTED to the server performing check

--check-leader

Check that all servers agree on a leader

--num-servers

Check that membership size equals specified number

--check-liveness

Check that all servers have responded within the specified number of seconds

--wait-for-acks

If specified along with --timeout, wait for messages to be received from all servers while the command is running

--check-converged

Check that all servers have the same commit index. This implies --check-leader.

--db-name

the database name in the SQL connection request

$NUOCMD_DB_NAME (required)

--connection-properties

connection properties for connection request

$NUOCMD_CONNECTION_PROPERTIES

--any-te

ignore default load balancing policies and return an arbitrary TE

--timeout

how long (in seconds) to wait for the check to pass

--wait-forever

wait forever for the process check to pass

--user

a database user to test. If omitted, check whether there is a suitable TE to service the SQL connection request without making a connection.

--password

the database user password

--nuosql-cmd

None

$NUOCMD_NUOSQL_CMD / $NUODB_HOME/bin/nuosql

--db-name

the name of the database to get a SQL connection for

$NUOCMD_DB_NAME (required)

--connection-properties

connection properties for connection request

$NUOCMD_CONNECTION_PROPERTIES

--db-name

the name of the database

$NUOCMD_DB_NAME (required)

--output-file

the path to the file to capture database to

(required)

--te-server-ids

the IDs of the servers to start additional TEs on

--archive-assignment

mapping of archive ID to server ID, for external start

--one-time

get a startplan for one-time use

--db-name

the database to get stats for

--start-id

the running process to get stats for

--db-name

the name of the database

$NUOCMD_DB_NAME (required)

--sg-name

the name of the storage group to add

(required)

--archive-ids

the IDs of the archives to add storage group to

(required)

--db-name

the name of the database

$NUOCMD_DB_NAME (required)

--sg-name

the name of the storage group to delete

(required)

--db-name

the name of the database

$NUOCMD_DB_NAME (required)

--sg-name

the name of the storage group to remove

(required)

--archive-ids

the IDs of the archives to remove storage group from

(required)

--db-name

the name of the database to list storage groups for

$NUOCMD_DB_NAME (required)

--db-name

the name of the database to list storage groups for

$NUOCMD_DB_NAME (required)

--storage-group-format

format string for storage groups

$NUOCMD_STORAGE_GROUP_FORMAT / [{id:>4}] [name = {name}] [state = {state}]

--process-format

format string for leader candidate processes

$NUOCMD_PROCESS_FORMAT / [{engine_type}] {address} [start_id = {start_id}] [pid = {pid::}] [node_id = {node_id::}] {durable_state}:{engine_state}

--alias

the alias of the certificate; this is a name used to refer to the certificate

(required)

--cert

the certificate to add to truststore as a PEM-encoded file

(required)

--timeout

the number of seconds to wait for the certificate to be propagated to all admin servers and engine processes

--no-wait

do not wait for certificate to be propagated

--alias

the alias of the trusted certificate to remove

(required)

--name

the name of the user to create

(required)

--roles

the roles for the user

--password

the user password, if basic authentication is to be used

--cert

the user PEM file, if certificate authentication is to be used; if the file does not exist, a new key-pair is generated

--nuokey-cmd

the path to the nuokeymgr executable

$NUOCMD_NUOKEY_CMD / $NUODB_HOME/etc/nuokeymgr

--name

the name of the user to delete

(required)

--name

the name of the user to update

(required)

--password

the user password, if basic authentication is to be used

--cert

the user PEM file, if certificate authentication is to be used; if the file does not exist, a new key-pair is generated

--nuokey-cmd

the path to the nuokeymgr executable

$NUOCMD_NUOKEY_CMD / $NUODB_HOME/etc/nuokeymgr

--name

the name of the user to update

(required)

--roles-to-add

the roles to add to the user

--roles-to-remove

the roles to remove from the user

--key

the key to get the value of

(required)

--key

the key to set a value for

(required)

--value

the new value to associate with key

(required)

--expected-value

expected current value for key

--unconditional

set value unconditionally