The nz tool

Downloading the nz tool

You can download the nz tool using folowing methods:

1. Using command-line interface

   Run the command:

   curl -o nz -k https://<API Server URL>/<version number>/download/<platform specific package>
   chmod +x nz
   

   where the API Server URL is API Server URL details.

   To retrieve this information, follow the steps:

   1. Log in to your IBM Cloud account.

   2. Go to Resource list > Services and Software > Databases.

   3. Click your Netezza Performance Server instance. You are now on the Service instance details page. In the Public Endpoints section, you can find information (URL details) about endpoints for accessing the web console, the API server, and the database.

   Examples:

   To download nz on a Linux box, run:

   curl -o nz -k https://<API Server URL>/v2/download/nz-linux-amd64
   

   To download nz on Windows, run:

   curl.exe -o nz.exe -k https://<API Server URL>/v2/download/nz-windows-amd64
   

2. Download from fix-central

   You can download the nzcli from Fix Central.

The nz syntax

The nz tool supports execution of select NPSaaS commands and Software Support Tools. Command execution syntax depends on the command type - NPSaaS command or Software Support Tool, and whether a shortcut command was installed.

1. For a list of supported NPSaaS commands and Software Support Tools, see Commands supported by the nz tool.
2. Execution of a Software Support Tool requires a run command: run, run-async, run-without-creds, or run-show-progress.
3. For more information about command shortcuts, including which commands can have shortcuts created, see Creating nz shortcuts with the nz install command.
4. You can set the APISERVER_URL, NZ_USER, and NZ_PASSWORD environment variables and forgo specifying the -apiserver, -u, and -pw options.

Beginning with 11.2.2.10, the APISERVER_URL must be used instead of the host argument. To ensure optimal performance, you should redownload nz tool at least every other release.

NPSaaS command syntax

nz [command] [subcommands] [options]

Example:

./nz nzstate -apiserver <apiserver-url> -u <nps-admin-user> -pw <nps-admin-user-password>
System state is 'Online'.

NPSaaS command shortcut syntax

[command] [subcommand] [options]

Example:

./nzstate -apiserver <apiserver-url> -u <nps-admin-user> -pw <nps-admin-user-password>
System state is 'Online'.

Software Support Tool syntax

nz [run-command] [software-support-tool] [subcommands] [options]

Example:

./nz run nz_get_table_rowcount database1 table1

nzbackup
nzbatchbnr
nzds
nzhw
nzrestore
nzrev
nzstate
nzstats
nzsession
nzsystem
nzprogress

nz_abort
nz_altered_tables
nz_backup_size_estimate
nz_best_practices
nz_build_html_help_output
nz_catalog_dump
nz_catalog_size
nz_change_owner
nz_check_statistics
nz_check_views
nz_cksum
nz_clone
nz_columns
nz_compiler_stats
nz_compressedTableRatio
nz_db_group_access_listing
nz_db_size
nz_db_tables_rowcount
nz_db_tables_rowcount_statistic
nz_db_user_access_listing
nz_db_views_rowcount
nz_ddl
nz_ddl_aggregate
nz_ddl_all_grants
nz_ddl_comment
nz_ddl_database
nz_ddl_diff
nz_ddl_ext_table
nz_ddl_function
nz_ddl_grant_group
nz_ddl_grant_role
nz_ddl_grant_user
nz_ddl_group
nz_ddl_history_config
nz_ddl_mview
nz_ddl_object
nz_ddl_owner
nz_ddl_procedure
nz_ddl_role
nz_ddl_scheduler_rule
nz_ddl_schema
nz_ddl_security
nz_ddl_sequence
nz_ddl_synonym
nz_ddl_sysdef
nz_ddl_table
nz_ddl_table_redesign
nz_ddl_user
nz_ddl_view
nz_ddl_view+
nz_dimension_or_fact
nz_find_32bit_udx
nz_find_control_chars_in_data
nz_find_non_integer_strings
nz_find_object
nz_find_object_orphans
nz_find_object_owners
nz_find_table_orphans
nz_fix_the_permissions
nz_frag
nz_genstats
nz_get
nz_get_acl
nz_get_admin
nz_get_aggregate_name
nz_get_aggregate_names
nz_get_aggregate_signatures
nz_get_column_attnum
nz_get_column_name
nz_get_column_names
nz_get_column_oid
nz_get_column_type
nz_get_database_name
nz_get_database_names
nz_get_database_objid
nz_get_database_owner
nz_get_database_table_column_names
nz_get_ext_table_name
nz_get_ext_table_names
nz_get_ext_table_objid
nz_get_ext_table_owner
nz_get_function_name
nz_get_function_names
nz_get_function_signatures
nz_get_group_name
nz_get_group_names
nz_get_group_objid
nz_get_group_owner
nz_get_group_users
nz_get_lastTXid
nz_get_library_name
nz_get_library_names
nz_get_mgmt_table_name
nz_get_mgmt_table_names
nz_get_mgmt_view_name
nz_get_mgmt_view_names
nz_get_model
nz_get_mview_basename
nz_get_mview_definition
nz_get_mview_matrelid
nz_get_mview_name
nz_get_mview_names
nz_get_mview_objid
nz_get_mview_owner
nz_get_object_name
nz_get_object_objid
nz_get_object_owner
nz_get_object_type
nz_get_procedure_name
nz_get_procedure_names
nz_get_procedure_signatures
nz_get_role_name
nz_get_role_names
nz_get_schema_name
nz_get_schema_names
nz_get_schema_objid
nz_get_sequence_name
nz_get_sequence_names
nz_get_sequence_objid
nz_get_sequence_owner
nz_get_stableTXid
nz_get_synonym_definition
nz_get_synonym_name
nz_get_synonym_names
nz_get_synonym_objid
nz_get_synonym_owner
nz_get_sysmgmt_table_name
nz_get_sysmgmt_table_names
nz_get_sysmgmt_table_objid
nz_get_sysmgmt_view_name
nz_get_sysmgmt_view_names
nz_get_sysmgmt_view_objid
nz_get_sys_table_name
nz_get_sys_table_names
nz_get_sys_view_name
nz_get_sys_view_names
nz_get_table_distribution_key
nz_get_table_fks
nz_get_table_name
nz_get_table_names
nz_get_table_objid
nz_get_table_organization_key
nz_get_table_owner
nz_get_table_pk
nz_get_table_rowcount
nz_get_table_rowcount_statistic
nz_get_user_groups
nz_get_user_name
nz_get_user_names
nz_get_user_objid
nz_get_user_owner
nz_get_view_definition
nz_get_view_name
nz_get_view_names
nz_get_view_objid
nz_get_view_owner
nz_get_view_rowcount
nz_grep_views
nz_groom
nz_host_memory
nz_inconsistent_data_types
nz_index
nz_invisible
nz_lock
nz_maintenance_mode
nz_migrate
nz_my_access
nz_my_grants
nz_online_vacuum
nz_permissions_audit
nz_physical_table_layout
nz_plan
nz_query_history
nz_query_stats
nz_record_skew
nz_rerandomize
nz_rev
nz_set
nz_show_locks
nz_skew
nz_sort_order
nz_spu_memory
nz_spu_swap_space
nz_spu_top
nz_state
nz_stats
nz_storage_stats
nz_sysutil_stats
nz_table_analyze
nz_table_constraints
nz_table_references
nz_tables
nz_test
nz_transactions
nz_truncate
nz_update_statistic_date_high_value
nz_update_statistic_length
nz_update_statistic_min_or_max
nz_update_statistic_null_values
nz_update_statistic_table_rowcount
nz_update_statistic_unique_values
nz_usage
nz_view_plan_file
nz_view_references
nz_wrapper
nz_zonemap

