Veritas Velocity™ User's Guide

Last Published:
Product(s): Velocity (2.9)
  1. Getting to know Velocity
    1.  
      Introducing Velocity
    2.  
      About the Velocity Appliance
    3.  
      About the Velocity Storage Server administration interfaces
    4.  
      Using the Velocity shell menu
    5.  
      How Velocity and NetBackup work together
  2. Setting up Velocity
    1.  
      Velocity administrator's checklist for setting up Veritas Velocity
    2.  
      Database administrator's checklist for setting up Veritas Velocity
    3.  
      Sandbox user's checklist for setting up Veritas Velocity
    4. How to set up the Velocity Storage Server
      1.  
        Deploying the Velocity Storage Server image on a virtual machine
      2.  
        Velocity Appliance initial configuration requirements
      3.  
        Configuring network and storage settings for the Velocity Storage Server in a virtual environment
      4.  
        Registering the Velocity Storage Server
      5.  
        Joining the Velocity Storage Server to the Active Directory domain
      6.  
        Adding a Certificate Authority signed certificate to the Velocity Storage Server
    5. How to set up the Velocity Client
      1.  
        Testing the network path for Oracle communications
      2.  
        Configuring the Velocity Client for Linux
      3.  
        Configuring the Velocity Client for Solaris
      4.  
        Configuring the Velocity Client for Windows
    6.  
      Deleting a Velocity Client
    7.  
      Configuring a proxy server for Velocity
    8.  
      Required and optional ports for Velocity
    9.  
      Installing the NetBackup Client on the Velocity Storage Server
  3. Setting up the Velocity on-premises management server
    1.  
      How to set up the Velocity on-premises management server
    2.  
      Deploying the Velocity on-premises management server image on a virtual machine
    3.  
      Configuring the network settings for the Velocity on-premises management server
    4.  
      Configuring Active Directory/LDAP settings on the Velocity on-premises management server
    5.  
      Adding users to the Velocity on-premises management server
    6.  
      Upgrading the Velocity on-premises management server
  4. Upgrading Velocity
    1.  
      How to upgrade to Velocity version 2.9
    2.  
      Finding the Velocity component version numbers
    3.  
      Downloading and transferring software updates to the Velocity Storage Server
    4.  
      Removing previous upgrade files
    5.  
      Upgrading the Velocity Storage Server
    6.  
      Upgrading the Velocity Client for Linux
    7.  
      Upgrading the Velocity Client for Windows
    8.  
      Upgrading the Velocity Client for Solaris
  5. Velocity Storage Server
    1.  
      About the Velocity Storage Server
    2.  
      Viewing physical storage usage on the Velocity Storage Server
    3.  
      About reclaiming storage space on the Veritas Velocity Storage Server
    4.  
      Increasing meta and data storage capacity on the Velocity Storage Server
    5.  
      Deregistering a Velocity Storage Server
    6.  
      How to reset the Velocity Storage Server
  6. Users and roles
    1.  
      How to configure users and roles in Velocity
    2.  
      Adding users
    3.  
      Role-based access control
    4.  
      Adding roles
    5.  
      Deleting roles
    6.  
      Viewing details about all users and roles
    7.  
      Assigning users to an existing role
    8.  
      Removing users from a role
    9.  
      Changing the database sources that are assigned to a role
  7. Oracle database ingestion using Velocity
    1.  
      How to provide copies of Oracle databases for sandboxes in Velocity
    2.  
      Adding an Oracle database to ingest into Velocity
    3.  
      Ingesting an Oracle database into Velocity for the first time
    4.  
      Ingesting an Oracle database again after the first ingest
    5.  
      Canceling an Oracle database ingestion
    6. How to use copy preparation to mask or sanitize sensitive data
      1.  
        Masking sensitive data manually in database copies
      2.  
        Masking sensitive data in database copies by using a script
      3.  
        Masking sensitive data manually in database copies that are already ingested
      4.  
        Masking sensitive data by using a script in database copies that are already ingested
      5.  
        Disabling copy preparation for Oracle database copies
    7.  
      Ingesting an Oracle database into Velocity from the command line
    8.  
      About setting custom initialization parameters for a sandbox for an Oracle database copy
    9.  
      Editing default options for the ingest method for Oracle databases
  8. Oracle database ingestion using NetBackup CoPilot
    1.  
      How to set up NetBackup CoPilot to ingest Oracle databases into Velocity
    2.  
      Ingesting an Oracle database with NetBackup CoPilot
  9. Microsoft SQL Server database ingestion using Velocity
    1.  
      How to provide copies of SQL Server databases for sandboxes in Velocity
    2.  
      Adding a SQL Server database to ingest into Velocity
    3.  
      Ingesting a SQL Server database into Velocity
    4.  
      Editing default options for SQL Server database ingestion
    5.  
      Canceling a SQL Server database ingestion
  10. Automatic ingestion of NetBackup deduplicated backups
    1.  
      About using NetBackup deduplicated backups to create Velocity sandboxes
    2.  
      How to set up automatic ingestion of NetBackup deduplicated backups
    3.  
      Supported Oracle policy options for automatic ingestions of NetBackup deduplicated backups
    4.  
      Supported SQL Server policy options for automatic ingestions of NetBackup deduplicated backups
    5.  
      Adding an Oracle database source to automatically ingest NetBackup deduplicated backups
    6.  
      Adding a SQL Server database source to automatically ingest NetBackup deduplicated backups
  11. Database sources and copies
    1.  
      About database sources and copies
    2.  
      Viewing details of an Oracle database source
    3.  
      Viewing details of a SQL Server database source
    4.  
      Changing the nickname or description of a database source
    5.  
      Deleting a database source from Velocity
    6. About scheduling ingestions for a database source
      1.  
        Viewing the ingestion schedule for a database source
      2.  
        Adding an ingestion schedule to a database source
      3.  
        Editing the ingestion schedule for a database source
      4.  
        Deleting the ingestion schedule for a database source
      5.  
        Restarting scheduled database ingestions after changing the system time or time zone on the Velocity Storage Server
    7. Retention periods for database sources and copies
      1.  
        Changing the default retention period for a database source
      2.  
        Deleting the default retention period for a database source
      3.  
        Changing the retention date for a database copy
      4.  
        Deleting the retention date for a database copy
    8.  
      Viewing database copies
    9.  
      Viewing the number of sandboxes that were created from a database copy
    10.  
      Viewing the status of database copies
    11.  
      Deleting database copies
  12. Sandboxes
    1.  
      About sandboxes
    2.  
      Creating a sandbox from an Oracle database copy
    3.  
      Starting an Oracle database instance manually
    4.  
      Creating a sandbox from a SQL Server database copy
    5.  
      Starting a SQL database manually
    6.  
      Finding your sandbox
    7.  
      Viewing details about your sandboxes
    8.  
      Deleting a sandbox
    9.  
      Managing sandboxes when you restart the host Oracle Database server
    10.  
      Unmounting a sandbox from an Oracle host server
  13. Database recovery
    1.  
      Recovering an Oracle database
  14. Alerts and logs
    1.  
      Viewing alerts
    2.  
      Creating audit log reports
    3.  
      Redirecting the syslog messages
    4.  
      Viewing the syslog messages on a Red Hat Enterprise Linux computer
    5.  
      Viewing the syslog messages on a Windows computer
  15. Managing the Velocity physical appliance
    1. Configuring network address settings on the Velocity physical appliance
      1.  
        About IPv4-IPv6-based network support on the Velocity physical appliance
      2.  
        About NIC1 (eth0) port usage on the Velocity physical appliance
      3.  
        Creating a network interface bond (NIC bond) on the Velocity physical appliance
      4.  
        VLAN tagging on the Velocity physical appliance
      5.  
        Configuring static routes on the Velocity physical appliance
      6.  
        Configuring DNS and host name mapping on the Velocity physical appliance
      7.  
        Setting the host name for the Velocity physical appliance
      8.  
        Using a proxy server with the Velocity physical appliance
      9. About WAN optimization on the Velocity physical appliance
        1.  
          Configuring WAN optimization on the Velocity physical appliance
      10.  
        About the maximum transmission unit size on the Velocity physical appliance
      11.  
        Setting the date and time on the Velocity physical appliance
    2. About the Veritas Remote Management Console on the Velocity physical appliance
      1.  
        Configuring the IPMI port on the Velocity physical appliance
      2.  
        Managing IPMI users on the Velocity physical appliance
      3.  
        Resetting the IPMI on the Velocity physical appliance
    3. About Velocity physical appliance storage
      1.  
        Configuring the storage on the Velocity physical appliance
      2.  
        Viewing the storage on the Velocity physical appliance
    4. About users on the Velocity physical appliance
      1.  
        Creating appliance user accounts on the Velocity physical appliance
      2.  
        Deleting appliance user accounts on the Velocity physical appliance
      3.  
        Changing user passwords on the Velocity physical appliance
    5. About Velocity physical appliance checkpoints
      1.  
        Creating a custom checkpoint on the Velocity physical appliance
      2.  
        Restoring the Velocity physical appliance from a checkpoint
    6. About factory reset on the Velocity physical appliance
      1.  
        Restoring the Velocity physical appliance to a factory state
  16. Monitoring the Velocity physical appliance
    1. About Veritas AutoSupport on the Velocity physical appliance
      1.  
        Setting up AutoSupport on the Velocity physical appliance
    2.  
      Setting up email notifications on the Velocity physical appliance
    3.  
      Setting up SNMP notifications on the Velocity physical appliance
    4. Auditing the SDCS logs on the Velocity physical appliance
      1.  
        About SDCS event type codes and severity codes on the Velocity physical appliance
      2.  
        Changing the SDCS log retention settings on the Velocity physical appliance
    5.  
      Testing the Velocity physical appliance hardware
  17. Velocity physical appliance security
    1. About Velocity physical appliance user account privileges
      1. Velocity physical appliance user name and password specifications
        1.  
          Password encryption and handling on the Velocity physical appliance
    2. About the Velocity physical appliance intrusion detection system
      1.  
        Reviewing SDCS events on the Velocity physical appliance
    3. About Velocity physical appliance operating system security
      1.  
        Vulnerability scanning of the Velocity physical appliance
      2.  
        Disabled service accounts on the Velocity physical appliance
    4.  
      About data security on the Velocity physical appliance
    5.  
      About data integrity on the Velocity physical appliance
    6.  
      About the Velocity physical appliance ports
    7. Recommended IPMI settings on the Velocity physical appliance
      1.  
        Replacing the default IPMI SSL certificate on the physical appliance
  18. Velocity REST APIs
    1.  
      Getting started with Velocity REST APIs
    2.  
      Authenticate a user for the Velocity REST APIs
    3.  
      Get Velocity Storage Servers
    4.  
      Create a share
    5.  
      Find the share ID
    6.  
      Find the share location
    7.  
      Create a snapshot
    8.  
      Find the snapshot ID
    9.  
      Create a sandbox
    10.  
      Find the sandbox ID
    11.  
      Get a sandbox
    12.  
      Delete a share
    13.  
      Delete a snapshot
    14.  
      Delete a sandbox
    15.  
      Get templates (shares)
    16.  
      Get snapshots
    17.  
      List all sandboxes
  19. Best practices
    1.  
      Improving the performance of Veritas Velocity for Oracle Database
    2.  
      Stopping and starting all mounts
    3.  
      Protecting the Velocity on-premises management server
  20. Troubleshooting
    1.  
      NFS export paths where ingested Oracle Database sources are stored are inaccessible
    2.  
      NFS export path is not created during a database ingestion
    3.  
      Database ingestion fails with the Oracle error 'diskgroup {xx} space exhausted'
    4.  
      After restart of the vpfsd service, links to the applications are broken
    5.  
      Sandbox creation fails on an Oracle Database server
    6.  
      Sandbox creation fails for a SQL Server database copy
    7.  
      Sandbox creation fails after you use the --adGroups argument when you configure the Velocity Client for Windows
    8.  
      Sandbox creation may take longer than usual on Oracle Database 12c
    9.  
      A sandbox cannot be deleted from an Oracle Database server because the mount point is busy
    10.  
      Error occurs when registering the Velocity Client; provide the Oracle DBA with access to the Velocity registration files
    11.  
      Error occurs when a new sandbox name has the same name as a deleted sandbox
    12.  
      Ingestions and sandboxes are stuck 'In Progress' after the Velocity Storage Server is restarted
  21. Glossary
    1.  
      Glossary terms for Velocity
  22. Section I. Velocity shell menu commands
    1. Introduction
      1.  
        About Velocity commands
    2. Appendix A. Main > Manage > Storage
      1.  
        Manage > Storage > Configure
      2.  
        Manage > Storage > Show
    3. Appendix B. Main > Manage > Cloud
      1.  
        Main > Manage > Cloud
    4. Appendix C. Main > Manage > Software
      1.  
        Manage > Software > Cancel
      2.  
        Manage > Software > Delete
      3.  
        Manage > Software > Download
      4.  
        Manage > Software > DownloadProgress
      5.  
        Manage > Software > Install
      6.  
        Manage > Software > List
      7.  
        Manage > Software > Readme
      8.  
        Manage > Software > Rollback
      9.  
        Manage > Software > Share
      10.  
        Manage > Software > UpgradeStatus
    5. Appendix D. Main > Monitor
      1.  
        Monitor > Hardware
      2.  
        Monitor > MemoryStatus
      3.  
        Monitor > NetworkStatus
      4.  
        Monitor > SDCS
      5.  
        Monitor > Top
      6.  
        Monitor > Uptime
      7.  
        Monitor > Who
    6. Appendix E. Main > Network
      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 > LinkAggregation
      12.  
        Network > VLAN
      13.  
        Network > WANOptimization
      14.  
        Network > Ping
      15.  
        Network > Proxy
      16.  
        Network > SetProperty
      17.  
        Network > Show
      18.  
        Network > TimeZone
      19.  
        Network > TraceRoute
      20.  
        Network > Unconfigure
    7. Appendix F. Main > Settings
      1.  
        Settings > Alerts > CallHome
      2.  
        Settings > Alerts > Email
      3.  
        Settings > Alerts > SNMP
      4.  
        Settings > Security > Authentication > LocalUser
    8. Appendix G. Main > Support
      1.  
        Support > Checkpoint
      2.  
        Support > Collect
      3.  
        Support > DataCollect
      4.  
        Support > FactoryReset
      5.  
        Support > InfraServices
      6.  
        Support > IPMI
      7.  
        Support > Logs
      8.  
        Support > Maintenance
      9.  
        Support > Processes
      10.  
        Support > RAID
      11.  
        Support > Reboot
      12.  
        Support > ServiceAllowed
      13.  
        Support > Shutdown
      14.  
        Support > Test

