Veritas NetBackup™ Virtual Appliance Documentation

Last Published:
Product(s): Appliances (3.0)
  1. Getting started
    1.  
      NetBackup Virtual Appliance product description
    2.  
      About the NetBackup Virtual Appliance combined master and media server role
    3.  
      About the NetBackup Virtual Appliance documentation
    4.  
      Known limitations of the NetBackup Virtual Appliance 3.0 release
    5.  
      Operational Notes for the NetBackup Virtual Appliance 3.0 release
  2. Deployment and initial configuration
    1.  
      NetBackup Virtual Appliance deployment guidelines
    2.  
      NetBackup Virtual Appliance initial deployment checklist
    3.  
      Deploying a NetBackup Virtual Appliance
  3. Post initial configuration procedures
    1. About installing NetBackup Administration Console and client software
      1.  
        Installing NetBackup client software through CIFS and NFS shares
      2.  
        Downloading NetBackup client packages to a client from a NetBackup Virtual Appliance
      3.  
        Downloading the NetBackup Administration Console to a Windows computer from a NetBackup Virtual Appliance
  4. Configuring
    1.  
      About modifying the NetBackup Virtual Appliance settings
    2.  
      Managing license keys on the NetBackup Virtual Appliance
    3.  
      Adding a permanent license key if an evaluation license key expires
    4. 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
    5.  
      Configuring DNS and host name mapping for the NetBackup Virtual Appliance
    6.  
      Setting the date and time on a NetBackup Virtual Appliance
    7.  
      Configuring static routes on the NetBackup Virtual Appliance
    8.  
      About IPv4-IPv6-based network support
    9.  
      Network settings for the NetBackup Virtual Appliance
  5. Alerting
    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 Virtual 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
  6. Using
    1. About 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.  
      8.  
        Removing an existing storage disk
    2.  
      Common tasks in NetBackup Virtual Appliance
    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
  7. 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 with the DataCollect command
  8. 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
  9. 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.  
    5.  
      About data encryption
    6.  
      About SSL certification
    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
  10. 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
  11. Section I. Commands
    1. 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
    2. Appendix A. Appliance commands
      1.  
        Appliance > Master
      2.  
        Appliance > ShowDedupPassword
      3.  
        Appliance > Status
    3. Appendix B. 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
    4. Appendix C. Support commands
      1.  
        Support > InfraServices
      2.  
        Support > iostat
      3.  
        Support > Logs
      4.  
        Support > Maintenance
      5.  
        Support > Messages
      6.  
        Support > NBDNA
      7.  
        Support > nbperfchk
      8.  
        Support > NBSU
      9.  
        Support > Processes
      10.  
        Support > Reboot
      11.  
        Support > Service
      12.  
        Support > Shutdown
      13.  
        Support > Storage SanityCheck
      14.  
        Support > DataCollect
      15.  
        Support > Disk
      16.  
        Support > Errors
      17.  
        Support > Test
    5. Appendix D. 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
    6. Appendix E. Settings commands
      1.  
        Settings > Deduplication
      2.  
        Settings > LifeCycle
      3.  
        Settings > LiveUpdateServer
      4.  
        Settings > NetBackup
      5.  
        Settings > Password
      6.  
        Settings > SystemLocale
      7.  
        Settings > Share
      8.  
        Settings > Notifications > LoginBanner
      9.  
        Settings > Security > Authentication > LDAP
      10.  
        Settings > Security > Authentication > ActiveDirectory
      11.  
        Settings > Security > Authentication > Kerberos
      12.  
        Settings > Security > Authentication > LocalUser
      13.  
        Settings > Security > Authorization
      14.  
        Settings > Sysctl
      15.  
        Settings > Alerts > CallHome
      16.  
        Settings > Alerts > SNMP
      17.  
        Settings > Alerts > Email
      18.  
        Settings > Alerts > Hardware
    7. Appendix F. Reports commands
      1.  
        Reports > Deduplication
      2.  
        Reports > Process
    8. Appendix G. 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 > Monitor
      15.  
        Manage > Storage > Move
      16.  
        Manage > Storage > Remove
      17.  
        Manage > Storage > Resize
      18.  
        Manage > Storage > Scan
      19.  
        Manage > MountPoints > List
      20.  
        Manage > MountPoints > Mount
      21.  
        Manage > MountPoints > Unmount
      22.  
        Manage > License > Add
      23.  
        Manage > License > List
      24.  
        Manage > License > ListInfo
      25.  
        Manage > License > Remove
      26.  
        Manage > Certificates > Generate
      27.  
        Manage > Certificates > Delete
      28.  
        Manage > NetBackupCLI > Create
      29.  
        Manage > NetBackupCLI > Delete
      30.  
        Manage > NetBackupCLI > List
      31.  
        Manage > NetBackupCLI > PasswordExpiry

Deploying a NetBackup Virtual Appliance

The following procedures describe how to deploy and configure a NetBackup Virtual Appliance from the VMware vSphere Web Client, the NetBackup Virtual Appliance Shell Menu, and the NetBackup Administration Console.

Note:

To ensure a successful deployment, make sure that you meet all of the deployment guidelines before you begin these procedures.

See NetBackup Virtual Appliance deployment guidelines.

