Delphix Reporting Admin Guide...Run€nginx -t€to test your config files to make sure they are...

Delphix Reporting Admin Guide

April, 2018

Delphix Reporting Admin GuideYou can find the most up-to-date technical documentation at:

The Delphix Web site also provides the latest product updates.docs.delphix.comIf you have comments about this documentation, submit your feedback to: [email protected]

© 2018 Delphix Corp. All rights reserved.Delphix and the Delphix logo and design are registered trademarks or trademarks of Delphix Corp. in the United States and/or other jurisdictions.All other marks and names mentioned herein may be trademarks of their respective companies.

Delphix Corp.1400 Seaport Blvd, Suite 200Redwood City, CA 94063

http://docs.delphix.com

1. Delphix Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.1 Getting Started with Delphix Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.2 Setting up HTTPS for Delphix Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.3 Delphix Reporting Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101.4 Search and Run Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201.5 Filter, Organize, and Extract Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261.6 Understanding the Graphs Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281.7 Delphix Reporting Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311.8 Support for Delphix Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Delphix Reporting Admin Guide © 2018 Delphix

Delphix Reporting

Getting Started with Delphix ReportingSetting up HTTPS for Delphix ReportingDelphix Reporting ConfigurationSearch and Run ReportsFilter, Organize, and Extract ReportsUnderstanding the Graphs InterfaceDelphix Reporting MaintenanceSupport for Delphix Reporting

Getting Started with Delphix Reporting

Welcome to Delphix ReportingUser Roles and Permissions

Admin User Auditor User

System RequirementsSupported BrowsersRelated Links

Welcome to Delphix Reporting

Delphix Mission Control is now known as Delphix Reporting.

Delphix Reporting is a centralized reporting and auditing tool for overseeing multiple Delphix Engine deployments. Delphix Reporting allowsadministrators to combine, sort, and audit data from multiple Delphix Engines. A centralized view of data from many Delphix Engines allowsadministrators to promptly identify any issues with the deployment, determine where resources are allocated, quickly locate deployed databases,and properly size future additions.

User Roles and Permissions

Delphix Reporting has two types of users:

Admin User

Admin users have full access to all report data and can configure the Delphix Reporting appliance. For example, they can:

add/delete Delphix Engineadd/delete reportsadd/delete userschange tunable settingsadd/delete tags

Auditor User

Auditor users can only view report data. Admin users can also assign auditor users a set of tags (arbitrary text strings) to restrict which report datathey can view. There is no default auditor account. The first Delphix Administrator will need to create the auditor users and will be responsible for

Delphix Mission Control is now known as Delphix Reporting.

For security purposes, Delphix recommends:

Changing your default Delphix Reporting password once you have successfully logged on for the first time.Limiting access to the Delphix Reporting MongoDB database to authorized administrators only.


creating their User IDs and Passwords.

System Requirements

The VM guest where you install Delphix Reporting has the following requirements:

VMware ESX: 4.x or greaterTwo Virtual CPUs4 GB of Memory50 GB of Storage

Delphix Reporting supports Delphix Engine 4.0 or later.

Supported Browsers

The following are the minimum supported browser versions for accessing the :Delphix Reporting console

Chrome 37Safari 7Firefox 32Internet Explorer 11

Related Links

Understanding the Graphs InterfaceDelphix Reporting Configuration

Setting up HTTPS for Delphix Reporting

This document walks you through how to setup HTTPS for Delphix Reporting. To achieve an end to end HTTPS support, the Delphix ReportingEngine needs to be configured in two parts:

Browser to Delphix ReportingDelphix Reporting to Delphix Engines

Browser to Delphix ReportingDelphix Reporting uses Meteor framework as its server and front end. Meteor itself does not support HTTPS, therefore Nginx is needed as amiddleman to accept the HTTPS requests and then delegate the requests to Meteor. The following instructions walk you through the steps toconfigure Nginx.

Preparing CertificatesThe HTTPS protocol dictates that you have a CA-signed certificate to establish trust between the browser and the Delphix Reporting server. Afteryou obtain your certificate (a pair of certificate and key file), please note the following:

CN value of your certificate should match the domain name.Delphix recommends placing your certificate and the server key under: /etc/nginx/ssl/

For example, /etc/nginx/ssl/server.crt or /etc/nginx/ssl/server.key).

Update the file permission on server.key as follows:

$ chmod 600 /etc/nginx/ssl/server.key

Configuring Nginx

Before you proceed, please note that HTTPS connection is “all or nothing”. Delphix Reporting will not fallback to HTTP connection ifHTTPS connection is unsuccessful.


1. 2.

1. 2.

3. 4. 5.

6.

Nginx will be installed and configured to route HTTP traffic automatically with the Delphix Reporting 1.5.0.0 installer. You will need to configureNginx so it forwards all HTTP traffic to HTTPS, then proxy the HTTPS traffic to meteor app:

Copy the HTTPS config file from /opt/delphix/nginx/nginx.https.config to /etc/nginx/sites-available/Rename the HTTPS config file to delphix-reporting, replacing the current delphix-reporting file.

The complete path to the config file should be: /etc/nginx/sites-available/delphix-reporting

Modifying the HTTPS Configuration FileOpen the config file at /etc/nginx/sites-available/delphix-reporting.Replace <# server_name #> with your server name. Note: this field must match the CN value in your certificate. You can use openssl onCentOS to look up the CN value in your certificate:

$ openssl x509 -noout -subject -in /etc/nginx/ssl/server.crt

Replace with the absolute path to your certificate. For example: /etc/nginx/ssl/server.crt<# certificate_path #>Replace : with the path to the server key associated with your certificate. For example /etc/nginx/ssl/server.key <# key_path #>The provided configuration file uses standard ports (port 80 for HTTP and port 443 for HTTPS). If you wish to use different ports you canupdate the config file (/etc/nginx/sites-available/delphix-reporting):

Update the HTTP port in the first server block:

...# http: route all traffic to httpsserver { listen 80 default_server; listen [::]:80 default_server ipv6only=on;...

Update the HTTPS port in the second server block:

..# https: pass all requests to Meteorserver { listen 443 ssl; server_name <# server_name #>;...

Run nginx -t to test your config files to make sure they are syntactically correct. If the test passes, you will see the following message:

$ nginx -tnginx: the configuration file /etc/nginx/nginx.conf syntax is oknginx: configuration file /etc/nginx/nginx.conf test is successful

If there is an error with your configuration file, such as missing a semicolon, you will get the following message:

$ nginx -tnginx: [emerg] directive "server_name" is not terminated by ";" in/etc/nginx/sites-enabled/delphix-reporting:20nginx: configuration file /etc/nginx/nginx.conf test failed


Restarting Nginx

To restart Nginx so that it uses the latest configuration enter the following command:

$ service nginx restart

All HTTP traffic will now be forwarded to HTTPS.

Delphix Reporting to Delphix Engines

To enable HTTPS traffic from Delphix Engines to Delphix Reporting, you will need to:

Generate a TrustStore to tell Delphix Reporting which certificates to trustConfigure Delphix Reporting to use HTTPS connection

Using TrustStores

A TrustStore file contains a list of certificates that Delphix Reporting should trust. By default, every Delphix Engine contains a self-signedcertificate. If you updated your engines with CA-signed certificates and you have a copy of these certificates, you may skip to Copying yourCertificate . step

Viewing your CA Certificate

To view your CA certificate on a 5.2.4.0 or later Delphix Engine, use the system admin CLI:


delphix.engine> cd service

delphix.engine service> cd tls

delphix.engine service tls> cd caCertificate

delphix.engine service tls caCertificate> ls

Objects

NAME REFERENCE ACCEPTED NOTAFTER

CN=CN=Delphix Engine delp... CA_CERTIFICATE-.. true 2022-04-24T19:23:26.000ZOperations

create

fetch

showProvidedCertificate

delphix.engine service tls caCertificate> select "CN=Delphix Enginedelphix.engine CA, O=Delphix, C=US"

delphix.engine service tls caCertificate 'CN=...'> toPEM

delphix.engine service tls caCertificate 'CN=...' toPEM *> commit

type: PemCertificate

contents: -----BEGIN CERTIFICATE-----

MIIDXDCCAkSgAwIBAgIEefhVnzANBgkqhkiG9w0BAQsFADBRMQswCQYDVQQGEwJVUzEQMA4GA1UE

...

aJa2s/bFLVHOFqdLTK8UCieFGVcIk63V/JVs7E+CwE8iPdI+jXhe+tZFEY04iIqN6r1CT5p5Ukqt

VFBxDZ6CF+zx

-----END CERTIFICATE-----

To upload a CA-signed certificate to each engine (recommended), please follow the directions in Replacing the HTTPS (HTTP Secure).Certificate

https://docs.delphix.com/display/DOCSDEV/Replacing+the+HTTPS+%28HTTP+Secure%29+Certificate

https://docs.delphix.com/display/DOCSDEV/Replacing+the+HTTPS+%28HTTP+Secure%29+Certificate


1.

2.

1.

2.

Copying your Certificate

