Veritas NetBackup™ Appliance Administrator's Guide

Last Published:
Product(s): Appliances (5.1.1)
Platform: NetBackup Appliance OS
  1. Overview
    1.  
      About NetBackup appliances
    2.  
      About the Primary Server role
    3.  
      About the media server role
    4. About accessing the NetBackup Appliance Web Console
      1.  
        Web browsers supported by the appliance
      2.  
        Disabling the Untrusted Connection page in Mozilla Firefox
    5. About the NetBackup Appliance Shell Menu
      1.  
        Logging in to the NetBackup Appliance Shell Menu
      2.  
        Limitations of the NetBackup Appliance Shell Menu
      3.  
        Command limitations on appliances that are not configured
    6. About appliance console components
      1.  
        About using the links on the title bar
      2.  
        Accessing and using help
      3.  
        About using Web browser bookmarks
      4.  
        Avoiding CSRF (Cross Site Request Forgery)
    7.  
      About the NetBackup Appliance Web Console login page
    8.  
      NetBackup appliance home page
    9.  
      Common tasks in NetBackup appliance
    10.  
      About the NetBackup appliance documentation
  2. Monitoring the NetBackup appliance
    1.  
      About monitoring the NetBackup appliance
    2. About hardware monitoring and alerts
      1. Monitor > Hardware options
        1.  
          Hardware components that are monitored
      2.  
        About Email notification from a NetBackup appliance
    3. About Symantec Data Center Security on the NetBackup appliance
      1.  
        Monitor > SDCS Events
      2.  
        Viewing SDCS audit log details
      3.  
        Filtering SDCS audit logs
      4.  
        Setting the SDCS audit log retention specification
      5. About Symantec Data Center Security Downloads
        1.  
          Downloading the IPS and IDS policies from the NetBackup appliance
      6.  
        Connecting to the SDCS server
      7.  
        Revert SDCS to unmanaged mode on a NetBackup appliance
  3. Managing a NetBackup appliance from the NetBackup Appliance Web Console
    1.  
      About the Manage views
    2. About storage configuration
      1.  
        Manage > Storage
      2.  
        Manage > Storage > Shares
      3.  
        About Universal shares migration
      4.  
        Checking partition details
      5.  
        Resizing a partition
      6.  
        Resize dialog
      7.  
        Troubleshooting resize-related issues
      8.  
        Moving a partition
      9.  
        Move dialog
      10.  
        Moving the MSDP partition from a base disk to an expansion disk for optimum performance
      11.  
        Scanning storage devices from the NetBackup Appliance Web Console
      12.  
        Adding the storage space from a newly available disk
      13.  
        Removing an existing storage disk
      14.  
        Monitoring the progress of storage manipulation tasks
      15.  
        Scanning storage devices using the NetBackup Appliance Shell Menu
      16. About Copilot functionality and Share management
        1.  
          About Optimized Shares and the Optimized Share Reserve
        2.  
          Creating a Share
        3.  
          Editing a Share
        4.  
          Deleting a Share
        5.  
          Moving a Share
        6.  
          Creating the Optimized Share Reserve
        7.  
          Deleting the Optimized Share Reserve
        8.  
          Viewing Share information from the NetBackup Appliance Shell Menu
        9.  
          NFS export options
      17. 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
      18.  
        About storage email alerts
    3. About appliance supported tape devices
      1.  
        Adding external robots to the NetBackup appliance
    4. About configuring Host parameters for your appliance
      1.  
        Manage > Host > Data Buffer options
      2.  
        Configuring data buffer parameters
      3.  
        Manage > Host > Lifecycle options
      4.  
        Configuring lifecycle parameters
      5. About configuring deduplication solutions
        1.  
          Adding the deduplication solution to a 52xx media appliance
        2.  
          Manage > Host > Deduplication
        3.  
          Configuring deduplication parameters
      6. About BMR integration
        1.  
          Manage > Host > Advanced options
        2.  
          Enabling BMR from the NetBackup Appliance Web Console
      7. Manage > Host > IPMI options
        1.  
          Resetting the IPMI
    5. Manage > Appliance Restore
      1. About creating an appliance checkpoint
        1.  
          Creating an appliance checkpoint
        2.  
          Checkpoint creation status
        3.  
          Creating an appliance checkpoint from the appliance shell menu
      2. About rollback to a checkpoint
        1.  
          About appliance rollback
        2.  
          About appliance rollback validation
        3.  
          Rollback to an appliance checkpoint from the NetBackup Appliance Web Console
        4.  
          About checkpoint rollback status
        5.  
          Rollback to an appliance checkpoint from the appliance shell menu
      3. About NetBackup appliance factory reset
        1.  
          Factory reset best practices
        2.  
          Starting a factory reset from the appliance shell menu
    6. Manage > License
      1.  
        Managing license keys on the NetBackup appliance
      2.  
        Adding a permanent license key if an evaluation license key expires
      3.  
        Generate and install an appliance license
    7. About the Migration Utility
      1.  
        Manage > Migration Utility > Configure Migration
      2.  
        Manage > Migration Utility > Migration Status
      3.  
        Configuring a new migration task
      4.  
        Viewing the migration task status
      5.  
        Best practices for migration utility
    8. Software release updates for NetBackup Appliances
      1.  
        Manage > Software Updates
      2.  
        Installing a NetBackup appliance software update using the NetBackup Appliance Shell Menu
      3.  
        Appliance servers to upgrade
      4.  
        Installing NetBackup PSF add-ons using the NetBackup Appliance Shell Menu
    9. About installing EEBs
      1.  
        Installing an EEB
    10. About installing NetBackup Administration Console and client software
      1.  
        Installing NetBackup client software through an NFS share
      2.  
        Downloading NetBackup client packages to a client from a NetBackup appliance
    11. Manage > Additional Servers
      1.  
        Managing additional servers to the appliance
    12.  
      Manage > File Manager
    13. Manage > High Availability
      1.  
        Monitoring a high availability configuration from the NetBackup Appliance Web Console
  4. Managing NetBackup appliance using the NetBackup Appliance Shell Menu
    1.  
      Expanding the bandwidth on the NetBackup appliance
    2.  
      About configuring the maximum transmission unit size
    3. About OpenStorage plugin installation
      1.  
        Installing the OpenStorage plugin
      2.  
        Uninstalling the OpenStorage plugin
    4. About mounting a remote NFS
      1.  
        Mounting a remote NFS drive
      2.  
        Unmounting an NFS drive
    5. About running NetBackup commands from the appliance
      1. About NetBackup administrator capabilities
        1.  
          Running NetBackup commands from the NetBackup appliance
        2. Creating a NetBackup touch file from the NetBackup appliance
          1.  
            Loading the NetBackup notify scripts
        3.  
          About NetBackup operating system commands
        4.  
          Best practices for running NetBackup commands from the NetBackup appliance
        5.  
          Known limitations of running NetBackup commands from the NetBackup appliance
      2. Creating NetBackup administrator user accounts
        1.  
          Logging on as a NetBackup administrator
        2.  
          Managing NetBackup administrator user account passwords
        3.  
          Auditing NetBackup administrator accounts
      3.  
        Deleting NetBackup administrator user accounts
      4.  
        Viewing NetBackup administrator user accounts
    6. About Auto Image Replication between appliances
      1. About Auto Image Replication between NetBackup appliances
        1.  
          Prerequisites for Auto Image Replication
        2. Configuring a replication target
          1.  
            Determining the appliance deduplication password
      2.  
        About Auto Image Replication between NetBackup appliances and deduplication appliances
    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
    8. About high availability configuration
      1.  
        Checking the status
      2.  
        Getting the asset tag
      3.  
        Switching the services over
      4.  
        Removing a node
    9. About data erasure
      1.  
        Configuring the data erasure
      2.  
        Viewing the data erasure status
      3.  
        Aborting the data erasure
  5. Understanding the NetBackup appliance settings
    1.  
      About modifying the appliance settings
    2. Settings > Notifications
      1. Settings > Notifications > Alert Configuration
        1.  
          Configuring alert settings
        2. About SNMP
          1.  
            About the Management Information Base (MIB)
        3. About Call Home
          1.  
            Enabling and disabling Call Home from the appliance shell menu
          2.  
            About AutoUpdate for Upgrade Readiness Check
          3.  
            Configuring a Call Home proxy server from the NetBackup Appliance Shell Menu
          4.  
            Understanding the Call Home workflow
          5.  
            About the Product Improvement Program
      2. Settings > Notifications > Login Banner
        1.  
          Creating the appliance login banner
        2.  
          Removing the appliance login banner
      3.  
        About AutoSupport
    3. Settings > Network
      1.  
        VLAN configuration for NetBackup Appliances
      2. Settings > Network > Network Settings
        1. About WAN Optimization
          1.  
            How to enable WAN optimization for a network interface port or a network interface port bond
          2.  
            How to disable WAN optimization for a network interface port or a network bond
          3.  
            Viewing the WAN optimization status
        2.  
          Network and VLAN configuration guidelines
        3.  
          Creating a bond
        4.  
          Tagging VLAN
        5.  
          Adding static route
      3. Settings > Network > Fibre Transport
        1.  
          About the HBA port mode configuration table
        2.  
          Configuring Fibre Transport settings
        3.  
          Configuring Fibre Transport to other NetBackup appliances
      4. Settings > Network > Host
        1.  
          Changing DNS and Host Name Resolution (non-DNS) configuration settings
      5.  
        About IPv4-IPv6-based network support
    4.  
      Settings > Date and Time
    5. Settings > Authentication
      1. About configuring user authentication
        1.  
          Generic user authentication guidelines
      2. About authorizing NetBackup appliance users
        1.  
          NetBackup appliance user role privileges
      3.  
        Settings > Authentication
      4. Settings > Authentication > LDAP
        1.  
          Adding an LDAP server configuration
        2.  
          Importing an LDAP server configuration
        3.  
          Setting the SSL certification
        4.  
          Exporting an LDAP configuration
        5.  
          Unconfiguring LDAP user authentication
        6.  
          Enabling the LDAP server configuration
        7.  
          Disabling the LDAP server configuration
        8.  
          Deleting LDAP configuration parameters
        9.  
          Adding LDAP configuration parameters
        10.  
          Adding an LDAP attribute mapping
        11.  
          Deleting an LDAP attribute mapping
      5. Settings > Authentication > Active Directory
        1.  
          Adding an Active Directory server configuration
        2.  
          Unconfiguring the Active Directory user authentication
      6. Settings > Authentication > User Management
        1.  
          Adding appliance users
        2.  
          Deleting appliance users
        3.  
          Adding appliance user groups
        4.  
          Deleting appliance user groups
        5.  
          Granting roles to users and user groups
        6.  
          Revoking roles from users and user groups
        7.  
          Synchronizing the user groups
    6.  
      Settings > Password Management
  6. Troubleshooting
    1.  
      Viewing log files using the Support command
    2.  
      Where to find NetBackup appliance log files using the Browse command
    3. About disaster recovery
      1.  
        Recovering a NetBackup appliance primary server using NetBackup catalog restore
    4.  
      Gathering device logs on a NetBackup appliance
  7. Deduplication pool catalog backup and recovery
    1.  
      Deduplication pool catalog backup policy
    2.  
      Automatic configuration of the deduplication pool catalog backup policy
    3.  
      Manually configuring the deduplication pool catalog backup policy
    4.  
      Manually updating the deduplication pool catalog backup policy
    5.  
      Recovering the deduplication pool catalog
  8.  
    Index

