Search <book_title>...

Veritas NetBackup™ Appliance Commands Reference Guide

Last Published: 2021-07-19

Product(s): Appliances (4.1)

Platform: NetBackup Appliance OS

Overview
1. About the NetBackup Appliance Shell Menu
2. Logging in to the NetBackup Appliance Shell Menu
  1. Command limitations on appliances that are not configured
3. Using the NetBackup Appliance Shell Menu
4. About the NetBackup Appliance Shell Menu command views
Appendix A. Main > Appliance commands
1. Appliance > Primary
2. Appliance > Media
3. Appliance > Management
4. Appliance > Remove
5. Appliance > ShowDedupPassword
6. Appliance > ShowIdentity
7. Appliance > Status
Appendix B. Main > Manage > FibreChannel commands
1. Manage > FibreChannel > Clean
2. Manage > FibreChannel > Configure
3. Manage > FibreChannel > Reset
4. Manage > FibreChannel > Scan
5. Manage > FibreChannel > Show
6. Manage > FibreChannel > Statistics
Appendix C. Main > Manage > HighAvailability commands
1. Manage > HighAvailability > AddNode
2. Manage > HighAvailability > GetAssetTag
3. Manage > HighAvailability > RemoveNode
4. Manage > HighAvailability > Setup
5. Manage > HighAvailability > Status
6. Manage > HighAvailability > Switchover
Appendix D. Main > Manage > Libraries commands
1. Manage > Libraries > Configure
2. Manage > Libraries > Deny
3. Manage > Libraries > Down
4. Manage > Libraries > Inventory
5. Manage > Libraries > List
6. Manage > Libraries > Requests
7. Manage > Libraries > Reset
8. Manage > Libraries > Resubmit
9. Manage > Libraries > Up
Appendix E. Main > Manage > Libraries > Advanced > ACS commands
1. Manage > Libraries > Advanced > ACS > ACS_CSI_HOSTPORT
2. Manage > Libraries > Advanced > ACS > ACS_SEL_SOCKET
3. Manage > Libraries > Advanced > ACS > ACS_SSI_HOSTNAME
4. Manage > Libraries > Advanced > ACS > ACS_SSI_INET_PORT
5. Manage > Libraries > Advanced > ACS > ACS_SSI_SOCKET
6. Manage > Libraries > Advanced > ACS > ACS_TCP_RPCSERVICE
7. Manage > Libraries > Advanced > ACS > ACS_UDP_RPCSERVICE
8. Manage > Libraries > Advanced > ACS > API_BARCODE_RULES
9. Manage > Libraries > Advanced > ACS > TestACS
10. Manage > Libraries > Advanced > ACS > ViewVMconf
Appendix F. Main > Manage > License commands
1. Manage > License > Add
2. Manage > License > List
3. Manage > License > ListInfo
4. Manage > License > Remove
Appendix G. Main > Manage > MountPoints commands
1. Manage > MountPoints > List
2. Manage > MountPoints > Mount
3. Manage > MountPoints > Unmount
Appendix H. Main > Manage > NetBackup CLI commands
1. Manage > NetBackupCLI > Create
2. Manage > NetBackupCLI > Delete
3. Manage > NetBackupCLI > List
Appendix I. Main > Manage > OpenStorage commands
1. Manage > OpenStorage > Install
2. Manage > OpenStorage > List
3. Manage > OpenStorage > Readme
4. Manage > OpenStorage > Share
5. Manage > OpenStorage > Uninstall
Appendix J. Main > Manage > Software commands
1. Manage > Software > Cancel
2. Manage > Software > Delete
3. Manage > Software > Download
4. Manage > Software > DownloadAnalyzer
5. Manage > Software > DownloadProgress
6. Manage > Software > Firmware
7. Manage > Software > Install
8. Manage > Software > List
9. Manage > Software > Readme
10. Manage > Software > Rollback
11. Manage > Software > Share
12. Manage > Software > UpgradeStatus
13. Manage > Software > VxUpdate
Appendix K. Main > Manage > Storage commands
1. Manage > Storage > Add
2. Manage > Storage > Create
3. Manage > Storage > Delete
4. Manage > Storage > Edit
5. Manage > Storage > Monitor
6. Manage > Storage > Move
7. Manage > Storage > Remove
8. Manage > Storage > Resize
9. Manage > Storage > Scan
10. Manage > Storage > Show
11. Manage > Storage > Erase
Appendix L. Main > Manage > Tapes commands
1. Manage > Tapes > Cleaning
2. Manage > Tapes > Delete
3. Manage > Tapes > Eject
4. Manage > Tapes > Freeze
5. Manage > Tapes > Inventory
6. Manage > Tapes > List
7. Manage > Tapes > ListNetBackupMedia
8. Manage > Tapes > Suspend
9. Manage > Tapes > Unfreeze
10. Manage > Tapes > Unsuspend
Appendix M. Main > Manage > Certificates commands
1. Manage > Certificates > Generate
2. Manage > Certificates > Delete
Appendix N. Main > Monitor commands
1. Monitor > Beacon
2. Monitor > MemoryStatus
3. Monitor > NetBackup
4. Monitor > NetworkStatus
5. Monitor > SDCS
6. Monitor > Top
7. Monitor > Uptime
8. Monitor > Who
9. Monitor > Hardware
Appendix O. Main > Network commands
1. Network > Configure
2. Network > Date
3. Network > DNS
4. Network > Gateway
5. Network > Hostname
6. Network > Hosts
7. Network > IPv4
8. Network > IPv6
9. Network > LinkAggregation
10. Network > NetStat
11. Network > NTPServer
12. Network > Ping
13. Network > SetProperty
14. Network > Show
15. Network > TimeZone
16. Network > TraceRoute
17. Network > Unconfigure
18. Network > VLAN
19. Network > WANOptimization
Appendix P. Main > Network > Security commands (IPsec)
1. Network > Security > Configure
2. Network > Security > Delete
3. Network > Security > Export
4. Network > Security > Import
5. Network > Security > Provision
6. Network > Security > Refresh
7. Network > Security > Show
8. Network > Security > Unconfigure
Appendix Q. Main > Reports commands
1. Reports > Deduplication
2. Reports > Process
Appendix R. Main > Settings commands
1. Settings > Deduplication
2. Settings > FibreTransport
3. Settings > iSCSI > Initiator
4. Settings > iSCSI > Interface
5. Settings > iSCSI > Target
6. Settings > LogForwarding
7. Settings > LifeCycle
8. Settings > NetBackup
9. Settings > NetBackup DNAT
10. Settings > NetBackup NATServers
11. Settings > Password
12. Settings > Share
13. Settings > SNMP polling
14. Settings > Sysctl
15. Settings > SystemLocale
Appendix S. Main > Settings > Alerts commands
1. Settings > Alerts > CallHome
2. Settings > Alerts > Email
3. Settings > Alerts > Hardware
4. Settings > Alerts > SNMP
Appendix T. Main > Settings > Notifications view commands
1. Settings > Notifications > LoginBanner
Appendix U. Main > Settings > Security commands
1. Settings > Security > Authorization
2. Settings > Security > Authentication > AccountStatus
3. Settings > Security > Authentication > ActiveDirectory
4. Main > Settings > Security > Authentication > CIFSShare
5. Settings > Security > Authentication > Kerberos
6. Settings > Security > Authentication > LDAP
7. Settings > Security > Authentication > LocalUser
8. Main > Settings > Security > Certificate
9. Main > Settings > Security > Certificate > CertificateSigningRequest
10. Main > Settings > Security > FIPS
11. Main > Settings > Security > Ports
12. Main > Settings > Security > STIG
13. Main > Settings > Security > SecurityLevel
Appendix V. Main > Support commands
1. Support > Checkpoint
2. Support > Cleanup > CleanMonInvData
3. Support > Cleanup > RemoveShelfEntries
4. Support > Cleanup > ResetDIMMErrors
5. Support > Collect
6. Support > DataCollect
7. Support > Disk
8. Support > Errors
9. Support > FactoryReset
10. Support > FibreTransport
11. Support > InfraServices
12. Support > InstantAccess
13. Support > iostat
14. Support > IPMI
15. Support > KillRemoteCall
16. Support > LogBrowser
17. Support > Logs
18. Support > Maintenance
19. Support > Messages
20. Support > NBDNA
21. Support > nbperfchk
22. Support > NBSU
23. Support > Processes
24. Support > RAID
25. Support > Reboot
26. Support > RecoverStorage
27. Support > Service
28. Support > ServiceAllowed
29. Support > ShelfOrdering
30. Support > Show
31. Support > Shutdown
32. Support > Storage ClearReservations
33. Support > Storage Reset
34. Support > Storage SanityCheck
35. Support > System
36. Support > Test