If you have a copy of your certificates already, you can upload them on to your Delphix Reporting VM directly. Otherwise, copy and pastethe certificate PEM string (beginning with -----BEGIN CERTIFICATE----- and ending with -----END CERTIFICATE----- ) from above asa .crt file on your Delphix Reporting VM.Place the certificate files under a temp directory, for example, /tmp/certs. You may discard these certificate files once you imported themto the TrustStore.

Please contact Delphix Support if you lost your engine certificates or you weren’t able to use the CLI to view the CA certificate (for example, ifyour Delphix Engines are running older versions than 5.2.4.0).

Creating a New TrustStore

To create a new TrustStore, run the following command on Delphix Reporting VM:

$ keytool -import -alias CA -file /tmp/certs/CA.crt -keystore/var/delphix/dlpx.truststoreEnter keystore password: Re-enter new password:Owner: CN=Delphix Engine CAIssuer: CN=Delphix Engine CA, O=Delphix, C=USSerial number: 6d7dc112Valid from: Fri Apr 27 13:37:53 PDT 2018 until: Sat Apr 27 13:37:53 PDT2019Certificate fingerprints: MD5: 04:D7:CF:81:DF:2D:E2:72:63:6F:D3:A8:9C:76:BD:BC

SHA1: 1B:3F:01:B0:BB:75:FA:85:BD:B7:9A:9F:BA:97:47:29:7A:13:BE:43...Trust this certificate? [no]: yesCertificate was added to keystore

Please note the following:

The alias value is for distinguishing the certificate when you view the TrustStore. You can enter anything here but make sure you can linkit back to the Delphix Engine that this certificate came from.-keystore option specifies the name and the path of the output TrustStore file. While you could place this file anywhere on disk, werecommend you name it dlpx.truststore and place it under /var/delphix (as shown above).Please be sure to remember the keystore password. You will need it in the later step. If you lose it, Delphix Report be able toWILL NOTrecover it.Make sure to mark this certificate as trusted by entering yes when prompted (as shown above).If all of your Delphix Engines are signed by one CA, it’s sufficient to only include the CA certificate in the TrustStore. Otherwise pleaserepeat this command to import the certificates from every Delphix Engine.

Turning on HTTPS Connection via the Command Line Tool

After the TrustStore is configured, run the following command as root:

$ delphix-https-config

This command will invoke a CLI application to allow you to enable HTTPS connection.Enable HTTPS and configure the path to your TrustStore. Here's an example of how to enable HTTPS and configure the TrustStore path

If all of your engines are signed by one CA, it’s sufficient to only upload the CA certificate. Otherwise please upload the certificate fromall your Delphix Engines.


2.

1.

and password:

> update useHttpsUpdating useHttps> trueuseHttps updated.

> update trustStorePathUpdating trustStorePath> /var/delphix/dlpx.truststoretrustStorePath updated.

> update trustStorePasswordUpdating trustStorePassword>Please enter your password again...Updating trustStorePassword>trustStorePassword updated.

Make sure to enter the absolute path to the TrustStore (i.e. /var/delphix/dlpx.truststore) and the password you used to create theTrustStore file. Additionally, you may also specify whether self-signed certificates are allowed.

It is important to remember your TrustStore password. For security reasons, once the trustStorePassword is set, this application will not letyou update any other settings without entering your TrustStore password.

Restarting the Delphix Collector Service

After you updated the HTTPS configurations, please restart the Delphix Reporting Service so the new settings can take effect:

$ service delphix-collector restart

Delphix Reporting should now connect to Delphix Engines via HTTPS.

Delphix Reporting Configuration

Activity One: Import the OVA file for Delphix Reporting into a VM guestAlternative: Setup for Cloudstack

Add Delphix Reporting to the NetworkLogging InNavigating the Delphix Reporting Toolbar and User InterfaceViewing ReportsConfiguring Delphix Reporting

Configure ReportsReport ScriptsScript ConfigurationEmail Reports Activity Two: Configure, Automate, and Email Delphix Reporting Reports

Configure EnginesConfigure Users

Activity Three: Add Delphix Engines to Delphix ReportingActivity Four: Add UsersActivity Five: Change a User PasswordRelated Links

Activity One: Import the OVA file for Delphix Reporting into a VM guest

If you enable HTTPS, you must also configure trustStorePath and trustStorePassword, otherwise, the Delphix service will not workcorrectly.


1. 2. 3. 4.

1. 2.

a. b. c. d. e. f.

g. 3. 4. 5. 6. 7. 8.

9. 10. 11. 12. 13. 14.

1. a.

2. a.

3. 4.

a. b. c. d.

