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
- nbhsmcmd
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nblogparser
- nbmariadb
- nbmysql
- nbmlb
- nborair
- nboracmd
- nbpem
- nbpemreq
- nbmariadb
- nbmlb
- nbperfchk
- nbpgsql
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbshvault
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqlcmd
- nbsqlite
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tiermover
- 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
nbcmdrun — wrapper command that is used to run NetBackup commands with a non-root account
SYNOPSIS
command_name [arguments]
-listCommands
-listCmdsWithGranularRbac
-listPermissionsForCmd command_name [arguments]
-primaryServer hostname command_name [arguments]
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 nbcmdrun command is a wrapper used to run NetBackup commands on a NetBackup host. The NetBackup host is a primary server, a media server, or a client.
You can run the commands based on your RBAC permissions. With the NetBackup Command-Line Administrator role, you can run most of the NetBackup commands with a non-root user account.
You must enter command name without any path or extension, followed by all required and any optional arguments. You must run the nbcmdrun from a directory to which you have read and write access.
The nbcmdrun command supports granular RBAC for NetBackup policy-related commands. Use the -listCmdsWithGranularRbac option to see the list of commands that nbcmdrun supports with granular RBAC.
To use nbcmdrun, the NetBackup service user must be enabled on the host. For more information about how to enable nbcmdrun and the NetBackup service user, see the NetBackup Security and Encryption Guide.
The nbcmdrun command is not supported with NetBackup Access Control (NBAC) features.
The nbcmdrun logs are found at the location shown:
UNIX: /usr/openv/netbackup/logs/nbcmdrun
Windows: install_path\NetBackup\logs\nbcmdrun
The logs of any command nbcmdrun runs are found in their respective log directory.
For more information about the nbcmdrun functionality, see the NetBackup Security and Encryption Guide.
OPTIONS
- -listCmdsWithGranularRbac
Lists NetBackup commands that can be run with granular RBAC permissions.
- -listCommands
Use this option to list all commands that the nbcmdrun command supports.
- -listPermissionsForCmd
Lists RBAC permissions that are required to run the given NetBackup command.
- -primaryServer
Specifies NetBackup primary server on which the command should be run with granular RBAC permissions.
EXAMPLES
Example 1: Run the mklogdir command and create the bpcd directory with non-root user access using the nbcmdrun command.
nbcmdrun mklogdir -create bpcd Creating [bpcd] with permissions [0700]. nbcmdrun: CMD EXIT STATUS = 0
Example 2: Run the vxlogcfg command with non-root user access using the nbcmdun command.
nbcmdrun vxlogcfg -l --prodid 51216 --orgid 140 Configuration settings for originator 140, of product 51216... LogDirectory = /usr/openv/logs/ DebugLevel = 3 DiagnosticLevel = 3 DynaReloadInSec = 0 LogToStdout = False LogToStderr = False LogToOslog = False RolloverMode = FileSize | LocalTime LogRecycle = False MaxLogFileSizeKB = 51200 RolloverPeriodInSeconds = 43200 RolloverAtLocalTime = 0:00 NumberOfLogFiles = 3 OIDNames = mmui AppMsgLogging = ON L10nLib = /usr/openv/lib/libvxexticu L10nResource = mmui L10nResourceDir = /usr/openv/resources SyslogIdent = VRTS-NB SyslogOpt = 0 SyslogFacility = LOG_LOCAL5 LogFilePermissions = 600 nbcmdrun: CMD EXIT STATUS = 0
Example 3: Get the RBAC permissions required to run given command with non-root user.
nbcmdrun - listPermissionsForCmd bppolicynew policy1
[
{
"namespace": "|PROTECTION|POLICIES|",
"requiredOperations": "|OPERATIONS|ADD|"
}
]