Veritas NetBackup™ Virtual Appliance Documentation

Last Published:
Product(s): Appliances (5.1.1)
Platform: NetBackup Virtual Appliance
  1. Getting to know the NetBackup Virtual Appliance
    1. NetBackup Virtual Appliance product description
      1.  
        About the NetBackup Virtual Appliance primary server role
      2.  
        About the NetBackup Virtual Appliance combined primary and media server role
      3.  
        About the NetBackup Virtual Appliance media server role
    2.  
      NetBackup Virtual Appliance supported features
    3.  
      About the NetBackup Virtual Appliance documentation
    4.  
      NetBackup Virtual Appliance 5.1.1 new features, enhancements, and changes
    5.  
      Known limitations of the NetBackup Virtual Appliance 5.1.1 release
    6.  
      Operational Notes for the NetBackup Virtual Appliance 5.1.1 release
  2. Preparing to deploy the appliance
    1.  
      NetBackup Virtual Appliance product files (OVF templates)
    2.  
      NetBackup Virtual Appliance deployment methods
    3. NetBackup Virtual Appliance deployment guidelines
      1.  
        Configuration overview for NetBackup Virtual Appliance MSDP cloud applications
      2.  
        NetBackup Virtual Appliance initial deployment checklist
  3. Deploying and configuring the appliance
    1. How to deploy and configure a NetBackup Virtual Appliance combined primary and media server
      1.  
        Using the vSphere Client to deploy a combined primary and media server appliance
      2.  
        Using the OVF Tool to deploy a combined primary and media server appliance
      3.  
        Performing the initial configuration on a NetBackup Virtual Appliance combined primary and media server
    2. How to deploy and configure a NetBackup Virtual Appliance media server
      1.  
        Using the vSphere Client to deploy a media server appliance
      2.  
        Using the OVF Tool to deploy a media server appliance
      3.  
        Configuring a primary server to communicate with an appliance media server
      4.  
        Performing the initial configuration on a NetBackup Virtual Appliance media server
    3. How to deploy and configure a NetBackup Virtual Appliance primary server
      1.  
        Using the vSphere Client to deploy a NetBackup Virtual Appliance primary server
      2.  
        Using the OVF Tool to deploy a primary server
      3.  
        Performing the initial configuration on a NetBackup Virtual Appliance primary server
  4. Post initial configuration procedures
    1.  
      About modifying the NetBackup Virtual Appliance settings
    2.  
      Adding a permanent license key if an evaluation license key expires
    3.  
      Managing license keys on the NetBackup Virtual Appliance
  5. Appliance common tasks
    1.  
      Common tasks in NetBackup Virtual Appliance
  6. Storage management
    1. About NetBackup Virtual Appliance storage configuration
      1. About viewing storage space information using the Show command
        1.  
          Viewing all storage information
        2.  
          Viewing disk information
        3.  
          Viewing partition information
        4.  
          Viewing the partition distribution on disks
      2.  
        Resizing a partition
      3.  
        Troubleshooting resize-related issues
      4.  
        Moving a partition
      5.  
        Monitoring the progress of storage manipulation tasks
      6.  
        Scanning storage devices using the NetBackup Virtual Appliance Shell Menu
      7.  
        Adding storage space for the NetBackup Virtual Appliance
      8.  
        Removing an existing storage disk
    2. About OpenStorage plugin installation
      1.  
        Installing the OpenStorage plugin
      2.  
        Uninstalling the OpenStorage plugin
  7. Deduplication pool catalog backup and recovery
    1.  
      About the NetBackup Virtual Appliance deduplication pool catalog backup policy
    2.  
      Automatic configuration of the NetBackup Virtual Appliance deduplication pool catalog backup policy
    3.  
      Manually configuring the NetBackup Virtual Appliance deduplication pool catalog backup policy
    4.  
      Manually updating the NetBackup Virtual Appliance deduplication pool catalog backup policy
    5.  
      Recovering the NetBackup Virtual Appliance deduplication pool catalog
  8. Network connection management
    1.  
      About IPv4-IPv6-based network support
    2.  
      Network settings for the NetBackup Virtual Appliance
    3.  
      Configuring DNS and host name mapping for the NetBackup Virtual Appliance
    4.  
      Setting the date and time on a NetBackup Virtual Appliance
    5.  
      Configuring static routes on the NetBackup Virtual Appliance
    6.  
      Expanding the bandwidth on the NetBackup Virtual Appliance
  9. Managing users
    1.  
      About managing NetBackup Virtual Appliance users
    2.  
      About NetBackup Virtual Appliance account types
    3.  
      Adding NetBackup Virtual Appliance users
    4.  
      Deleting NetBackup Virtual Appliance users
    5.  
      Adding NetBackup Virtual Appliance user groups
    6.  
      Deleting NetBackup Virtual Appliance user groups
    7.  
      Granting roles to NetBackup Virtual Appliance users and user groups
    8.  
      Revoking roles from NetBackup Virtual Appliance users and user groups
    9. About user name and password specifications
      1.  
        About STIG-compliant password policy rules
    10.  
      Changing NetBackup Virtual Appliance user passwords
    11.  
      About password management and recovery
    12. About authenticating LDAP users
      1.  
        Adding or modifying an LDAP server configuration on the NetBackup Virtual Appliance
      2.  
        Importing an LDAP server configuration for the NetBackup Virtual Appliance
      3.  
        Setting the SSL certification for LDAP on the NetBackup Virtual Appliance
      4.  
        Exporting an LDAP server configuration from the NetBackup Virtual Appliance
      5.  
        Unconfiguring LDAP user authentication on the NetBackup Virtual Appliance
      6.  
        Disabling LDAP user authentication on the NetBackup Virtual Appliance
      7.  
        Enabling LDAP user authentication on the NetBackup Virtual Appliance
      8.  
        Adding an LDAP attribute mapping on the NetBackup Virtual Appliance
      9.  
        Deleting an LDAP attribute mapping on the NetBackup Virtual Appliance
    13. About authenticating Active Directory users
      1.  
        Adding an Active Directory server configuration
      2.  
        Unconfiguring Active Directory user authentication on the NetBackup Virtual Appliance
    14. About authentication using smart cards and digital certificates
      1.  
        2FA
      2.  
        Smart card Authentication for NetBackup Web UI
      3.  
        Configure role-based access control
      4.  
        Configure authentication for a smart card or digital certificate for the NetBackup Web UI
    15.  
      Generic user authentication guidelines
    16. About user authorization on the NetBackup Virtual Appliance
      1.  
        NetBackup Virtual Appliance user role privileges
      2.  
        About the Administrator user role
      3.  
        About the NetBackupCLI user role
    17. Creating NetBackup administrator user accounts
      1.  
        Logging on as a NetBackup administrator
      2.  
        Managing NetBackup administrator user account passwords
      3.  
        Viewing NetBackup administrator user accounts
      4.  
        Auditing NetBackup administrator accounts
    18.  
      Deleting NetBackup administrator user accounts
  10. Using the appliance
    1. About configuring Host parameters for your appliance on the NetBackup Virtual Appliance
      1.  
        Configuring data buffer options on the NetBackup Virtual Appliance
      2.  
        Configuring lifecycle parameters on the NetBackup Virtual Appliance
      3.  
        Managing NetBackup Virtual Appliance deduplication
      4. About BMR integration
        1.  
          Enabling BMR from the NetBackup Virtual Appliance Shell Menu
    2. About Copilot functionality and Share management
      1.  
        Creating a Share
      2.  
        Editing a Share
      3.  
        Deleting a Share
      4.  
        Moving a Share
      5.  
        Viewing Share information from the NetBackup Virtual Appliance Shell Menu
      6.  
        NFS export options
    3. About NetBackup Virtual Appliance as a VMware backup host
      1.  
        NetBackup Virtual Appliance as backup host: component overview
      2.  
        Notes on NetBackup Virtual Appliance as a VMware backup host
    4. About running NetBackup commands from the appliance
      1.  
        Running NetBackup commands from the NetBackup Virtual Appliance
      2.  
        Creating a NetBackup touch file from the NetBackup Virtual Appliance
      3.  
        Best practices for running NetBackup commands from the NetBackup Virtual Appliance
      4.  
        About NetBackup operating system commands
      5.  
        Known limitations of running NetBackup commands from the NetBackup Virtual Appliance
    5. About mounting a remote NFS
      1.  
        Mounting a remote NFS drive
      2.  
        Unmounting an NFS drive
    6. About Auto Image Replication from a NetBackup Virtual Appliance
      1.  
        Prerequisites for Auto Image Replication
      2.  
        Configuring a replication target
      3.  
        Determining the appliance deduplication password
    7.  
      Generating certificates
  11. Monitoring the appliance
    1.  
      About NetBackup Virtual Appliance alerts
    2.  
      Setting up email notifications for a NetBackup Virtual Appliance
    3.  
      Setting up SNMP notifications for a NetBackup Virtual Appliance
    4.  
      Enabling and disabling Call Home from the appliance shell menu
    5.  
      Configuring a Call Home proxy server from the NetBackup Virtual Appliance Shell Menu
    6. About SNMP
      1.  
        About the Management Information Base (MIB)
    7. About Call Home
      1.  
        Understanding the Call Home workflow
      2.  
        About the Product Improvement Program
    8.  
      About AutoSupport
    9.  
      About storage email alerts
  12. Appliance security
    1. About Symantec Data Center Security on the NetBackup Virtual Appliance
      1.  
        Auditing the SDCS logs on the NetBackup Virtual Appliance
      2.  
        Viewing SDCS audit log details
      3.  
        Changing the SDCS log retention settings on the NetBackup Virtual Appliance
      4.  
        About SDCS event type codes and severity codes on the NetBackup Virtual Appliance
    2.  
      About data security
    3.  
      About data integrity
    4.  
      About data classification
    5. About data encryption
      1.  
        KMS support
    6.  
      About SSL usage
    7.  
      About implementing external certificates
    8.  
      About the NetBackup Virtual Appliance intrusion detection system
    9.  
      About the NetBackup Virtual Appliance intrusion prevention system
    10.  
      Major components of the NetBackup Virtual Appliance OS
    11.  
      OS STIG hardening for NetBackup Virtual Appliance
    12.  
      FIPS 140-2 conformance for NetBackup Virtual Appliance
    13.  
      Disable user access to the NetBackup appliance operating system
    14.  
      Manage support access to the maintenance shell
    15.  
      About the appliance login banner
    16. Setting the appliance login banner
      1.  
        Creating the appliance login banner
      2.  
        Removing the appliance login banner
    17.  
      Log Forwarding feature overview
  13. Upgrading the appliance
    1. About upgrading to NetBackup Virtual Appliance software version 5.1.1
      1.  
        Supported upgrade paths
      2.  
        Preflight check before the upgrade
      3.  
        Appliance behavior during upgrades
      4.  
        About corresponding NetBackup software versions
      5.  
        About the Appliance Install Manager
    2. Requirements and best practices for upgrading NetBackup appliances
      1.  
        Upgrade time estimation
    3.  
      Pre-upgrade tasks for appliance upgrades
    4. Methods for downloading appliance software release updates
      1.  
        Downloading software updates directly to a NetBackup appliance
      2.  
        Downloading software updates to a NetBackup appliance using a client share
    5.  
      Installing a NetBackup Virtual Appliance software update using the NetBackup Virtual Appliance Shell Menu
    6.  
      Troubleshooting upgrade issues
  14. NetBackup client upgrades with VxUpdate
    1.  
      About VxUpdate
    2.  
      VxUpdate repository management
    3.  
      Deployment policy management
    4.  
      Manually initiating upgrades from the primary server using VxUpdate
    5.  
      Manually initiating upgrades from the client using VxUpdate
    6.  
      Deployment job status
  15. Appliance restore
    1.  
      About appliance restore
    2.  
      Creating an appliance checkpoint from the appliance shell menu
    3.  
      Rollback to an appliance checkpoint from the appliance shell menu
    4.  
      About NetBackup Virtual Appliance factory reset
    5.  
      Factory reset best practices
    6.  
      How to factory reset the NetBackup Virtual Appliance
  16. Decommissioning and Reconfiguring
    1.  
      About decommissioning a NetBackup Virtual Appliance
    2.  
      Decommissioning a NetBackup Virtual Appliance with the media server role
    3.  
      Migrating from NetBackup Cloud Catalyst Appliance to MSDP direct cloud tiering
  17. Troubleshooting
    1.  
      About troubleshooting the NetBackup Virtual Appliance
    2.  
      About contacting Technical Support
    3.  
      Determining the NetBackup Virtual Appliance serial number
    4. About disaster recovery
      1.  
        Recovering a NetBackup appliance primary server using NetBackup catalog restore
    5. About NetBackup support utilities
      1.  
        NetBackup Domain Network Analyzer (NBDNA)
      2.  
        NetBackup Support Utility (NBSU)
    6.  
      Troubleshooting NetBackup Virtual Appliance deployment or initial configuration issues
    7.  
      Error messages displayed on the NetBackup Virtual Appliance Shell Menu
    8.  
      NetBackup status codes applicable for NetBackup Virtual Appliance
    9.  
      Installing an EEB
    10.  
      Rolling back an EEB using the NetBackup Virtual Appliance Shell Menu
  18. Appliance logging
    1.  
      About NetBackup Virtual Appliance log files
    2.  
      Viewing log files using the Support command
    3.  
      Where to find NetBackup Virtual Appliance log files using the Browse command
    4.  
      Enabling and disabling VxMS logging
    5.  
      Gathering device logs on a NetBackup virtual appliance
    6.  
      Moving the log data
    7. About forwarding logs to an external server
      1.  
        Uploading certificates for TLS
      2.  
        Enabling log forwarding
      3.  
        Changing the log forwarding interval
      4.  
        Viewing the log forwarding configuration
      5.  
        Disabling log forwarding
  19. Commands overview
    1.  
      About the NetBackup Virtual Appliance Shell Menu
    2.  
      Logging in to the NetBackup Virtual Appliance Shell Menu
    3.  
      Using the NetBackup Virtual Appliance Shell Menu
    4.  
      About the NetBackup Virtual Appliance Shell Menu command views
  20. Appendix A. Appliance commands
    1.  
      Appliance > Primary
    2.  
      Appliance > Media
    3.  
      Appliance > ShowDedupPassword
    4.  
      Appliance > Status
    5.  
      Appliance > Configure
  21. Appendix B. Manage commands
    1.  
      Manage > Software > Delete
    2.  
      Manage > Software > Download
    3.  
      Manage > Software > List
    4.  
      Manage > Software > Install
    5.  
      Manage > Software > Share
    6.  
      Manage > Software > Readme
    7.  
      Manage > Software > Rollback
    8.  
      Manage > Software > Cancel
    9.  
      Manage > Software > DownloadAnalyzer
    10.  
      Manage > Software > DownloadProgress
    11.  
      Manage > Software > UpgradeStatus
    12.  
      Manage > Software > VxUpdate
    13.  
      Manage > Storage > Show
    14.  
      Manage > Storage > Add
    15.  
      Manage > Storage > Create
    16.  
      Manage > Storage > Delete
    17.  
      Manage > Storage > Edit
    18.  
      Manage > Storage > Monitor
    19.  
      Manage > Storage > Move
    20.  
      Manage > Storage > Remove
    21.  
      Manage > Storage > Resize
    22.  
      Manage > Storage > Scan
    23.  
      Manage > OpenStorage > Install
    24.  
      Manage > OpenStorage > List
    25.  
      Manage > OpenStorage > Readme
    26.  
      Manage > OpenStorage > Share
    27.  
      Manage > OpenStorage > Uninstall
    28.  
      Manage > MountPoints > List
    29.  
      Manage > MountPoints > Mount
    30.  
      Manage > MountPoints > Unmount
    31.  
      Manage > License
    32.  
      Manage > Certificates > Generate
    33.  
      Manage > Certificates > Delete
    34.  
      Manage > NetBackupCLI > Create
    35.  
      Manage > NetBackupCLI > Delete
    36.  
      Manage > NetBackupCLI > List
  22. Appendix C. Monitor commands
    1.  
      Monitor > Uptime
    2.  
      Monitor > Who
    3.  
      Monitor > NetworkStatus
    4.  
      Monitor > Top
    5.  
      Monitor > MemoryStatus
    6.  
      Monitor > SDCS
    7.  
      Monitor > NetBackup
    8.  
      Monitor > Hardware
  23. Appendix D. 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 > WANOptimization
  24. Appendix E. Reports commands
    1.  
      Reports > Deduplication
    2.  
      Reports > Process
  25. Appendix F. Settings commands
    1.  
      Settings > Deduplication
    2.  
      Settings > LifeCycle
    3.  
      Settings > LogForwarding
    4.  
      Settings > NetBackup
    5.  
      Settings > NetBackup DNAT
    6.  
      Settings > NetBackup NATServers
    7.  
      Settings > Password
    8.  
      Settings > SystemLocale
    9.  
      Settings > Share
    10.  
      Settings > Sysctl
    11.  
      Settings > Notifications > LoginBanner
    12.  
      Settings > Security > Authentication > AccountStatus
    13.  
      Settings > Security > Authentication > LDAP
    14.  
      Settings > Security > Authentication > ActiveDirectory
    15.  
      Settings > Security > Authentication > LocalUser
    16.  
      Main > Settings > Security > Authentication > CIFSShare
    17.  
      Settings > Security > Authorization
    18.  
      Main > Settings > Security > Certificate
    19.  
      Main > Settings > Security > Certificate > CertificateSigningRequest
    20.  
      Main > Settings > Security > STIG
    21.  
      Main > Settings > Security > FIPS
    22.  
      Main > Settings > Security > SecurityLevel
    23.  
      Main > Settings > Security > Sessions
    24.  
      Settings > Alerts > CallHome
    25.  
      Settings > Alerts > SNMP
    26.  
      Settings > Alerts > Email
    27.  
      Settings > Alerts > Hardware
  26. Appendix G. Support commands
    1.  
      Support > Checkpoint
    2.  
      Support > Cleanup > CleanMonInvData
    3.  
      Support > DataCollect
    4.  
      Support > Disk
    5.  
      Support > Errors
    6.  
      Support > FactoryReset
    7.  
      Support > InfraServices
    8.  
      Support > InstantAccess
    9.  
      Support > iostat
    10.  
      Support > LogBrowser
    11.  
      Support > Logs
    12.  
      Support > Maintenance
    13.  
      Support > Messages
    14.  
      Support > NBDNA
    15.  
      Support > Nbperfchk
    16.  
      Support > NBSU
    17.  
      Support > Processes
    18.  
      Support > Reboot
    19.  
      Support > Service
    20.  
      Support > Shutdown
    21.  
      Support > Storage Create LogPartition
    22.  
      Support > Storage Create NDMPLogPartition
    23.  
      Support > Storage SanityCheck
    24.  
      Support > Storage Reset
    25.  
      Support > System
    26.  
      Support > Test
  27. Appendix H. Available commands for a NetBackupCLI user
    1.  
      Command
    2.  
      Password