e. f.

5. a.

6. a.

i. ii.

b. 7.

a.

Using the vSphere client, login to the vSphere server where you want to install Delphix Reporting.Click File.Select Deploy OVA Template.Select the Delphix Reporting OVA file.

Alternative: Setup for Cloudstack

If your organization uses Cloudstack instead of VMWare, you can still use Delphix Reporting. After locating the image on the Delphixqcow2download site, follow the steps below to configure Delphix Reporting:

Launch the Cloudstack user interface.Create a new template (Register Template) with the following parameters:

Name: <any name>Description: <any description>URL: <url_to_the_qcow2_image>Zone: <any name>Hypervisor: KVMFormat: QCOW2OS Type: CentOS 6.5 (64-bit)

Wait for the template to be downloaded and installed into the appropriate zone(s) and for the status to be Ready.In , click .Instances Add InstanceSelect a in which to run Delphix Reporting.ZoneClick .TemplateSelect the template you just created.Choose a .Compute Offering

For , do not add any additional disks.Disk OfferingSelect any affinity groups to which you want this VM to belong.Select a .security groupGive the new instance a .nameLaunch the VM.The Delphix Reporting web application should be accessible via the assigned IP.

Add Delphix Reporting to the Network

By default, Delphix Reporting is configured to use DHCP to acquire an IP address. If this is acceptable within your organization, then DelphixReporting should be immediately accessible at the IP hostname assigned to the VM guest within vSphere.

However, many organizations do not support the use of DHCP by servers on their network. In that case, you will need to log into DelphixReporting as via the console provide by vSphere, and work with your network administrator to perform the following actions to set up a staticrootIP address on the VM guest.

Connect to the VM guest (running a stripped-down version of Linux) as . The initial default password is .root delphixChange this password as soon as possible.

Run the Linux command .ifconfig -a | grep -i hwaddrRecord the output for later use. This should be six hexadecimal numbers delimited by colons, such as HwAddr 0A:1B:2C:4D:

.5E:6FChange to the directory ./etc/sysconfig/network-scriptsEdit the file to make the following changes:ifcfg-eth0

Copy the existing file to another name like .ifcfg-eth0 ifcfg-eth0.saveChange to .bootproto=dhcp bootproto=staticUsing the value saved from step #2 above, add a line reading .HwAddr HWADDR=<hwaddr-value-captured-above>Using an available IP address value obtained from your network administrator, add a line reading IPADDR=<available-IP-ad

.dress>Using an IP netmask value obtained from your network administrator, add a line reading .NETMASK=<netmask-spec>Save the changes.

Make sure that output from the command matches the value set within vSphere.hostnameIf the output does not match, use the Linux command to set it.hostname <short-IP-hostname-value>

Create a default gateway route for the static IP address assigned above.Typically, the default gateway address has the fourth digit of ".1" for the IP address of the server.

The server at IP address might have a gateway of .192.168.7.10 192.168.7.1Obtain the gateway IP address from your network administrator.

Use the Linux command .route add default gw <gateway-IP-address>Make sure that the contents of the file are set appropriately to permit DNS name resolution./etc/resolv.conf

The Compute Offering should have at least 2 CPU cores with 4GB of memory.


7.

a.

b.

8. a.

1.

2.

Ensure that the line that specifies the IP domain name is correct for your network. For example, for servers within Delphix, the

line reads .domain delphix.comEnsure that at least one (and preferably two or more) DNS nameserver IP addresses are specified and that they are reachable

via "ping." For example, each line should read nameserver <DNS-nameserver-IP-address>. Running the Linux command ping <DNS-nameserver-IP-address> shouldcomplete successfully.

Once you have made all of these changes, restart network services on the Linux OS.Run the Linux command and ensure that it completes successfully.service network restart

Logging In

Access Delphix Reporting by opening a web browser using the IP address or DNS qualified host name. Delphix Reporting does notcurrently support SSL connections, so you should use http, not https.Delphix Reporting ships with one generic Delphix Admin User. The User ID is and the password is .delphix_admin delphix

Once logged in as the Delphix Admin User, change your password. You can find instructions to do this in the sectionChange a User Passwordbelow.

Navigating the Delphix Reporting Toolbar and User Interface

The Delphix Reporting Toolbar appears after logging into Delphix Reporting. The navigation bar enables you to analyze, manage, and configure data reporting for a Delphix deployment. The View Report drop-down menu appears on the left-hand side of the toolbar. The , configuration help

, and buttons appear on the right-hand side of the toolbar. Below is a screenshot of the toolbar as well as a brief summary of theloginfunctionality available.

