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

nboraadm — set up instances and instance groups as part of an Oracle backup policy

SYNOPSIS

nboraadm [-S master_server] -list_rac_dbs [{-rac_dbid dbid -rac_db_unique_name name}] [-rac_type type] [-scan_name name] [-service_name name] [-port number] [-active | -inactive] [-registered | -unregistered]

nboraadm [-S master_server] -list_rac_instances [instance_name] [{-rac_dbid dbid -rac_db_unique_name name}] [-host name] [-backup_host name] [-os Unix | Windows] [-active | -inactive] [-registered | -unregistered]

nboraadm [-S master_server] -add_rac_db -rac_dbid dbid -rac_db_unique_name name -rac_type type -scan_name name -service_name name -port number [-load_balanced_node_count number]

nboraadm [-S master_server] -add_rac_instance instance_name -rac_dbid dbid -rac_db_unique_name name -host name -oracle_home oracle_home [-backup_priority priority] [-backup_host name]

nboraadm [-S master_server] -delete_rac_db -rac_db_unique_name name [-rac_dbid dbid] [-scan_name name]

nboraadm [-S master_server] -delete_rac_instance instance_name [-host name] [-backup_host name] [-rac_dbid dbid] [-rac_db_unique_name name] [-oracle_home oracle_home]

nboraadm [-S master_server] -modify_rac_db -rac_dbid dbid -rac_db_unique_name name [-new_scan_name name] [-rac_type type] [-load_balanced_node_count number] [-port number] [-scan_name name] [-service_name name] {[-oracle_auth user [-oracle_TNS tns] | -disable_oracle_auth] | [-wallet_path path [-wallet_rman_TNS tns | -disable_rman_catalog] | -disable_wallet_auth]} [-rman_catalog_user name [-rman_catalog_TNS tns] | -disable_rman_catalog] [-active | -inactive] [-force] [-no_warnings]

nboraadm [-S master_server] -register_rac_db -rac_db_unique_name name [-scan_name name] [-rac_dbid dbid] {-oracle_auth user | -wallet_path path [-wallet_rman_TNS tns]} [-rman_catalog_user name [-rman_catalog_TNS tns]] [-add_rac_dbid dbid] [-force] [-no_warnings]

nboraadm [-S master_server] -modify_rac_instance instance_name -rac_dbid dbid -rac_db_unique_name name [-new_instance instance_name] [-host name] [-backup_host name | -disable_backup_host] [-oracle_home oracle_home] [-backup_priority priority] [-active | -inactive] [-force] [-no_warnings]

nboraadm [-S master_server] -list_instance_aliases [instance_name] [-host name] [-oracle_home oracle_home]

nboraadm [-S master_server] -add_instance_alias instance_name -alias alias_name [-host name] [-oracle_home oracle_home]

nboraadm [-S master_server] -delete_instance_alias instance_name -alias alias_name [-host name] [-oracle_home oracle_home]

nboraadm [-S master_server] -list_instances [instance_name] [-instance_group name] [-host name] [-os Unix | Windows] [-active | -inactive] [-registered | -unregistered]

nboraadm [-S master_server] -add_instance instance_name -host name -oracle_home oracle_home [-tns_admin tns_admin] {[-instance_group name] | [-os_user name [-os_domain name]] | [-oracle_auth user [-oracle_TNS tns]] | [-wallet_path path -wallet_TNS tns [-wallet_rman_TNS tns]]} [-rman_catalog_user name [-rman_catalog_TNS tns]]] [-force]

nboraadm [-S master_server] -register_instance instance_name [-host name] [-oracle_home oracle_home] {-instance_group name | -os_user name [-os_domain name] | -oracle_auth user [-oracle_TNS tns] | -wallet_path path -wallet_TNS tns [-wallet_rman_TNS tns]} [-rman_catalog_user name [-rman_catalog_TNS tns]] [-no_warnings] [-force]

nboraadm [-S master_server] -delete_instance instance_name [-host name] [-oracle_home oracle_home] [-no_warnings]

nboraadm [-S master_server] -modify_instance instance_name [-new_instance instance_name] [-host name] [-new_host name] [-oracle_home oracle_home] [-new_oracle_home oracle_home] [-tns_admin tns_admin] [-instance_group name] [-os_user name [-os_domain name] | -disable_os_user] [-oracle_auth user [-oracle_TNS tns] | -disable_oracle_auth] [-wallet_path path -wallet_TNS tns [-wallet_rman_TNS tns | -disable_rman_catalog] | -disable_wallet_auth] [-rman_catalog_user name [-rman_catalog_TNS tns] | -disable_rman_catalog] [-active | -inactive] [-force] [-no_warnings]

nboraadm [-S master_server] -remove_from_instance_group instance_name [-instance_group name] [-host name] [-oracle_home oracle_home] [-no_warnings]

nboraadm [-S master_server] -list_instance_groups [instance_group_name]

