NuoDB Command Reference

Global Arguments

Argument Description Default

--api-server

the REST API server to send request to

$NUOCMD_API_SERVER / localhost:8888

--show-http

emit HTTP request and response logging; to emit this logging separately from standard output, the file descriptor 5 can be redirected, e.g. nuocmd --show-http show domain 5>/tmp/http-logging

--show-json

show the full JSON response

--show-json-fields

the JSON fields to show from the response

--client-key

client key-pair if server requires client authentication (see 'needClientAuth' REST setting); specified as a single file containing both certificate and private key, or as '<certificate>,<private key>'

$NUOCMD_CLIENT_KEY

--basic-creds

client basic credentials in the format '<username>:<password>'; this takes precedence over --client-key

$NUOCMD_BASIC_CREDS

--verify-server

trusted certificate used to verify the server when using HTTPS; if no argument is specified then the default set of trusted CA certificates for the system is used

$NUOCMD_VERIFY_SERVER

--no-verify

if specified, then server verification is disabled; this takes precedence over --verify-server

…​ archive Subcommands

create archive

create a database archive

nuocmd create archive [-h] --db-name DB_NAME
                      (--server-id SERVER_ID | --is-external)
                      --archive-path ARCHIVE_PATH
                      [--journal-path JOURNAL_PATH]
                      [--snapshot-archive-path SNAPSHOT_ARCHIVE_PATH]
                      [--restored] [--archive-id ARCHIVE_ID]
                      [--observers [OBSERVERS [OBSERVERS ...]]]
Argument Description Default

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

--observers

list of storage groups to observe

delete archive

delete a non-running database archive

nuocmd delete archive [-h] --archive-id ARCHIVE_ID [--purge]
Argument Description Default

--archive-id

the ID of the archive to delete

(required)

--purge

whether to remove the archive permanently

set archive

Set the specified archive to either regular server or passive observer of storage groups

nuocmd set archive [-h] --archive-id ARCHIVE_ID
                   [--no-observers SG_NAME [SG_NAME ...]]
                   [--observers SG_NAME [SG_NAME ...]]
Argument Description Default

--archive-id

The id of the archive

(required)

--no-observers

Promote the specified archive to a regular server of the named storage groups

--observers

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

…​ archives Subcommands

get archives

show database archives

nuocmd get archives [-h] [--db-name DB_NAME] [--removed]
Argument Description Default

--db-name

the name of the database to list archives for

$NUOCMD_DB_NAME

--removed

show removed archives

show archives

show database archives

nuocmd show archives [-h] [--db-name DB_NAME] [--removed]
                     [--archive-format ARCHIVE_FORMAT]
                     [--removed-archive-format REMOVED_ARCHIVE_FORMAT]
                     [--process-format PROCESS_FORMAT]
                     [--exited-process-format EXITED_PROCESS_FORMAT]
Argument Description Default

--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::?})

…​ certificate Subcommands

import certificate

import a certificate into a truststore

nuocmd import certificate [-h] --keystore KEYSTORE
                          [--store-type {JKS,PKCS12}] [--alias ALIAS]
                          [--store-password STORE_PASSWORD]
                          --truststore TRUSTSTORE
                          [--truststore-type {JKS,PKCS12}]
                          [--truststore-password TRUSTSTORE_PASSWORD]
                          [--for-recovery] [--nuokey-cmd NUOKEY_CMD]
Argument Description Default

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

show certificate

output key-pair or certificate from a keystore as a base64-encoded string according to RFC-7468

nuocmd show certificate [-h] --keystore KEYSTORE
                        [--store-type {JKS,PKCS12}] [--alias ALIAS]
                        [--store-password STORE_PASSWORD]
                        [--key-password KEY_PASSWORD | --prompt-key-password]
                        [--cert-only] [--nuokey-cmd NUOKEY_CMD]
Argument Description Default

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

sign certificate

sign a certificate in a keystore with a CA certificate

nuocmd sign certificate [-h] --keystore KEYSTORE
                        [--store-type {JKS,PKCS12}] [--alias ALIAS]
                        [--store-password STORE_PASSWORD] --ca-keystore
                        CA_KEYSTORE [--ca-store-type {JKS,PKCS12}]
                        [--ca-alias CA_ALIAS]
                        [--ca-store-password CA_STORE_PASSWORD]
                        [--update]
                        [--sub-altnames [SUB_ALTNAMES [SUB_ALTNAMES ...]]]
                        [--resolve-san] [--validity VALIDITY]
                        [--start-date START_DATE] [--ca]
                        [--nuokey-cmd NUOKEY_CMD]
