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

Settings > Notifications > Alert Configuration

The Settings > Notifications > Alert Configuration page on the NetBackup Appliance Web Console provides you with one location from where you can enable SNMP, SMTP, and Call Home alert notifications. The page is divided into three sections. Each section is dedicated to provide details for SNMP, SMTP, and Call Home alert notifications.

Under Alert Configuration is the Notification Interval field. You must enter the time interval in minutes between two subsequent notifications for the SNMP and the SMTP configurations. The time interval should be in multiples of 15 and it should not be zero.

Configuring SNMP

Table: SNMP Server Configuration settings lists the fields from the SNMP (Simple Network Management Protocol) section of the NetBackup Appliance Web Console.

Table: SNMP Server Configuration settings

Fields

Description

Notification Interval

Enter the interval for the server to upload alerts to the Veritas Call Home server. Entries must be in increments of 15 minutes.

SNMP Server Configuration

Select one of the following options:

  • SNMP V2

  • SNMP V3

  • None (default)

SNMP Server

Enter the SNMP Server host name. You can enter a host name or an IP address to define this computer. The IP address can be an IPv4 or IPv6 address. Only global-scope and unique-local IPv6 addresses are allowed.

Notification of the alerts or traps that are generated in the appliance are sent to this SNMP manager.

Note:

The NetBackup appliance supports all the SNMP servers in the market. However, the ManageEngine™ SNMP server and the HP OpenView SNMP server are tested and certified for version 2.6.

See About IPv4-IPv6-based network support.

SNMP Port

Enter the SNMP Server port number. The default port is 162.

Note:

Your firewall must allow access from the appliance to the SNMP server through this port.

SNMP Community

This field is required for SNMP V2 and is optional for SNMP V3.

Enter the community to which the alerts or traps are sent. For example, Backup Reporting Department.

You can enter a value that you configured on your SNMP server. For example, your company name. If you do not expect to disclose your company name, Veritas provides the system-defined values including: admin_group, public, and private. The default is public.

SNMP Username (SNMP V3 only)

Enter an SNMP user name as follows:

  • Enter up to 32 characters maximum.

  • May include uppercase letters, lowercase letters, numbers, and the following punctuation marks: period, hyphen/dash, underscore.

  • Spaces, commas, and special characters are not allowed.

Authentication Protocol (SNMP V3 only)

Configure as follows to set the security level:

  • None (default)

    Sets the security level to no authentication and no privileges (authentication is disabled). Password and encryption fields are greyed out and not required.

  • SHA256 or SHA512

    Sets the security level for authentication. An SNMP password is required.

SNMP Password/Confirm SNMP Password (SNMP V3 only)

Enter a password for the SNMP user as follows:

  • Must have 8 or more characters.

  • May include uppercase letters, lowercase letters, numbers, and the following punctuation marks: period, hyphen/dash, underscore.

  • Spaces, commas, and special characters are not allowed.

Enter the same password in the Confirm SNMP Password field.

Encryption Protocol (SNMP V3 only)

Configure as follows to set the encryption policy:

  • None (default)

    Encryption policy is not used or enforced. Passphrase fields are greyed out and not required.

  • AES128 AES192 AES256 AES512

    Select one of these options to enforce the associated encryption policy. An Encryption Passphrase is required.

Encryption Passphrase/Confirm Encryption Passphrase (SNMP V3 only)

If you set the Encryption Protocol to use an encryption policy, enter a passphrase for the SNMP user as follows:

  • Must have 8 or more characters.

  • May include uppercase letters, lowercase letters, numbers, and the following punctuation marks: period, hyphen/dash, underscore.

  • Spaces, commas, and special characters are not allowed.

Enter the same passphrase in the Confirm Encryption Passphrase field.

The following describes summaries of the required fields for specific SNMP configuration scenarios:

  • SNMP V2

    SNMP Server

    SNMP Port

    SNMP Community

    All other fields are not required.

  • SNMP V3 - no authentication/no privileges

    SNMP Server

    SNMP Port

    SNMP Community (optional)

    Authentication Protocol - None

    All other fields are not required.

  • SNMP V3 - authentication/no privileges

    SNMP Server

    SNMP Port

    SNMP Community (optional)

    Authentication Protocol (SHA256, SHA512)

    SNMP Password/Confirm SNMP Password

    All other fields are not required.

  • SNMP v3 - authentication/privileges

    SNMP Server

    SNMP Port

    SNMP Community (optional)

    Authentication Protocol (SHA256, SHA512)

    SNMP Password/Confirm SNMP Password

    Encryption Protocol (AES128, AES192, AES256, AES512)

    Encryption Passphrase/Confirm Encryption Passphrase

The SNMP MIB file serves as a data dictionary that is used to assemble and interpret SNMP messages. If you configure SNMP, you must import the MIB file into the monitoring software so that the software can interpret the SNMP traps. You can view the details of the MIB file from the SNMP Server Configuration pane. To view details about the SNMP MIB file, click View SNMP MIB file. An SNMP MIB file opens.

You can also use the following command in the appliance shell menu to configure the SNMP server:

Main_Menu > Settings > Alerts > SNMP Set Server [Community] [Port]

