Veritas NetBackup™ Virtual Appliance Documentation

Last Published:
Product(s): Appliances (3.1)
  1. Getting to know the NetBackup Virtual Appliance
    1. NetBackup Virtual Appliance product description
      1.  
        About the NetBackup Virtual Appliance combined master and media server role
      2.  
        About the NetBackup Virtual Appliance media server role
    2.  
      NetBackup Virtual Appliance supported features
    3.  
      About the NetBackup Virtual Appliance documentation
    4.  
      Known limitations of the NetBackup Virtual Appliance 3.1 release
    5.  
      Operational Notes for the NetBackup Virtual Appliance 3.1 release
    6.  
      NetBackup Virtual Appliance 3.1 new features, enhancements, and changes
  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.  
        NetBackup Virtual Appliance initial deployment checklist
  3. Deploying and configuring the appliance
    1. How to deploy and configure a NetBackup Virtual Appliance combined master and media server
      1.  
        Using the vSphere Client to deploy a combined master and media server appliance
      2.  
        Using the OVF Tool to deploy a combined master and media server appliance
      3.  
        Performing the initial configuration on a NetBackup Virtual Appliance combined master and media server
      4.  
        Completing the initial configuration of the NetBackup Virtual Appliance combined master 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 master server to communicate with an appliance media server
      4.  
        Performing the initial configuration on a NetBackup Virtual Appliance media 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
  7. 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
  8. 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
    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 authenticating Kerberos-NIS users
      1.  
        Adding a Kerberos-NIS authentication configuration on the NetBackup Virtual Appliance
      2.  
        Unconfiguring Kerberos-NIS user authentication on the NetBackup Virtual Appliance
    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
  9. 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
  10. 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 NetBackup and Access 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
  11. 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
    6.  
      About SSL usage
    7.  
      About the NetBackup Virtual Appliance intrusion detection system
    8.  
      About the NetBackup Virtual Appliance intrusion prevention system
    9.  
      Overriding the NetBackup Virtual Appliance intrusion prevention system policy
    10.  
      Re-enabling the NetBackup Virtual Appliance intrusion prevention system policy
    11.  
      Major components of the NetBackup Virtual Appliance OS
    12.  
      List of software packages included in the NetBackup Virtual Appliance OS
    13.  
      Disabled service accounts on the NetBackup Virtual Appliance
    14.  
      Vulnerability scanning of the NetBackup Virtual Appliance
    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
  12. 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
  13. Decommissioning and Reconfiguring
    1.  
      About decommissioning a NetBackup Virtual Appliance
    2.  
      Decommissioning a NetBackup Virtual Appliance with the media server role
  14. 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
    5. About NetBackup support utilities
      1.  
        NetBackup Domain Network Analyzer (NBDNA)
      2.  
        NetBackup Support Utility (NBSU)
    6.  
      Troubleshooting NetBackup Virtual Appliance initial deployment 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
  15. 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. 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
  16. Commands overview
    1.  
      About the NetBackup Virtual Appliance Shell Menu
    2.  
      Logging on 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
      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
  17. Appendix A. Appliance commands
    1.  
      Appliance > Master
    2.  
      Appliance > Media
    3.  
      Appliance > ShowDedupPassword
    4.  
      Appliance > Status
    5.  
      Appliance > Configure
  18. Appendix B. Manage commands
    1.  
      Manage > Software > Delete
    2.  
      Manage > Software > Download
    3.  
      Manage > Software > List
    4.  
      Manage > Software > LiveUpdateClients
    5.  
      Manage > Software > Install
    6.  
      Manage > Software > Share
    7.  
      Manage > Software > Readme
    8.  
      Manage > Software > Rollback
    9.  
      Manage > Software > Cancel
    10.  
      Manage > Software > DownloadProgress
    11.  
      Manage > Software > UpgradeStatus
    12.  
      Manage > Storage > Show
    13.  
      Manage > Storage > Add
    14.  
      Manage > Storage > Create
    15.  
      Manage > Storage > Delete
    16.  
      Manage > Storage > Edit
    17.  
      Manage > Storage > Monitor
    18.  
      Manage > Storage > Move
    19.  
      Manage > Storage > Remove
    20.  
      Manage > Storage > Resize
    21.  
      Manage > Storage > Scan
    22.  
      Manage > MountPoints > List
    23.  
      Manage > MountPoints > Mount
    24.  
      Manage > MountPoints > Unmount
    25.  
      Manage > License > Add
    26.  
      Manage > License > List
    27.  
      Manage > License > ListInfo
    28.  
      Manage > License > Remove
    29.  
      Manage > Certificates > Generate
    30.  
      Manage > Certificates > Delete
    31.  
      Manage > NetBackupCLI > Create
    32.  
      Manage > NetBackupCLI > Delete
    33.  
      Manage > NetBackupCLI > List
    34.  
      Manage > NetBackupCLI > PasswordExpiry
  19. 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
  20. 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 > NetStat
    10.  
      Network > NTPServer
    11.  
      Network > Ping
    12.  
      Network > SetProperty
    13.  
      Network > Show
    14.  
      Network > TimeZone
    15.  
      Network > TraceRoute
    16.  
      Network > Unconfigure
    17.  
      Network > WANOptimization
  21. Appendix E. Reports commands
    1.  
      Reports > Deduplication
    2.  
      Reports > Process
  22. Appendix F. Settings commands
    1.  
      Settings > Deduplication
    2.  
      Settings > LifeCycle
    3.  
      Settings > LiveUpdateServer
    4.  
      Settings > LogForwarding
    5.  
      Settings > NetBackup
    6.  
      Settings > Password
    7.  
      Settings > SystemLocale
    8.  
      Settings > Share
    9.  
      Settings > Notifications > LoginBanner
    10.  
      Settings > Security > Authentication > LDAP
    11.  
      Settings > Security > Authentication > ActiveDirectory
    12.  
      Settings > Security > Authentication > Kerberos
    13.  
      Settings > Security > Authentication > LocalUser
    14.  
      Settings > Security > Authorization
    15.  
      Settings > Sysctl
    16.  
      Settings > Alerts > CallHome
    17.  
      Settings > Alerts > SNMP
    18.  
      Settings > Alerts > Email
    19.  
      Settings > Alerts > Hardware
  23. Appendix G. Support commands
    1.  
      Support > Checkpoint
    2.  
      Support > DataCollect
    3.  
      Support > Disk
    4.  
      Support > Errors
    5.  
      Support > FactoryReset
    6.  
      Support > InfraServices
    7.  
      Support > iostat
    8.  
      Support > Logs
    9.  
      Support > Maintenance
    10.  
      Support > Messages
    11.  
      Support > NBDNA
    12.  
      Support > nbperfchk
    13.  
      Support > NBSU
    14.  
      Support > Processes
    15.  
      Support > Reboot
    16.  
      Support > Service
    17.  
      Support > Shutdown
    18.  
      Support > Storage SanityCheck
    19.  
      Support > Storage Reset
    20.  
      Support > Test

