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

Name

Main > Support > Logs — Share, unshare logs files for the appliance. Show and set debug levels for the logs.

SYNOPSIS

Browse

Delete Date LogType

GetLevel

SetLevel Option Level

Share

VXLogView JobID job_id

VXLogView Minutes minutes_ago

VXLogView Module module_name

Upload JobID jobid case_num

Upload Time start end case_num

DESCRIPTION

Use this command to do the following functions:

  • Browse the appliance log directories and files.

    You can use the Browse command to view the log directories and log files that are configured in your appliance. When you run the Browse command the command prompt changes to LOGROOT/>. From the LOGROOT/ command prompt you can run the following commands to list, view, and change directories:

    • ls - List the directories and files

    • tree - Provides a tree-view of the directories and files.

    • cd DIR - Use to change the directory, where DIR is the directory name. For example, you can use cd ., cd .., and cd -.

    • less FILE - Provides a read-only view of a file. You must enter the letter q or quit to exit this view.

    • exit|quit - Enables you to exit the log shell.

    • help|? - Use either of these two commands to display help.

    From the LOGROOT/> command prompt, you can use the ls command to see the following log directories on your appliance:

    • APPLIANCE

    • NBU

    • OS

    • PD

    To see the log files from within a log directory, you must change directories to the log directory that contains the log files that you want to view. After you change directories, the same commands that were available under the LOGROOT/ view are available for each of the log directories.

    For example, to see the operating system (OS) log files, you must first enter cd OS at the LOGROOT/> command prompt. The command prompt changes to LOGROOT/OS>/. Then you can enter ls to see the file names. Finally, you can use the less filename command to view a read-only version of the log file.

  • Set the level of debug logs

    Use the SetLevel command to set the NetBackup log level for an appliance component that you choose. The range begins with zero and can differ for each component. A value of zero means that logging is at its lowest level.

    In addition, you can use the GetLevel command to get the NetBackup log level.

  • Export or remove CIFS and NFS shares for the logs.

    Use the Share Open command to export the CIFS and the NFS shares for the logs. The Share Close command removes the CIFS and the NFS shares for the logs.

  • Display debug information from the VxLog files.

    Use the VxLogView command to display log files for specific job or by a set duration of time.

  • Upload the NetBackup log files for your appliance to Support. The files that you send can be based on the job ID, the time that the log files were taken, or the default-based duration.

    If an issue occurs and you decide you need additional support, you should call Veritas Technical Support and open a customer case. The customer support contact assigns a unique customer case number that identifies you, your company information, and your issue. To further help you diagnose the issue, the customer support contact needs to obtain a copy of your appliance log files. You can use the Upload command to send all of the log files that are associated with your appliance to Support.

    The following procedure describes the process that you use to send the log files from your appliance to Technical Support.

To configure your appliance to upload log files using the Logs Upload command

  1. Make sure that you have a customer case number assigned to your issue. If you do not have a case number, contact Technical Support and have a customer case opened and a unique customer case number assigned to your issue. The customer case number is used to create the name of the file that you send to Support. That helps the technical support contact identify the file that you sent.
  2. Log on to your appliance as the administrator.
  3. Enter the Main > Support view.
  4. Type one of the following commands to create a log set for technical support. Depending on the nature of your issue, technical support may ask you to use one of the following commands to create the log set. Each of these commands creates a .tar file that is based on the job ID, a specific start and end time, or a default duration of four hours.
    • Type Logs Upload Jobid jobid case_num.

      This command creates a .tar file that contains log files that are based on the job ID.

    • Type Logs Upload Time start End case_num.

      This command creates a .tar file that contains log files that are based on the default duration of four hours

      Where case_num is the customer case number that was issued to you by your NetBackup Support contact. This number becomes a part of the .tar file name so your Technical Support contact can identify the files that came from your appliance.

      Where jobid is the job ID number that is used to collect the logs.

      Where start and End are the start date and the end date of the logs to collect.

OPTIONS

Browse

Use the show the appliance logs.

Delete Date LogType

Use this command to delete archived log files. Here, Date defines the date until which you want to delete archived log files. LogType is the product name for which you want to delete the archived log files.

The available LogType options are the following:

CoreDump/NetBackup/Puredisk/ALL

GetLevel

Use to view the NetBackup log levels

SetLevel Option Level

Use to set the NetBackup log levels. Where Option is the appliance component. For example, an appliance component can be NetBackup or PureDisk. In addition, Level is the appliance logging level. For NetBackup, you can select a level from 0 to 5 and for PureDisk, you can select a level from 0 to 10. Zero provides the lowest level of logging that is available.

Share

Use to extract the CIFS and the NFS shares for the logs.

For CIFS, you must map the share using the appliance "admin" user's credentials.

VXLogView JobID job_id

Display debug information from the log files by designating a specific job ID as the criteria by which the information is parsed.

Where job_id is the NetBackup job that you determine you want to view from the debug information.

VXLogView Minutes minutes_ago

Display debug information from the log files using time (in minutes) as the criteria by which the information is parsed.

Where minutes_ago is the amount of time, in minutes, used to determine how much of the past debug information to display.

VXLogView Module module_name

Display debug information from the log files by designating a specific logging module as the criteria by which the information is parsed.

Where module_name is the module from which you want to view log files. You can select from the following modules:

All/CallHome/Common/Config/Database/HWMonitor/Network/Seeding/SelfTest
/Storage/SWUpdate/Commands/CrossHost/Trace/AuthService/TaskService
All/CallHome/Checkpoint/Common/Config/Database/Hardware/HWMonitor
/Network/RAID/Seeding/SelfTest/Storage/SWUpdate/Commands/CrossHost
/Trace/FTMS/FTDedupTarget/AuthService/TaskService
Upload JobID jobid case_num

Upload log files for the appliance to Support. This command creates a .tar file of the logs using the job ID. Use FTP to upload the file to Support.

Where jobid contains the job ID number that is used to collect the logs. The case_num variable is a unique number filed with Support that identifies the customer and their corresponding log files. The format of this number is ###-###-###

Upload Time start end case_num

Upload the logs based on the default duration. The default duration is four hours. This command creates a .tar file of the logs using the time. Use FTP to upload the file to Support.

Where start is the start date of the log files to send to Support. end is the end date of the log files to send to Support. And case_num is a unique number filed with Support that identifies the customer and their corresponding log files. The format of this number is ###-###-###

SEE ALSO