Skip to main content

Using the Masking DXM Toolkit (DXM) for Reporting Purposes (KBA7628)




KBA# 7628

Applicable Delphix Versions

Click here to view the versions of the Delphix engine to which this article applies
Major Release All Sub Releases

How to generate masking reports using the DXM toolkit.

As a masking administrator or user, you may need to generate reports.

For example, you may be required to generate a list of Environments and the Connectors and Rulesets defined within those environments. Another example could be the need to get a list of the masked columns and show what masking algorithms are assigned to, or are used to, mask those columns.  

Uses cases for the information:

- There is a need to identify which columns are masked by a particular algorithm where, for example, there is a need to change the algorithms in use.

- Auditing/checking that the appropriate algorithms are being used to mask columns.

The Masking API can be used to retrieve this information. However, it could take several steps to collate the information, and the information is not returned in a user-friendly or readable format. Therefore we can use the DXM Toolkit.

To Install and access DXM Toolkit Reporting


  1. Install the DXM Toolkit:
    1. Take note of your masking engine IP/host address, for example, and masking user login and password, by default this isadmin and Admin-12. Ensure that the username and password is correct.
    2. Download the toolkit file from:
  • This example is using dmx from a Linux host. (There are toolkit packages downloadable also for Mac OSX and Windows).
  • You can also download through the browser by clicking on the file that you need for your platform.


--2021-05-10 10:10:44--

Resolving (

Connecting to (||:443... connected.

HTTP request sent, awaiting response... 302 Found


Connecting to (||:443... connected.

HTTP request sent, awaiting response... 200 OK

Length: 13705838 (13M) [application/octet-stream]

Saving to: ‘dxmc-v0.8.2.1-redhat7.tar.gz’

100%[======================================================================================================================================================================================================>] 13,705,838 39.7MB/s in 0.3s

2021-05-10 10:10:45 (39.7 MB/s) - ‘dxmc-v0.8.2.1-redhat7.tar.gz’ saved [13705838/13705838]


  1. Uncompress the toolkit file, for example:

 gunzip dxmc-v0.8.2.1-redhat7.tar.gz
 tar -xvf dxmc-v0.8.2.1-redhat7.tar

The toolkit is now installed on your Linux host.

  1. You can see what command-line options are available by issuing:

 cd dxmc
./dxmc --help

This will return the options/parameters available:

Usage: dxmc [OPTIONS] COMMAND [ARGS]...

dxmc is a Delphix Masking Toolkit command line interface This command can

be used to run all applications

If option --engine is not specified, dxm will run all actions against

masking engines configured with default option set to Y.

To run command on all engines configured for this toolkit use all as a



--version Show the version and exit.

--help Show this message and exit.


algorithms   Algorithm group allow to control Algorithm

application   Application group allow to control applications

column    Column group allow to control inventory

connector   Connector group allow to control environments

domain   Domain group allow to control domains

engine   engine is a group of command to add, delete and list Masking...

environment   Environment group allow to control environments

expression   Expression group allow to control Profile expressions

fileformat   Filetype group allow to control file types

job   Job group allow to control job

meta   Meta group allow to control tables and files metadata

profilejob   Profile job group allow to control Profile jobs

profileset   Profileset group allow to control Profile Sets

role   Role group allow to control user roles

ruleset   Ruleset group allow to control rulesets

sync   Sync objects between engines or export/import to files

user   User group allow to control users


  1. Add the masking engine to be used.

./dxmc engine add --engine md607msk --ip --username admin --default Y

You are prompted for:
Password:       <<---- enter the password for user
Repeat for confirmation:      <<---- enter the password for user

Engine added to the configuration

To confirm the 'engine add' worked:

./dxmc engine list

Engine name IP username protocol port default proxy URL proxy user

============================== ============================== ============================== ======== ===== ======= ============================== ==============================

md607msk admin http 80 Y N/A N/A

Issue another command, for example:

./dxmc environment list

Engine name Environment name Application name

============================== ============================== ==============================

md607msk MD_Masked_provisioning template_ENV

md607msk Testing_for_orac_masking template_ENV


  1. To get help or usage info for an option use the  --help argument, for example:

./dxmc column --help

Usage: dxmc column [OPTIONS] COMMAND [ARGS]...

Column group allow to control inventory


--help Show this message and exit.



batch Set / unset masking for columns specified in CSV file.

list Display list of columns (inventory) defined in Masking...

replace Change an algorithm for column(s) from algname to...

save Save column masking rules (inventory) into CSV file which...

setmasking Setting a masking algorithm for defined column and flagging...

unsetmasking Deleting a masking algorithm from defined column and...


  1. You are now ready to explore the Toolkit's reporting capabilities. Here are some examples:

 ./dxmc ruleset list

Screenshot 2021-05-10 at 17.12.50.png

./dxmc column list

Screenshot 2021-05-10 at 15.57.22.png

In the example above we can see what algorithms have been assigned the columns.


Related Articles

The following articles may provide more information or related information to this article: