Veritas NetBackup™ Appliance Commands Reference Guide

Last Published:
Product(s): Appliances (3.1.1)
  1. Overview
    1.  
      About the NetBackup Appliance Shell Menu
    2. Logging on 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
      1.  
        About the commands under the Appliance view
      2.  
        About the commands under the Manage view
      3.  
        About the commands under the Monitor view
      4.  
        About the commands under the Network view
      5.  
        About the commands under the Reports view
      6.  
        About the commands under the Settings view
      7.  
        About the commands under the Support view
  2. Appendix A. Main > Appliance commands
    1.  
      Appliance > Master
    2.  
      Appliance > Media
    3.  
      Appliance > Management
    4.  
      Appliance > Remove
    5.  
      Appliance > ShowDedupPassword
    6.  
      Appliance > ShowIdentity
    7.  
      Appliance > Status
  3. 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
  4. 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
  5. 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
  6. 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
  7. Appendix F. Main > Manage > License commands
    1.  
      Manage > License > Add
    2.  
      Manage > License > List
    3.  
      Manage > License > ListInfo
    4.  
      Manage > License > Remove
  8. Appendix G. Main > Manage > MountPoints commands
    1.  
      Manage > MountPoints > List
    2.  
      Manage > MountPoints > Mount
    3.  
      Manage > MountPoints > Unmount
  9. Appendix H. Main > Manage > NetBackup CLI commands
    1.  
      Manage > NetBackupCLI > Create
    2.  
      Manage > NetBackupCLI > Delete
    3.  
      Manage > NetBackupCLI > List
    4.  
      Manage > NetBackupCLI > PasswordExpiry
  10. 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
  11. Appendix J. Main > Manage > Software commands
    1.  
      Manage > Software > Cancel
    2.  
      Manage > Software > Delete
    3.  
      Manage > Software > Download
    4.  
      Manage > Software > DownloadProgress
    5.  
      Manage > Software > Firmware
    6.  
      Manage > Software > Install
    7.  
      Manage > Software > List
    8.  
      Manage > Software > LiveUpdateClients
    9.  
      Manage > Software > Readme
    10.  
      Manage > Software > Rollback
    11.  
      Manage > Software > Share
    12.  
      Manage > Software > UpgradeStatus
  12. 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
  13. 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
  14. Appendix M. Main > Manage > Certificates commands
    1.  
      Manage > Certificates > Generate
    2.  
      Manage > Certificates > Delete
  15. 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
  16. 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
  17. Appendix P. Main > Network > Security (IPsec) commands
    1.  
      Network > IPsec > Configure
    2.  
      Network > IPsec > Delete
    3.  
      Network > IPsec > Export
    4.  
      Network > IPsec > Import
    5.  
      Network > IPsec > Provision
    6.  
      Network > IPsec > Refresh
    7.  
      Network > IPsec > Show
    8.  
      Network > IPsec > Unconfigure
  18. Appendix Q. Main > Reports commands
    1.  
      Reports > Deduplication
    2.  
      Reports > Process
  19. Appendix R. Main > Settings commands
    1.  
      Settings > Cloud
    2.  
      Settings > Deduplication
    3.  
      Settings > FibreTransport
    4.  
      Settings > iSCSI > Initiator
    5.  
      Settings > iSCSI > Interface
    6.  
      Settings > iSCSI > Target
    7.  
      Settings > LogForwarding
    8.  
      Settings > LifeCycle
    9.  
      Settings > LiveUpdateServer
    10.  
      Settings > NetBackup
    11.  
      Settings > Password
    12.  
      Settings > Share
    13.  
      Settings > SNMP polling
    14.  
      Settings > Sysctl
    15.  
      Settings > SystemLocale
  20. Appendix S. Main > Settings > Alerts commands
    1.  
      Settings > Alerts > CallHome
    2.  
      Settings > Alerts > Email
    3.  
      Settings > Alerts > Hardware
    4.  
      Settings > Alerts > SNMP
  21. Appendix T. Main > Settings > Notifications view commands
    1.  
      Settings > Notifications > LoginBanner
  22. Appendix U. Main > Settings > Security commands
    1.  
      Settings > Security > Authorization
    2.  
      Settings > Security > Authentication > ActiveDirectory
    3.  
      Settings > Security > Authentication > Kerberos
    4.  
      Settings > Security > Authentication > LDAP
    5.  
      Settings > Security > Authentication > LocalUser
    6.  
      Main > Settings > Security > STIG
    7.  
      Main > Settings > Security > FIPS
  23. Appendix V. Main > Support commands
    1.  
      Support > Checkpoint
    2.  
      Support > Cleanup > RemoveShelfEntries
    3.  
      Support > Cleanup > ResetDIMMErrors
    4.  
      Support > Collect
    5.  
      Support > DataCollect
    6.  
      Support > Disk
    7.  
      Support > Errors
    8.  
      Support > FactoryReset
    9.  
      Support > FibreTransport
    10.  
      Support > InfraServices
    11.  
      Support > iostat
    12.  
      Support > IPMI
    13.  
      Support > KillRemoteCall
    14.  
      Support > Logs
    15.  
      Support > Maintenance
    16.  
      Support > Messages
    17.  
      Support > NBDNA
    18.  
      Support > nbperfchk
    19.  
      Support > NBSU
    20.  
      Support > Processes
    21.  
      Support > RAID
    22.  
      Support > Reboot
    23.  
      Support > RecoverStorage
    24.  
      Support > Service
    25.  
      Support > ServiceAllowed
    26.  
      Support > Show
    27.  
      Support > Shutdown
    28.  
      Support > Storage ClearReservations
    29.  
      Support > Storage Reset
    30.  
      Support > Storage SanityCheck
    31.  
      Support > Test

