Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (9.0.0.1, 9.0)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
  2. Appendix A. NetBackup Commands
    1.  
      acsd
    2.  
      add_media_server_on_clients
    3.  
      backupdbtrace
    4.  
      backuptrace
    5.  
      bmrc
    6.  
      bmrconfig
    7.  
      bmrepadm
    8.  
      bmrprep
    9.  
      bmrs
    10.  
      bmrsrtadm
    11.  
      bp
    12.  
      bparchive
    13.  
      bpbackup
    14.  
      bpbackupdb
    15.  
      bpcatarc
    16.  
      bpcatlist
    17.  
      bpcatres
    18.  
      bpcatrm
    19.  
      bpcd
    20.  
      bpchangeprimary
    21.  
      bpclient
    22.  
      bpclimagelist
    23.  
      bpclntcmd
    24.  
      bpclusterutil
    25.  
      bpcompatd
    26.  
      bpconfig
    27.  
      bpdbjobs
    28.  
      bpdbm
    29.  
      bpdgclone
    30.  
      bpdown
    31.  
      bpduplicate
    32.  
      bperror
    33.  
      bpexpdate
    34.  
      bpfis
    35.  
      bpflist
    36.  
      bpgetconfig
    37.  
      bpgetdebuglog
    38.  
      bpimage
    39.  
      bpimagelist
    40.  
      bpimmedia
    41.  
      bpimport
    42.  
      bpinst
    43.  
      bpkeyfile
    44.  
      bpkeyutil
    45.  
      bplabel
    46.  
      bplist
    47.  
      bpmedia
    48.  
      bpmedialist
    49.  
      bpminlicense
    50.  
      bpnbat
    51.  
      bpnbaz
    52.  
      bppficorr
    53.  
      bpplcatdrinfo
    54.  
      bpplclients
    55.  
      bppldelete
    56.  
      bpplinclude
    57.  
      bpplinfo
    58.  
      bppllist
    59.  
      bpplsched
    60.  
      bpplschedrep
    61.  
      bpplschedwin
    62.  
      bppolicynew
    63.  
      bpps
    64.  
      bprd
    65.  
      bprecover
    66.  
      bprestore
    67.  
      bpretlevel
    68.  
      bpschedule
    69.  
      bpschedulerep
    70.  
      bpsetconfig
    71.  
      bpstsinfo
    72.  
      bpstuadd
    73.  
      bpstudel
    74.  
      bpstulist
    75.  
      bpsturep
    76.  
      bptestbpcd
    77.  
      bptestnetconn
    78.  
      bptpcinfo
    79.  
      bpup
    80.  
      bpverify
    81.  
      cat_convert
    82.  
      cat_export
    83.  
      cat_import
    84.  
      configureCerts
    85.  
      configureCertsForPlugins
    86.  
      configureMQ
    87.  
      configurePorts
    88.  
      configureWebServerCerts
    89.  
      create_nbdb
    90.  
      csconfig cldinstance
    91.  
      csconfig cldprovider
    92.  
      csconfig meter
    93.  
      csconfig reinitialize
    94.  
      csconfig throttle
    95.  
      duplicatetrace
    96.  
      importtrace
    97.  
      jbpSA
    98.  
      jnbSA
    99.  
      ltid
    100.  
      manageClientCerts
    101.  
      mklogdir
    102.  
      nbauditreport
    103.  
      nbcatsync
    104.  
      NBCC
    105.  
      NBCCR
    106.  
      nbcertcmd
    107.  
      nbcertupdater
    108.  
      nbcldutil
    109.  
      nbcloudrestore
    110.  
      nbcomponentupdate
    111.  
      nbcplogs
    112.  
      nbcredkeyutil
    113.  
      nbdb_admin
    114.  
      nbdb_backup
    115.  
      nbdb_move
    116.  
      nbdb_ping
    117.  
      nbdb_restore
    118.  
      nbdb_unload
    119.  
      nbdb2adutl
    120.  
      nbdbms_start_server
    121.  
      nbdbms_start_stop
    122.  
      nbdc
    123.  
      nbdecommission
    124.  
      nbdelete
    125.  
      nbdeployutil
    126.  
      nbdevconfig
    127.  
      nbdevquery
    128.  
      nbdiscover
    129.  
      nbdna
    130.  
      nbemm
    131.  
      nbemmcmd
    132.  
      nbfindfile
    133.  
      nbfirescan
    134.  
      nbftadm
    135.  
      nbftconfig
    136.  
      nbgetconfig
    137.  
      nbhba
    138.  
      nbholdutil
    139.  
      nbhostidentity
    140.  
      nbhostmgmt
    141.  
      nbhypervtool
    142.  
      nbidpcmd
    143.  
      nbimageshare
    144.  
      nbinstallcmd
    145.  
      nbjm
    146.  
      nbkmiputil
    147.  
      nbkmscmd
    148.  
      nbkmsutil
    149.  
      nboraadm
    150.  
      nborair
    151.  
      nbpem
    152.  
      nbpemreq
    153.  
      nbmlb
    154.  
      nbperfchk
    155.  
      nbplupgrade
    156.  
      nbrb
    157.  
      nbrbutil
    158.  
      nbregopsc
    159.  
      nbreplicate
    160.  
      nbrepo
    161.  
      nbrestorevm
    162.  
      nbseccmd
    163.  
      nbsetconfig
    164.  
      nbsnapimport
    165.  
      nbsnapreplicate
    166.  
      nbsqladm
    167.  
      nbstl
    168.  
      nbstlutil
    169.  
      nbstop
    170.  
      nbsu
    171.  
      nbsvrgrp
    172.  
      resilient_clients
    173.  
      restoretrace
    174.  
      stopltid
    175.  
      tldd
    176.  
      tldcd
    177.  
      tpautoconf
    178.  
      tpclean
    179.  
      tpconfig
    180.  
      tpext
    181.  
      tpreq
    182.  
      tpunmount
    183.  
      verifytrace
    184.  
      vltadm
    185.  
      vltcontainers
    186.  
      vlteject
    187.  
      vltinject
    188.  
      vltoffsitemedia
    189.  
      vltopmenu
    190.  
      vltrun
    191.  
      vmadd
    192.  
      vmchange
    193.  
      vmcheckxxx
    194.  
      vmd
    195.  
      vmdelete
    196.  
      vmoprcmd
    197.  
      vmphyinv
    198.  
      vmpool
    199.  
      vmquery
    200.  
      vmrule
    201.  
      vmupdate
    202.  
      vnetd
    203.  
      vssat
    204.  
      vwcp_manage
    205.  
      vxlogcfg
    206.  
      vxlogmgr
    207.  
      vxlogview
    208.  
      W2KOption
  3.  
    Index