For example: Main_Menu > Settings > Alerts > SNMP Set Server 10.80.97.223

For information on how to send a test SNMP trap after configuration, see the following technical article on the Veritas Support website:

https://www.veritas.com/content/support/en_US/article.100009877

Configuring SMTP

The SMTP mail server protocol is used for outgoing email. You can configure SMTP from the NetBackup Appliance Web Console (Settings > Alert Configuration > SMTP Server Configuration).

You can also use the following command in the appliance shell menu to configure the SMTP server and add a new email account:

Main_Menu > Settings > Alerts > Email SMTP Add Server [Account] [Password], where Server is the host name of the target SMTP server that is used to send emails. [Account] and [Password] are optional parameters to identify the name of the account and the account password if authentication is required.

For more information, see the related documentation of your appliance.

Starting with release 3.1.2, you can configure the SMTP port and set encryption.

You can use the following commands in the appliance shell menu to configure encrypted communication with the SMTP server:

  • Main_Menu > Settings > Alerts > Email SMTP ConfigurePort [25] [465] [587] [custom]

  • Main_Menu > Settings > Alerts > Email SMTP Encryption [Disable] [Enable]

You can use the following command to view the SMTP port number and encryption configuration details.

Main_Menu > Settings > Alerts > Email Show

Table: SMTP server configuration settings lists the fields from the SMTP section of the NetBackup Appliance Web Console.

Table: SMTP server configuration settings

Fields

Description

SMTP Server

Enter the SMTP (Simple Mail Transfer Protocol) Server host name. Notifications of the alerts that are generated in Appliance are sent using this SMTP server. The IP address can be an IPv4 or IPv6 address. Only global-scope and unique-local IPv6 addresses are allowed.

See About IPv4-IPv6-based network support.

SMTP port

You can select one of the following options:

  • Port 25 to use Plain Text

  • Port 465 to use the SMTPS protocol

  • Port 587 to use the STARTTLS protocol

  • Custom port within the range of 1 to 65,535

The default SMTP port number is 25. Encryption is disabled by default.

Encryption

Select Enable Encryption to use a secure connection.

Software Administrator Email

Enter the email ID of the software administrator, to receive software alerts that are specific to the Veritas NetBackup Appliance software. The email ID that you designate receives alerts for the following software conditions:

  • Host information such as:

    • Disk information.

    • Overall backup status.

    • Results of last seven backups for each client.

  • An email of your catalog backup disaster recovery file.

  • A patch installation success report.

Hardware Administrator Email

Enter the email ID of the hardware administrator, to receive hardware alerts that are specific to the Veritas NetBackup Appliance hardware. For example, enter hardwareadmin@usergroup.com.

Email Test

A test email is sent to the email address that was configured above. If the test email is not received, follow the error prompts to view the network connections, SMTP settings, and email settings. You can contact your system administrator for more assistance.

Sender Email

Enter the email ID to receive any replies to the alerts or the reports that the appliance sends.

SMTP Account

Enter the user name to access the SMTP account.

Password

Enter the password for the above mentioned SMTP user account.

You can configure this server to send email reports to a proxy server or to the Veritas Call Home server.

The following describes the supported proxy servers:

  • Squid

  • Apache

  • TMG

Note:

NTLM authentication in the proxy configuration is also supported.

All email notifications that get generated by the appliance use the same SMTP settings. These emails include hardware monitoring notifications and NetBackup job notifications. The configuration settings are located under Settings > Notification > Alert Configuration in the NetBackup Appliance Web Console or Main_Menu > Settings > Alerts in the NetBackup Appliance Shell Menu. These settings override any previous SMTP setup you may have previously used to send NetBackup job notifications.

Configuring Call Home

Table: Call Home Configuration settings lists the fields from the Call Home Configuration section.

Table: Call Home Configuration settings

Fields

Description

Enable Call Home

Select this check box to enable Call Home alert configuration.

Enable AutoUpdate for Upgrade Readiness Check

Select this check box to enable automatic updates for the Appliance Upgrade Readiness Analyzer tool (analyzer tool) on the appliance.

Enabling this feature lets you keep pre-upgrade checks up to date and receive accurate upgrade readiness status recommendations through System Health Insights on the NetInsights Console. You can download the latest version of the analyzer tool from the Veritas Download Center. Veritas recommends that you enable AutoUpdate.

Enable Proxy Server

Select this check box to enable proxy.

Enable Proxy Tunneling

Select this check box if your proxy server supports SSL tunneling.

Proxy Server

Enter the name of the proxy server.

Proxy Port

Enter the port number of the proxy server.

Proxy Username

Enter the user name to log into the proxy server.

Proxy Password

Enter the password for the user name to log into the proxy server.

When Call Home is enabled, you can test if Call Home functions correctly by clicking the Test Call Home option that is available below the Call Home configuration settings.

Note:

The Test Call Home option is active on the NetBackup Appliance Web Console only when Call Home is enabled.

Starting with the 5.0 release, when you enable Call Home and click Save, a Call Home test is performed automatically.

The following describes the supported proxy servers:

  • Squid

  • Apache

  • TMG

NTLM is the supported authentication method for Call Home proxy settings.