Argument Description Default

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

…​ certificate-info Subcommands

get certificate-info

get certificate data for the entire domain, including all admin server certificates, all database process certificates, and trusted certificates for all admin servers and database processes

nuocmd get certificate-info [-h]

…​ core-file Subcommands

get core-file

download the core file for a running database process

nuocmd get core-file [-h] --start-id START_ID [--output OUTPUT]
                     [--output-dir OUTPUT_DIR]
                     [--socket-read-timeout SOCKET_READ_TIMEOUT]
Argument Description Default

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

…​ data-encryption Subcommands

check data-encryption

check that the specified storage password is current and ensure that it is propagated to all admin servers and database processes

nuocmd check data-encryption [-h] --db-name DB_NAME --password PASSWORD
                             [--existing-passwords [EXISTING_PASSWORDS [EXISTING_PASSWORDS ...]]]
                             [--config-update-timeout CONFIG_UPDATE_TIMEOUT]
                             [--timeout TIMEOUT | --wait-forever]
Argument Description Default

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

update data-encryption

update storage password used for transparent data encryption of archives

nuocmd update data-encryption [-h] --db-name DB_NAME --new-password
                              NEW_PASSWORD
                              (--current-password CURRENT_PASSWORD | --is-initial-password)
                              [--existing-passwords [EXISTING_PASSWORDS [EXISTING_PASSWORDS ...]]]
                              [--config-update-timeout CONFIG_UPDATE_TIMEOUT]
Argument Description Default

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

…​ database Subcommands

capture database

capture the state of a running database

nuocmd capture database [-h] --db-name DB_NAME --capture-file
                        CAPTURE_FILE
Argument Description Default

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

check database

Check the status of a database

nuocmd check database [-h] --db-name DB_NAME
                      [--timeout TIMEOUT | --wait-forever]
                      [--check-running | --check-syncing]
                      [--num-processes NUM_PROCESSES]
                      [--check-liveness CHECK_LIVENESS]
                      [--wait-for-acks] [--fail-on-process-exit]
Argument Description Default

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

connect database

establish a SQL connection with a database

nuocmd connect database [-h] --db-name DB_NAME
                        (--server-id SERVER_ID | --this-server)
                        [--user USER] [--password PASSWORD]
                        [--nuosql-cmd NUOSQL_CMD]
                        [--connection-properties [CONNECTION_PROPERTIES [CONNECTION_PROPERTIES ...]]]
Argument Description Default

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

create database

create a database

nuocmd create database [-h] --db-name DB_NAME --dba-user DBA_USER
                       --dba-password DBA_PASSWORD
                       [--te-server-ids TE_SERVER_IDS [TE_SERVER_IDS ...]]
                       [--capture-file CAPTURE_FILE | --nuodb-cmd NUODB_CMD]
                       [--no-autostart] [--is-external]
                       [--archive-assignment ARCHIVE_ASSIGNMENT [ARCHIVE_ASSIGNMENT ...]]
                       [--region-assignment [REGION_ASSIGNMENT [REGION_ASSIGNMENT ...]]]
                       [--default-options [DEFAULT_OPTIONS [DEFAULT_OPTIONS ...]]]
                       [--sms-running-timeout SMS_RUNNING_TIMEOUT]
Argument Description Default

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

delete database

delete a non-running database

nuocmd delete database [-h] --db-name DB_NAME
Argument Description Default

--db-name

the name of the database to delete

$NUOCMD_DB_NAME (required)

diagnose database

diagnose database

nuocmd diagnose database [-h] --db-name DB_NAME
                         [--output-dir OUTPUT_DIR] [--timeout TIMEOUT]
                         action target [arguments [arguments ...]]
Argument Description Default

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

enforce database

start a database

nuocmd enforce database [-h] --capture-file CAPTURE_FILE
                        [--incremental | --unconditional]
                        [--nuodb-cmd NUODB_CMD]
                        [--sms-running-timeout SMS_RUNNING_TIMEOUT]
Argument Description Default

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

get database

get database state for a specific database

nuocmd get database [-h] --db-name DB_NAME
Argument Description Default

--db-name

the name of the database

$NUOCMD_DB_NAME (required)

