Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.0)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
  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.  
      bppolicynew
    62.  
      bpps
    63.  
      bprd
    64.  
      bprecover
    65.  
      bprestore
    66.  
      bpretlevel
    67.  
      bpschedule
    68.  
      bpschedulerep
    69.  
      bpsetconfig
    70.  
      bpstsinfo
    71.  
      bpstuadd
    72.  
      bpstudel
    73.  
      bpstulist
    74.  
      bpsturep
    75.  
      bptestbpcd
    76.  
      bptestnetconn
    77.  
      bptpcinfo
    78.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configurePorts
    84.  
      create_nbdb
    85.  
      csconfig
    86.  
      duplicatetrace
    87.  
      importtrace
    88.  
      jbpSA
    89.  
      jnbSA
    90.  
      ltid
    91.  
      mklogdir
    92.  
      nbauditreport
    93.  
      nbcatsync
    94.  
      NBCC
    95.  
      NBCCR
    96.  
      nbcertcmd
    97.  
      nbcertupdater
    98.  
      nbcomponentupdate
    99.  
      nbcplogs
    100.  
      nbdb_admin
    101.  
      nbdb_backup
    102.  
      nbdb_move
    103.  
      nbdb_ping
    104.  
      nbdb_restore
    105.  
      nbdb_unload
    106.  
      nbdbms_start_server
    107.  
      nbdbms_start_stop
    108.  
      nbdc
    109.  
      nbdecommission
    110.  
      nbdelete
    111.  
      nbdeployutil
    112.  
      nbdevconfig
    113.  
      nbdevquery
    114.  
      nbdiscover
    115.  
      nbdna
    116.  
      nbemm
    117.  
      nbemmcmd
    118.  
      nbexecute
    119.  
      nbfindfile
    120.  
      nbfirescan
    121.  
      nbftadm
    122.  
      nbftconfig
    123.  
      nbgetconfig
    124.  
      nbhba
    125.  
      nbholdutil
    126.  
      nbhypervtool
    127.  
      nbjm
    128.  
      nbkmsutil
    129.  
      nboraadm
    130.  
      nbpem
    131.  
      nbpemreq
    132.  
      nbperfchk
    133.  
      nbplupgrade
    134.  
      nbrb
    135.  
      nbrbutil
    136.  
      nbregopsc
    137.  
      nbreplicate
    138.  
      nbrestorevm
    139.  
      nbseccmd
    140.  
      nbsetconfig
    141.  
      nbsnapimport
    142.  
      nbsnapreplicate
    143.  
      nbsqladm
    144.  
      nbstl
    145.  
      nbstlutil
    146.  
      nbsu
    147.  
      nbsvrgrp
    148.  
      resilient_clients
    149.  
      restoretrace
    150.  
      stopltid
    151.  
      tl4d
    152.  
      tl8d
    153.  
      tl8cd
    154.  
      tldd
    155.  
      tldcd
    156.  
      tlhd
    157.  
      tlhcd
    158.  
      tlmd
    159.  
      tpautoconf
    160.  
      tpclean
    161.  
      tpconfig
    162.  
      tpext
    163.  
      tpreq
    164.  
      tpunmount
    165.  
      verifytrace
    166.  
      vltadm
    167.  
      vltcontainers
    168.  
      vlteject
    169.  
      vltinject
    170.  
      vltoffsitemedia
    171.  
      vltopmenu
    172.  
      vltrun
    173.  
      vmadd
    174.  
      vmchange
    175.  
      vmcheckxxx
    176.  
      vmd
    177.  
      vmdelete
    178.  
      vmoprcmd
    179.  
      vmphyinv
    180.  
      vmpool
    181.  
      vmquery
    182.  
      vmrule
    183.  
      vmupdate
    184.  
      vnetd
    185.  
      vxlogcfg
    186.  
      vxlogmgr
    187.  
      vxlogview
    188.  
      W2KOption

Name

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

SYNOPSIS

nboraadm [-S master_server] -list_instances [instance_name] [-instance_group 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 [-instance_group group_name | -os_user name [-os_domain name] [-oracle_auth user [-oracle_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] [-new_oracle_home oracle_home] [-instance_group name | -os_user name [-os_domain name] [-oracle_auth user [-oracle_TNS tns]] [-rman_catalog_user name [-rman_catalog_TNS tns]] [-force]
[-no_warnings]

nboraadm nboraadm -delete_instance instance_name [-S master_server] [-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] [-instance_group name | -os_user name [-os_domain name] [-oracle_auth user [-oracle_TNS tns] | -disable_oracle_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] [-windows_os_user name] -os_domain name} [-oracle_auth user [-oracle_TNS tns]] [-rman_catalog_user name [-rman_catalog_TNS tns]]

nboraadm [-S master_server] -delete_instance_group name

nboraadm [-S master_server] -modify_instance_group name [-new_instance_group name] [-unix_os_user name] [-windows_os_user name -os_domain name] [-oracle_auth user [-oracle_TNS tns] | -disable_oracle_auth] [-rman_catalog_user name [-rman_catalog_TNS tns] | -disable_rman_catalog] [-validate]

nboraadm [-S master_server] -auto_registration instance_group_name

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_name -instance instance_name [-schedule schedule_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 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 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.

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.

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_rman_catalog

Disables the use of Oracle RMAN Recovery Catalog Credentials.

-force

Forces the instance to be added to the repository despite a validation failure. Unregistered instances 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 operation and -instance operation are required.

-instance_group name

Specifies that you want the new or 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.

-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.

-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.

-unix_os_user name -windows_os_user name

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