Name

nbsqladm — configure SQL Server instances for a SQL Server Intelligent backup policy

SYNOPSIS

nbsqladm [-S master_server] -list_instances [instance_name] [-host name] [-active | -inactive] [-registered | -unregistered]

nbsqladm [-S master_server] -add_instance instance_name -host name [-instance_group name | -local_credentials | -user name -domain name] [-force]

nbsqladm [-S master_server] -register_instance instance_name [-host name] [-instance_group name | -local_credentials | -user name -domain name] [-force]

nbsqladm [-S master_server] -delete_instance instance_name [-host name]

nbsqladm [-S master_server] -modify_instance instance_name -host name [-instance_group name | -local_credentials | -user name -domain name] [-active | -inactive] [-force]

nbsqladm [-S master_server] -remove_from_instance_group instance_name [-instance_group name] [-host name]

nbsqladm [-S master_server] -initiate_availability_group_browse instance_name -host name

nbsqladm [-S master_server] -initiate_discovery

nbsqladm [-S master_server] -list_instance_groups [instance_group_name]

nbsqladm [-S master_server] -add_instance_group instance_group_name [-local_credentials | -user name -domain name]

nbsqladm [-S master_server] -delete_instance_group name

nbsqladm [-S master_server] -modify_instance_group name [-new_instance_group name] [[-local_credentials | -user name -domain name] [-validate]]

nbsqladm [-S master_server] -list_availability_groups [-ag_name name] [-cluster cluster_name] [-ag_id availability_group_ID]

nbsqladm [-S master_server] -add_availability_group -ag_name name {-cluster cluster_name | -ag_id availability_group_ID} [-instance instance_name -host name]

nbsqladm [-S master_server] -delete_availability_group -ag_name name {-cluster cluster_name | -ag_id availability_group_ID}

nbsqladm [-S master_server] -list_replicas -ag_name name {-cluster cluster_name | -ag_id availability_group_ID}

nbsqladm [-S master_server] -add_replica -ag_name name {-cluster cluster_name | -ag_id availability_group_ID} -instance instance_name -host name [-force]

nbsqladm [-S master_server] -delete_replica -ag_name name {-cluster cluster_name | -ag_id availability_group_ID} -instance instance_name -host name

nbsqladm [-S master_server] -list_dbas

nbsqladm [-S master_server] -add_dba host_name user_name

nbsqladm [-S master_server] -delete_dba host_name user_name

nbsqladm [-S master_server] -auto_registration instance_group_name

nbsqladm [-S master_server] -disable_auto_registration

 

On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/

On Windows systems, the directory path to this command is install_path\NetBackup\bin\

