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

About the NetBackupCLI user role

A NetBackupCLI user can execute all NetBackup commands, view logs, edit NetBackup touch files, and edit NetBackup notify scripts. NetBackupCLI users are solely restricted to run NetBackup commands with superuser privileges and do not have access outside the scope of NetBackup software directories. Once these users log on, they are taken to a restricted shell from where they can run the NetBackup commands. The NetBackupCLI users share a home directory and do not have access to the NetBackup Virtual Appliance Shell Menu.

Table: Rights and restrictions of the appliance NetBackupCLI user lists the rights and restrictions of NetBackupCLI users.

Table: Rights and restrictions of the appliance NetBackupCLI user

Rights

Restrictions

The NetBackupCLI user can use the NetBackup Virtual Appliance Shell Menu to do the following:

  • Run the NetBackup CLI and access the NetBackup directories and files.

  • Modify or create NetBackup notify scripts using the cp-nbu-notify command.

  • Run the following NetBackup commands and for the following directories that contain the NetBackup CLI:

    • /usr/openv/netbackup/bin/*

    • /usr/openv/netbackup/bin/admincmd/*

    • /usr/openv/netbackup/bin/goodies/*

    • /usr/openv/volmgr/bin/*

    • /usr/openv/volmgr/bin/goodies/*

    • /usr/openv/pdde/pdag/bin/mtstrmd

    • /usr/openv/pdde/pdag/bin/pdcfg

    • /usr/openv/pdde/pdag/bin/pdusercfg

    • /usr/openv/pdde/pdconfigure/pdde

    • /usr/openv/pdde/pdcr/bin/*

The following restrictions are placed on NetBackupCLI users:

  • NetBackupCLI users do not have access outside of the NetBackup software directories.

  • They cannot edit the bp.conf file directly using an editor. Use the bpsetconfig command to set an attribute.

  • The cp-nbu-config command supports creating and editing NetBackup touch configuration files only in the /usr/openv/netbackup/db/config directory.

  • They cannot use the man or -h command to see the help of any other command.

How to run NetBackup commands as a NetBackupCLI user

Use one of the following methods to run commands as a NetBackupCLI user:

  • Restricted shell.

  • Absolute path ["sudo"]. For example: bppllist or /usr/openv/netbackup/bin/admincmd/bpplist

See About running NetBackup commands from the appliance.

How to run special directive operations

Special directive operations can fail if the special directive files and commands are not in the correct NetBackup list or path. One example of a special directive operation is when you specify an alternate restore path.

Appliance users that need to run NetBackup commands to access special directive files as a NetBackupCLI user, must do the following to ensure successful operation:

  • Add the /home/nbusers path to the NetBackup bpcd whitelist.

  • Add the special directive commands to the /home/nbusers directory.

For details about adding entries to the NetBackup bpcd whitelist, refer to the BPCD_WHITELIST_PATH configuration option in the following documents:

NetBackup Administrator's Guide, Volume 1 - Release 7.7.2

NetBackup Commands Reference Guide - Release 7.7.2

More Information

Granting roles to NetBackup Virtual Appliance users and user groups

Creating NetBackup administrator user accounts

About the Administrator user role

NetBackup Virtual Appliance user role privileges

About user authorization on the NetBackup Virtual Appliance

About managing NetBackup Virtual Appliance users