Veritas NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- add_media_server_on_clients
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bptpcinfo
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCertsForPlugins
- configureMQ
- configurePorts
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig throttle
- csconfig reinitialize
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- manageClientCerts
- mklogdir
- nbauditreport
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- nbcomponentupdate
- nbcplogs
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbfindfile
- nbfirescan
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbsetconfig
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- resilient_clients
- restoretrace
- stopltid
- tl4d
- tl8d
- tl8cd
- tldd
- tldcd
- tlhd
- tlhcd
- tlmd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
Name
nboraadm — set up instances and instance groups as part of an Oracle backup policy
SYNOPSIS
[-S master_server] -list_instances [instance_name] [-instance_group group_name] [-host name] [-os Unix | Windows] [-active | -inactive] [-registered | -unregistered]
[-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]
[-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 -delete_instance instance_name [-S master_server] [-host name] [-oracle_home oracle_home] [-no_warnings]
[-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_domainname] | -disable_os_user] [-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]
[-S master_server] -remove_from_instance_group instance_name [-instance_group name] [-host name] [-oracle_home oracle_home] [-no_warnings]
[-S master_server] -list_instance_groups [instance_group_name]
[-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]]
[-S master_server] -delete_instance_group name
[-S master_server] -modify_instance_group name [-new_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] [-rman_catalog_user name [-rman_catalog_TNS tns] | -disable_rman_catalog] [-validate]
[-S master_server] -auto_registration instance_group_name [-unix_tns_admin tns_admin] [-windows_tns_admin tns_admin]
[-S master_server] -disable_auto_registration
[-S master_server] -list_dbas
[-S master_server] -add_dba client_name user_name
[-S master_server] -delete_dba client_name user_name
[-S master_server] -immediate -policy policy_name -instance instance_name [-schedule schedule_name] [-w [hh:mm:ss]]
[-S master_server] -list _jobs [count] [-utc]
[-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_os_user
Disables the use of operating system 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
LOGmessages from Job Details for the specified Oracle job that the parameter -jobid defines. Use the nboraadm -list_jobs command to determine the specifiedjobidyou 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, andEnded. 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.StartedandEndedfields) 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.
- -unix_tns_admin tns_admin and -windows_tns_admin tns_admin
Used to override default UNIX TNS_ADMIN or Windows TNS_ADMIN path.