handoff database

Handoff the database, making the passive datacenter active

nuocmd handoff database [-h] --db-name DB_NAME
                        (--archive-ids ID [ID ...] | --all-observer-archive-ids)
                        [--oldest-acceptable OLDEST_ACCEPTABLE]
                        [--timeout TIMEOUT]
Argument Description Default

--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 '%Y-%m-%dT%H:%M:%S'

--timeout

The number of seconds to wait for each step of handoff

300

hotcopy database

issue a hot-copy request on a database

nuocmd hotcopy database [-h] --db-name DB_NAME --type
                        {simple,full,incremental,journal} [--shared]
                        [--default-backup-dir DEFAULT_BACKUP_DIR]
                        [--backup-dirs [BACKUP_DIRS [BACKUP_DIRS ...]]]
                        [--max-rate MAX_RATE] [--timeout TIMEOUT]
Argument Description Default

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

--backup-dirs

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

--max-rate

maximum I/O rate in MB/sec

--timeout

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

prepare database

display commands to create a nuoadmin database from a nuoagent capture file

nuocmd prepare database [-h] --capture-file CAPTURE_FILE
                        [--server-mapping [SERVER_MAPPING [SERVER_MAPPING ...]]]
Argument Description Default

--capture-file

capture file describing a nuoagent database

(required)

--server-mapping

mapping of stable ID in nuoagent to corresponding server ID in nuoadmin

show database

show database state

nuocmd show database [-h] --db-name DB_NAME
                     [--num-incarnations NUM_INCARNATIONS | --all-incarnations | --skip-exited]
                     [--db-format DB_FORMAT]
                     [--process-format PROCESS_FORMAT]
                     [--exited-process-format EXITED_PROCESS_FORMAT]
Argument Description Default

--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::?})

shutdown database

shutdown all database processes for a database

nuocmd shutdown database [-h] --db-name DB_NAME
Argument Description Default

--db-name

the name of the database to shutdown

$NUOCMD_DB_NAME (required)

start database

start a database

nuocmd start database [-h] --db-name DB_NAME
                      [--te-server-ids TE_SERVER_IDS [TE_SERVER_IDS ...]]
                      [--archive-assignment ARCHIVE_ASSIGNMENT [ARCHIVE_ASSIGNMENT ...]]
                      [--incremental | --unconditional]
                      [--nuodb-cmd NUODB_CMD]
                      [--sms-running-timeout SMS_RUNNING_TIMEOUT]
Argument Description Default

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

…​ database-connectivity Subcommands

get database-connectivity

get the connectivity graph for a database

nuocmd get database-connectivity [-h] --db-name DB_NAME
                                 [--with-node-ids] [--suppress-errors]
Argument Description Default

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

show database-connectivity

show the connectivity graph for a database

nuocmd show database-connectivity [-h] --db-name DB_NAME
                                  [--with-node-ids]
                                  [--last-ack-threshold LAST_ACK_THRESHOLD]
Argument Description Default

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

…​ database-options Subcommands

update database-options

update database options

nuocmd update database-options [-h] --db-name DB_NAME
                               [--default-options [DEFAULT_OPTIONS [DEFAULT_OPTIONS ...]]]
                               [--replace-all]
Argument Description Default

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

…​ database-version Subcommands

upgrade database-version

upgrade the database version

nuocmd upgrade database-version [-h] --db-name DB_NAME
                                (--version VERSION | --max-version)
Argument Description Default

--db-name

the database upgrade

(required)

--version

the version to upgrade to

--max-version

upgrade to maximum available version

…​ database-versions Subcommands

show database-versions

show the database version for all processes in the database

nuocmd show database-versions [-h] --db-name DB_NAME
                              [--process-format PROCESS_FORMAT]
Argument Description Default

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

…​ databases Subcommands

get databases

list all databases

nuocmd get databases [-h]

…​ diagnose-info Subcommands

get diagnose-info

download server logs for all reachable admin processes and cores for all reachable engine processes

nuocmd get diagnose-info [-h] [--output-dir OUTPUT_DIR]
                         [--no-pack | --print-to-stdout]
                         [--include-cores]
                         [--socket-read-timeout SOCKET_READ_TIMEOUT]
Argument Description Default

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

--socket-read-timeout

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

…​ documentation Subcommands

generate documentation

generate documentation for all nuocmd subcommands in AsciiDoc format

