NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpcleanrestore
- 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
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureMQ
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- msdpcldutil
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcmdrun
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdb2adutl
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbepicfile
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nboracmd
- nbpem
- nbpemreq
- nbmariadb
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbshvault
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbsqlite
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tldd
- tldcd
- 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_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]
[-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]
[-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]
[-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]
[-S master_server] -delete_rac_db -rac_db_unique_name name [-rac_dbid dbid] [-scan_name name]
[-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]
[-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]
[-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]
[-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]
[-S master_server] -list_instance_aliases [instance_name] [-host name] [-oracle_home oracle_home]
[-S master_server] -add_instance_alias instance_name -alias alias_name [-host name] [-oracle_home oracle_home]
[-S master_server] -delete_instance_alias instance_name -alias alias_name [-host name] [-oracle_home oracle_home]
[-S master_server] -list_instances [instance_name] [-instance_group name] [-host name] [-os Unix | Windows] [-active | -inactive] [-registered | -unregistered]
[-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]
[-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]
[-S master_server] -delete_instance instance_name [-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] [-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]
[-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 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]]
[-S master_server] -delete_instance_group instance_group_name
[-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]
[-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_nameuser_name
[-S master_server] -delete_dba client_nameuser_name
[-S master_server] -immediate -policy policy [-schedule schedule] {-instance instance | {-rac_dbid dbid -rac_db_unique_name name}} [-w[hh:mm:ss]]
[-S master_server] -list_jobs [count] [-utc]
[-S master_server] -list_job_details -jobid jobid [-utc]
[-S master_server] -add_data_guard -dbid dbid -db_name name
[-S master_server] -delete_data_guard -dbid dbid -db_name name
[-S master_server] -add_rac_to_data_guard db_unique_name -dbid dbid -db_name name
[-S master_server] -remove_rac_from_data_guard db_unique_name -dbid dbid
[-S master_server] -add_instance_to_data_guard instance_name -dbid dbid -db_name name [-host name][-oracle_home oracle_home]
[-S master_server] -remove_instance_from_data_guard instance_name [-host name][-oracle_home oracle_home]
[-S master_server] -list_data_guard_instances [-dbid dbid -db_name name]
[-S master_server] -list_data_guard_rac_databases [-dbid dbid -db_name name]
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.
-add_data_guard adds an Oracle Data Guard to the repository.
-delete_data_guard removes an Oracle Data Guard from the repository.
-add_rac_to_data_guard adds the specified RAC database to the Data Guard configuration.
-remove_rac_from_data_guard removes the specified RAC database to the Data Guard configuration.
-add_instance_to_data_guard adds the specified instance to the Data Guard configuration.
-remove_instance_from_data_guard removes the specified instance to the Data Guard configuration.
-list_data_guard_instances lists all the instances that are associated with a Data Guard configuration.
-list_data_guard_rac_databases lists all the RAC databases that are associated with a Data Guard configuration.
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.
- -dbid
Specifies the database id.
- -db_name
Specifies the database name.
- -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
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.- -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.