Remote command-line nz

Deployment options: Netezza Performance Server for Cloud Pak for Data

Use the nz command to remotely run Netezza commands in a secure way through TLS/SSL to view, manage, and modify various aspects of your Netezza instances.

On Netezza Performance Server for Cloud Pak for Data, ports 5481, 5482 and 5483 are not exposed by default. To issue the commands that go through those ports, you must use the nz command line.

The nz command accepts subcommands and options (flags or switches), which control the behavior of the command. In addition, you can set the CPD_HOST, CPD_USER, and CPD_PASSWORD Cloud Pak for Data environment variables, and forgo specifying the -u, -pw, and -host options when you run the nz commands.

Syntax

nz instance [subcommands] [options]

Subcommands

The subcommands that you can run with nz are divided into three groups:
1. High-level nz commands
This group includes high-level backup and restore related commands. With high-level nz commands, you can set, view, and modify backup schedules, update backup and restore object store credentials and details, or start backup and restore operations.
You can also synchronize database backup images that are migrated from other Netezza systems to Cloud Object Storage (COS) and restored into a Netezza on Cloud database.
2. nz commands
This group includes certain client and support toolkit commands. With nz subcommands, you can, in a secure way, remotely start a curated group of commonly used nz commands that typically run on the host, such as nzhw or nzds.
3. Cloud Pak for Data commands
This group includes commands that you can use to manage Netezza on Cloud instances. With Cloud Pak for Data commands, you can update the system, scale it, pause it, resume it.
You can also manage Netezza on Cloud users, synchronize users between Netezza on Cloud and Cloud Pak for Data, and start other Cloud Pak for Data platform-level operations.

Environment variables

If you set the following environment variables, you can forgo specifying the -u, -pw, and -host options when you are running select nz commands.
CPD_HOST
The Cloud Pak for Data endpoint or hostname.
CPD_USER
This value is usually the same as the privileged Netezza user or admin.
CPD_PASSWORD
The password for the CPD_USER.
  • For Linux or Mac OSX terminal:
    export CPD_HOST=<cpd-hostname>
export CPD_USER=<cpd-admin-user>
export CPD_PASSWORD=<cpd-admin-user-password>
  • For Windows (cmd.exe):
    set CPD_HOST=<cpd-hostname>
set CPD_USER=<cpd-admin-user>
set CPD_PASSWORD=<cpd-admin-user-password>