DESCRIPTION

The nbsqladm command configures SQL Server instances, instance groups, and availability groups for use with a SQL Server Intelligent Policy. Supported availability groups include basic, advanced, and read-scale. You can also use this command on the master server to authorize DBAs to use the nbsqladm on a specific host.

You can disable or enable the nbsqladm command with the ENABLE_NBSQLADM option in the bp.conf file or in the registry. This command is enabled by default. To disable the command, use ENABLE_NBSQLADM=0.

OPTIONS

-add_availability_group -ag_name name {-cluster cluster_name | -ag_id availability_group_ID} -instance instance_name -host name

Add an availability group to the NetBackup catalog. You can add only the availability group and at a later point add the instances. This way you can build the availability group topology more quickly. For advanced and basic availability groups provide the -cluster cluster_name, which is the name of the Windows Server Failover Clustering (WSFC) cluster. For read-scale availability groups provide the -ag_id availability_group_ID.

To add the full AG topology including the instances, use the -instance instance_name -host name option.

-add_dba host_name user_name

Authorizes the specified DBA (user_name) to use the nbsqladm command on a specific host (host_name). Can only be used on the master server.

If you have multiple NICs, provide the private interface name of the SQL Server host.

For a SQL Server cluster, authorize the DBA for each node in the cluster. (Do not authorize a DBA using the virtual name of the SQL Server cluster.) For the -host name provide one of the node names in the SQL Server cluster.

For a SQL Server cluster with multiple NICs, authorize the DBA using the private interface name for each of the nodes in the SQL Server cluster.

-add_instance instance_name -host name [-instance_group name | -local_credentials | -user name -domain name] [-force]

Add an instance to the NetBackup catalog. After you add an availability group instance, use the -add_replica option.

-add_instance_group instance_group_name [-local_credentials | -user name -domain name]

Add an instance group to the NetBackup catalog. You can add credentials to the instance group with the -local_credentials or the -user name -domain name option.

-auto_registration instance_group_name

Enables the automatic registration for the named instance group. Newly discovered instances are automatically registered with the group credentials and added to the instance group. If you want any instances that were previously discovered to be included in the instance group, you must add those instances manually. Only one instance group can be enabled for automatic registration.

-add_replica -ag_name name {-cluster cluster_name | -ag_id availability_group_ID} -instance instance_name -host name [-force]

Add a replica of an availability group to the NetBackup catalog. Use this option after you add the availability group instance. For advanced and basic availability groups provide the -cluster cluster_name, which is the name of the Windows Server Failover Clustering (WSFC) cluster. For read-scale availability groups provide the -ag_id availability_group_ID.

-delete_dba host_name user_name

Removes the authorization to use the nbsqladm command for the specified host (host_name) and DBA (user_name). Can only be used on the master server.

If you have multiple NICs, provide the private interface name of the SQL Server host.

For a SQL Server cluster, remove authorization for the DBA for each node in the cluster. (You cannot remove authorization for a DBA using the virtual name of the SQL Server cluster.) For the -host_name provide one of the node names in the SQL Server cluster.

For a SQL Server cluster with multiple NICs, remove authorization using the private interface name for each of the nodes in the SQL Server cluster.

-delete_availability_group -ag_name name {-cluster cluster_name | -ag_id availability_group_ID}

Delete an availability group from the NetBackup catalog. For advanced and basic availability groups provide the -cluster cluster_name, which is the name of the Windows Server Failover Clustering (WSFC) cluster. For read-scale availability groups provide the -ag_id availability_group_ID.

-delete_instance instance_name [-host name]

Delete an instance from the NetBackup catalog.

-delete_instance_group name

Delete an instance group.

-delete_replica -ag_name name {-cluster cluster_name | -ag_id availability_group_ID}

Delete a replica of an availability group from the NetBackup catalog. For advanced and basic availability groups provide the -cluster cluster_name, which is the name of the Windows Server Failover Clustering (WSFC) cluster. For read-scale availability groups provide the -ag_id availability_group_ID.

-disable_auto_registration

Disables the automatic registration so that newly discovered instances are not automatically registered and added to an instance group.

-force

Forces NetBackup to register the instance or the replica instance and skip the validation of the instance credentials. NetBackup for SQL Server cannot protect any instances that are not registered or that have invalid credentials.

-host name

Specifies the name of the host where the SQL Server database resides.

If you have multiple NICs, provide the private interface name of the SQL Server host. For a SQL Server cluster, for the host name provide the virtual name of the SQL Server cluster. For a SQL Server cluster with multiple NICs, provide the private virtual name of the SQL Server cluster.

-instance instance_name

Specifies the name of the SQL Server instance.

-instance_group name