About the NetBackup Appliance Web Console login page

The login page provides the fields to enter your login credentials and also includes the following links and information:

Section

Description

Product Information

This section provides the following links where you can access NetBackup appliance information and documentation:

  • What is new in Version 5.1.1?

  • Release Notes

  • Appliance Documentation Set

  • View Compatibility Lists

  • View Veritas Services and Operations Readiness Tools

Download Packages

This section indicates whether there are NetBackup client packages stored on the appliance that can be installed on clients. Client packages also include the NetBackup Administration Console. You can select to install all listed client packages or select a specific package to install.

Note the following important points about downloading client packages:

  • If you want to store clients on the appliance, a separate client package is available to download.

    If a client package does not exist on the appliance, the following message appears when you select to download it:

    No packages found.

    The client packages are posted on the Veritas Services and Operations Readiness Tools (SORT) site (https://www.veritas.com/support/en_US/downloads). Client versions that are stored on the appliance do not have to match the NetBackup version that is currently installed on the appliance.

  • To install the NetBackup Administration Console client, you must first download the Windows client package. This client is required to access the NetBackup Administration Console.

  • You can install the vCentre Plug-in to use vSphere Client to monitor virtual machine backups and recover a virtual machine from a backup.

Browser Recommendation

This section verifies and displays a confirmation if the NetBackup Appliance Web Console supports your browser.

This interface works best with Google Chrome 96.0 and later, Microsoft Edge 96.0 and later, and Mozilla Firefox 95.0.2 and later.

Notifications

This section provides notifications or alerts about the current appliance services and components, such as Call Home functionality.

Logging into the NetBackup Appliance Web Console

There are two options for logging in to the Appliance Web Console

  • Username/Password - You can login with a valid username/password.

  • Smart Card Login - If the appliance has been configured and enabled for smart card login, you can log in using smart card. Ensure that you have configured the smart card. For details, see the NetBackup Appliance Security Guide.

To log on to the NetBackup Appliance Web Console

  1. Enter the following URL in the web browser:

    https://ip|hostname/appliance

    In the URL use the IP or hostname of your appliance. The hostname is the label that is assigned to your appliance to identify the device in your network.

    Note:

    If you use Internet Explorer 11.0 or higher to access the NetBackup Appliance Web Console, security certificate warnings appear when you access a pop-up menu. Select Continue to this website (not recommended) to log into the appliance. Once you select this option, the security certificate warnings do not appear on the pop-up menus.

    The browser displays the NetBackup Appliance Web Console login page.

    Note:

    If the initial configuration for an appliance is in progress, do not try to run a new instance of the NetBackup Appliance Web Console. You cannot log on to the appliance thus causing an unsuccessful login.

  2. To log on with user name and password:
    • Enter your user name in the Username field. The default user name is admin.

    • Enter your password in the Password field. The default user password is P@ssw0rd, where 0 is the number zero.

    • Click on Log in with username and password, or press the return button of the keyboard.

      Note:

      If you log on as an AMS user on the login page on the AMS, you are redirected to the Appliance Management Console. If you log on as an Administrator, you are directed to the NetBackup Appliance Web Console.

      Note:

      After the new appliance is configured and you have been registered as a user, the user name and password are sent to your registered email ID.

  3. To log in with a smart card:
    • Ensure that the appliance has been configured and enabled for smart card authentication. Make sure that your smart card is connected to your computer.

    • You may be prompted to select a certificate. A pop-up dialog may appear and show certificates that are cached in your browser. Select the certificate you want to use for smart card authentication. You can click Cancel if you do not want to log in with a smart card.

      Note:

      You can use your username and password if you select a certificate.

    • If you selected a certificate, click on the Log in with Smart Card button. It may take up to 30 seconds to complete the login.

    The browser remembers your selection. If you selected a certificate, you can log in again with that same certificate. If you did not select a certificate, you can log in with your user name and password. If you want to change your authentication choice to use a certificate or a different certificate, it is necessary to terminate the browser and start it again. Refer to your browser's documentation.

  4. Select your preferred language from the Language drop-down list. Based on the language you select, the labels on the NetBackup Appliance Web Console are displayed in that language.

    English, Japanese, and Simplified Chinese web user interfaces are available for this release. Veritas recommends that the language that you select in the NetBackup Appliance Web Console is the same as your system locale. If the language that you want to select in the NetBackup Appliance Web Console is not the same as your system locale, you should first change the locale in the following manner:

    To change the system locale

    Details

    1. Browse the locales on your system

    Log on to the shell menu and run Settings> SystemLocale List language_code.

    Example: Run Settings> SystemLocale List ja to browse the available locales in Japanese language.

    The following locales can be displayed:

    • ja_JP

    • ja_JP.UTF-8

    • ja_JP.eucJP

    • ja_JP.eucjp

    • ja_JP.ujis

    • ja_JP.utf8

    2. Set the preferred locale along with its format

    Run Settings > SystemLocale Set language_code command.

    Example: Run Settings> SystemLocale Set ja_JP.UTF-8 to set the ja_JP.UTF-8 locale to the Appliance.

    Note:

    Selecting a language in the NetBackup Appliance Web Console that is different from the language of system locale may result in a mixing up of the two languages in the NetBackup Appliance Web Console.

  5. Click Login.

    The appliance displays either of the following:

    • Initial Configuration Setup - When you log into the appliance for the first time you are asked to perform the initial configuration and set up your appliance. For more information, refer to the NetBackup Initial Configuration Guide.

      Note:

      If the NetBackup license key on the appliance has expired after an ISO install, continue with the initial configuration. A temporary license key is generated which is valid for 30 days. Veritas recommends that you add a permanent license key before the temporary license key has expired.

    • NetBackup Appliance home page - After you have successfully configured your appliance, the Home page is displayed. More information about the Home page is available.

      See NetBackup appliance home page.

Note:

On some server-class systems, an enhanced security configuration can cause some pages to not display properly in Internet Explorer. If you encounter this issue, add to the NetBackup Appliance Web Console Trusted-sites list and lower the security setting. To resolve this issue, open Internet Explorer and select Tools > Internet Options > Security to configure the Trusted-sites list and lower the security level.

Table: Troubleshooting login failures lists the reasons due to which login failure can occur.

Table: Troubleshooting login failures

Error message

Reasons

Troubleshooting

User authentication 
failed. Please enter valid 
user name and password. 
If problem persists 
contact your System
Administrator. 
  • If the provided user name and password are incorrect.

  • If the authentication server is not responsive.

  • Verify that you have entered the correct user name and password.

  • Contact your System Administrator in case the error appears again.

Login was
unsuccessful, 
click ? for details.
  • If you try to log onto a new instance of the NetBackup Appliance Web Console, while the initial configuration is in progress on that appliance.

  • If an unexpected error has occurred.

  • Ensure that you do not log onto a single appliance using multiple instances of the NetBackup Appliance Web Console.

  • View the UI logs to view the exceptions stack and trace all programmatic statements. You can find the UI logs at the following location:

    /log/webgui/webserver

The connection 
has timed out

If the web server is not responsive the login page is not displayed.

Contact your system administrator for more assistance.

Unable to connect

If the web server has been shut down.

Contact your system administrator for more assistance.