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

Ingesting an Oracle database into Velocity from the command line

Velocity provides an application named ingest_dba that you can run from the command line to ingest an Oracle database from an Oracle server to an NFS mount path on the Velocity Storage Server. The ingest_dba application performs a differential, incrementally updated ingest (RMAN incremental level 1) to ingest an Oracle database to an NFS path.

Note:

This topic does not apply to using NetBackup to ingest databases.

On the first ingest of an Oracle database, Velocity performs an image copy backup of the database. On subsequent ingests of the same database, Velocity backs up only changed data blocks from individual database pages. These incremental changes are rolled forward and merged into the data files on the NFS mount path on the Velocity Storage Server. The first backup that runs with the full parameter is a full backup, and all subsequent backups are level 1 incrementals. To see all available parameters for the ingest_dba application, use the -h parameter to view the help.

Velocity also provides an automated method to ingest databases.

See How to provide copies of Oracle databases for sandboxes in Velocity.

Note:

In an ASM environment, the ingest_dba application automatically detects databases on ASM storage, dynamically creates the destination ASM disk group, and mounts it in the local ASM instance.

When you run the script, the database can be in either an open state or a mounted state.

Databases that are ingested are listed on the Database Sources window on the Velocity Console.

Table: What to do before you use the command line to ingest a database

Before you run the ingest_dba application, review the following options:

More information

Review the best practices for improving the performance of the Velocity ingest process.

See Improving the performance of Veritas Velocity for Oracle Database.

Decide if you want to customize the ingest_dba application for your environment or to customize a specific ingest.

You can edit the default options in the ingest_options.json file to customize the ingest_dba application

See Editing default options for the ingest method for Oracle databases.

To ingest from an Oracle database that is hosted on ASM to a regular file system that is hosted on the Velocity Storage Server, you must set the 'StorageType' option to 'FS' in the ingest_options.json file.

If you use the ingest method on the Velocity Console, then you must save the ingest without running it, set the 'StorageType' Option to 'FS', and then run the ingest.

See Editing default options for the ingest method for Oracle databases.

Decide if you want to use a custom parameter file to control the startup behavior of a sandbox. When a database is ingested to Velocity, the custom parameter file is stored with the database copy. Then, the custom parameter file is automatically applied to a sandbox when it is created from the database copy.

See About setting custom initialization parameters for a sandbox for an Oracle database copy.

Requirements

You must do the following before you run the application:

To run the application, you must have the following rights and assignments:

  • On the host Oracle Database server:

    • You must be an oracle user who belongs to the oinstall group and the dba group.

    • When the Oracle DBA ingests an Oracle database that uses ASM storage, the DBA must be part of the Oracle Grid Infrastructure user group. Otherwise, the ingest_dba application prompts you to enter the password for the Oracle Grid Infrastructure user when the destination ASM disk group is created, mounted, and dismounted.

  • In Velocity, you must have at least a DBA role.

Note:

Refer to your Oracle documentation for best practices on how to configure backups for an Oracle RAC environment.

To ingest an Oracle database into Velocity by using the command line

  1. From the Velocity Console, in the left pane, click Database Sources.
  2. On the Database Sources dialog, click +, and then click Add Database to Ingest.
  3. On the Choose Method dialog, select whether you want to use Velocity or NetBackup to ingest this database source.

    See Ingesting an Oracle database with NetBackup CoPilot.

  4. On the Add a Database Source dialog, enter the hostname or IP address of the Oracle database server that hosts the database that you want to add to Velocity.
  5. Click + to add the hostname or IP address to the Added Hosts list.
  6. To specify a database in a RAC environment, enter each node name or IP address one at a time. Then, click + to add each node to the Added Hosts list.
  7. (Optional) For the option Enable Copy Preparation, click Yes if you want to change data in a database before users can access the database copies from their sandboxes.

  8. Enter the name of the Oracle database that you want to add to Velocity.
  9. (Optional) Enter a name for the Oracle database that is meaningful or easy to remember.
  10. (Optional) Enter a description of the Oracle database that is meaningful or easy to remember.
  11. Click Save to save the database information that you added and return to the Database Sources window without starting the ingest process.
  12. On the Oracle host server, log in as an oracle user who belongs to the oinstall group and the dba group.
  13. Type the following command to change the directory to the NFS mount path on the Oracle Server:

    cd /<NFS mount path>

    Where NFS mount path is the path name that displays in the Database Source Details dialog.

    To find the NFS mount path, on the Velocity Console, in the left pane, click Database Sources, select the database source that you want to ingest, and then click Details.

  14. Type one of the following commands to run the ingest application:

    To run the default for the first ingest and for all subsequent ingests

    /tools/bin/ingest_dba

    To start a full backup

    /tools/bin/ingest_dba --full

    Note:

    If necessary, you can cancel an ingest process after you have started it.

    See Canceling an Oracle database ingestion.

  15. If you are prompted, enter the Oracle Grid Infrastructure user password.

    After the application has run, to view the database that was ingested into Velocity, sign in to the Velocity Console, and then in the left pane, click Database Sources.