To deploy a NetBackup Virtual Appliance

  1. Download the NetBackup Virtual Appliance product file from the Licensing Portal on the MyVeritas website and save it to your local computer.

    For more information on the Licensing Portal, see the MyVeritas Licensing Portal Guide on the Support website.

  2. Review the initial deployment checklist to make sure that you have all of the necessary information to complete the deployment procedure. Veritas recommends that you print this file and fill it out for use as you perform the deployment. Then store it in a secure location for future reference.

    See NetBackup Virtual Appliance initial deployment checklist.

  3. Using the VMware vSphere Web Client, log on to the vCenter Server where you want to deploy your appliance.

    Note:

    Your vCenter Server user account must have at least the minimum privileges required to deploy an OVF template. Refer to the VMware documentation for more information.

  4. Select File > Deploy OVF Template to start the deployment wizard.
  5. On the Source page of the deployment wizard, click Browse to navigate to the NetBackup Virtual Appliance product file. If you split the file when you downloaded it, make sure that all of the pieces are saved in the same folder and navigate to that folder.

    Verify the path and click Next.

  6. Review the OVF Template Details page and click Next.
  7. On the End User License Agreement page, read through the EULA and click Accept and then Next.
  8. Enter the destination details as follows:
    • Name: Enter a unique name for your appliance.

    • Inventory Location: Select the folder or the data center where you want the appliance to be located. The options are autopopulated based on what is available to that vCenter Server.

    Click Next.

  9. Select the resource location where you want the deployed template to run.

    Click Next.

  10. Select the destination storage where you want to store the appliance files.

    Click Next.

    Caution:

    If you select a storage cluster, make sure that one of the datastores in the cluster has enough storage space for the entire appliance. If none of the individual datastores in the cluster has enough space, the deployment fails.

  11. Select Thick Provision Lazy Zeroed as the provisioning format for the appliance disks. For more information on provisioning, refer to the VMware documentation.

    Click Next.

  12. On the Properties page, fill in the following information:

    Network configuration:

    • Host name

      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:

      The host name can only be set during initial deployment. After the initial deployment has completed successfully, the only way to change the host name is to redeploy the appliance.

      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.

    • IP address

      Enter the IPv4 address to be used for this appliance.

      Note:

      IPv6 addresses are not supported during the initial deployment process. However, you can configure an IPv6 address after deployment through the NetBackup Virtual Appliance Shell Menu.

      See “To complete the initial configuration of a NetBackup Virtual Appliance”.

    • Netmask

      Enter the netmask that corresponds to the IP address.

    • Gateway

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

    • DNS server

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

      Note:

      You can only add one DNS server during initial deployment. If you want to add additional servers, you can do so after deployment through the NetBackup Virtual Appliance Shell Menu.

      See “To complete the initial configuration of a NetBackup Virtual Appliance”.

    Storage configuration:

    • 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.

    • MSDP disk pool name

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

    • MSDP storage unit name

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

    Caution:

    You cannot change the storage configuration after initial deployment. After the initial deployment has completed successfully, the only way to change the storage configuration is to redeploy the appliance.

  13. When you have filled in all of the required information, click Next.
  14. Read through and verify the deployment options that you entered. If everything is correct, click Finish to deploy the appliance.

    The amount of time that it takes for the deployment process to complete varies depending on your network connection. After the deployment, NetBackup Virtual Appliance automatically configures the network, the role, and the storage. This configuration process can take up to 30 minutes to complete.

  15. Once the deployment and the automatic configuration are complete, proceed to the remaining configuration steps in the following procedure.

To complete the initial configuration of a NetBackup Virtual Appliance

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

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

    Note:

    You cannot log on to the NetBackup Virtual Appliance Shell Menu until the automatic configuration is complete. If you attempt to log on before then, a message appears to let you know that the configuration is still in progress. If you see this message, wait a few minutes and try again.

  2. 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.0.
    
    Appliance is configured as master appliance.
    

    If the output does not show that the appliance is configured as a master 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.

  3. 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.

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

    Main > Network > TimeZone Set

    Select the appropriate time zone from the displayed list.

  5. Use the following command to add a Network Time Protocol (NTP) server:

    Main > Network > NTPServer Add <Server>

    Where <Server> is the name of the NTPServer.

  6. 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.

  7. (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.

    [InterfaceName] is an optional parameter for a comma-separated list of interface names. If an interface name is not provided, the command searches for an interface and configures it.

    See About IPv4-IPv6-based network support.

  8. (Optional)

    If you want to add more than one DNS server on the appliance, run the following command:

    Main > Network > DNS Add NameServer <IPAddress>

    Where <IPAddress> is the IP address of the additional DNS server.

    The address can be either IPv4 or IPv6. Only global-scope and unique-local IPv6 addresses are allowed.

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

  9. Log on to the appliance from the NetBackup Administration Console and activate the NetBackup catalog backup policy.

    By default, the appliance creates an inactive backup policy that uses a Storage Lifecycle Policy (SLP) to protect the NetBackup catalog. The SLP backs up the data to AdvancedDisk and then duplicates it to MSDP. You are then able to use Auto Image Replication to save your catalog backup off site. Veritas recommends that you use this replication-based strategy for disaster recovery (DR) due to the combined master and media server role of the appliance.

    To activate the policy, navigate to the NetBackup Management > Policies tab in the Administration Console, right-click on the nbu-catalog policy, and select Activate.

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 About installing NetBackup Administration Console and client software.