nuocmd generate documentation [-h] [--group-by-noun]
Argument Description Default

--group-by-noun

if specified, group generated documentation by noun rather than verb

…​ domain Subcommands

prepare domain

generate a nuoadmin domain state capture file from nuoagent state

nuocmd prepare domain [-h] [--nuoagent-address NUOAGENT_ADDRESS]
                      [--domain-user DOMAIN_USER]
                      [--domain-password DOMAIN_PASSWORD]
Argument Description Default

--nuoagent-address

the address and port of the nuoagent server

localhost

--domain-user

the domain user for the nuoagent domain

$NUOCMD_DOMAIN_USER / domain

--domain-password

the domain password for the nuoagent domain

$NUOCMD_DOMAIN_PASSWORD

show domain

show summary of domain state

nuocmd show domain [-h] [--server-format SERVER_FORMAT]
                   [--db-format DB_FORMAT]
                   [--process-format PROCESS_FORMAT]
                   [--client-token CLIENT_TOKEN]
Argument Description Default

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

…​ domain-state Subcommands

capture domain-state

capture the domain state of the API server

nuocmd capture domain-state [-h] [--output OUTPUT]
Argument Description Default

--output

the output file to save captured domain state to

…​ effective-license Subcommands

get effective-license

get the current effective license for the server or domain

nuocmd get effective-license [-h]

…​ hotcopy-status Subcommands

get hotcopy-status

get the status of a hot-copy request

nuocmd get hotcopy-status [-h] --coordinator-start-id
                          COORDINATOR_START_ID --hotcopy-id HOTCOPY_ID
                          [--timeout TIMEOUT]
Argument Description Default

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

…​ keypair Subcommands

create keypair

create a key-pair

nuocmd create keypair [-h] --keystore KEYSTORE
                      [--store-type {JKS,PKCS12}] [--alias ALIAS]
                      [--store-password STORE_PASSWORD]
                      [--key-password KEY_PASSWORD | --prompt-key-password]
                      [--dname DNAME]
                      [--sub-altnames [SUB_ALTNAMES [SUB_ALTNAMES ...]]]
                      [--resolve-san] [--algorithm {RSA,DSA,EC}]
                      [--validity VALIDITY] [--start-date START_DATE]
                      [--ca]
Argument Description Default

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

…​ kubernetes-config Subcommands

get kubernetes-config

get the NuoDB Kubernetes configuration

nuocmd get kubernetes-config [-h]

…​ license Subcommands

check license

check supplied license

nuocmd check license [-h] --license-file LICENSE_FILE
Argument Description Default

--license-file

the license file to check

(required)

set license

set the license for the domain

nuocmd set license [-h] --license-file LICENSE_FILE [--allow-downgrade]
Argument Description Default

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

…​ load-balancer Subcommands

delete load-balancer

remove a load-balancer policy

nuocmd delete load-balancer [-h] --policy-name POLICY_NAME
Argument Description Default

--policy-name

the name of the load-balancer policy to delete

(required)

set load-balancer

set a load-balancing policy

nuocmd set load-balancer [-h] --policy-name POLICY_NAME --lb-query
                         LB_QUERY
Argument Description Default

--policy-name

the name of the load-balancer policy to set

(required)

--lb-query

the load-balancer query to set

(required)

…​ load-balancer-config Subcommands

get load-balancer-config

get load-balancer configuration for all databases

nuocmd get load-balancer-config [-h]

set load-balancer-config

set a load-balancing configuration

nuocmd set load-balancer-config [-h] (--db-name DB_NAME | --is-global)
                                [--default DEFAULT | --unregister-default]
                                [--prefilter PREFILTER | --unregister-prefilter]
Argument Description Default

--db-name

the name to register default for

--is-global

whether to register global default

--default

the default load-balancer register

--unregister-default

whether to unregister current default

--prefilter

the prefilter to register

--unregister-prefilter

whether to unregister the current prefilter

…​ load-balancers Subcommands

get load-balancers

get all load-balancing policies

nuocmd get load-balancers [-h]

…​ log-messages Subcommands

get log-messages

get log messages from running database processes

nuocmd get log-messages [-h] --log-options LOG_OPTIONS
                        [LOG_OPTIONS ...]
                        [--db-name DB_NAME | --start-id START_ID]
                        [--engine-file ENGINE_FILE]
Argument Description Default

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

show log-messages

show log messages from running database processes

