nuodb-cp CLI Reference

Command-line interface for the NuoDB Control Plane REST Service

nuodb-cp [-hV] [backup
               |backuppolicy
               |database
               |project
               |user
               |httpclient
               |server
               |external-operator
               |k8s
               |generate-completion
               |generate-doc]

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

backup

Inspect and manage backups using the DBaaS REST service

nuodb-cp backup [-hV] [list
                      |get
                      |create
                      |update
                      |delete]

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

list

List backups

nuodb-cp backup list [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                     [--token=<token>] [--trusted-cert=<trustedCert>]
                     [-l=<labelFilter>]... [--list-accessible]
                     [--limit=<limit>] [--offset=<offset> | --cursor=<cursor>]
                     [--expand-all | --expand-field=<expandFields>
                     [--expand-field=<expandFields>]...] RESOURCE

RESOURCE

The fully-qualified name of the resource containing backups to list, e.g. <organization>/<project>/<database> for a database, <organization>/<project> for a project, <organization> for an organization, or / to list backups across all organizations

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--offset

The offset at which to list items
required

--cursor

The cursor at which to list items, which represents the last item returned`
required

--expand-all

Whether to expand payload fields
required

--expand-field

Field to expand, in the format <field> or <field>=<JSONPath expression>
required

-l, --label-filter

Filter to apply based on labels

--list-accessible

Whether to return any accessible sub-resources even if the current user does not have access privileges to list all resources at this level

--limit

The number of items to return

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

get

Get an existing backup

nuodb-cp backup get [-whV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                    [--token=<token>] [--trusted-cert=<trustedCert>]
                    [--watch-non-interactive] BACKUP

BACKUP

The fully-qualified name of the backup in the format <organization>/<project>/<database>/<backup>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-w, --watch

Whether to stream events on resource. Non-interactive mode is automatically enabled if standard input or output is not connected to a TTY.

--watch-non-interactive

Whether to stream events on resource in non-interactive mode

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

create

Create a new backup

nuodb-cp backup create [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                       [--token=<token>] [--trusted-cert=<trustedCert>]
                       [-l=<String=String>]...
                       [--import-source-handle=<backupHandle>]
                       [--import-source-plugin=<backupPlugin>] BACKUP BACKUP

BACKUP

The fully-qualified name of the backup in the format <organization>/<project>/<database>/<backup>

BACKUP

The fully-qualified name of the backup to create in the format <organization>/<project>/<database>/<backup>, or the database name in the format <organization>/<project>/<database> for an on-demand backup

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-l, --label

Label to attach to resource

--import-source-handle

The existing backup handle to import

--import-source-plugin

The plugin used to create the backup to import

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

update

Update an existing backup

nuodb-cp backup update [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                       [--token=<token>] [--trusted-cert=<trustedCert>]
                       [--editor=<editor>] BACKUP

BACKUP

The fully-qualified name of the backup in the format <organization>/<project>/<database>/<backup>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--editor

The editor to use to update the resource
default: ${NUODB_CP_EDITOR}

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

delete

Delete an existing backup

nuodb-cp backup delete [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                       [--token=<token>] [--trusted-cert=<trustedCert>]
                       [--timeout=<timeout>] BACKUP

BACKUP

The fully-qualified name of the backup in the format <organization>/<project>/<database>/<backup>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--timeout

The number of seconds to wait for the operation to be finalized, unless 0 is specified which indicates not to wait

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

backuppolicy

Inspect and manage backup policies using the DBaaS REST service

nuodb-cp backuppolicy [-hV] [list
                            |list-backups
                            |list-databases
                            |get
                            |create
                            |update
                            |delete]

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

list

List backup policies

nuodb-cp backuppolicy list [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                           [--token=<token>] [--trusted-cert=<trustedCert>]
                           [-l=<labelFilter>]... [--list-accessible]
                           [--limit=<limit>] [--offset=<offset> |
                           --cursor=<cursor>] [--expand-all |
                           --expand-field=<expandFields>
                           [--expand-field=<expandFields>]...] ORGANIZATION

ORGANIZATION

The name of the organization, or / to list backup policies across all organizations

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--offset

The offset at which to list items
required

--cursor

The cursor at which to list items, which represents the last item returned`
required

--expand-all

Whether to expand payload fields
required

--expand-field

Field to expand, in the format <field> or <field>=<JSONPath expression>
required

-l, --label-filter

Filter to apply based on labels

--list-accessible

Whether to return any accessible sub-resources even if the current user does not have access privileges to list all resources at this level

--limit

The number of items to return

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

list-backups

List the backups taken by the backup policy

nuodb-cp backuppolicy list-backups [-hV] [-b=<urlBase>] [-u=<user>] [-p
                                   [=<password>]] [--token=<token>]
                                   [--trusted-cert=<trustedCert>]
                                   [-l=<labelFilter>]... [--list-accessible]
                                   [--limit=<limit>] [--offset=<offset> |
                                   --cursor=<cursor>] [--expand-all |
                                   --expand-field=<expandFields>
                                   [--expand-field=<expandFields>]...] POLICY

POLICY

The fully-qualified name of the backup policy in the format <organization>/<policy>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--offset

The offset at which to list items
required

--cursor

The cursor at which to list items, which represents the last item returned`
required

--expand-all

Whether to expand payload fields
required

--expand-field

Field to expand, in the format <field> or <field>=<JSONPath expression>
required

-l, --label-filter

Filter to apply based on labels

--list-accessible

Whether to return any accessible sub-resources even if the current user does not have access privileges to list all resources at this level

--limit

The number of items to return

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

list-databases

List the databases that the backup policy applies to

nuodb-cp backuppolicy list-databases [-hV] [-b=<urlBase>] [-u=<user>] [-p
                                     [=<password>]] [--token=<token>]
                                     [--trusted-cert=<trustedCert>]
                                     [-l=<labelFilter>]... [--list-accessible]
                                     [--limit=<limit>] [--offset=<offset> |
                                     --cursor=<cursor>] [--expand-all |
                                     --expand-field=<expandFields>
                                     [--expand-field=<expandFields>]...] POLICY

POLICY

The fully-qualified name of the backup policy in the format <organization>/<policy>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--offset

The offset at which to list items
required

--cursor

The cursor at which to list items, which represents the last item returned`
required

--expand-all

Whether to expand payload fields
required

--expand-field

Field to expand, in the format <field> or <field>=<JSONPath expression>
required

-l, --label-filter

Filter to apply based on labels

--list-accessible

Whether to return any accessible sub-resources even if the current user does not have access privileges to list all resources at this level

--limit

The number of items to return

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

get

Get an existing backup policy

nuodb-cp backuppolicy get [-whV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                          [--token=<token>] [--trusted-cert=<trustedCert>]
                          [--watch-non-interactive] POLICY

POLICY

The fully-qualified name of the backup policy in the format <organization>/<policy>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-w, --watch

Whether to stream events on resource. Non-interactive mode is automatically enabled if standard input or output is not connected to a TTY.

--watch-non-interactive

Whether to stream events on resource in non-interactive mode

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

create

Create a new backup policy

nuodb-cp backuppolicy create [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                             [--token=<token>] [--trusted-cert=<trustedCert>]
                             [-l=<String=String>]... --frequency=<frequency>
                             --selector-scope=<selectorScope>
                             [--selector-sla=<selectorSlas>]...
                             [--selector-tier=<selectorTiers>]...
                             [--selector-label=<String=String>]...
                             [--hourly-retention=<hourlyRetention>]
                             [--daily-retention=<dailyRetention>]
                             [--weekly-retention=<weeklyRetention>]
                             [--monthly-retention=<monthlyRetention>]
                             [--yearly-retention=<yearlyRetention>]
                             [--day-of-week=<dayOfWeek>] [--month=<month>]
                             [--use-current-time] [--promote-latest-to-hourly]
                             [--promote-latest-to-daily]
                             [--promote-latest-to-monthly] [--suspended]
                             [--disable-policy-label-propagation]
                             [--disable-db-label-propagation] POLICY

POLICY

The fully-qualified name of the backup policy in the format <organization>/<policy>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-l, --label

Label to attach to resource

--frequency

The frequency to schedule backups at, in cron format
required

--selector-scope

The scope that the backup policy applies to
required

--selector-sla

SLA to filter databases on

--selector-tier

Tier to filter databases on

--selector-label

Label to filter databases on

--hourly-retention

The number of hourly backups to retain

--daily-retention

The number of daily backups to retain

--weekly-retention

The number of weekly backups to retain

--monthly-retention

The number of monthly backups to retain

--yearly-retention

The number of yearly backups to retain

--day-of-week

The day of the week used to promote backup to weekly

--month

The month of the year used to promote backup to yearly

--use-current-time

Whether to apply the backup rotation scheme relative to the current time instead to the last successful backup

--promote-latest-to-hourly

Whether to promote the latest backup within the hour if multiple backups exist for that hour

--promote-latest-to-daily

Whether to promote the latest backup within the day if multiple backups exist for that day

--promote-latest-to-monthly

Whether to promote the latest backup within the month if multiple backups exist for that month

--suspended

Whether backups from the policy are suspended

--disable-policy-label-propagation

Whether to disable propagation of policy labels to backups created from the policy

--disable-db-label-propagation

Whether to disable propagation of database labels to backups created from the policy

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

update

Update an existing backup policy

nuodb-cp backuppolicy update [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                             [--token=<token>] [--trusted-cert=<trustedCert>]
                             [--editor=<editor>] POLICY

POLICY

The fully-qualified name of the backup policy in the format <organization>/<policy>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--editor

The editor to use to update the resource
default: ${NUODB_CP_EDITOR}

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

delete

Delete an existing backup policy

nuodb-cp backuppolicy delete [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                             [--token=<token>] [--trusted-cert=<trustedCert>]
                             [--timeout=<timeout>] POLICY

POLICY

The fully-qualified name of the backup policy in the format <organization>/<policy>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--timeout

The number of seconds to wait for the operation to be finalized, unless 0 is specified which indicates not to wait

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

database

Inspect and manage databases using the DBaaS REST service

nuodb-cp database [-hV] [list
                        |get
                        |create
                        |update
                        |delete
                        |connect]

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

list

List databases

nuodb-cp database list [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                       [--token=<token>] [--trusted-cert=<trustedCert>]
                       [-l=<labelFilter>]... [--list-accessible]
                       [--limit=<limit>] [--offset=<offset> |
                       --cursor=<cursor>] [--expand-all |
                       --expand-field=<expandFields>
                       [--expand-field=<expandFields>]...] RESOURCE

RESOURCE

The fully-qualified name of the resource containing databases to list, e.g. <organization>/<project> for a project, <organization> for an organization, or / to list databases across all organizations

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--offset

The offset at which to list items
required

--cursor

The cursor at which to list items, which represents the last item returned`
required

--expand-all

Whether to expand payload fields
required

--expand-field

Field to expand, in the format <field> or <field>=<JSONPath expression>
required

-l, --label-filter

Filter to apply based on labels

--list-accessible

Whether to return any accessible sub-resources even if the current user does not have access privileges to list all resources at this level

--limit

The number of items to return

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

get

Get an existing database

nuodb-cp database get [-whV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                      [--token=<token>] [--trusted-cert=<trustedCert>]
                      [--watch-non-interactive] DATABASE

DATABASE

The fully-qualified name of the database in the format <organization>/<project>/<database>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-w, --watch

Whether to stream events on resource. Non-interactive mode is automatically enabled if standard input or output is not connected to a TTY.

--watch-non-interactive

Whether to stream events on resource in non-interactive mode

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

create

Create a new database

nuodb-cp database create [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                         [--token=<token>] [--trusted-cert=<trustedCert>]
                         [-l=<String=String>]... [--dba-password
                         [=<dbaPassword>]] [--tier=<tier>]
                         [--expires-in=<expiresIn>] [--disabled]
                         [--restore-from-backup=<restoreFromBackup>]
                         [--archive-size=<archiveSize>]
                         [--journal-size=<journalSize>]
                         [--tier-param=<String=String>]...
                         [--inherit-tier-params]
                         [--product-version=<productVersion>] DATABASE

DATABASE

The fully-qualified name of the database in the format <organization>/<project>/<database>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-l, --label

Label to attach to resource

--dba-password

The password for the DBA user

--tier

The tier for the database

--expires-in

Set the database to expire after elapsed time

--disabled

Set the database as disabled

--restore-from-backup

The backup to restore the database from

--archive-size

The size of database archives

--journal-size

The size of database journals

--tier-param

Opaque parameter supplied to service tier

--inherit-tier-params

Whether to inherit tier parameters from the project if the database service tier matches the project.

--product-version

The version/tag of the NuoDB image to use. For available tags, see https://hub.docker.com/r/nuodb/nuodb/tags. If omitted, the database version will be inherited from the project.

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

update

Update an existing database

nuodb-cp database update [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                         [--token=<token>] [--trusted-cert=<trustedCert>]
                         [--editor=<editor>] DATABASE

DATABASE

The fully-qualified name of the database in the format <organization>/<project>/<database>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--editor

The editor to use to update the resource
default: ${NUODB_CP_EDITOR}

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

delete

Delete an existing database

nuodb-cp database delete [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                         [--token=<token>] [--trusted-cert=<trustedCert>]
                         [--timeout=<timeout>] DATABASE

DATABASE

The fully-qualified name of the database in the format <organization>/<project>/<database>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--timeout

The number of seconds to wait for the operation to be finalized, unless 0 is specified which indicates not to wait

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

connect

Connect to a database

nuodb-cp database connect [-sShV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                          [--token=<token>] [--trusted-cert=<trustedCert>]
                          --db-user=<dbUser> [--db-password[=<dbPassword>]]
                          [--ingress-port=<ingressPort>]
                          [-P=<String=String>]... [-t=<truststore>]
                          [--truststore-password=<truststorePassword>]
                          [-o=<outputFormat>] [-i=<inputFile> | -I=<input>]
                          DATABASE

DATABASE

The fully-qualified name of the database in the format <organization>/<project>/<database>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--db-user

The name of the database user
default: ${NUODB_CP_DB_USER}

--db-password

The password to authenticate the database user

--ingress-port

The port for the ingress load balancer enabling database connectivity
default: ${NUODB_CP_INGRESS_PORT}

-P, --property

A connection property

-t, --truststore

The path of the truststore to create from the CA PEM of the database response. If not specified, the truststore will be created in a temporary location. If a truststore already exists at the specified location, it will be used instead of a newly created one.

--truststore-password

The password to use for integrity checks of the truststore
default: changeIt

-o, --output-format

The format to display results when executing in non-interactive mode
default: csv

-s, --show

Show the URL and connection properties

-S, --show-only

Show the URL and connection properties without connecting to the database

-i, --input-file

File containing SQL statements to execute in non-interactive mode
required

-I, --input

SQL statements to execute in non-interactive mode
required

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

project

Inspect and manage projects using the DBaaS REST service

nuodb-cp project [-hV] [list
                       |get
                       |create
                       |update
                       |delete]

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

list

List projects

nuodb-cp project list [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                      [--token=<token>] [--trusted-cert=<trustedCert>]
                      [-l=<labelFilter>]... [--list-accessible]
                      [--limit=<limit>] [--offset=<offset> | --cursor=<cursor>]
                      [--expand-all | --expand-field=<expandFields>
                      [--expand-field=<expandFields>]...] ORGANIZATION

ORGANIZATION

The name of the organization, or / to list projects across all organizations

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--offset

The offset at which to list items
required

--cursor

The cursor at which to list items, which represents the last item returned`
required

--expand-all

Whether to expand payload fields
required

--expand-field

Field to expand, in the format <field> or <field>=<JSONPath expression>
required

-l, --label-filter

Filter to apply based on labels

--list-accessible

Whether to return any accessible sub-resources even if the current user does not have access privileges to list all resources at this level

--limit

The number of items to return

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

get

Get an existing project

nuodb-cp project get [-whV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                     [--token=<token>] [--trusted-cert=<trustedCert>]
                     [--watch-non-interactive] PROJECT

PROJECT

The fully-qualified name of the project in the format <organization>/<project>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-w, --watch

Whether to stream events on resource. Non-interactive mode is automatically enabled if standard input or output is not connected to a TTY.

--watch-non-interactive

Whether to stream events on resource in non-interactive mode

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

create

Create a new project

nuodb-cp project create [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                        [--token=<token>] [--trusted-cert=<trustedCert>]
                        [-l=<String=String>]... --sla=<sla> --tier=<tier>
                        [--tier-param=<String=String>]...
                        [--product-version=<productVersion>]
                        [--expires-in=<expiresIn>] [--disabled] PROJECT

PROJECT

The fully-qualified name of the project in the format <organization>/<project>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-l, --label

Label to attach to resource

--sla

The SLA for the project
required

--tier

The tier for the project
required

--tier-param

Opaque parameter supplied to service tier

--product-version

The version/tag of the NuoDB image to use. For available tags, see https://hub.docker.com/r/nuodb/nuodb/tags. If omitted, the project version will be resolved based on the SLA and cluster configuration.

--expires-in

Set the database to expire after elapsed time

--disabled

Set the database as disabled

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

update

Update an existing project

nuodb-cp project update [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                        [--token=<token>] [--trusted-cert=<trustedCert>]
                        [--editor=<editor>] PROJECT

PROJECT

The fully-qualified name of the project in the format <organization>/<project>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--editor

The editor to use to update the resource
default: ${NUODB_CP_EDITOR}

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

delete

Delete an existing project

nuodb-cp project delete [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                        [--token=<token>] [--trusted-cert=<trustedCert>]
                        [--timeout=<timeout>] PROJECT

PROJECT

The fully-qualified name of the project in the format <organization>/<project>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--timeout

The number of seconds to wait for the operation to be finalized, unless 0 is specified which indicates not to wait

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

user

Inspect and manage users using the DBaaS REST service

nuodb-cp user [-hV] [list
                    |get
                    |create
                    |update
                    |delete]

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

list

List users

nuodb-cp user list [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                   [--token=<token>] [--trusted-cert=<trustedCert>]
                   [-l=<labelFilter>]... [--list-accessible] [--limit=<limit>]
                   [--offset=<offset> | --cursor=<cursor>] [--expand-all |
                   --expand-field=<expandFields>
                   [--expand-field=<expandFields>]...] ORGANIZATION

ORGANIZATION

The name of the organization, or / to list users across all organizations

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--offset

The offset at which to list items
required

--cursor

The cursor at which to list items, which represents the last item returned`
required

--expand-all

Whether to expand payload fields
required

--expand-field

Field to expand, in the format <field> or <field>=<JSONPath expression>
required

-l, --label-filter

Filter to apply based on labels

--list-accessible

Whether to return any accessible sub-resources even if the current user does not have access privileges to list all resources at this level

--limit

The number of items to return

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

get

Get an existing user

nuodb-cp user get [-whV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                  [--token=<token>] [--trusted-cert=<trustedCert>]
                  [--watch-non-interactive] USER

USER

The fully-qualified name of the USER in the format <organization>/<user>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-w, --watch

Whether to stream events on resource. Non-interactive mode is automatically enabled if standard input or output is not connected to a TTY.

--watch-non-interactive

Whether to stream events on resource in non-interactive mode

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

create

Create a new user

nuodb-cp user create [-XhV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                     [--token=<token>] [--trusted-cert=<trustedCert>]
                     [-l=<String=String>]... [-P[=<password>]] [-a=<allow>]...
                     [-d=<deny>]... USER

USER

The fully-qualified name of the USER in the format <organization>/<user>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-l, --label

Label to attach to resource

-P, --user-password

The password for the user to create

-a, --allow

A rule entry that grants access to the user

-d, --deny

A rule entry that denies access to the user

-X, --allow-cross-organization

Allow user to have access outside of its organization

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

update

Update an existing user

nuodb-cp user update [-XhV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                     [--token=<token>] [--trusted-cert=<trustedCert>]
                     [--editor=<editor>] USER

USER

The fully-qualified name of the USER in the format <organization>/<user>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--editor

The editor to use to update the resource
default: ${NUODB_CP_EDITOR}

-X, --allow-cross-organization

Allow user to have access outside of its organization

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

delete

Delete an existing user

nuodb-cp user delete [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                     [--token=<token>] [--trusted-cert=<trustedCert>]
                     [--timeout=<timeout>] USER

USER

The fully-qualified name of the USER in the format <organization>/<user>

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

--timeout

The number of seconds to wait for the operation to be finalized, unless 0 is specified which indicates not to wait

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

httpclient

Issue an HTTP/REST request

nuodb-cp httpclient [-hV] [-b=<urlBase>] [-u=<user>] [-p[=<password>]]
                    [--token=<token>] [--trusted-cert=<trustedCert>]
                    [-q=<String=String>]... [-d=<data>] [-j=<jsonPath>]
                    [--full-response] [--pretty-print] [--unquote] METHOD
                    PATH...

METHOD

The request method

PATH

The resource path

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-q, --query-param

A query parameter to supply

-d, --data

The request data to supply

-j, --jsonpath

The JSONPath expression to apply to the response payload

--full-response

Whether to show the response headers and status code

--pretty-print

Whether to pretty print the response payload

--unquote

Whether to unquote the filtered response if it is a string

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

server

Server-related subcommands

nuodb-cp server [-hV] [start
                      |get-spec]

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

start

Start the REST server

nuodb-cp server start [-hV] [-p=<String=String>]...

-p, --property

A server property override

--shutdown-immediately

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

get-spec

Get OpenAPI spec for REST API

nuodb-cp server get-spec [-hV] [-u=<url>] [-f=<format>]

-u, --url

The URL for the server in the generated spec

-f, --format

The output format to use
default: json

--server-version

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

external-operator

Subcommands related to the DBaaS External Operator

nuodb-cp external-operator [-hV] [start
                                 |generate-crds]

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

start

Start the DBaaS External Operator

nuodb-cp external-operator start [-hV] [--log-levels=<logLevels>]
                                 [--kubeconfig=<kubeconfig>]
                                 [--enable-leader-election]
                                 [--property=<String=String>]... [-b=<urlBase>]
                                 [-u=<user>] [-p[=<password>]]
                                 [--token=<token>]
                                 [--trusted-cert=<trustedCert>]

--log-levels

Log levels in the format <logger name>:<level>,…, where level is one of OFF, TRACE, DEBUG, INFO, WARN, ERROR, ALL. If <logger name>: is omitted, then the root logger is assumed.

--kubeconfig

The kubeconfig file to use to configure the Kubernetes client

--enable-leader-election

Whether to enable leader election

--property

A server property override

-b, --url-base

The base URL for the server, including the protocol
default: ${NUODB_CP_URL_BASE:-http://localhost:8080}

-u, --user

The name of the user issuing the request
default: ${NUODB_CP_USER}

-p, --password

The password to authenticate the user
default: ${NUODB_CP_PASSWORD}

--token

The token used to authenticate the user
default: ${NUODB_CP_TOKEN}

--trusted-cert

The certificate used to verify the HTTPS server in PEM format
default: ${NUODB_CP_TRUSTED_CERT}

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

generate-crds

Generate CRDs for the DBaaS External Operator

nuodb-cp external-operator generate-crds [-hV] [--output-dir=<outputDir>]

--output-dir

The directory to output CRDs to

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

k8s

Inspect and manage Kubernetes state for the NuoDB Control Plane

nuodb-cp k8s [-hV] [generate-tls
                   |create-user
                   |rotate-dba-creds
                   |delete-cluster-config]

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

generate-tls

Generate TLS keys and certificates for a NuoDB project

nuodb-cp k8s generate-tls [-chV] [-e=<endpoint>] [-t[=<truststorePassword>]] [-k
                          [=<keystorePassword>]] [--key-strength=<keyStrength>]
                          [--key-type=<keyType>] [--validity=<daysValid>]
                          ORGANIZATION PROJECT

ORGANIZATION

The name of the organization containing the project to generate TLS key data for

PROJECT

The name of the project to generate TLS key data for

-e, --endpoint

Endpoint for SQL clients, which will be used as the Common Name (CN) attribute in the certificate

-t, --truststore-password

The password used to verify the integrity of the truststore

-k, --keystore-password

The password used to encrypt the keystore

--key-strength

The strength of the key-pairs to generate
default: MEDIUM

--key-type, --key-algorithm

The asymmetric encryption algorithm to use
default: RSA

--days-valid, --validity

The number of days for generated certificates to be valid
default: 365

-c, --create-secret

Whether to create the Kubernetes secret resource in configured cluster

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

create-user

Create a user secret resource for the NuoDB Control Plane REST service

nuodb-cp k8s create-user [-chV] [--password[=<password>]] -p=<project> [-ap
                         [=<authorizedProjects>...]]... [-ao
                         [=<authorizedOrganizations>...]]... [--plain-password]
                         ORGANIZATION USER

ORGANIZATION

The name of the organization the user will belong to

USER

The name of the user

--password

The password for the user

-p, --project

The project the user will be authorized to access
required

-ap, --authorized-projects

Additional projects the user will be authorized to access

-ao, --authorized-organizations

Additional organizations the user will be authorized to access

-c, --create-secret

Whether to create the Kubernetes secret resource in configured cluster that defines the user

--plain-password

Whether to serialize password as plaintext rather than serializing a salted hash of the password

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

rotate-dba-creds

Rotate DBA credentials for a NuoDB database

nuodb-cp k8s rotate-dba-creds [-hV] [--dba-password[=<dbaPassword>]]
                              [--finalize] ORGANIZATION PROJECT DATABASE

ORGANIZATION

The name of the organization for the target database

PROJECT

The name of the project for the target database

DATABASE

The name of the database which credentials are being rotated

--dba-password

The target password for the DBA user

--finalize

Finalize database DBA password rotation to make the target DBA password current

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

delete-cluster-config

Delete cluster configuration resources

nuodb-cp k8s delete-cluster-config [-yhV] [-l=<labelFilter>]...
                                   [-r=<resourceTypes>...]...
                                   [--timeout=<timeout>]

-l, --label-filter

Filter to apply based on labels

-r, --resource-types

List of cluster resource types to delete

--timeout

The number of seconds to wait for the operation to be finalized, unless 0 is specified which indicates not to wait

-y, --auto-approve

Automatically approve deletion of resources

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

generate-completion

Generate Bash or Zsh completion script for nuodb-cp

nuodb-cp generate-completion [-hV]

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

generate-doc

Generate documentation for nuodb-cp in Asciidoc format

nuodb-cp generate-doc [-hV]

-h, --help

Show this help message and exit.

-V, --version

Print version information and exit.

REST API Reference

NuoDB CRDs Reference

nuodb-cp CLI Reference

backup#

list#

get#

create#

update#

delete#

backuppolicy#

list#

list-backups#

list-databases#

get#

create#

update#

delete#

database#

list#

get#

create#

update#

delete#

connect#

project#

list#

get#

create#

update#

delete#

user#

list#

get#

create#

update#

delete#

httpclient#

server#

start#

get-spec#

external-operator#

start#

generate-crds#

k8s#

generate-tls#

create-user#

rotate-dba-creds#

delete-cluster-config#

generate-completion#

generate-doc#

backup

list

get

create

update

delete

backuppolicy

list

list-backups

list-databases

get

create

update

delete

database

list

get

create

update

delete

connect

project

list

get

create

update

delete

user

list

get

create

update

delete

httpclient

server

start

get-spec

external-operator

start

generate-crds

k8s

generate-tls

create-user

rotate-dba-creds

delete-cluster-config

generate-completion

generate-doc