nboraadm [-S master_server] -add_instance_group instance_group_name {{-unix_os_user name AND/OR -windows_os_user name -os_domain name} | [-oracle_auth user [-oracle_TNS tns]] | [-wallet_path path -wallet_TNS tns [-wallet_rman_TNS tns]]} [-rman_catalog_user name [-rman_catalog_TNS tns]]

nboraadm [-S master_server] -delete_instance_group instance_group_name

nboraadm [-S master_server] -modify_instance_group instance_group_name [-new_instance_group instance_group_name] {[[-unix_os_user name] [-windows_os_user name -os_domain name] | -disable_os_user] [-oracle_auth user [-oracle_TNS tns] | -disable_oracle_auth] | [-wallet_path path -wallet_TNS tns [-wallet_rman_TNS tns | -disable_rman_catalog] | -disable_wallet_auth]} [-rman_catalog_user name [-rman_catalog_TNS tns] | -disable_rman_catalog] [-validate]

nboraadm [-S master_server] -auto_registration instance_group_name [-unix_tns_admin tns_admin] [-windows_tns_admin tns_admin]

nboraadm [-S master_server] -disable_auto_registration

nboraadm [-S master_server] -list_dbas

nboraadm [-S master_server] -add_dba client_name user_name

nboraadm [-S master_server] -delete_dba client_name user_name

nboraadm [-S master_server] -immediate -policy policy [-schedule schedule] {-instance instance | {-rac_dbid dbid -rac_db_unique_name name}} [-w[hh:mm:ss]]

nboraadm [-S master_server] -list_jobs [count] [-utc]

nboraadm [-S master_server] -list_job_details -jobid jobid [-utc]

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 nboraadm command can add, modify, list, and remove RAC databases, instances, and instance groups as part of an Oracle backup policy. If you modify an instance that is not local to the host where you ran nboraadm, a prompt asks you if you want to change the instance. The nboraadm command performs the following operations:

  • -list_instances lists all Oracle instances in the repository.

  • -add_instance adds an instance to the repository.

  • -register_instance registers credentials for an instance or an instance group.

  • -delete_instance deletes an instance.

  • -modify_instance changes the attributes of the specified instance.

  • -list_instance_groups lists all Oracle instance groups that have been created.

  • -add_instance_group adds an instance group to the repository.

  • -delete_instance_group deletes an instance group from the repository.

  • -modify_instance_group changes the attributes of the specified instance group.

  • -auto_registration automatically registers newly discovered instances into the specified instance group name.

  • -disable_auto_registration disables automatic registration of newly discovered instances.

  • -list_dbas displays a list of all DBAs able to use nboraadm on a specified client.

  • -add_dba allows the NetBackup Administrator to give a database administrator (DBA) the ability to use the nboraadm command on a specific client.

  • -delete_dba removes the ability of the specified DBA to use nboraadmon the specified client.

  • -list_jobs displays job information for the Oracle jobs that contain RMAN output.

  • -list_job_details displays the RMAN output for a specified job.

  • -list_rac_dbs lists all the databases that NetBackup can identify as Oracle RAC.

  • -add_rac_db lets you manually add an Oracle RAC database to NetBackup.

  • -register_rac_db lets you register the Oracle RAC credentials with NetBackup.

  • -modify_rac_db modifies an existing Oracle RAC database in NetBackup.

  • -delete_rac_db lets you delete the Oracle RAC database and any associated instances from NetBackup.

  • -list_rac_instances lists all the instances that NetBackup can identify as Oracle RAC.

  • -add_rac_instance lets you manually add an Oracle RAC instance to NetBackup. You cannot add instance without a database.

  • -modify_rac_instance modifies an existing Oracle RAC instance in NetBackup.

  • -delete_rac_instance lets you delete an Oracle RAC instance from NetBackup.

  • -list_instance_aliases lists all the aliases that are associated with the Oracle instance.

  • -add_instance_alias adds an alias that is associated with the Oracle instance.

  • -delete_instance_alias deletes an alias that is associated with the Oracle instance.

OPTIONS

-active | -inactive

When used with the -list_instances operation, you can narrow the list to only the active instances or the inactive instances. The default condition is to list all instances.

When used with the -modify_instance operation, you can change the status of an instance from active to inactive or vice versa.

When used with -modify_rac_instance, this option adds or removes the instance from the pool of available nodes for backup. When the option is used with -modify_rac_db, you can change the status of a database from active to inactive or vice versa.

-add_rac_dbid id

Used to add an Oracle RAC database ID. Used only with -register_rac_db when the database ID is not discovered.

-alias name

Used with -add_instance_alias or -delete_instance_alias to add or delete an alias that is associated with the database instance.

-backup_host name

Used to specify an alternate network host for transport of backup data. This option only applies to -add_rac_instance and -modify_rac_instance.

-disable_backup_host

Disables the use of a backup host name. This option only applies to -modify_rac_instance.

-backup_priority number

An integer that defines the order in which to use RAC instances for protection. Valid values are any integer. If two instances of a RAC share the same priority, instances are selected in alphabetical order. As NetBackup tests the credentials for the highest priority instance, if the instance is unavailable, NetBackup does not test credentials on any other instances. Use -force to skip validation.

