Important Update: Cohesity Products Documentation
All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.
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
- msdpimgutil
- 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
W2KOption — run the utility program that modifies normal backup and restore behavior on Windows systems
SYNOPSIS
-backup -display [-server server_name] -system_state value | -kms_activated_server value | -snapshotprovidertype value | -ignore_unresolved_volumes volume[:volume...]
-display
-restore -display [-server server_name] same_hardware value | -mounted_devices value | -sysvol value | -hard_links value | -active_directory value | -system_state value
The directory path to this command is install_path\NetBackup\bin\
DESCRIPTION
This command operates only on Windows systems.
The W2KOption utility lets you modify normal backup and restore behavior.
OPTIONS
- -ad, active_directory value
Controls how the Active Directory is restored. By default, Active Directory are restored in an authoritative manner. If you want to perform an Active Directory restore in a catchup manner, use this utility to change the behavior from authoritative to catchup.
1 - Run an authoritative restore, which replaces all existing Active Directory objects.
4 - Run a non-authoritative (catchup) restore. The restore merges with changes on other controllers in the domain.
- -b, -backup
Lets you modify values for one or more of the backup options. The backup options are system_state, kms_activated_server, snapshotprovidertype, and ignore_unresolved_volumes.
- -d, -display
Displays the program usage and shows how the options operate.
- -hl, -hard_links 0 | 1
Controls how hard links are restored. By default, if the file is not present on the system, NetBackup tries to restore the file after the current restore completes. This action is called a secondary restore. You can change the behavior to shut off the secondary restore.
0 - Do not perform the secondary restore.
1 - Perform the secondary restore.
- -iuv, -ignore_unresolved_volumes volume[:volume...]
Deletes the log files from the folder that the product configures.
- -kas, -kms_activated_server 0 | 1
Specifies if NetBackup treats the computer as a Key Management Service (KMS) activated host during backups.
0 - Do not treat the host as a KMS activated server.
1 - Treat the host as a KMS activated server.
- -md, -mounted_devices 0 | 1
Determines if the mounted devices registry key is restored.
0 - Restore the mounted device configuration.
1 - Do not restore the mounted device configuration.
- -r, -restore options
Lets you modify values for one or more of the restore options. The restore options are - same_hardware, -mounted_devices, -sysvol, -hard_links, -active_directory, and - system_state.
- -sh, -same_hardware 0 | 1
Determines how to restore the registry system hive. A normal restore operation does not restore all the registry items. However, when you restore to the same hardware, you can safely restore all these items.
0 - Assume different hardware. Do not restore all the registry items.
1 - Assume the same hardware. Restore all the registry items.
- -s, -server server_name
Displays or sets the options on a computer other than the local computer. The default is the local computer.
- -spt, -snapshotprovidertype 0 | 1 | 2 | 3
Selects the snapshot provider type.
0 - Automatic provider selection
1 - Use the system provider
2 - Use a software provider
3 - Use a hardware provider
- -ss, -system_state 0
Changes the backup method from the legacy system state method back to the normal VSS system state method. Selecting the legacy system state method is not allowed.
0 - Disallow legacy system state restore.
- -sv, -sysvol 2 | 4
Determines how the Active Directory SYSVOL is restored. By default, NetBackup restores as if the SYSVOL being restored is the primary version. You can change this setting from the primary version to the non-authoritative version.
2 - Non-authoritative version.
4 - Primary version.
EXAMPLES
Example 1 - Ignore volumes H, K, and I during backup.
W2KOption -backup -ignore_unresolved_volumes H:K:I:
Example 2 - Treat the host as a KMS activated server.
W2KOption -backup -kms_activated_server 1