nuocmd show log-messages [-h] --log-options LOG_OPTIONS
                         [LOG_OPTIONS ...]
                         [--db-name DB_NAME | --start-id START_ID]
                         [--log-format LOG_FORMAT]
                         [--engine-file ENGINE_FILE]
Argument Description Default

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

log message

Emit a log message to the admin server

nuocmd log message [-h] --message MESSAGE
Argument Description Default

--message

The message to log

(required)

…​ process Subcommands

check process

Check the status of a process

nuocmd check process [-h] --start-id START_ID
                     [--check-running | --check-exited]
                     [--check-liveness CHECK_LIVENESS] [--wait-for-ack]
                     [--timeout TIMEOUT | --wait-forever]
Argument Description Default

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

diagnose process

diagnose process

nuocmd diagnose process [-h] --start-id START_ID
                        [--output-dir OUTPUT_DIR] [--timeout TIMEOUT]
                        action target [arguments [arguments ...]]
Argument Description Default

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

shutdown process

shutdown a database process

nuocmd shutdown process [-h] --start-id START_ID
                        [--evict | --kill | --kill-with-core]
                        [--timeout TIMEOUT]
Argument Description Default

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

start process

start a database process

nuocmd start process [-h] --db-name DB_NAME
                     (--server-id SERVER_ID | --this-server)
                     [--engine-type {TE,SM,SSM}]
                     [--archive-id ARCHIVE_ID]
                     [--expected-incarnation EXPECTED_INCARNATION]
                     [--nuodb-cmd NUODB_CMD]
                     [--options [OPTIONS [OPTIONS ...]]]
                     [--labels [LABELS [LABELS ...]]]
Argument Description Default

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

…​ processes Subcommands

get processes

get database processes

nuocmd get processes [-h] [--db-name DB_NAME] [--exited]
Argument Description Default

--db-name

the name of the database to list processes for

$NUOCMD_DB_NAME

--exited

get exited processes

…​ region Subcommands

create region

create a region (deprecated)

nuocmd create region [-h] --name NAME
Argument Description Default

--name

the name of the region

(required)

delete region

delete a region (deprecated)

nuocmd delete region [-h] --region-id REGION_ID
Argument Description Default

--region-id

the ID of the region to delete

(required)

…​ region-assignment Subcommands

add region-assignment

add servers to a region (deprecated)

nuocmd add region-assignment [-h] --db-name DB_NAME
                             (--region-name REGION_NAME | --region-id REGION_ID)
                             --server-ids SERVER_IDS [SERVER_IDS ...]
Argument Description Default

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

remove region-assignment

remove servers from their current region (deprecated)

nuocmd remove region-assignment [-h] --db-name DB_NAME --server-ids
                                SERVER_IDS [SERVER_IDS ...]
Argument Description Default

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

…​ regions Subcommands

get regions

get regions (deprecated)

nuocmd get regions [-h]

show regions

show regions (deprecated)

nuocmd show regions [-h] --db-name DB_NAME
                    [--region-format REGION_FORMAT]
                    [--process-format PROCESS_FORMAT]
Argument Description Default

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

…​ report-timestamp Subcommands

handoff report-timestamp

Query the storage managers to report latest state that will remain after handoff from active to passive datacenter

nuocmd handoff report-timestamp [-h] --db-name DB_NAME --archive-ids ID
                                [ID ...] [--timeout TIMEOUT]
Argument Description Default

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

…​ reset-state Subcommands

handoff reset-state

Reset the state of the database for handoff from active to passive datacenter

nuocmd handoff reset-state [-h] --db-name DB_NAME --commits COMMIT
                           [COMMIT ...] --epoch EPOCH --leaders SG_ID
                           AR_ID [SG_ID AR_ID ...]
Argument Description Default

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

…​ role Subcommands

create role

create a new role

nuocmd create role [-h] --name NAME
                   [--sub-roles [SUB_ROLES [SUB_ROLES ...]]]
                   [--any-method | --method {PUT,GET,POST,DELETE}]
                   [--url URL]
                   [--query-param-constraints [QUERY_PARAM_CONSTRAINTS [QUERY_PARAM_CONSTRAINTS ...]]]
                   [--path-param-constraints [PATH_PARAM_CONSTRAINTS [PATH_PARAM_CONSTRAINTS ...]]]
                   [--payload-param-constraints [PAYLOAD_PARAM_CONSTRAINTS [PAYLOAD_PARAM_CONSTRAINTS ...]]]