Specifies the name of the instance group to which you want to add or remove an instance.

Or indicates that the instance group you want to use to register an instance. Alternatively, you can register an instance with instance group credentials or specific credentials. Also see the -local_credentials and -user name -domain name options.

The credentials must have certain security privileges. See the NetBackup for SQL Server Administrator's Guide.

-initiate_availability_group_browse instance_name -host name

Initiates discovery of a read-scale availability group. Any availability groups associated with the instance_name and host are discovered.

-initiate_discovery

Start the discovery process to discover any SQL Server instances that were added to your environment since the last discovery.

-list_availability_groups [-ag_name name] [-cluster cluster_name] [-ag_id availability_group_ID]

List the SQL Server availability groups in the NetBackup catalog. To list an availability group with a specific name, use -ag_name name. To list an advanced or a basic availability group that is part of a specific Windows Server Failover Clustering (WSFC) cluster, use -cluster cluster_name. To list read-scale availability groups, use the -ag_id availability_group_ID.

-list_dbas

Display a list of all database administrators (DBAs) able to use nbsqladm. Can only be used on the master server.

-list_instances [instance_name] [-host name] [-active | -inactive] [-registered | -unregistered]

List all SQL Server instances in the NetBackup catalog.

Use instance_name or -host name to list a specific instance. Use -registered or -unregistered to list the registered or unregistered SQL Server instances. The options -active and -inactive to display the instances that are active for NetBackup (available for backup) and the inactive instances.

-list_instance_groups [instance_group_name]

List the SQL Server instance groups that exist. Use instance_group_name to list a specific instance group.

-list_replicas -ag_name name {-cluster cluster_name | -ag_id availability_group_ID}

List all availability group replicas in the NetBackup catalog. The -ag_name name option indicates the availability group. To list replicas in an advanced or a basic availability group that is part of a specific Windows Server Failover Clustering (WSFC) cluster, use -cluster cluster_name. For read-scale availability groups, use -ag_id availability_group_ID.

-local_credentials

Indicates that you want to register an instance with the credentials that were used to install NetBackup. Alternatively, you can register an instance with instance group credentials or specific credentials. See the -instance_group name and -user name -domain name options.

The credentials must have certain security privileges. See the NetBackup for SQL Server Administrator's Guide.

When it is used with the -validate option to modify an instance group you can also validate the credentials for each instance in the group.

-modify_instance instance_name -host name [-instance_group name | -local_credentials | -user name -domain name] [-active | -inactive] [-force]

Change the attributes of the specified instance.

Use -active to make an instance that you deactivated in NetBackup available for backup. Or you can make an instance inactive in NetBackup with -inactive. For example, if the instance is under maintenance.

The options -new_instance and -new_host are deprecated. To change an instance or a host name, delete the instance and use the -add_instance option to add the instance again.

-modify_instance_group [-new_instance_group name] [[-local_credentials | -user name -domain name] [-validate]]

Change the attributes of the specified instance group.

-new_instance_group name changes the name of the instance group. Use -local_credentials or -user name -domain name to add or change the credentials for the instance group. The -validate option validates the group credentials for each instance in the instance group. This option is used with -local_credentials or -user name -domain name.

-register_instance instance_name [-instance_group name | -local_credentials | -user name -domain name] [-force]

Register credentials for an instance. See the description for -instance_group name, -local_credentials, and -user name -domain name.

For a SQL Server cluster or multiple NICs, before you register an instance ensure that the instance was added with the correct host name. If you have multiple NICs, the host name is the private interface name of the SQL Server host. A SQL Server cluster requires only one entry in instance management; the host name is the virtual name of the SQL Server cluster. For a SQL Server cluster with multiple NICs, the host name is the private virtual name of the SQL Server cluster.

-remove_from_instance_group instance_name [-instance_group name] [-host name]

Remove an instance from an instance group.

-S master_server

Specifies the master server for the instance or the instance group that you want to add, change, or delete. Or use to indicate the master server on which you want to perform a specific command.

-user name -domain name

Indicates that you want to register an instance with the specific credentials that you provide. Alternatively, you can register an instance with instance group credentials or local credentials. See the -instance_group name and -local_credentials options.

The credentials must have certain security privileges. See the NetBackup for SQL Server Administrator's Guide.

When it is used with the -validate option to modify an instance group you can also validate the credentials for each instance in the group.

EXAMPLES

Example 1 - Add local credentials to the instance group marketing without validating the credentials.

nbsqladm -modify_instance_group marketing -local_credentials

Example 2 - Add credentials for the user adminuser in the domain corp to the instance group marketing. Also validate the credentials for each instance in the group.

nbsqladm -modify_instance_group marketing -user adminuser -domain 
corp -validate