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
- 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
- bptpcinfo
- 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
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbshvault
- 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
Name
msdpcldutil — the immutable cloud storage utility
SYNOPSIS
create --bucket bucket_name --volume volume_name --mode retention_mode --min min_time --max max_time --live live_untildate [--storageclass storage_class] [--credfile cred_file] [--enable_sas]
list [--bucket bucket_name | --filter bucket_name_filter] [--volume volume_name] [--credfile cred_file] [--enable_sas]
update mode --bucket bucket_name --volume volume_name --mode COMPLIANCE --live live_untildate [--credfile cred_file] [--enable_sas]
update range --bucket bucket_name --volume volume_name --min min_time --max max_time [--credfile cred_file] [--enable_sas]
update live --bucket bucket_name --volume volume_name --live live_untildate [--credfile cred_file] [--enable_sas]
update inherit --bucket bucket_name --volume volume_name --inherit inherit_value [--credfile cred_file] [--enable_sas]
update bucket-policy --bucket bucket_name [--credfile cred_file] [--enable_sas] [--userid userid]
bucket create --bucket bucket_name --mode retention_mode - period period_time
bucket info --bucket bucket_name
bucket sync --bucket bucket_name
bucket update --bucket bucket_name --mode retention_mode - period period_time
platform list
--help
create --help
list --help
update mode --help
update range --help
update live --help
update bucket-policy --help
bucket create --help
bucket info --help
bucket sync - help
bucket list - help
bucket update --help
--version
On UNIX systems, the directory path to this command is /usr/openv/pdde/pdcr/bin/
DESCRIPTION
Use the msdpcldutil command to create, update, and list cloud immutable volume for AWS S3 storage, S3-compatible cloud storage, and Azure blob storage.
This utility is only supported on Red Hat Linux.
Set the following environment variables before you use msdpcldutil for AWS S3 immutable storage:
export MSDPC_ACCESS_KEY=your_access_key_id export MSDPC_SECRET_KEY=your_secret_key export MSDPC_REGION=your_region export MSDPC_PROVIDER=amazon
MSDPC_ACCESS_KEY is the AWS access key associated with an IAM user. MSDPC_SECRET_KEY is the secret key associated with the access key. MSDPC_REGION is the AWS region where the bucket is created or accessed. MSDPC_PROVIDER is the name of the S3-compatible cloud storage provider.
Set the following environment variables before you use msdpcldutil for S3-compatible cloud storage:
export MSDPC_ACCESS_KEY=your_access_key_id export MSDPC_SECRET_KEY=your_secret_key export MSDPC_REGION=your_region export MSDPC_PROVIDER=s3-compatible export MSDPC_ENDPOINT=your_s3_endpoint_url
Set the following environment variables before you use msdpcldutil for Azure blob immutable storage:
export MSDPC_ACCESS_KEY=your_storage_account export MSDPC_SECRET_KEY=your_access_key export MSDPC_REGION=your_region export MSDPC_PROVIDER=azure export MSDPC_ENDPOINT=https://your_storage_account.blob.core.windows.net/
Set the following environment variables before you use msdpcldutil for Google Cloud Platform bucket retention storage:
export MSDPC_ACCESS_KEY=your_storage_account export MSDPC_SECRET_KEY=your_access_key export MSDPC_REGION=your_region export MSDPC_PROVIDER=google export MSDPC_ENDPOINT=your_gcp_endpoint_url export MSDPC_GCP_SAKEY=gcp_service_account_key_file_path
You are not required to set the environment variables if the NetBackup media server is deployed on Amazon EC2 instance. You can use IAM role-based authentication. An access key, secret key, region, endpoint, and the provider are set automatically.
export MSDPC_ACCESS_KEY= export MSDPC_SECRET_KEY= export MSDPC_REGION= export MSDPC_ENDPOINT= export MSDPC_PROVIDER=
Use the - enable_sas option with Recovery Vault Azure and AzureGov storage. When you provide this option, the environment variables are used as follows:
MSDPC_ACCESS_KEY is the credential name, not the account name.
MSDPC_ALIAS is the alias of the storage volume that is associated with the credential. MSDPC_MASTER_SERVER is the master server. When you provide these two environment variables, they are used to query the NetBackup CMS for the credentials. In this case, MSDPC_SECRET_KEY is ignored.
If you do not provide MSDPC_ALIAS and MSDPC_MASTER_SERVER, provide MSDPC_ACCESS_TOKEN. It is used to query Recovery Vault directly for the credentials. You can optionally provide MSDPC_RVLT_SERVICE_URI to specify Recovery Vault service endpoint. It is nrv.veritas.com by default.
If MSDPC_ALIAS, MSDPC_MASTER_SERVER, and MSDPC_ACCESS_TOKEN environment variables are not provided for Recovery Vault that results in an error.
If you do not set the environment variables and IAM role-based authentication does not exist, msdpcldutil enters interactive mode. You can enter the parameters at the command-line prompt as follows:
Enter Provider id: amazon Enter region: us-east-2 Enter Access key: xxxxxxxxx Enter secret key:
OPTIONS
- --bucket bucket_name, -b bucket_name
The bucket name in AWS S3 and S3 compatible storage or the container name in Azure blob.
- --credfile credfile_path
The credential file that contains the environment variables in the following format:
MSDPC_ACCESS_KEY=your_storage_account MSDPC_SECRET_KEY=your_access_key MSDPC_REGION=your_region MSDPC_PROVIDER=your_provider
- --debug
Provides a more detailed log for debugging.
- --enable_sas
Shared access signatures (SAS) authentication method on Azure blob storage. The default value is false.
- --inherit enable|disable, -i enable|disable
When you switch retention mode from ENTERPRISE mode to COMPLIANCE mode, use the inherit option to specify retention time behavior. You can either inherit the retention time from the ENTERPRISE mode or overwrite it with the new retention time for the COMPLIANCE mode. If you want to inherit the retention time, specify enable. If you want to overwrite the retention time, specify disable.
- --live live_utildate, -l live_utildate
The cloud immutable volume live duration. This value is set as YYYY-MM-DD hh:mm:ss timezone. For a value of noon on August 18, 2025 in UTC, use 2025-08-18 12:00:00 UTC.
- --max max_duration, -M max_duration
The maximum object locking duration: number plus D or Y. The value of 12Y means 12 years.
- --min min_duration, -N min_duration
The minimum object locking duration: number plus D or Y. The value of 12D means 12 days.
- --mode retention_mode, -m retention_mode
The retention mode for the immutable cloud storage. The option has two possible values:
COMPLIANCE mode:
Users cannot overwrite or delete the data that is protected using the compliance mode for the defined retention period. Once you set a retention period for the data storage, you can extend it but cannot shorten it.
ENTERPRISE mode:
Users require special permissions to disable the retention lock and then delete the image. Only the cloud administrator user can disable the retention lock and then the delete the image if required. You can use the enterprise mode to test the retention period behavior before you use compliance mode.
- --storageclass storage_class, -s storage_class
Amazon S3 storage class, such as STANDARD_IA or GLACIER_IR. The default is STANDARD.
- --userid user_id, -u user_id
The AWS user ID in aws sts get-caller-identity. The default is null. This option is only available for AWS S3 immutable storage.
- --volume volume_name, -v volume_name
The volume name is the directory name under the S3 bucket or the Azure blob container.
EXAMPLES
Example 1: Create a cloud immutable volume.
/usr/openv/pdde/pdcr/bin/msdpcldutil create -b bucketname -v volumename --mode ENTERPRISE --min 1D --max 30D --live 2021-12-31
Example 2: Update the cloud immutable volume mode.
/usr/openv/pdde/pdcr/bin/msdpcldutil update mode -b bucketname -v volumename --mode COMPLIANCE --live 2021-12-31 --inherit enable
Example 3: Update the cloud immutable volume minimum and maximum retention periods.
/usr/openv/pdde/pdcr/bin/msdpcldutil update range -b bucketname -v volumename --min 1D --max 90D
Example 4: Update the cloud immutable volume live duration.
/usr/openv/pdde/pdcr/bin/msdpcldutil update live -b bucketname -v volumename -l 2022-01-31
Example 5: Create GCP bucket with the bucket level retention.
/usr/openv/pdde/pdcr/bin/msdpcldutil bucket create -b bucketname -m ENTERPRISE -p 100D