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
nbinstallcmd — used to create and launch deployment jobs
SYNOPSIS
-policy policy -schedule schedule {-hosts filename | -host_filelist host1, host2, hostN} [-master_server name]
-i -policy policy_name -schedule schedule_name [-master_server name]
-operation_type {precheck | stage | install} -package item... -media_server name [-limit_jobs max_concurrent_jobs] [-master_server name]
-operation_type (precheck | stage | install) -package item -media_server name -unix_eca_cert_path path -unix_eca_crl_check_level (use_cdp |use_path | disabled) -unix_eca_trust_store_path path -unix_eca_private_key_path path [-host_filelist client] [-limit_jobs max_concurrent_jobs] [-master_server name] [-unix_eca_crl_path path] [-unix_eca_key_passphrasefile path]
-operation_type (precheck | stage | install) -package item -media_server name -win_eca_cert_path path -win_eca_crl_check_level (use_cdp |use_path | disabled) -win_eca_trust_store_path path -win_eca_private_key_path path [-host_filelist client] [-limit_jobs max_concurrent_jobs] [-master_server name] [-win_eca_crl_path path] [-win_eca_key_passphrasefile path]
-operation_type (precheck | stage | install) -package item -media_server name -win_eca_cert_store path -win_eca_crl_check_level (use_cdp |use_path | disabled) [-host_filelist client] [-limit_jobs max_concurrent_jobs] [-master_server name] [-win_eca_crl_path path]
-operation_type (precheck | stage | install) -package item -media_server name -use_existing_certs [-host_filelist client] [-limit_jobs max_concurrent_jobs] [-master_server 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
Use the nbinstallcmd command to create and launch VxUpdate jobs. The command launches client and media server update jobs. You can launch the command from both the client, the media server, and the master server. Jobs that you launch can be part of a policy, but a policy is not required to launch an update job. If you start a non-policy-based job from a master server, you can upgrade a client or a media server. From a client or a media server you can only upgrade the host where you launch the job. The options available for the command depend on the job launched. Jobs that are associated with policies have one set of options, non-policy related jobs have a second set of options. Review the command synopsis for details.
Logs for the nbinstallcmd command are located in the legacy logging directory. For UNIX and Linux, the logs are found in /usr/openv/netbackup/logs. On Windows, the logs are in install_path\Veritas\NetBackup\logs.
OPTIONS
- -host_filelist host1,host2,hostN
Used to specify multiple host names. The names are separated with commas. Do not add a space before or after the comma or the list is truncated at the specified space. All the specified hosts must be either clients or media servers. You cannot specify a mix of clients and media servers.
- -hosts filename
Used to specify a file name that contains the names of all the hosts being updated. Each host name is on a separate line. All the specified hosts must be either clients or media servers. You cannot specify a mix of clients and media servers.
- -i
Forces the policy job to run immediately. If you do not specify this option, the policy is launched the next time there is an available schedule window in the specified policy. Use of the -i option prevents a scheduled start of same policy and schedule. This behavior prevents duplicate jobs.
- -limit_jobs max_concurrent_jobs
The maximum number of jobs that are allowed per host. The default is unlimited.
- -media_server name
The name of the media server with which the client communicates. Files are cached to the specified media server. The repository resides on the master server. The files are cached to media server to prevent a communications overload on the master server. When you upgrade media servers, the -media_server option must specify the name of the master server. If you specify another media server the job fails.
- -master_server name
If the client or the media server has multiple master servers, the master_name specified is the one that contains the repository. This option is required for media server upgrades.
- -operation_type {precheck | stage | install}
Specifies what sort of operation you want to start. Valid options are:
precheck: Performs the various precheck operations, including confirming there is sufficient space on the host for the update.
stage: Moves the update package to the host, but does not install it. Also performs the precheck operation.
install: Installs the specified package. Also performs the precheck and stage operations. If you already performed the stage operation, the install command does not move the package again.
- -package item
The name of the package you want installed. Use the nbrepo -l command to retrieve the package ID value, which is an integer. Then use that integer with the nbrepo -p command to determine the value. This value is the item value that you use with the nbinstall -package command. Review the nbrepo command for more details and examples.
- -policy policy_name
The name of the deployment policy you want to start.
- -schedule schedule_name
The name of the schedule you want to start.
- -unix_eca_cert_path path
Use this option to specify the path to the certificate file and the certificate file name for UNIX and Linux hosts.
- -unix_eca_crl_check_level (use_cdp | use_path | disabled)
Specifies how you want to handle the Certificate Revocation List on UNIX and Linux hosts. Specify use_cdp to use the CRL defined in the certificate. Specify use_path to specify the path to the CRL. Specify disabled to not use a CRL.
- -unix_eca_crl_path path
Use this option to specify the path to the external certificate authority file for UNIX and Linux hosts. If you use the -unix_eca_crl_check_level use_path option, this option is required.
- -unix_eca_key_passphrasefile path
Use this option to provide the path to the passphrase file on UNIX and Linux hosts. This option is not required.
- -unix_eca_private_key_path path
Use this option to specify the path to the private key file and the private key file name on UNIX and Linux hosts.
- -unix_eca_trust_store_path path
This option lets you specify the path to the trust store and the trust store file name on UNIX and Linux hosts.
- -use_existing_certs
This option instructs NetBackup to use the existing NetBackup CA or external CA certificates for upgrades, if available. Please note that if you specify this option and certificates are not available, your upgrade fails.
- -win_eca_cert_path path
Use this option to specify the path to the certificate file and the certificate file name for Windows hosts.
- -win_eca_cert_store path
Use this option to specify the path to the Windows certificate store. You must enter the certificate location as Certificate_Store_Name\Issuer_Distinguished_Name\Subject_Distinguished_Name.
- -win_eca_crl_check_level (use_cdp | use_path | disabled)
Specifies how you want to handle the Certificate Revocation List on Windows hosts. Specify use_cdp to use the CRL defined in the certificate. Specify use_path to specify the path to the CRL. Specify disabled to not use a CRL.
- -win_eca_crl_path path
Use this option to specify the path to the external certificate authority file for Windows hosts. If you use the -win_eca_crl_check_level use_path option, this option is required.
- -win_eca_key_passphrasefile path
Use this option to provide the path to the passphrase file on Windows hosts. This option is not required.
- -win_eca_private_key_path path
Use this option to specify the path to the private key file and the private key file name on Windows hosts.
- -win_eca_trust_store_path path
This option lets you specify the path to the trust store and the trust store file name on Windows hosts.
EXAMPLES
Example 1: Launches the sched-precheck schedule in the policy-deployment20 policy, and launches it immediately.
nbinstallcmd -policy policy-deployment20 -schedule sched-precheck -i
Example 2: Starts an installation of the 8.2 client package from the media1 media server.
nbninstallcmd -h client1 -operation _type install -package nbclient_8.2 -media_server media1
Example 3: Manually initiate an upgrade of a single media server (media1) from the command line of the master server without an associated policy. The media_server option must be set to the master server (master1). When you upgrade a media server you must specify the master_server option.
nbinstallcmd -operation_type install -package nbserver_8.2 -media_server master1 -master_server master1 -host_filelist media1
Note:
You can manually initiate the upgrade of a host from the command line of the host without an associated policy. Use the preceding command and omit the -host_filelist option. It is unnecessary, as clients and media servers can only initiate jobs on themselves.
Example 4: Shows the pre-check of the myclient.veritas.com client that uses the security certificate from the specified Windows certificate store and the Certificate Revocation List that is defined in the certificate.
nbinstallcmd -operation_type precheck -package nbclient_8.2 -media_server mymediaserver.veritas.com -win_eca_cert_store MyCertStore\ MyIssuer\MyClient -win_eca_crl_check_level use_cdp -host_filelist myclient.veritas.com
Example 5: Shows the upgrade of the myclient.veritas.com client to NetBackup 8.2 software, using the mymediaserver.veritas.com media server and the Certificate Revocation List that is defined with the specified path.
nbinstallcmd -operation_type install -package nbclient_8.2 -media_server mymediaserver.veritas.com -unix_eca_cert_path /usr/local/cert.pem -unix_eca_crl_check_level use_path -unix_eca_trust_store_path /usr/local/truststore.pem -unix_eca_private_key_path /usr/local/key.pem -host_filelist myclient.veritas.com -unix_eca_crl_path /usr/local/crl
SEE ALSO
See nbrepo.