nz install syntax

1. --dry-run: displays the symlinks that will be created.
2. --dest: directory where links are installed.
3. --force: overwrites a pre-existing link.

nz install [--dry-run] [--dest DESTINATION-DIRECTORY] [--force]

Example:

./nz install --dest /usr/local/bin --force
2024/09/13 09:18:09 main.go:131: Linking /root/nz -> /usr/local/bin/nzbackup
2024/09/13 09:18:09 main.go:131: Linking /root/nz -> /usr/local/bin/nzrestore
2024/09/13 09:18:09 main.go:131: Linking /root/nz -> /usr/local/bin/nzsystem
2024/09/13 09:18:09 main.go:131: Linking /root/nz -> /usr/local/bin/nzds
2024/09/13 09:18:09 main.go:131: Linking /root/nz -> /usr/local/bin/nzhw
2024/09/13 09:18:09 main.go:131: Linking /root/nz -> /usr/local/bin/nzstate
2024/09/13 09:18:09 main.go:131: Linking /root/nz -> /usr/local/bin/nzbatchbnr
2024/09/13 09:18:09 main.go:131: Linking /root/nz -> /usr/local/bin/nzrev
2024/09/13 09:18:09 main.go:131: Linking /root/nz -> /usr/local/bin/nzstats
2024/09/13 09:18:09 main.go:131: Linking /root/nz -> /usr/local/bin/nzsession

Creating nz shortcuts with the nz install command

You can create shortcuts for the following commonly used commands by running the nz install command. As a result, for example, instead of running nz nzstate, you can issue nzstate.

nzbackup
nzbatchbnr
nzds
nzhw
nzrestore
nzrev
nzsession
nzstate
nzstats
nzsystem

nz environment variables

Set the APISERVER_URL, NZ_USER, and NZ_PASSWORD environment variables to forgo specifying the -apiserver, -u, and -pw options when you are running nz commands.

• From Linux or Mac OSX terminal, run:

  export APISERVER_URL=<api-server-url>
  export NZ_USER=<nps-admin-user>
  export NZ_PASSWORD=<nps-admin-user-password>
  

• From Windows (cmd.exe), run:

  set APISERVER_URL=<api-server-url>
  set NZ_USER=<nps-admin-user>
  set NZ_PASSWORD=<nps-admin-user-password>
  

CLI

For more information about commands, see the command-line interface section.

Username formatting

• Use a single quote followed by double quotes '" "' for usernames that:

  • Contain lowercase letters.
  • Include special characters other than an underscore _ or @ symbol.

  Example - Username: SampleUser → '"SampleUser"'

• For all other usernames, double quotes "" are optional.

  Example - Username: SAMPLEUSER → SAMPLEUSER or "SAMPLEUSER"

Case Sensitivity:

• DB Users: Usernames are not case-sensitive.

  Example - sample_user and SAMPLE_USER are treated the same.

• IBMIAM Users: Usernames are case-sensitive.

  Example - sample_user@ibm.com and SAMPLE_USER@ibm.com are treated differently.