Name

Main > Settings > LifeCycle — Change the backup image life cycle parameter settings.

SYNOPSIS

Lifecycle Defaults

LifeCycle Show

LifeCycle Tune CLEANUP_SESSION_INTERVAL Interval Unit

LifeCycle Tune DUPLICATION_GROUP_CRITERIA Criteria

LifeCycle Tune IMAGE_EXTENDED_RETRY_PERIOD Interval Unit

LifeCycle Tune JOB_SUBMISSION_INTERVAL Interval Unit

LifeCycle Tune MAX_SIZE_PER_DUPLICATION_JOB Size Unit

LifeCycle Tune MAX_TIME_TIL_FORCE_SMALL_DUPLICATION_JOB Time

LifeCycle Tune MIN_SIZE_PER_DUPLICATION_JOB Size Unit

LifeCycle Tune REPLICA_METADATA_CLEANUP_TIMER Time

LifeCycle Tune TAPE_RESOURCE_MULTIPLIER Value

LifeCycle Tune VERSION_CLEANUP_DELAY Time Unit

DESCRIPTION

You can use the LifeCycle command with the Default and Show options to display the default values for each of the LifeCycle parameters and the current parameter values, respectively.

You can use the LifeCycle Tune command to adjust the following parameters:

  • CLEANUP_SESSION_INTERVAL - To define how often the deleted life cycle policies should be cleaned up.

  • DUPLICATION_GROUP_CRITERIA - To define how batches are created.

  • IMAGE_EXTENDED_RETRY_PERIOD - To define how long NetBackup waits before an image copy is added to the next duplication job.

  • JOB_SUBMISSION_INTERVAL - Set the frequency of job submission for all operations.

  • MAX_SIZE_PER_DUPLICATION_JOB - To define how large the batch of images is allowed to grow.

  • MAX_TIME_TIL_FORCE_SMALL_DUPLICATION_JOB - To define how old any image in the group can become before the batch is submitted as a duplication job.

  • MIN_SIZE_PER_DUPLICATION_JOB - To define the size that the batch of images should reach before one duplication job is run for the entire batch.

  • REPLICA_METADATA_CLEANUP_TIMER - To set the number of days after which the Import Manager stops trying to import the image.

  • TAPE_RESOURCE_MULTIPLIER - To set the multiplier for the number of concurrently active duplication jobs that can access a single storage unit.

  • VERSION_CLEANUP_DELAY - To define how much time must pass since an inactive version was the active version.

OPTIONS

LifeCycle Defaults

Show the default values of each of the parameters.

LifeCycle Show

Show the current values of each of the parameters.

LifeCycle Tune CLEANUP_SESSION_INTERVAL Interval Unit

How often the deleted life cycle policies should be cleaned up. The Interval variable denotes the time interval after which the policies are to be cleaned. The Unit variable is used to provide the unit for the time interval in Seconds, Minutes, Hours, Days, Weeks, Months, or Years. The default value is 24 hours. You must enter a value that is greater than 10 Seconds when the unit is set to Seconds.

