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

Name

Main > Settings > Alerts > CallHome — Manage CallHome settings.

SYNOPSIS

CallHome Disable

CallHome Enable

CallHome NBInventory Disable

CallHome NBInventory Enable

CallHome Proxy Add name port [username] [passwd]

CallHome Proxy Disable

CallHome Proxy DisableTunnel

CallHome Proxy Enable

CallHome Proxy EnableTunnel

CallHome Registration Show

CallHome Show

CallHome Test

DESCRIPTION

You can use the CallHome Enable and CallHome Disable commands to instruct the appliance whether or not to send the appliance health status to Veritas Technical Support. Veritas uses the health status to automatically open Support cases to resolve problems faster. The functionality is enabled by default.

You can use the CallHome NBInventory Enable and CallHome NBInventory Disable commands to instruct the appliance whether or not to send installation deployment and product usage information to Veritas for use in the Product Improvement Program. The functionality is enabled by default.

In addition, you can use the CallHome Proxy command to specify proxy server information. If your appliance environment has a proxy server between the environment and external Internet access, you must enable the proxy settings on the appliance. The proxy settings include both a proxy server and a port. The proxy server must accept https connections from the Veritas Call Home server. This feature is disabled by default. To use this feature, the proxy server on your site must be able to handle https requests.

OPTIONS

CallHome Disable

Disable the Call Home feature. Disabling Call Home also disables the Product Improvement Program.

CallHome Enable

Enable the Call Home feature. Enabling the feature lets you send the health status of the appliance to Veritas Technical Support. In case of any failure, Veritas Technical Support uses this information to resolve the issue.

CallHome NBInventory Disable

Disable the Product Improvement Program. Disabling the program prevents Veritas from capturing installation deployment and product usage information from your appliance.

CallHome NBInventory Enable

Enable the Product Improvement Program. Enabling the program allows Veritas to capture installation deployment and product usage information. The information that Veritas receives becomes part of a continuous quality improvement program that helps Veritas understand how customers configure, deploy, and use the product.

You cannot enable the Product Improvement Program if Call Home is disabled.

CallHome Proxy Add name port [username] [passwd]

Add a proxy server to the appliance. Here, name is the name of the proxy server that is either the TCP/IP address or the fully qualified name of the proxy server. Port is the proxy port number on the proxy server. The [username] is the name of the user for the proxy server authentication and [passwd] is the password for the proxy server authentication.

If you do not add "http(s):" at the start of the server name then by default http:// is added to it.

CallHome Proxy Disable

Disable the use of the proxy server settings.

CallHome Proxy DisableTunnel

Disable SSL tunneling for the proxy server.

CallHome Proxy Enable

Enable the use of the proxy server settings.

CallHome Proxy EnableTunnel

Enable SSL tunneling for the proxy server.

CallHome Registration Show

View registration details for the appliance and the link to the MyAppliance portal to register and edit contact information.

Note:

The NetBackup Virtual Appliance is not currently supported for registration. Visit the MyAppliance portal to see the latest information about supported appliance models.

CallHome Show

View the Call Home and proxy settings that are currently configured for your appliance.

CallHome Test

Validate whether or not the appliance is able to send Call Home information to Veritas Technical Support.

EXAMPLES

The following example demonstrates how to add a proxy server to your appliance and the confirmation message that is returned.

Settings> Alerts> CallHome Proxy Add abc123.com 1234

Successfully set proxy server

The following example demonstrates how to disable the Call Home proxy server and the confirmation message that is returned.

Settings> Alerts> CallHome Proxy Disable

Successfully disabled proxy

The following example demonstrates how to disable SSL tunneling for the Call Home proxy server and the confirmation message that is returned.

Settings>  Alerts> CallHome Proxy DisableTunnel
- [Info] Successfully added proxy tunnel flag
Successfully set proxy tunneling

The following example demonstrates how to add a proxy server to your appliance and the confirmation message that is returned.

Settings> Alerts> CallHome Proxy Enable

Proxy enabled successfully

The following example demonstrates how to enable SSL tunneling for the Call Home proxy server and the confirmation message that is returned.

Settings>  Alerts> CallHome Proxy EnableTunnel
- [Info] Successfully added proxy tunnel flag
Successfully set proxy tunneling

        

Note:

NBInventory refers to the NetBackup Product Improvement Program