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
- configureCerts
- configureCertsForPlugins
- configureMQ
- configurePorts
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- manageClientCerts
- mklogdir
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- 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
- nbfindfile
- nbfirescan
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- 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
- Index
Name
bpinst — configure legacy NetBackup Encryption
SYNOPSIS
-LEGACY_CRYPT [-crypt_option option] [-crypt_strength strength] [-passphrase_prompt |-passphrase_stdin] [-verbose] [ [-policy_encrypt 0 | 1] -policy_names] name1 [name2 ... nameN]
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
NetBackup Encryption provides file-level encryption of backups and archives.
-LEGACY_CRYPT is the Legacy Encryption method. It provides the user with the encryption strength choices previously available (40-bit DES and 56-bit DES).
The bpinst command that is used with the -LEGACY_CRYPT option configures the legacy NetBackup Encryption product on the NetBackup clients that can support encryption. You can also configure encryption for a client that is installed on the master server host.
Activate bpinst -LEGACY_CRYPT on the master server to configure NetBackup Encryption on the clients. A single activation makes the necessary configuration changes on both the clients and the master server.
Note:
Ensure that the DISALLOW_SERVER_FILE_WRITES NetBackup configuration option is not set on the client. If this option is set, the server cannot configure the software on the client.
OPTIONS
- -LEGACY_CRYPT
Required if you use 40-bit DES or 56-bit DES encryption. To configure DES encryption, specify this option first to use the bpinst command. The order is important; do not omit this option.
- -crypt_option option
Configures the CRYPT_OPTION configuration entry on the NetBackup clients. If you do not specify -crypt_option, the client allows either encrypted or unencrypted backups (see ALLOWED).
The possible values for option are:
DENIED | denied | -1
Specifies that the client does not permit encrypted backups. If the server requests an encrypted backup, it is considered an error. This option is the default for a client that has not been configured for encryption.
ALLOWED | allowed | 0
Specifies that the client allows either encrypted or unencrypted backups. ALLOWED is the default condition.
REQUIRED | required | 1
Specifies that the client requires encrypted backups. If the server requests an unencrypted backup, it is considered an error.
- -crypt_strength strength
Configures the CRYPT_STRENGTH configuration entry on the NetBackup clients. If you do not specify this option, the CRYPT_STRENGTH configuration entries on the clients remain unchanged.
The possible values for strength are:
DES_40 | des_40 | 40
Specifies the 40-bit DES encryption. This value is the default value for a client that has not been configured for encryption.
DES_56 | des_56 | 56
Specifies the 56-bit DES encryption.
- -passphrase_prompt | -passphrase_stdin
Note:
Do not forget the pass phrase. If the key file is damaged or lost, you may need the pass phrase to regenerate the key file. Without the proper key file, you cannot restore encrypted backups.
NetBackup uses a pass phrase to create the data that it places in a key file on each client. NetBackup then uses the data in the key file to create the encryption keys that are required to encrypt and decrypt the backup data. This option applies to the -LEGACY_CRYPT option only.
The -passphrase_prompt option prompts you to enter a pass phrase. The actual pass phrase is hidden while you type.
The -passphrase_stdin option reads the pass phrase through standard input. You must enter the pass phrase twice. This option is less secure than the -passphrase_prompt option because the pass phrase is not hidden. However, it may be more convenient if you use bpinst -LEGACY_CRYPT in a shell script.
NetBackup uses the pass phrase for all the clients that you specify on the bpinst -LEGACY_CRYPT command. If you want separate pass phrases for each client, enter a separate bpinst -LEGACY_CRYPT command for each client.
When you specify a pass phrase, bpinst -LEGACY_CRYPT creates or updates the key files on the clients. The encryption keys (generated from the pass phrase) are used for subsequent backups. Old encryption keys are retained in the key file to allow restores of previous backups.
If you do not specify either the -passphrase_prompt or -passphrase_stdin option, the key files on the clients remain unchanged.
- -verbose
Prints the current encryption configuration of each client and what gets installed and reconfigured on each client.
- -policy_encrypt 0 | 1
Sets the Encryption policy attribute for the NetBackup policies. You can include -policy_encrypt only with the -policy_names option. The possible values are:
0 - clears the Encryption attribute (or leaves it clear) so the server does not request encryption for clients in this policy. This setting is the default for the policies that are not configured for encryption.
1 - sets the Encryption attribute so the server requests encryption for clients in this policy.
If you do not specify this option, the Encryption attributes for the policies remain unchanged.
- -policy_names
Specifies that the names you specify (with the names option) are NetBackup policy names.
If you include the -policy_names option, bpinst -LEGACY_CRYPT configures all the clients in each specified policy. If you omit the -policy_names option, the names are assumed to be NetBackup client names.
- name1 [name2 ... nameN]
Specifies one or more NetBackup client or policy names, depending on whether you have included the -policy_names option. If you omit the -policy_names option, the names are assumed to be NetBackup client names.
NOTES
The following notes apply to the -LEGACY_CRYPT option:
If you are running NetBackup in a clustered environment, you can push configuration data to the client only from the active node.
If you push the configuration to clients that are located in a cluster, do the following: Specify the hostnames of the individual nodes (not virtual names) in the clients list.
When you finish the restore of encrypted files from a client, rename or delete the key file created. Move or rename your own key file to its original location or name. If you do not re-establish your key file to its original location or name, you may not be able to restore your own encrypted backups.
Existing 40-bit encryption license keys or 56-bit encryption license keys are valid for upgrades.
A privately defined NetBackup 40-bit DES key encrypts the pass phrase that bpinst -LEGACY_CRYPT sends over the network.
The key file on each NetBackup client is encrypted with a privately defined NetBackup DES key. The key can be 40 bits or 56 bits depending on how the client is configured. Restrict access to the key file to the administrator of the client computer. On a UNIX client, the owner of the key file should be root and the mode bits should be 600. The key file should not be exportable through NFS.
The key file must be the same on all nodes in a cluster.
Remember pass phrases. In a disaster recovery situation, you may have to recreate a key file on a client by using bpinst -LEGACY_CRYPT. For example, suppose a NetBackup client that is named orca performs encrypted backups and an accident occurs that causes orca to lose its files. In this case you must reinstall and configure encryption on the client to restore your backups.
For more about how to restore the operating system and NetBackup, see the NetBackup Troubleshooting Guide.
To provide disaster recovery when you use encryption (client named orbit)
- Reinstall the operating system on orbit.
- Reinstall and configure the NetBackup client software on orbit.
- Reinstall and configure encryption on orbit by using the following command:
# bpinst -LEGACY_CRYPT -crypt_option allowed
- Activate bpinst -LEGACY_CRYPT to create a pass phrase by using the following command:
# bpinst -LEGACY_CRYPT -passphrase_prompt orbit Enter new NetBackup pass phrase: ********************* Re-enter new NetBackup pass phrase: *********************
Enter the pass phrase that is used on orca.
- Activate bpinst -LEGACY_CRYPT for each subsequent pass phrase that is used on orbit by entering the following:
# bpinst -LEGACY_CRYPT -passphrase_prompt orbit Enter new NetBackup pass phrase: ********************* Re-enter new NetBackup pass phrase: *********************
- Restore the backed up files to orbit.
EXAMPLES
Example 1 - Configure all on one line 40-bit DES encryption on UNIX clients in a policy named policy40:
# bpinst -LEGACY_CRYPT -crypt_option allowed -crypt_strength des_40 -policy_encrypt 1 -policy_names policy40
Use the -policy_encrypt option to set the Encryption attribute for the policy. You can also use the NetBackup administrator utility to set the Encryption attribute.
Example 2 - Use the -passphrase_prompt option to create a passphrase on all clients in a policy named policy40:
# bpinst -LEGACY_CRYPT -passphrase_prompt -policy_names policy40 Enter new NetBackup pass phrase: ********************* Re-enter new NetBackup pass phrase: *********************
Example 3 - Specify all on one line the NetBackup client named strong must use 56-bit DES encryption:
# bpinst -LEGACY_CRYPT -crypt_option required -crypt_strength des_56 strong
Example 4 - Display a verbose listing of the configuration for the client named strong:
# bpinst -LEGACY_CRYPT -verbose strong BPCD protocol version 8.0.0 on client strong 40-bit library version is 3.1.0.40 on client strong 56-bit library version is 3.1.0.56 on client strong BPCD platform is redhat for client strong Current configuration entries are: CRYPT_KEYFILE = /usr/openv/netbackup/keyfile CRYPT_LIBPATH = /usr/openv/lib CRYPT_OPTION = required CRYPT_STRENGTH = des-56 V_PATH_SHARE = /usr/openv/share No update of NetBackup configuration required for client strong No update of NetBackup pass phrase required for client strong
FILES
The following are the files that are used on UNIX systems:
UNIX server command
/usr/openv/netbackup/bin/bpinst
UNIX client encryption libraries for 40-bit DES and 56-bit DES
/usr/openv/lib/libvdes*.*
UNIX client encryption key file for 40-bit DES and 56-bit DES
/usr/openv/netbackup/keyfile
UNIX client encryption key file utility for 40-bit DES and 56-bit DES
/usr/openv/netbackup/bin/bpkeyfile
UNIX client encryption key file utility for 128-bit OpenSSL cipher and 256-bit OpenSSL cipher
/usr/openv/netbackup/bin/bpkeyutil /usr/openv/share/ciphers.txt
The following are the files that are used on Windows systems:
Windows server command
install_path\NetBackup\bin\bpinst.exe
Windows client encryption key file
install_path\NetBackup\var\keyfile.dat
Windows client encryption libraries
install_path\bin\libvdes*.dll
Windows client encryption key file utility
install_path\bin\bpkeyfile.exe install_path\share\ciphers.txt