DUPLICATION_GROUP_CRITERIA Criteria

Define how batches are created. Batches are created based on the life cycle policy name or the duplication job priority. You enter either PolicyName or JobPriority

LifeCycle Tune IMAGE_EXTENDED_RETRY_PERIOD Interval Unit

How long NetBackup waits before an image copy is added to the next duplication job. The Unit variable is used to provide the unit for the time interval in Seconds, Minutes, Hours, Days, Weeks, Months, or Years. The default value is 2 hours. You must enter a value that is greater than 10 Seconds when the unit is set to Seconds.

LifeCycle Tune JOB_SUBMISSION_INTERVAL Interval Unit

Use this command to set the frequency of job submission for all operations. The Interval variable is defined in minutes. The Unit variable is used to provide the unit for the time interval in Seconds, Minutes, Hours, Days, Weeks, Months, or Years. The default value is 5 minutes. You must enter a value that is greater than 10 Seconds when the unit is set to Seconds. The maximum interval for this variable is not identified.

LifeCycle Tune MAX_SIZE_PER_DUPLICATION_JOB Size Unit

How large the batch of images is allowed to grow. The Size variable is the size of the duplication job. The Unit variable is used to provide the unit for the time interval in Bytes, KB, MB, GB, TB, or PB. If you select the unit as Bytes, you cannot enter a size that is less than 1024 Bytes. The maximum value is 2147483647. The default value is 100 GB.

LifeCycle Tune MAX_TIME_TIL_FORCE_SMALL_DUPLICATION_JOB Time Unit

How old any image in the group can become before the batch is submitted as a duplication job. The Time variable is the time of the image. The Unit variable is used to provide the unit for the time interval in Seconds, Minutes, Hours, Days, Weeks, Months, or Years. The default value is 30 minutes. You must enter a value that is greater than 10 Seconds when the unit is set to Seconds. The maximum seconds number is 2147483647.

The logical maximum number for the other unit options is as follows:

  • Minutes: 35,791,394

  • Hours: 396,523

  • Days: 24,855

  • Weeks: 3,550

  • Months: 828

  • Years: 68

If a user enters a higher number than the maximum, it automatically uses the allowed maximum number.

LifeCycle Tune MIN_SIZE_PER_DUPLICATION_JOB Size Unit

The size that the batch of images should reach before one duplication job is run for the entire batch. The Size variable denotes the size of the duplication job. The Unit variable denotes unit of size in Bytes, KB, MB, GB, TB, or PB. The default value is 8 GB. You must enter a value that is greater than 1024 Bytes.

LifeCycle Tune REPLICA_METADATA_CLEANUP_TIMER Time

Set the number of days after which the Import Manager stops trying to import the image. The Time variable is defined in the number of days. You turn this parameter off if you enter a value of zero.

LifeCycle Tune TAPE_RESOURCE_MULTIPLIER Value

Set the multiplier for the number of concurrently active duplication jobs that can access a single storage unit. The Value variable contains the multiplier value that is between 1 to 2147483647. The default value is 2.

LifeCycle Tune VERSION_CLEANUP_DELAY Time Unit

How much time must pass since an inactive version was the active version. The Time variable denotes the time that must pass since an inactive version was the active version. The Unit variable is used to provide the unit for the time interval in Seconds, Minutes, Hours, Days, Weeks, Months, or Years. The default value is 14 hours. You must enter a value that is greater than 10 Seconds when the unit is set to Seconds.

EXAMPLES

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

LifeCycle > Defaults
CLEANUP_SESSION_INTERVAL                 : 24 hours
DUPLICATION_GROUP_CRITERIA               : 1
IMAGE_EXTENDED_RETRY_PERIOD              : 2 hours
JOB_SUBMISSION_INTERVAL                  : 5 minutes
MAX_SIZE_PER_DUPLICATION_JOB             : 100 GB
MAX_TIME_TIL_FORCE_SMALL_DUPLICATION_JOB : 30 minutes
MIN_SIZE_PER_DUPLICATION_JOB             : 8 GB
REPLICA_METADATA_CLEANUP_TIMER           : 0 hours
TAPE_RESOURCE_MULTIPLIER                 : 2
VERSION_CLEANUP_DELAY                    : 14 days