Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.2)
  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.  
      configureCertsForPlugins
    85.  
      configureMQ
    86.  
      configurePorts
    87.  
      configureWebServerCerts
    88.  
      create_nbdb
    89.  
      csconfig cldinstance
    90.  
      csconfig cldprovider
    91.  
      csconfig meter
    92.  
      csconfig throttle
    93.  
      csconfig reinitialize
    94.  
      duplicatetrace
    95.  
      importtrace
    96.  
      jbpSA
    97.  
      jnbSA
    98.  
      ltid
    99.  
      manageClientCerts
    100.  
      mklogdir
    101.  
      nbauditreport
    102.  
      nbcatsync
    103.  
      NBCC
    104.  
      NBCCR
    105.  
      nbcertcmd
    106.  
      nbcertupdater
    107.  
      nbcldutil
    108.  
      nbcloudrestore
    109.  
      nbcomponentupdate
    110.  
      nbcplogs
    111.  
      nbdb_admin
    112.  
      nbdb_backup
    113.  
      nbdb_move
    114.  
      nbdb_ping
    115.  
      nbdb_restore
    116.  
      nbdb_unload
    117.  
      nbdbms_start_server
    118.  
      nbdbms_start_stop
    119.  
      nbdc
    120.  
      nbdecommission
    121.  
      nbdelete
    122.  
      nbdeployutil
    123.  
      nbdevconfig
    124.  
      nbdevquery
    125.  
      nbdiscover
    126.  
      nbdna
    127.  
      nbemm
    128.  
      nbemmcmd
    129.  
      nbfindfile
    130.  
      nbfirescan
    131.  
      nbftadm
    132.  
      nbftconfig
    133.  
      nbgetconfig
    134.  
      nbhba
    135.  
      nbholdutil
    136.  
      nbhostidentity
    137.  
      nbhostmgmt
    138.  
      nbhypervtool
    139.  
      nbimageshare
    140.  
      nbinstallcmd
    141.  
      nbjm
    142.  
      nbkmsutil
    143.  
      nboraadm
    144.  
      nborair
    145.  
      nbpem
    146.  
      nbpemreq
    147.  
      nbperfchk
    148.  
      nbplupgrade
    149.  
      nbrb
    150.  
      nbrbutil
    151.  
      nbregopsc
    152.  
      nbreplicate
    153.  
      nbrepo
    154.  
      nbrestorevm
    155.  
      nbseccmd
    156.  
      nbsetconfig
    157.  
      nbsnapimport
    158.  
      nbsnapreplicate
    159.  
      nbsqladm
    160.  
      nbstl
    161.  
      nbstlutil
    162.  
      nbstop
    163.  
      nbsu
    164.  
      nbsvrgrp
    165.  
      resilient_clients
    166.  
      restoretrace
    167.  
      stopltid
    168.  
      tl4d
    169.  
      tl8d
    170.  
      tl8cd
    171.  
      tldd
    172.  
      tldcd
    173.  
      tlhd
    174.  
      tlhcd
    175.  
      tlmd
    176.  
      tpautoconf
    177.  
      tpclean
    178.  
      tpconfig
    179.  
      tpext
    180.  
      tpreq
    181.  
      tpunmount
    182.  
      verifytrace
    183.  
      vltadm
    184.  
      vltcontainers
    185.  
      vlteject
    186.  
      vltinject
    187.  
      vltoffsitemedia
    188.  
      vltopmenu
    189.  
      vltrun
    190.  
      vmadd
    191.  
      vmchange
    192.  
      vmcheckxxx
    193.  
      vmd
    194.  
      vmdelete
    195.  
      vmoprcmd
    196.  
      vmphyinv
    197.  
      vmpool
    198.  
      vmquery
    199.  
      vmrule
    200.  
      vmupdate
    201.  
      vnetd
    202.  
      vssat
    203.  
      vwcp_manage
    204.  
      vxlogcfg
    205.  
      vxlogmgr
    206.  
      vxlogview
    207.  
      W2KOption

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 [-new_instance instance_name] -host name [-new_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.

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 or -new_instance instance_name

Specifies the name of the SQL Server instance.

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_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 [-new_instance instance_name] -host name [-new_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.

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

Change the attributes of the specified instance group. The -new_instance instance_name option changes the name of the instance. The -new_host name option updates the host where the database resides.

-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