Performing the initial configuration on a NetBackup Virtual Appliance media server

This section describes how to perform the initial configuration on a NetBackup Virtual Appliance with the media server role.

You must complete the following tasks on the master server before you start the initial configuration. The following link provides specific instructions about how to accomplish the necessary tasks:

See Configuring a master server to communicate with an appliance media server.

  • Make sure that the master server and this media server have compatible software versions.

  • Add the host name of this media server to the SERVERS list on the master server that you plan to use with it.

  • If a firewall exists between the master server and this media server, open the appropriate ports on the master server.

  • Make sure that the date and time of this media server matches the date and time on the master server.

To perform the initial configuration of a NetBackup Virtual Appliance

  1. After you have deployed a new virtual appliance, log on to the NetBackup Virtual Appliance Shell Menu.

    The logon is admin, and the default password is P@ssw0rd.

  2. Use the following commands to change the admin and the maintenance account passwords from the known default password (P@ssw0rd):
    • Main > Settings > Password admin

    • Main > Settings > Password maintenance

    See Changing NetBackup Virtual Appliance user passwords.

  3. (Optional) Configure the appliance date and time.

    NTP is an optional during the initial configuration wizard. If you do not use an NTP server in your environment, make sure to configure the appliance date and time before the initial configuration.

    Caution:

    If the date and time of this media server matches the date and time of the master server, the initial configuration wizard fails.

    • Navigate to the Main > Network view.

    • Set the time zone by entering the following command:

      TimeZone Set

      Select the appropriate time zone from the displayed list.

    • Set the date and the time by entering the following command:

      Date Set Month Day HHMMSS Year

      Where Month is the name of the month.

      Where Day is the day of the month from 1 to 31.

      Where HHMMSS is the hour, minute, and seconds in a 24-hour format. The fields are separated by semi-colons, for example, HH:MM:SS.

      Where Year is the calendar year from 1970 through 2037.

  4. Use the following command to start the initial configuration:

    Main > Appliance > Configure

    A message about the Virtual Appliance Initial Configuration Wizard appears. This wizard will walk you through a two-step process to configure this appliance.

    The following prompt appears:

    >> Do you want to continue? [yes, no] (no)yes
    

    Type yes.

    The network configuration prompts appear in the following order:

    • Hostname

      Enter a short host name or a fully qualified domain name (FQDN) for this appliance. As a best practice, Veritas recommends that you use FQDN.

      Caution:

      After the initial deployment has completed successfully, the only way to change the host name is to perform a factory reset.

      Note:

      If you plan to configure Active Directory (AD) authentication on this appliance, the host name must be 15 characters or less. Otherwise, AD configuration can fail.

    • DNS domain name

      Enter a DNS domain name for this appliance.

    • IPv4 address

      Enter the IPv4 address to be used for this appliance.

    • Netmask

      Enter the netmask that corresponds to the IP address.

    • Gateway IP address

      Enter the IPv4 address of the gateway (network point) that acts as an entrance to another network.

    • DNS server 1 IP address

      Enter the IPv4 address of the primary DNS server for this appliance.

    • DNS server 2 IP address(Optional)

      Enter the IPv4 address of the secondary DNS server for this appliance.

  5. (Optional) The following prompt appears:

    The host name must be resolvable with a DNS or a HOSTS file for the initial configuration to be successful. Do you want to write the host name resolution information to the HOSTS file? [yes, no](no)

    Note:

    If the host name is not resolvable with a DNS or a HOSTS file during the initial configuration, the initial configuration wizard will fail.

    Type yes to use the HOSTS file to resolve the appliance host name. This ensures that the host name is resolvable when DNS is not available.

    Type no to use the DNS you entered.

  6. After the network configuration is completed, the wizard takes you to the second step for storage configuration.

    In the second step, specify the following:

    • NTP server (Optional)

      Enter the Network Time Protocol (NTP) server for this appliance.

    • Master server

      Enter the NetBackup master server name or IP address for this appliance. The master server can be a traditional (non-appliance) NetBackup master server or a NetBackup physical appliance.

      Note:

      If the host name of the master server is an FQDN, Veritas recommends that you use the FQDN to specify the master server for the media server.

      When you are prompted with the CA certificate details from the master server, review the details, and then enter yes if you want to continue. If a token is required to deploy the host ID-based certificate, obtain the token from the NetBackup administrator of the master server, and then enter the token.

      For more information about security certificates, refer to the NetBackup Security and Encryption Guide.

    • AdvancedDisk disk pool name

      Enter a name for the AdvancedDisk disk pool on the appliance.

    • AdvancedDisk storage unit name

      Enter a name for the AdvancedDisk storage unit on the appliance.

    • AdvancedDisk storage size

      Enter a size for the AdvancedDisk storage.

    • MSDP storage unit name

      Enter a name for the MSDP storage unit on the appliance.

    • MSDP disk pool name

      Enter a name for the MSDP disk pool on the appliance.

    • MSDP storage size

      Enter a size for the MSDP storage.

    • MSDP Catalog size

      Enter a size for the MDSP Catalog storage.

  7. Use the following command to verify that the automatic configuration completed successfully:

    Main > Appliance > Status

    The command output should contain a message similar to the following:

    Appliance Version is 3.1.
    
    Appliance is configured as media appliance.
    

    If the output does not show that the appliance is configured as a media appliance, you need to redeploy the appliance or perform other troubleshooting steps to fix the issue before you proceed to the next step. See Troubleshooting NetBackup Virtual Appliance initial deployment issues.

  8. Use the following command to set the time zone:

    Main > Network > TimeZone Set

    Select the appropriate time zone from the displayed list.

  9. Add a permanent license key before the evaluation key expires with the following command:

    Main > Manage > License > Add

    You can locate your permanent license key from the Licensing Portal on the MyVeritas website.

    Warning:

    The NetBackup Virtual Appliance has a specific license key, and if the correct key is not installed, the appliance services stop functioning after the evaluation key expires. Make sure that the permanent license key that you add is correct for NetBackup Virtual Appliance.

    See Managing license keys on the NetBackup Virtual Appliance.

  10. (Optional)

    If you want to configure an IPv6 address for the appliance, run the following command:

    Main > Network > IPv6 <IPAddress> <Prefix> InterfaceName

    Where <IPAddress> is the IPv6 address and <Prefix> is the prefix length.

    See About IPv4-IPv6-based network support.

  11. (Optional)

    If you want to an IPv6 DNS server on the appliance, run the following command:

    Main > Network > DNS Add NameServer <IPAddress>

    Where <IPAddress> is the IPv6 address of the additional DNS server. Only global-scope and unique-local IPv6 addresses are allowed.

    See Configuring DNS and host name mapping for the NetBackup Virtual Appliance.

After the appliance is configured and operational, you are ready to install NetBackup client software on the computers that you want to back up.

See the NetBackup Installation Guide for how to install NetBackup clients.