Upgrading the Velocity Storage Server

Before you upgrade the Velocity Storage Server, you must do the following:

To upgrade the Velocity Storage Server

  1. Do the following to delete the existing log files in the /var/log/velocity/pushd directory:
    • Log on to the Velocity Storage Server as the admin user.

    • From the Velocity shell menu, select Support > Maintenance.

    • Enter the password.

    • At the maintenance-!> prompt, type elevate.

    • Type the following command:

      rm /var/log/velocity/pushd/*.log

  2. Do you use NetBackup to ingest database sources?

    Yes

    Skip steps 3 and 4. Proceed to step 5.

    No

    Proceed to step 3.

  3. On the host server where the Velocity Client is installed, stop each active sandbox.
    • For Oracle, type the following command:

      <mnt path>/tools/scripts/sandbox stop

    • For SQL, from SQL Management Studio, right-click the database, and then click Tasks > Take Offline.

      Note:

      If you do not use SQL Management Studio, type the following command:

      ALTER DATABASE <database name> SET OFFLINE;

    Perform this step on every host server where the Velocity Client is installed and for every sandbox and database source on each host server.

  4. If you have an Oracle ASM environment, on the host server where the Velocity Client is installed, do the following to unmount the ASM disk group from each database source and sandbox:

    Note:

    If you do not have an ASM environment, skip step 4 and proceed to step 5.

    • Log in as a grid infrastructure user on the Oracle database server where the database source is mounted.

    • From the directory where the database source is mounted, type the following command:

      <mnt path>/tools/scripts/asmtasks_grid umountdg

    You must unmount the ASM disk group on every host server where the Velocity Client is installed and for every sandbox and database source on each host server.

  5. On the host server where the Velocity Client is installed, do the following to unmount all sandboxes and database sources:
    • Type the following command to access the scripts that are available:

      cd /opt/veritas/velocity/shutdown

    • Type the following command to view the list of scripts that are available:

      ls

      Note:

      One script is available for each mount point. The name of the script does not match the name of the mount point.

    • Run the K11dismount*<name> scripts to unmount the sandboxes and database sources.

      Note:

      If you have a RAC environment, run the K11dismount* script on each RAC node.

    This step is required on every host server where the Velocity Client is installed and for every sandbox and database source on each host server.

  6. (Optional) If you use NetBackup 7.7.3 or 8.0 to ingest database sources into Velocity, perform the following steps from a command line on the Velocity Storage Server to install the appropriate NetBackup Emergency Engineering Binary (EEB):

    Note:

    Use the command line, not the Velocity shell menu, to run the commands in step 6.

    • Contact Veritas Technical Support to obtain and download the correct EEB.

      • For NetBackup 7.7.3, EEB 3903951 Version 2 is required.

      • For NetBackup 8.0, EEB 3903952 Version 2 is required.

      • For NetBackup 8.1, an EEB is not required.

    • Type the following command to locate the script to stop Velocity services:

      cd /opt/veritas/velocity/scripts

    • Type the following command to run the script to stop Velocity services:

      ./velocitysvcs.sh forcestop

      Note:

      Do not cancel this command. If you cancel it, you must start it again.

    • Type the following command:

      chmod +x <path to where you downloaded the EEB>

    • Type the following command:

      /user/openv/netbackup/bin/bp.kill_all

    • Type the following command:

      mv /etc/nbapp-release /tmp

    • Type the following command:

      sh <path to where you downloaded the EEB>

    • Type the following command:

      mv /tmp/nbapp-release /etc

    • Type the following command:

      /use/openv/netbackup/bin/bp.start_all

    • Type the following command to run the script to restart Velocity services:

      velocitysvcs.sh start

    Note:

    You must also update the EEB on the Oracle server and on any NetBackup servers that the NetBackup Client is installed on.

  7. From the Velocity Storage Server, log in to the Velocity shell menu, and then go to the Main_Menu > Manage > Software view.
  8. Type the following command to install the upgrade:

    Install <file name>

  9. When you are prompted, type yes to confirm that you want to proceed with the upgrade.

    Several pre-check processes are performed. These processes require at least 30 minutes to complete.

  10. After the pre-check processes complete, type yes each time you are prompted to confirm that you want to proceed with the upgrade.

    The upgrade process may take several hours to complete.

  11. To track the progress of the upgrade, type the following command:

    UpgradeStatus

    The upgrade status may stop posting status updates during the upgrade process after the software that is used to run the program is updated. The status may show as 1% complete for a long time. However, the upgrade should be complete a few minutes after the system comes back online after restarting.

    Note:

    During the upgrade process, the Velocity Storage Server restarts.

    If you use a physical Velocity Storage Server, a self-diagnostic test runs after the upgrade installation completes. If SMTP alerts are enabled, the Velocity Storage Server sends an email notification that contains the self-test results. You can also refer to the following file for the test results:

    /log/selftest_report_<appliance_serial>_<timedate>.txt

  12. On the host server where the Velocity Client is installed, do the following to remount all sandboxes and database sources:
    • Type the following command to view the remount scripts:

      cd /opt/veritas/velocity/startup

    • Run the S89mount*<name> scripts to remount the sandboxes and database sources.

    Note:

    If you have a RAC environment, run the S89mount* script on each RAC node.

    This step is required on every host server where the Velocity Client is installed and for every sandbox and database source on each host server.

  13. Do you use NetBackup to ingest database sources?

    Yes

    Skip steps 14 and 15. You can now upgrade the Velocity Client for Linux.

    See Upgrading the Velocity Client for Linux.

    No

    Proceed to step 14.

  14. If you have an Oracle ASM environment, on the host server where the Velocity Client is installed, do the following to remount all disk groups:
    • Log in as a grid infrastructure user on the Oracle database server where the database source is mounted.

    • From the directory where the database source is mounted, type the following command:

      <mnt path>/tools/scripts/asmtasks_grid mountdg

    This step is required on every host server where the Velocity Client is installed and for every sandbox and database source on each host server.

  15. On the host server where the Velocity Client is installed, for each sandbox, type the following command to restart sandboxes:
    • For Oracle, type the following command:

      <mnt path>/tools/scripts/sandbox start

      Note:

      If you have a RAC environment, you only need to run the restart command on one node.

    • For SQL, from SQL Management Studio, right-click the database, and then click Tasks > Bring Online.

      If you do not use SQL Management Studio, type the following command:

      ALTER DATABASE <database name> SET ONLINE;

    This step is required on every host server where the Velocity Client is installed and for every sandbox and database source on each host server.

  16. From the Velocity shell menu, type the following command to verify that the correct version is installed:

    List Version

    The following versions should appear in the list:

    • Appliance version: 1.2.7

    • Velocity version: 2.8.3849-0

    • Build tag: 1.2.7-99999920170808193238

You should now upgrade the Velocity Client. You must upgrade the Velocity Client on any host servers that you use to create sandboxes or ingest data.

See Upgrading the Velocity Client for Linux.

See Upgrading the Velocity Client for Windows.

See Upgrading the Velocity Client for Solaris.