Name

Main > Settings > Deduplication — Change the deduplication parameters.

SYNOPSIS

Defaults

Show

Tune BACKUPRESTORERANGE Addresses

Tune BANDWIDTH_LIMITLimit

Tune COMPRESSION Comp

Tune DONT_SEGMENT_TYPES Append FileTypes

Tune DONT_SEGMENT_TYPES Change FileTypes

Tune ENCRYPTION Value

Tune LOCAL_SETTINGSOverride

Tune LOGLEVEL Value

Tune MAX_IMG_MBSIZE Value

Tune MAX_LOG_MBSIZE Value

Tune MSDP_ENCRYPTION Value

Tune OPTDUP_BANDWIDTH Value

Tune OPTDUP_COMPRESSION Value

Tune OPTDUP_ENCRYPTION Value

Tune OPTDUP_TIMEOUT Time

Tune WS_RETRYCOUNT Count

Tune WS_TIMEOUT Time

DESCRIPTION

You can use the Deduplication command with the Default and Show options to display the default values for each of the Deduplication parameters and the current parameter values, respectively. You can use the Deduplication Tune command to adjust the following parameters:

Table: Deduplication parameters and default values

Setting	Default	Possible values	Action
BACKUPRESTORERANGE	N/A	Classless Inter-Domain Routing format or comma-separated list of IP addresses	Specifies the IP address or range of addresses of the local network interface card (NIC) for backups and restores.
BANDWIDTH_LIMIT	0	0 (no limit) to the practical system limit, in KBs/sec	Determines the maximum bandwidth that is allowed when backing up or restoring data between the media server and the deduplication pool. The value is specified in KBytes/second. The default is no limit.
COMPRESSION	1	0 (disabled) or 1 (enabled)	Specify whether you want files compressed. By default, this option is enabled.
DONT_SEGMENT_TYPES	N/A	Any file extension	You can specify a list of comma-separated file name extensions. Files in the backup stream that have the specified extensions are given a single segment if smaller than 16 MB. Larger files are deduplicated using the maximum 16-MB segment size. Example: DONT_SEGMENT_TYPES = mp3,avi This setting prevents NetBackup from analyzing and managing segments within the file types that do not deduplicate globally.
ENCRYPTION	0	0 (disabled) or 1 (enabled)	Specify whether to encrypt data. Enable this option to encrypt data that is written directly to this media server, or from an MSDP pool which also has the ENCRYPTION or the MSDP ENCRYPTION option enabled. By default, this option is disabled. If you enable this parameter on all hosts, the data is encrypted during transfer and in the storage.
LOCAL_SETTINGS	0	0 (allow override) or 1 (always use local settings)	Specifies whether to allow the pd.conf settings of the deduplication storage server to override the settings in the local pd.conf file.
LOGLEVEL	0	An integer, 0 to 10 inclusive	Specifies the amount of information that is written to the log file. The range is from 0 to 10, with 10 being the most logging. Note: Only change this value if a Veritas representative directs you to do so.
MAX_IMG_MBSIZE	50,000	0 to 50,000, in MBs	The maximum backup image fragment size in megabytes. Note: Only change this value if a Veritas representative directs you to do so.
MAX_LOG_MBSIZE	500	0 to 50,000, in MBs	The maximum size of the log file in megabytes.
MSDP_ENCRYPTION	0	0 (disabled) or 1 (enabled)	Specify whether to encrypt MSDP data. Enable this option to encrypt all data that is written to the MSDP pool, regardless of the source. When enabled, this option overrides the ENCRYPTION option. By default, this option is disabled.
OPTDUP_BANDWIDTH	0	0 (no limit) to the practical system limit, in KBs/sec	Determines the maximum bandwidth that is allowed for optimized duplication. The value is specified in KBytes/second.
OPTDUP_COMPRESSION	1	0 (disabled) or 1 (enabled)	Specify whether to compress optimized duplication data. By default, this option is enabled.
OPTDUP_ENCRYPTION	0	0 (disabled) or 1 (enabled)	Specify whether to encrypt optimized duplication data. By default, this option is disabled. If you enable this option on all hosts, the data is encrypted during transfer and on the storage.
OPTDUP_TIMEOUT	N/A	expressed in minutes	Specifies the number of minutes before the optimized duplication times out. Indicated in minutes.
WS_RETRYCOUNT	3	Integer	This parameter applies to the PureDisk Deduplication Option only. It does not affect NetBackup deduplication. The WSRetryCount parameter lets you configure the amount of retries that are attempted in case the Web service fails or times out.
WS_TIMEOUT	120	Integer	This parameter applies to the PureDisk Deduplication Option only. It does not affect NetBackup deduplication. The WSTimeout parameter lets you increase or decrease the timeout value for Web service calls made from NetBackup media servers to PureDisk storage units.

OPTIONS

Deduplication Defaults: Display the default values for the Deduplication parameters.

Deduplication Show: Display the current values for the Deduplication parameters.

Deduplication Tune BACKUPRESTORERANGE Addresses: Specify the IP addresses or range of addresses of the local network interface card for backup and restore. The Addresses variable contains an IP addresses list or a range of addresses.

Deduplication Tune BANDWIDTH_LIMIT Limit: The maximum bandwidth that is allowed when backing up or restoring data between the media server and the deduplication pool. The limit variable contains the maximum bandwidth limit. The value for this variable is in KBytes/second.

Deduplication Tune COMPRESSION Value

Specify whether you want files compressed. Where Value is Enable (default), or Disable.

When you run the Settings > Deduplication> Show command, the current setting appears as 0 when disabled or 1 when enabled.

Deduplication Tune DONT_SEGMENT_TYPES Append FileTypes: Append new file types to the list of file types that NetBackup does not analyze or manage segments. The FileTypes variable lists the file types.

Deduplication Tune DONT_SEGMENT_TYPES Change FileTypes: Change the whole list of file types. The FileTypes variable lists the file types.

Deduplication Tune ENCRYPTION Value

Specify whether you want to encrypt data. Enable this option to encrypt data that is written directly to this media server, or from an MSDP pool which also has the ENCRYPTION or the MSDP ENCRYPTION option enabled. Where Value is Enable or Disable (default).