Argument Description Default

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

delete role

delete an existing role

nuocmd delete role [-h] --name NAME
Argument Description Default

--name

the name of the role to delete

(required)

…​ role-privileges Subcommands

add role-privileges

add privileges to an existing role

nuocmd add role-privileges [-h] --name NAME
                           [--sub-roles [SUB_ROLES [SUB_ROLES ...]]]
                           [--any-method | --method {PUT,GET,POST,DELETE}]
                           [--url URL]
                           [--query-param-constraints [QUERY_PARAM_CONSTRAINTS [QUERY_PARAM_CONSTRAINTS ...]]]
                           [--path-param-constraints [PATH_PARAM_CONSTRAINTS [PATH_PARAM_CONSTRAINTS ...]]]
                           [--payload-param-constraints [PAYLOAD_PARAM_CONSTRAINTS [PAYLOAD_PARAM_CONSTRAINTS ...]]]
Argument Description Default

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

remove role-privileges

remove privileges from an existing role

nuocmd remove role-privileges [-h] --name NAME
                              [--sub-roles [SUB_ROLES [SUB_ROLES ...]]]
                              [--any-method | --method {PUT,GET,POST,DELETE}]
                              [--url URL]
                              [--query-param-constraints [QUERY_PARAM_CONSTRAINTS [QUERY_PARAM_CONSTRAINTS ...]]]
                              [--path-param-constraints [PATH_PARAM_CONSTRAINTS [PATH_PARAM_CONSTRAINTS ...]]]
                              [--payload-param-constraints [PAYLOAD_PARAM_CONSTRAINTS [PAYLOAD_PARAM_CONSTRAINTS ...]]]
Argument Description Default

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

…​ role-templates Subcommands

add role-templates

add set of privileges to an existing role

nuocmd add role-templates [-h] --name NAME [--accessor]
                          [--domain-admin] [--db-admin DB_NAME]
                          [--hotcopy-admin DB_NAME]
Argument Description Default

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

remove role-templates

remove set of privileges from an existing role

nuocmd remove role-templates [-h] --name NAME [--accessor]
                             [--domain-admin] [--db-admin DB_NAME]
                             [--hotcopy-admin DB_NAME]
Argument Description Default

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

…​ roles Subcommands

get roles

get all roles

nuocmd get roles [-h]

…​ server Subcommands

check server

Check the status of the API server

nuocmd check server [-h] [--timeout TIMEOUT | --wait-forever]
                    [--check-active] [--check-connected]
                    [--check-converged]
Argument Description Default

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

delete server

remove a server from the raft membership remove all process and archive state for a server

nuocmd delete server [-h] --server-id SERVER_ID
Argument Description Default

--server-id

the ID of the server to remove from the membership

(required)

shutdown server

shutdown a server

nuocmd shutdown server [-h] (--server-id SERVER_ID | --this-server)
                       [--evict-local]
Argument Description Default

--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-config Subcommands

get server-config

get the NuoAdmin service server configuration

nuocmd get server-config [-h] (--server-id SERVER_ID | --this-server)
                         [--property-key PROPERTY_KEY]
Argument Description Default

--server-id

the ID of the NuoAdmin server

--this-server

get the configuration of the API server

--property-key

get only a specific property

…​ server-logs Subcommands

get server-logs

download the server logs for the API server

nuocmd get server-logs [-h] [--output OUTPUT] [--include-core-files]
                       [--dump-threads] [--unpack]
Argument Description Default

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

…​ server-processes Subcommands

shutdown server-processes

shutdown database processes connected to an admin server

nuocmd shutdown server-processes [-h] --server-id SERVER_ID
                                 [--db-name DB_NAME]
                                 [--evict | --kill | --kill-with-core]
                                 [--timeout TIMEOUT]
Argument Description Default

--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-state Subcommands

delete server-state

remove all process and archive state for a server

nuocmd delete server-state [-h] --server-id SERVER_ID
Argument Description Default

--server-id

the ID of the server to remove from domain state

(required)

…​ servers Subcommands

check servers

Check the status of admin servers

nuocmd check servers [-h] [--timeout TIMEOUT | --wait-forever]
                     [--check-active] [--check-connected]
                     [--check-leader] [--num-servers NUM_SERVERS]
                     [--check-liveness CHECK_LIVENESS]
                     [--wait-for-acks] [--check-converged]