Manually initiating upgrades from the client using VxUpdate

Manually initiate deployment jobs when you are logged into the client locally and want to force an immediate update. You can either use a deployment policy to initiate an immediate upgrade or specify an upgrade without an associated policy. You can use the upgrade to update the NetBackup version or for other upgrades such as emergency binaries.

Among the reasons for a client initiated upgrade using VxUpdate is mission critical systems with specific maintenance windows. One example of these systems is database servers with limited available down time.

Note:

You can only launch updates on the local client. You cannot use the nbinstallcmd command on a client to launch jobs on other clients. If you want to launch updates on other clients, you must initiate them from the primary server.

VxUpdate also provides the ability to launch upgrades from the primary server with the command line. More information is available.

See Manually initiating upgrades from the primary server using VxUpdate.

The nbinstallcmd version on a back-level host is not the current nbinstallcmd version when you initiate a non-policy based upgrade directly on the target client or media server. Refer to the NetBackup Commands Reference Guide for the currently installed version of NetBackup for the exact format of nbinstallcmd command.

Because of this older version of nbinstallcmd, exceptions to normal VxUpdate behavior include:

  • If your primary server uses both NetBackup certificate and an external certificate, and your target media server or client is at NetBackup 8.1.2: Running a non-policy based upgrade directly on the target host is not supported. You must upgrade with one of the options shown:

    • Upgrade the client or the media server using VxUpdate from the primary server.

    • Create a policy on the primary server. Then run policy-based nbinstallcmd on the target client or media server.

    • Disable the external certificate on your primary server before starting the non-policy-based upgrade on the target host. You may turn on the external certificate after the upgrade completes successfully.

  • If the client or the media server is at NetBackup 8.2 or earlier, the -components flag is not available. This flag was introduced in NetBackup 8.3 to enable optional installation of the NetBackup Java GUI and JRE. When you run an ad-hoc nbinstallcmd on a client or a media server at NetBackup 8.2 or earlier, the -components javagui_jre option defaults to MATCH. This value causes the upgrade to match the Java GUI and JRE status of the pre-upgrade host. If the pre-upgrade host had Java GUI and JRE installed, it remains installed after upgrade. If the pre-upgrade host did not have Java GUI and JRE installed, it is not installed after upgrade.

To start a client initiated deployment job based on an existing policy

  1. Navigate to the binary directory from a command prompt.

    UNIX or Linux: /usr/openv/netbackup/bin

    Windows: install_path\netbackup\bin

  2. Use the nbinstallcmd as shown:

    nbinstallcmd -policy policy -schedule schedule -master_server name

    Example: nbinstallcmd -policy all_clients -schedule install812 -master_server primary1

    If the job initiated successfully, you are returned to the command prompt without an error message.

  3. Monitor upgrade status with the NetBackup administrator and the Activity Monitor in the NetBackup Administrative Console.

You can start a client initiated deployment job without an associated policy from the command line. The options required for the nbinstallcmd command vary depending on your security configuration. Please refer to the nbinstallcmd command documentation for a list of all possible options and examples of command usage.

NetBackup Commands Reference Guide