Delphix ReportingToolbar

Viewing Reports

The functionality provides aggregated data across all connected Delphix Engines and presents it as a set of different reports. YouView Reportscan select these reports from the drop-down menu. Delphix Reporting has automated features that check for updates across all DelphixEngine and sync these updates into reports every 10 minutes. To refresh the currently displayed report manually, click .Refresh

http://delphix.com


Reports menu

Interactive reports such as Storage Breakdown and History display interactive graphical representations of historical and current storage usageacross all Delphix Engines you are monitoring. These visualizations of storage and disk capacity enable you to analyze and mediate storageacross Delphix Engine from multiple perspectives.


1.

2.

Graphs tab

Configuring Delphix Reporting

Clicking the configuration icon in the upper right-hand corner of the screen brings up four configuration tabs: Reports, Engines, Users, and System. Read below for more details.

Configure Reports

The Reports tab is the central place to configure settings, create scripts, and email reports in Delphix Reporting. There are three sections: Report, (tunables), and . The documentation below describe how to navigate and work in each of thesescripts Script configuration Email reports

sections.

To navigate to the configuration tab:Report

, click the configuration icon. On the right-hand side of the toolbar Click Reports.

Report Scripts

You can use report scripts to:

Enable/disable individual reports to determine which ones are available in the menureports drop-downDelete reports

Deleted reports are no longer generated in Delphix Reporting


1. 2. 3.

Upload new reports

Script Configuration

To configure tunable parameters for specific reports, click the field in the value column to make it editable.

Report Scripts Section

Email Reports

You can configure Delphix Reporting to:

Send email reports which automatically send tabular data to any number of email addressesSend emails on daily, weekly, or monthly schedulesCustomize the way the data is presented in emails by choosing the sort column and limiting the number of rows.

To access the Email Reports section:

, click the configuration icon. On the right-hand side of the toolbarClick Reports. Scroll down to Email Reports.

This is an experimental feature. Please contact Delphix if you are interested in customizing existing reports or creating newones.


1. 2. 3. 4.

Email Reports Configuration

Activity Two: Configure, Automate, and Email Delphix Reporting Reports

This activity will walk you through the system and report configuration and automation features that facilitate emailing Delphix Reporting reports inthe configuration section. To begin, you will need to navigate the the configuration icon and select system configurations first inEmail Reportsorder to enable system connections such as the SMTP server.

, click the configuration icon. On the right-hand side of the toolbar Click . SystemScroll down to .EmailClick .Edit Settings


4.

5. 6.

7.

Delphix Reporting Configuring Email System

Populate all the fields in the Edit Email Settings as seen below.Click Save changes.

Delphix Reporting Email Settings


7. 8.

1. 2.

1. 2.

Now that SMTP has been configured, navigate to the Reports Configuration page and scroll down to Email reports.Follow and complete the three-step process as illustrated below to begin automating and emailing Delphix Reporting reports.

Delphix Reporting Email Reports Configuration Window

: Required . A series of fields will appear to help guide the configuration and automation of emailing selected DelphixClick Add Email ReportReporting reports. The following is a description of each of these fields.

The Report field provides a selection of the specific Delphix Reporting report you would like to use for the Email Report function.

Sort by Selection provides a drop-down of the column you wish to sort by, which varies based on the report you have selected above,

and whether the results should be ascending or descending. In the Limit the Report To fields, a selection choice appears allowing you to run and email a report with all data rows or to enter thenumber of data rows you would like included in the report.In the Schedule field, fields are provided to select the scheduled day and time that you want the report to be sent. In the Send to field, enter the to which you want to send the report.email addresses

Once you have configured all of the fields above, save the information by clicking .Add Email Report The newly added report will appear. Youwill then have access to additional features to edit, send a report now, or click the X button to delete the report.

: Optional Click the Edit button when you need to change or enter new information into any of the configuration fields found in the Add Email Report functionality.

Optional: Click the Send Now button to either:

Send a test email report during the process of configuring an email report in order to verify the report settings or design. OrSend a one-off email outside of an automated and scheduled email report.

Configure Engines

To navigate to the Engines screen, as seen below:

, click the configuration icon. On the right-hand side of the toolbar Click Engines.

The Engines tab lists all Delphix Engines that you have added to Delphix Reporting. The Status column shows whether Delphix Reporting isconnected to each platform; it will prompt a specific error message if it is unable to connect. To remove an engine from Delphix Reporting:

Click the X icon next to the engine you want to delete.

Only tabular reports are available for email.

Use a comma to separate email addresses.


2.

1. 2.

1.

2. 3. 4. 5.