When you run the Settings > Deduplication> Show command, the current setting appears as 0 when disabled or 1 when enabled.

Deduplication Tune LOCAL_SETTINGS Override: Whether to allow settings of the deduplication server to override the local settings. The Override variable determines whether to allow an override to occur. The values that you can enter in this field are AllowOverride or UseLocalSetting.

Deduplication Tune LOGLEVEL Value: The amount of information that is written to the log file. The Value variable sets the range from 0 to 10. A value of 10 provides the most logging.

Deduplication Tune MAX_IMG_MBSIZE Value: Set the maximum backup image fragment size. The Value variable contains the maximum size of the backup image fragment in megabytes. You can enter a value between zero and 50000.

Deduplication Tune MAX_LOG_MBSIZE Value: Set the maximum size of the log file. The Value variable contains the maximum size of the log file in megabytes. You can enter a value between zero and 50000.

Deduplication Tune MSDP_ENCRYPTION Value

Specify whether you want to encrypt data. Enable this option to encrypt all data that is written to the MSDP pool, regardless of the source. When enabled, this option overrides the ENCRYPTION option. Where Value is Enable or Disable (default).

When you run the Settings > Deduplication> Show command, the current setting appears as 0 when disabled or 1 when enabled.

Deduplication Tune OPTDUP_BANDWIDTH Value: The maximum bandwidth that is allowed for optimized duplication. Where Value is the maximum bandwidth in KBs/sec.

Deduplication Tune OPTDUP_COMPRESSION Value

Specify whether to compress optimized duplication data. Where Value is Enable (default), or Disable.

When you run the Settings > Deduplication> Show command, the current setting appears as 0 when disabled or 1 when enabled.

Deduplication Tune OPTDUP_ENCRYPTION Value

Specify whether to encrypt optimized duplication data. Where Value is Enable or Disable (default).

When you run the Settings > Deduplication> Show command, the current setting appears as 0 when disabled or 1 when enabled.

Deduplication Tune OPTDUP_TIMEOUT Time: The number of minutes before the optimized duplication times out. The Time variable is the number of minutes before the optimized duplication times out.

Deduplication Tune WS_RETRYCOUNT Count: The amount of retries that are attempted in case the Web service fails or times out. The Count variable is the amount of retries that are attempted in case the Web service fails or times out.

Deduplication Tune WS_TIMEOUT Time: The timeout value for Web service calls made from NetBackup media servers to PureDisk storage units. The Time variable is the timeout value for Web service calls made from NetBackup media servers to PureDisk storage units.

EXAMPLES

The Defaults command shows the values of each of the Deduplication parameters:

Deduplication> Defaults
BACKUPRESTORERANGE                                : N/A
BANDWIDTH_LIMIT                                   : 0
COMPRESSION                                       : 1
DONT_SEGMENT_TYPES                                : N/A
ENCRYPTION                                        : 0
LOCAL_SETTINGS                                    : 0
LOGLEVEL                                          : 0
MAX_IMG_MBSIZE                                    : 50000
MAX_LOG_MBSIZE                                    : 500
OPTDUP_BANDWIDTH                                  : 0
OPTDUP_COMPRESSION                                : 1
OPTDUP_ENCRYPTION                                 : 0
OPTDUP_TIMEOUT                                    : N/A
SEGKSIZE                                          : 128
WS_RETRYCOUNT                                     : 3
WS_TIMEOUT                                        : 120
MSDP_ENCRYPTION                                   : 0