-client_name user_name

Specifies a client name and the user name of a database administrator (DBA) to enable or disable the use the nboraadm command. These options are used only with the -add_dbaoperation and the -delete_dba operation.

-disable_oracle_auth

Disables the use of Oracle authentication.

-disable_os_user

Disables the use of operating system authentication.

-disable_rman_catalog

Disables the use of Oracle RMAN Recovery Catalog Credentials as well as Wallet RMAN recovery catalog credentials.

-disable_wallet_auth

Disables the use of Wallet authentication.

-force

Forces the instance or RAC database to be added to the repository despite a validation failure. Unregistered instances or RAC databases cannot be protected using a NetBackup for Oracle policy.

-host name

Specifies the name of the host where the Oracle database resides

-immediate

Allows the Oracle DBA to start an immediate backup from the Oracle client. The Oracle DBA can start the backup instead of waiting for the backup to be initiated based on the NetBackup schedule. When -immediate is used, the -policy option is required. Additional, you must specify either the -instance option or the -rac_dbid and -rac_db_unique_name options. The Oracle DBA can use this option for the immediate backup of a RAC database.

-instance_group name

Specifies that you want the new or the changed instance to be part of the instance group with the specified name.

-instance_name

Names the instance that is created or changed.

-list_job_details -jobid jobid [-utc]

Displays the RMAN output that is contained in the LOG messages from Job Details for the specified Oracle job that the parameter -jobid defines. Use the nboraadm -list_jobs command to determine the specified jobid you want RMAN details about. The optional -utc parameter displays each Job Details message timestamp in UTC format instead of the default UNIX time format.

-list_jobs [count] [-utc]

Displays the Oracle jobs that contain RMAN output where the count parameter specifies the number of the most recent Oracle jobs to list. Displays the following job information for each Oracle job in JSON format: Jobid, JobType, Status, State, Policy, ScheduleType, Schedule, Started, and Ended. The valid range of values for the count parameter is 1 to 1024. If the optional count parameter is not specified the default is 128. The optional -utc parameter displays all Job Details message timestamps (i.e. Started and Ended fields) in UTC format instead of the default UNIX time format.

-load_balanced_node_count number

An integer that defines the maximum number of nodes NetBackup uses for backup. Backups proceed with a lower number, if the number of nodes that is specified is not available. If you specify 0 (zero) NetBackup uses all the available nodes.

-new_scan_name name

Used to change the SCAN (single client access name) name of the Oracle RAC database. Used with the -modify_rac_db option.

-no_warnings

NetBackup warns the user if you change an instance that is not local to the host where you ran the command. NetBackup prompts to ask if you want to change the instance. Use this option to prevent the display of this warning.

-oracle_auth user [-oracle_TNS tns]

Specifies the user name and the Net Service Name (TNS alias) of the Oracle authentication credentials.

-oracle_home oracle_home

Specifies the file path of the Oracle home directory where the instance resides.

-os Unix | Windows

Specifies if the operating system type for the instance is UNIX or Windows.

-os_user name [-os_domain name]

Specifies the user name and the domain of the operating system credentials.

-port number

The grid service listener port. The behavior of this option varies based on the operation specified.

-rac_db_unique_name name

The unique database name for the Oracle RAC database. Once this name is discovered or manually added, it cannot be changed. The behavior of this option varies based on the operation specified.

-rac_dbid id

The database ID for the Oracle RAC database. You cannot change the database ID once it is added. The behavior of this option varies based on the operation specified.

-rac_type values

The type of Oracle RAC database communicating with NetBackup. Accepted values are RAC and RACOneNode.

-registered | -unregistered

Specifies all instances that are registered and all instances that are not registered due to incorrect credentials.

-rman_catalog_user name [-rman_catalog_TNS tns]

Specifies the user name and the Net Service Name (TNS alias) of the Oracle RMAN Recovery Catalog credentials.

-S master_server

Specifies the master server that contains the instance to be added or changed.

-scan_name name

The database SCAN name for the Oracle RAC database. The behavior of this option varies based on the operation specified.

-service_name name

The service name for the Oracle RAC database. The behavior of this option varies based on the operation specified.

-unix_os_user name -windows_os_user name

Specifies the user name for UNIX and/or Windows OS credentials for an instance group.

-unix_tns_admin tns_admin and -windows_tns_admin tns_admin

Used to override default UNIX TNS_ADMIN or Windows TNS_ADMIN path.

-wallet_path

Specifies the path to the Oracle wallet that contains the credentials for use with the instance or RAC database.

-wallet_tns

Specifies the wallet connect descriptor to use to look up the credentials within the Oracle wallet. You cannot use this option with a RAC database

-wallet_rman_TNS

Specifies the RMAN Net Service Name of the Oracle RMAN recovery catalog credentials that are stored in the Oracle wallet. This option is used with both instances and RAC databases.