Skip to main content

Creating a File Masking CIFS/SMB Connection (KBA7488)




KBA# 7488

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 Create a File Masking CIFS/SMB Connection

The aim of this knowledge article is to provide an example of setting up a Common Internet File System (CIFS) connection for file masking. This includes delimited, flat, and XML files.


  • A Delphix Masking Engine of Version 6 or higher.
  • Port 445 open between the masking engine and the target server.
  • Access to the Masking Engine API-Client (or API).
  • An Administrator level user account.

To set up the CIFS connection

Complete the following procedure to create the CIFS connection.

  1. Navigate and log in to the Masking engine API-client. 
    1. The Masking API client can be accessed by adding 'API-Client' to the end of the masking engine URL:
      For example
    2. Log in and authorize the API connection:


  2. Ensure the folder is being shared, Windows Example:
  3. Add the CIFS configuration to the mountFilesystem part of the API-Client.
    Open the mountFilesystem section of the API client.

    In the Body enter the required CIFS parameters Example:

    "mountName": "my_new_cifs_connection",
    "hostAddress": "",
    "mountPath": "/filemasking",
    "type": "CIFS",
    "connectOnStartup": true,
    "options": "username=delphix,password=delphix,,vers=3.0"

    Please note that the mountPath must be a slash / not a backslash \ when creating the connection. 

    Further mount options and information can be found in the documentation:

  4. You will need to know the mountID. Each time a new mountFilesystem is added, this value will increment by one. All of the available mounts can be listed in the GET /mount-filesystem section, this will show all the available mounts and the mountID value.
  5. You now need to Connect the masking engine to the CIFS share, this is again done through the API-Client. Enter the mountID value and Execute, this should now be connected.

  6. The status of the connection can be checked by either the GET /mount-filesystem/ or GET /mount-filesystem/{mountID}
    If everything is working, then 'ACTIVE' should be displayed.

  7. The masking file connection can be created. Under the Mount Name the newly configured CIFS connection will be visible:

  8. The Rule Set can be created and should display all the files under the remote directory:


If any issues are encountered please either post on our community pages or reach out to Delphix support for assistance.


Related Articles

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