Argument Description Default

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

get servers

get admin servers

nuocmd get servers [-h]

…​ sql-connection Subcommands

get sql-connection

get TE to service a SQL connection

nuocmd get sql-connection [-h] --db-name DB_NAME
                          [--connection-properties [CONNECTION_PROPERTIES [CONNECTION_PROPERTIES ...]]]
Argument Description Default

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

…​ startplan Subcommands

get startplan

get the startplan for a database

nuocmd get startplan [-h] --db-name DB_NAME --output-file OUTPUT_FILE
                     [--te-server-ids TE_SERVER_IDS [TE_SERVER_IDS ...]]
                     [--archive-assignment ARCHIVE_ASSIGNMENT [ARCHIVE_ASSIGNMENT ...]]
                     [--one-time]
Argument Description Default

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

…​ stats Subcommands

get stats

get stats from running database processes

nuocmd get stats [-h] [--db-name DB_NAME | --start-id START_ID]
Argument Description Default

--db-name

the database to get stats for

--start-id

the running process to get stats for

…​ storage-group Subcommands

add storage-group

add a storage group to a set of archives

nuocmd add storage-group [-h] --db-name DB_NAME --sg-name SG_NAME
                         --archive-ids ARCHIVE_IDS [ARCHIVE_IDS ...]
Argument Description Default

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

delete storage-group

remove a storage group from the database

nuocmd delete storage-group [-h] --db-name DB_NAME --sg-name SG_NAME
Argument Description Default

--db-name

the name of the database

$NUOCMD_DB_NAME (required)

--sg-name

the name of the storage group to delete

(required)

remove storage-group

remove a storage group from a set of archives

nuocmd remove storage-group [-h] --db-name DB_NAME --sg-name SG_NAME
                            --archive-ids ARCHIVE_IDS [ARCHIVE_IDS ...]
Argument Description Default

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

…​ storage-groups Subcommands

get storage-groups

get storage groups for a database

nuocmd get storage-groups [-h] --db-name DB_NAME
Argument Description Default

--db-name

the name of the database to list storage groups for

$NUOCMD_DB_NAME (required)

show storage-groups

show storage groups for a database

nuocmd show storage-groups [-h] --db-name DB_NAME
                           [--storage-group-format STORAGE_GROUP_FORMAT]
                           [--process-format PROCESS_FORMAT]
Argument Description Default

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

…​ trusted-certificate Subcommands

add trusted-certificate

add a trusted certificate to all admin servers and engine processes

nuocmd add trusted-certificate [-h] --alias ALIAS --cert CERT
                               (--timeout TIMEOUT | --no-wait)
Argument Description Default

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

remove trusted-certificate

remove a trusted certificate from all admin servers and engine processes

nuocmd remove trusted-certificate [-h] --alias ALIAS
Argument Description Default

--alias

the alias of the trusted certificate to remove

(required)

…​ user Subcommands

create user

create a new user

nuocmd create user [-h] --name NAME [--roles ROLES [ROLES ...]]
                   (--password PASSWORD | --cert CERT)
                   [--nuokey-cmd NUOKEY_CMD]
Argument Description Default

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

delete user

delete an existing user

nuocmd delete user [-h] --name NAME
Argument Description Default

--name

the name of the user to delete

(required)

…​ user-credentials Subcommands

update user-credentials

update credentials for an existing user

nuocmd update user-credentials [-h] --name NAME
                               (--password PASSWORD | --cert CERT)
                               [--nuokey-cmd NUOKEY_CMD]
Argument Description Default

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

…​ user-roles Subcommands

update user-roles

update roles for an existing user

nuocmd update user-roles [-h] --name NAME
                         [--roles-to-add [ROLES_TO_ADD [ROLES_TO_ADD ...]]]
                         [--roles-to-remove [ROLES_TO_REMOVE [ROLES_TO_REMOVE ...]]]
Argument Description Default

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

…​ users Subcommands

get users

get all users

nuocmd get users [-h]

…​ value Subcommands

get value

get the value for a key in the key-value store

nuocmd get value [-h] --key KEY
Argument Description Default

--key

the key to get the value of

(required)

set value

associate a key with a value in the key-value store

nuocmd set value [-h] --key KEY --value VALUE
                 [--expected-value EXPECTED_VALUE | --unconditional]
Argument Description Default

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