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
nbcldutil — the cloud storage utility for performing various operations specific to cloud deployment.
SYNOPSIS
-appendcert -sourcecert source_certificate_path_and_name
-copycert -sourcecert source_certificate_path_and_name [-destcert destination_certificate_path]
-createbucket [-storage_server servername] [-cmscredname cmscredname] [-region regionname] [-j]
-get_supported_api_list
-validatecreds [-storage_server servername] [-cmscredname cmscredname] [-j]
-help
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/
DESCRIPTION
Use the nbcldutil command to validate user credentials and create buckets for Amazon S3 compatible cloud storage providers and Microsoft Azure.
Note:
This utility only supports Red Hat Linux.
OPTIONS
- -appendcert
This option appends certificate data in a
.pemformat to NetBackup cloud store CA certificate bundle. Use this option if your cloud vendor's CA certificate isn't present in the NetBackup cloud store CA bundle (cacert.pem) at thedb/cloudlocation, or if it's expired. The data is appended to the certificate in theinstall_path/var/global/wmc/clouddirectory on UNIX and theinstall_path\netbackup\var\global\wmc\clouddirectory on Windows.- -cmscredname
The Credential Management System (CMS) credential name is the name that you give to your credentials. It can only contain alphanumeric characters, hyphens, colons, and underscores.
- -copycert
This option copies the certificate to a specified destination.
- -createbucket
Creates a bucket in the cloud storage provider. The createbucket option requires the storage server, CMS credentials, and region name options for Amazon S3 compatible cloud storage providers. For Microsoft Azure, the region name option is not supported. For NetBackup versions before 10.3, substitute user name for the CMS credentials.
- -destcert destination_certificate_path
Use this option to copy the certificate to a specific path destination. By default, the certificate is copied to the
install_path/var/global/wmc/clouddirectory on UNIX and theinstall_path\netbackup\var\global\wmc\clouddirectory on Windows.. This parameter is optional. If the source file extension is not.pembut it is a valid.pemformat, the command copies the file to the destination with the.pemextension.Be aware that you cannot use the -destcert option with the -appendcert option.
- -get_supported_api_list
Displays a list of nbcldutil supported APIs.
- -help
Displays help information for the command or option.
- -j
Generates output data in the json format that spans multiple lines.
- -region
For Amazon S3 compatible cloud storage region support, specifies the region in which to create the bucket. Use the Amazon suggested region values. If you do not add the region value, the default region is used.
- -sourcecert source_certificate_path_and_name
The file name and path of the source certificate.
- -storage_server
Specifies the cloud storage server for bucket creation or validation.
- -username
Starting with NetBackup 10.3, the cmscredname option replaces the username option. Use the cmscredname option for all NetBackup 10.3 and later servers. The username option is deprecated, but still available for the convenience of users that have not upgraded to storing credentials using CMS.
Specifies the user name of a user that has administrator privileges.
For Recovery Vault Azure the cloud provider user name is the credential name you add from the credentials page from NetBackup web UI. The password for this user can be anything as the credentials are already provided in the NetBackup web UI.
- -validatecreds
Validates the user credentials for the cloud storage provider. The validatecreds option requires the storage server and user name options. When you run the nbcldutil command with this option, a password prompt is displayed.
EXAMPLES
Example 1: Copy the certificate to a non-default location.
nbcldutil -copycert -sourcecert /root/cert/file.pem -destcert /root/destpath/
Example 2: Append a certificate.
nbcldutil -appendcert -sourceCert /root/certpath/file.pem
Example 3: Create Bucket in Amazon S3
nbcldutil -createbucket -storage_server mystorage_server -username myusername -bucket_name bucketname -region us-west-1
nbcldutil -createbucket -storage_server mystorage_server -cmscredname myCMSname -bucket_name bucketname -region us-west-1