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

Configuring the Velocity Client for Windows

The Velocity Client is a service that facilitates automated database ingestion and sandbox preparation. To configure the Velocity Client, you must copy an installation package from the Velocity Storage Server. Then, you must install it on any host servers that are intended to be used for either sandboxes or database ingestion. Finally, each host server must be registered with Velocity before you can ingest databases or create sandboxes.

You can install and register the Velocity Client manually using a Windows installation wizard. If you prefer, you can install the Client using the Velocity launch pad. The launch pad walks you through the configuration process.

Note:

By default, Velocity uses host-based security for access to CIFS shares. To restrict access of CIFS shares to authorized users, you can choose to integrate with Active Directory when you configure the Velocity Client for Windows. However, you must first join the Velocity Storage Server to the Active Directory domain.

See Joining the Velocity Storage Server to the Active Directory domain.

When the Velocity Client is successfully registered, it appears in the Velocity Console. To view any registered instances of the Velocity Client, click Clients in the left pane.

Note:

When you uninstall an instance of the Velocity Client, it must be able to connect to the Velocity Storage Server because the process also deregisters the Velocity Client.

You can also delete a client if an error was made in the initial registration and you want set it up again with valid information.

Configuring the Velocity Client for Windows manually

Note:

If you configure the Velocity Storage Server so that it is multihomed, these commands may not provide the correct IP address. You may need to change the IP address to the same IP address that matches the network that the Velocity Client is on.

To configure the Velocity Client for Windows manually

  1. Log on to the Windows host server as an administrator.
  2. Run the velocity-client.msi and follow the prompts to install the Client on your host server.

    \\<storage FQDN/IP address>\packages\velocity-client.msi

  3. Log on to the Velocity Console as an administrator.
  4. From the Velocity Console, in the left pane, click Velocity Storage Server.
  5. Click Generate Server Credentials.

    Make a note of the generated User name and Password credentials that display.

  6. On the host server, use one of the following commands to register the host with Velocity:

    If you use the computer's hostname to identify the host server on the network:

    Type the following command:

    %PROGRAMFILES%\Veritas\Velocity\bin\velocity_registration.exe initialize -s https://<Storage FQDN/IP address>:8443 -u <user> -p <password>

    Note:

    If you configure the Velocity Storage Server so that it is multihomed, these commands may not provide the correct IP address. You may need to change the IP address to the same IP address that matches the network that the Velocity Client is on.

    Where <Storage FQDN/IP address> is the FQDN or IP address of the Velocity Storage Server. Replace <user> with the user name and <password> with the password from the Generate Server Credentials dialog in the previous step.

    Note:

    If you installed the Client in a directory other than the default directory, C:\Program Files, you must modify the command to use the appropriate directory.

    If the primary FQDN or IP address of the host server is not on the same network path as the Velocity Storage Server:

    Type the following command:

    %PROGRAMFILES%\Veritas\Velocity\bin\velocity_registration.exe initialize -i <MS SQL FQDN/IP address> -s https://<Storage FQDN/IP address>:8443 -u <user> -p <password>

    Note:

    If you configure the Velocity Storage Server so that it is multihomed, these commands may not provide the correct IP address. You may need to change the IP address to the same IP address that matches the network that the Velocity Client is on.

    Where <Storage FQDN/IP address> is the appropriate FQDN or IP address of the Velocity Storage Server.

    Replace <user> with the user name and <password> with the password from the Generate Server Credentials dialog in the previous step.

    The -i flag lets you specify the FQDN or IP address that is associated with the interface and represents the network path to the Velocity Storage Server. Using the -i flag ensures that Velocity uses the correct network path when it communicates with the Velocity Storage Server.

    Note:

    If you installed the Client in a directory other than the default directory, C:\Program Files, you must modify the command to use the appropriate directory.

    (Optional) If you want to secure the CIFS shares with Active Directory

    Note:

    You must first join the Velocity Storage Server to the Active Directory domain.

    See Joining the Velocity Storage Server to the Active Directory domain.

    For Active Directory integration, include the following arguments:

    --adGroups <group1, group2,...> --clientUser <user> [-- clientPassword <password>]

    Where:

    • <group1, group2,...> is a group or a set of groups that are separated by commas with no spaces in between. Group names that include spaces are currently not supported. Members of the group or groups have access to the CIFS share.

    • <user> must be a member of at least one of the groups that are listed in the adGroups argument.

    • <password> is the password for the Active Directory user account. Velocity uses this password to configure the Velocity Client vexecd service. Velocity does not store this password.

      You can provide the user name on the command line to assist with the script. Otherwise, Velocity prompts you to enter a password.

    The SQL Server service account for the instance on the server that will host the sandbox database must be configured to run as an Active Directory account. The Active Directory account must be a member of at least one of the Active Directory groups that is specified when the Velocity Client is registered. Then, the SQL Server service account can access the CIFS share and start the database for the sandbox.

Configuring the Velocity Client for Windows using the Velocity launch pad

To configure the Velocity Client for Windows using the Velocity launch pad

  1. On the Velocity Console, click Launch Pad.
  2. On the Configure the Velocity Client tile, click Configure.
  3. Click Next.
  4. Select Windows for SQL Databases, and then click Next.
  5. Do one of the following:

    To use host-based security for access to CIFS shares

    Complete the directions that display on the launch pad.

    To secure the CIFS shares with Active Directory

    Note:

    You must first join the Velocity Storage Server to the Active Directory domain.

    See Joining the Velocity Storage Server to the Active Directory domain.

    Complete the directions that display on the launch pad, and include the following arguments to the commands that are copied and pasted into the terminal:

    --adGroups <group1, group 2,...> --clientUser <user> [--clientPassword <password>]

    Where:

    • <group1, group 2,...> is a group or a set of groups that are separated by commas with no spaces in between. Group names that include spaces are not currently supported. Members of the group or groups have access to the CIFS share.

    • <user>must be a member of at least one of the groups that are listed in the adGroups argument.

    • <password> is the password for the Active Directory user account. Velocity uses this password to configure the Velocity Client vexecd service. Velocity does not store this password.

      You can provide the user name on the command line to assist with the script. Otherwise, Velocity prompts you to enter a password.

    The SQL Server service account for the instance on the server that will host the sandbox database must be configured to run as an Active Directory account. The Active Directory account must be a member of at least one of the Active Directory groups that is specified when the Velocity Client is registered. Then, the SQL Server service account can access the CIFS share and start the database for the sandbox.

  6. Click Done.