In the confirmation dialog, click .OK

Configure Engines Tab

Configure Users

To navigate to the Users screen, as seen below.

, click the configuration icon. On the right-hand side of the toolbarClick . Users

The Users tab displays the set of user accounts that have permission to access Delphix Reporting. You can assign tags to auditor users torestrict which Delphix Engines and containers they can see. For more information, see the activity below.How to Assign Tags

Users Tab

Activity Three: Add Delphix Engines to Delphix Reporting

Access Delphix Reporting with a supported web browser using its I P address or DNS qualified host name. Supported web browsersinclude Chrome 37, IE 11, Safari 7, and Firefox 32.Click the Engines tab in the Delphix Reporting Toolbar.Click .Add EngineIn the .Hostname field, enter the Delphix Engine's IP address or hostnameEnter a username and password.

The user must have at least an auditor role on the target Delphix Engine.


1.

2.

3. 4. 5. 6.

1.

2.

3. 4.

Adding a Delphix Engine

Activity Four: Add Users

, click the configuration icon. On the right-hand side of the toolbar Click Users. Click .Add userEnter a . username and password Select . auditor or adminInform the newly created user of their user ID and password login credentials.

Activity Five: Change a User Password

, click the configuration icon. On the right-hand side of the toolbar

Click Users.

, click the In the upper right-hand corner user , name for which you need to change password.Click Change password.

Related Links

Search and Run ReportsFilter, Organize, and Extract Reports

Search and Run Reports

Activity Six: Search and View a ReportEngine Activity ReportsHealth ReportsSource ReportsStorage ReportsVDB ReportsRelated Links


1. 2.

Reports are the heart of Delphix Reporting. Reports gather data that spans all connected Delphix Engines and presents the data in a singlelocation.

Activity Six: Search and View a Report

Click View Report. Click the report drop-down menu to reveal a selection of report options, as seen below.

Five new category sections appear to help you quickly locate the report of your choice. They are: , , , , andEngine Activity Health Source Storage.VDB

Reports of interest may include the Storage Summary report found under Storage, allowing you to view, compare, and analyze storage usageacross Delphix Engines. Other useful reports include Active Faults, SnapSync, and Replication Summary. Below is a summary list of allreporting categories found under View Reports and a description of the reports found under each category.

Running a Report

Engine Activity Reports

Audit Log: Provides a view of all actions that have been performed on all Delphix Engines. This includes both user- and system-executedactions.


Audit Log Report

Bookmarks: Tracks Jet Stream (Delphix Self-Service) bookmark usage across a Delphix Self-Service deployment, particularly in relation tostorage/capacity, as bookmarks pin storage on the Delphix Engine.

Recent Jobs: Covers all jobs across all Delphix Engines, such as provisioning or refreshing a VDB.

Replication Status: Allows you to validate that replication is running successfully across all Delphix Engines where it has been configured. Ifreplication is not running successfully, it allows you to determine the cause.

Health Reports

Active Faults: Presents a consolidated view of faults across all Delphix Engines, along with suggested actions (in the “Action” column) to resolvethe fault. When you have identified and fixed a fault, an administrator can go to the affected engine and mark the fault as resolved through theGUI or CLI.


Active Faults Report

Engine Summary: A high-level overview report of all Delphix Engines. It contains version and engine information, the number of faults and recentjobs, and critical alerts for each engine.

Recent Alerts: Alerts are events that have occurred, their severity, and the point in time at which they occurred. The Recent Alerts reportcombines the alerts and their associated information across engines.

Replication Status: If you work with multiple Delphix Engines, it can be difficult to keep track of the various replication jobs. This report helps youdetermine quickly whether everything is running smoothly or whether a certain replication job is failing.

Replication Status Report

Source Reports

dSource Usage: Shows a list of dSources with the following information for each:

Actual disk capacity the dSource usesUnvirtualized capacity – that is, the disk space that would be required if not using Delphix EnginesPercentage storage savedNumber of VDBs that are currently provisioned from the dSource

SnapSync Summary: Allows you to validate that SnapSync is occurring as expected and to compare the current and average duration ofSnapSync operations. The duration of SnapSync operations may vary based on the size of the database, available network bandwidth, anddatabase configuration – for example, whether change block tracking (CBT) is enabled. You can use this report to easily find the dSources forwhich SnapSyncs take the longest.


SnapSync Summary Report

Storage Reports

Storage Breakdown

Using the information displayed with the Total button, you can:

Determine which engines have the most free space and identify good candidates for new dSources/VDBsDetermine which engines have the least free space, identify which engines need additional storage or require storage to be freed, andidentify which engines may require different retention policiesDetermine which engines have the most space used by VDBs and take actions such as refreshing VDBs or removing unneeded VDBsand/or VDB snapshotsDetermine which engines have the most space used by dSources and identify source breakdown to see how capacity is used for dSourcedata. If needed, you can make appropriate changes to free up space.

Using the information displayed with the Source button, you can determine which engines have the most space used for logs and snapshots andmodify retention policies or refresh VDBs to release old snapshots.

Storage Breakdown Report

Storage History: Clicking the Historical tab summarizes total storage usage of all monitored engines for the past 30 days. Storage Summary: Shows the total, used, and available storage for each engine, which allows you to identify when you are approaching alow-storage availability state.


Storage Summary Report

VDB Reports

VDB Inventory: Shows a consolidated list of all virtual datasets (VDBs and vFiles) that have been provisioned from a data source using theDelphix Engine. This report contains the same data as the top-level Containers tab. You can use this report to easily identify where each virtualdatabase is located.

VDB Inventory Report

VDB Refresh Summary: Allows you to verify that refreshes are happening as expected and to compare the current and average duration ofrefresh operations.

VDB Usage: Shows a list of VDBs with the following information for each:

Actual disk capacity the VDB usesUnvirtualized capacityPercentage of storage savedDate of most recent refresh operation or, if never refreshed, date when VDB was provisioned


1.

2. 3. 4. 5.

VDB Usage Report

Related Links

Understanding the Graphs Interface

Filter, Organize, and Extract Reports

Filter, Organize, and Extract Reports

TaggingActivity Seven: Apply Tags

FilteringActivity Eight: Extracting Data from ReportsRelated Links

Tagging

You can tag Delphix Engines in Delphix Reporting with a set of arbitrary text strings. You can then filter reports to show only data from DelphixEngines with a certain tag. You can also use tags to restrict auditor users so that they can only view data from Delphix Engines with that tag.

Activity Seven: Apply Tags

lick the configuration icon. On the right-hand side of the toolbar, c

Click Users. Click the space under the Tag headline.Enter any text string.Click OK.


1.

2.

3. 4. 5.

Applying Tags

The screenshot below illustrates how to use a tag to filter the kinds of data and reports an Auditor User can access.

lick the configuration icon. On the right-hand side of the toolbar, c

Click Users. Click in space under the Tag headline.Enter the tag category configured for the Auditor User.Click OK.

Applying Tags to Users

Once you apply the tag filter, the Auditor User will only have access to reports and data associated with that tag.

Filtering

Each report contains a free-text filter field. Using this filter allows you to search all displayed columns and returns all rows that have at least onematch. Examples of report filtering include:

Identifying certain types of faultsIdentifying all assets related to an engineLocating a virtual database by name

Activity Eight: Extracting Data from Reports

Once you have selected the report you are interested in viewing, you will be able to extract the report data with a variety of options. Extract andsave the report data by clicking Copy, CSV, PDF, or Print on the right-hand side. Click the option of your choice to extract and save the report.The screenshot below highlights the sequence of steps to extract reports.


Extracting Data From Reports

Related Links

Search and Run ReportsUnderstanding the Graphs Interface

Understanding the Graphs Interface

Activity Nine: Viewing Storage Breakdown ReportsWorking with Total Storage GraphsWorking with Source Usage Graphs

Activity Ten: Viewing Storage History ReportsRelated Links

The View Report drop-down menu on the Delphix Reporting Toolbar includes interactive graphical representations of historical and currentstorage usage across all Delphix Engines you are monitoring.

These include visualizations of Storage Breakdown and Storage History. provides different ways of viewing data,Storage Breakdownincluding Total to interact with graphs containing the current total storage on all engines and Source to view the breakdown of disk capacitycurrently used for dSource data. Storage History provides a graphical interface to analyze all historical storage data collected by monitoredengines in the past 30 days.

The following activities provide more detail for how to interact with the graphs.

The View Report Drop-Down Menu in the Delphix ReportingToolbar

Activity Nine: Viewing Storage Breakdown Reports


Selecting allows you to analyze current storage usage by and Storage Breakdown Total Source .

Working with Total Storage Graphs

Clicking the Total button presents an interactive data visualization of total storage on each Delphix Engine. The bar graphs show the breakdownof all disk capacity between:

Source – The capacity used for dSource dataVirtual – The capacity used for VDBsFree space – The amount of available free space on the engine

The Category Legend Key on the right-hand side, shown in the screenshot below, helps you see how your current storage is distributed.

Graphical Visualization of Storage Capacity Breakdown for All Engines

To display engines according to a particular category:

Click a category in the Category Legend Key.

The engines will appear in order according to the category you chose to prioritize. In the screenshot above, Total has been prioritized.

Using the information displayed with the Total button, you can:

Determine which engines have the most free space and identify good candidates for new dSources/VDBsDetermine which engines have the least free space, identify which engines need additional storage or require storage to be freed, andidentify which engines may require different retention policiesDetermine which engines have the most space used by VDBs and take actions such as refreshing VDBs or removing unneeded VDBsand/or VDB snapshotsDetermine which engines have the most space used by dSources and identify source breakdown to see how capacity is used for dSourcedata. If needed, you can make appropriate changes to free up space.

Working with Source Usage Graphs

Selecting the Source button presents an interactive data visualization from a source perspective. The bar graphs show how much of eachengine’s storage space is used by:

Active Source Data – The capacity used for current active copy of dSourcesManually Retained Snapshots – The capacity held exclusively due to manually retained snapshotsSnapshot Retention – The capacity held due to snapshot retention policy, either exclusively or in combination with manual settingsSnapshots for Dependent VDBs – The capacity of snapshots held due to VDBs that have been provisioned from them, eitherexclusively or in combination with policy or manual settingsLog Retention – The capacity held due to LogSync retention policy.

The Category Legend Key on the right-hand side helps you see how your current storage is distributed.


Graphical Visualization of Storage Capacity Breakdown for All Engines by Source

To display engines according to a particular category:

Click a category in the Category Legend Key.

The engines will appear in order according to the category you chose to prioritize. In the screenshot above, Active Source Data has beenprioritized.

Using the information displayed with the Source button, you can determine which engines have the most space used for logs and snapshots andmodify retention policies or refresh VDBs to release old snapshots.

Activity Ten: Viewing Storage History Reports

Clicking the Storage History Report visually summarizes total storage usage of all monitored engines for the past 30 days. In this tab, a linegraph appears with the historical storage data for the selected Delphix Engine(s) and a drop-down list of Delphix Engines from which to choose,as seen in the screenshot below.

Storage History for Top Five Engines

By default, the above graph shows historical details of the top five engines, based on the most recent data point. However, you can choose whichengines’ details to display by selecting it from the drop-down menu.

The screenshot below illustrates using the scroll bar at the bottom to hone in on a particular time and date of capacity use. Use your mouse andhover over interesting points on the graph for specific storage information. A rollover box will appear with specific information.


1. 2.

Specific Historical Storage Capacity Details

Related Links

Delphix Engine Configuration

Delphix Reporting Maintenance

Managing the Operating SystemActivity Eleven: Delphix Self-Service Upgrade of Delphix ReportingActivity Twelve: Generate and Upload MC Support BundlesRelated Links

Managing the Operating System

Delphix Reporting runs as an open virtual appliance. The underlying operating system, CentOS, can be modified or patched as needed. For bestpractices, please refer to the official documentation: https://www.centos.org/docs/

To manage the appliance or the Operation System or to upgrade, you must have root access. The default root password is . You shoulddelphixchange this as soon as possible.

To navigate to the screen, as seen below:System

On the right-hand side of the toolbar, click the configuration icon.Click .System

Here you can view the current version of Delphix Reporting.

Note: Any changes to files related to Delphix may result in an unusable system. These files are stored in the following locations:

/opt/delphix/var/delphix/var/log/delphix

https://www.centos.org/docs/


1.

2. 3. 4. 5. 6.

System Tab

Activity Eleven: Delphix Self-Service Upgrade of Delphix Reporting

When a new version of Delphix Reporting is available, download the upgrade script from Delphix.


Click System. Scroll down to the Upgrade section.Click Choose file.Select the upgrade script.Click Upload & Install.

Upgrading Delphix Reporting

Activity Twelve: Generate and Upload MC Support Bundles


1.

2. 3. 4. 5.

You only need to do this when Delphix support requests that you send a Delphix Reporting support bundle.


Click System. Scroll down to the Support section.Enter the case number if provided by Delphix support.Click Submit.

Related Links

Delphix Reporting ConfigurationGetting Started with Delphix Reporting

Support for Delphix Reporting

To file support requests from the support portal please go to https://support.delphix.com.

Additional support is available with the Delphix community at https://community.delphix.com/delphix under the “Delphix Reporting” category.

https://support.delphix.com/

https://community.delphix.com/delphix

Date post:	16-Mar-2020
Category:	Documents
Upload:	others
View:	8 times
Download:	0 times

Delphix Reporting Admin Guide...Run€nginx -t€to test your config files to make sure they are...

Documents