Skip to main content
Delphix

Automating Script Install Of Delphix Connector For Windows Target and Staging Environments (KBA1363)

 

KBA

KBA#1363

Applicable Delphix Versions

Click here to view the versions of the Delphix engine to which this article applies
Major Release All Sub Releases
6.0 6.0.0.0, 6.0.1.0, 6.0.1.1, 6.0.2.0, 6.0.2.1, 6.0.3.0, 6.0.3.1, 6.0.4.0, 6.0.4.1, 6.0.5.0

5.3

5.3.0.0, 5.3.0.1, 5.3.0.2, 5.3.0.3, 5.3.1.0, 5.3.1.1, 5.3.1.2, 5.3.2.0, 5.3.3.0, 5.3.3.1, 5.3.4.0, 5.3.5.0 5.3.6.0, 5.3.7.0, 5.3.7.1, 5.3.8.0, 5.3.8.1, 5.3.9.0

5.2

5.2.2.0, 5.2.2.1, 5.2.3.0, 5.2.4.0, 5.2.5.0, 5.2.5.1, 5.2.6.0, 5.2.6.1

5.1

5.1.0.0, 5.1.1.0, 5.1.2.0, 5.1.3.0, 5.1.4.0, 5.1.5.0, 5.1.5.1, 5.1.6.0, 5.1.7.0, 5.1.8.0, 5.1.8.1, 5.1.9.0, 5.1.10.0

5.0

5.0.1.0, 5.0.1.1, 5.0.2.0, 5.0.2.1, 5.0.2.2, 5.0.2.3, 5.0.3.0, 5.0.3.1, 5.0.4.0, 5.0.4.1 ,5.0.5.0, 5.0.5.1, 5.0.5.2, 5.0.5.3, 5.0.5.4

4.3

4.3.1.0, 4.3.2.0, 4.3.2.1, 4.3.3.0, 4.3.4.0, 4.3.4.1, 4.3.5.0

4.2

4.2.0.0, 4.2.0.3, 4.2.1.0, 4.2.1.1, 4.2.2.0, 4.2.2.1, 4.2.3.0, 4.2.4.0 , 4.2.5.0, 4.2.5.1

4.1

4.1.0.0, 4.1.2.0, 4.1.3.0, 4.1.3.1, 4.1.3.2, 4.1.4.0, 4.1.5.0, 4.1.6.0

Troubleshooting Automating Installation via Script

In larger environments, it may be desirable to automate the installation of the Delphix Connector package, rather than walking through the UI install and configuration.  This document provides a methodology for executing this via PowerShell, et cetera.

Resolution for MSI and EXE Packages

The following sections contain the proper commands for the DelphixConnector silent install and uninstall using the command line.  There are currently two styles of packages based on the Delphix engine release version.

  • MSI package (pre-6.0.5.0 Delphix release) known as DelphixConnectorInstaller.msi
  • EXE package (6.0.5.0 and forward Delphix release) known as DelphixConnectorInstaller.exe

MSI Silent Install and Uninstall

As the Delphix Connector installer is distributed as a Windows installer (.msi) file, the installation can be completed silently from PowerShell using msiexec, which can greatly accelerate the deployment to target and staging hosts. 

Microsoft provides details on the msiexec execution options available at this hyperlink:

https://msdn.microsoft.com/en-us/library/windows/desktop/aa367988(v=vs.85).aspx

To execute a complete installation in quiet mode, with logging, an example is provided below: 

C:\Users\Administrator> msiexec /i C:\Users\Administrator\Downloads\DelphixConnectorInstaller.msi /quiet /qn /log C:\delphix_msi_log.txt

This command executes the installation using the .msi provided by Delphix, and places the installation log under C:.  The location of this log can be modified as desired.  

The DelphixConnnector installation defaults to C:\Program Files\Delphix\DelphixConnector. If an alternate installation path is desired, add the TARGETDIR property.  The next example installs the package to D:\DelphixConnector instead:

C:\Users\Administrator> msiexec /i C:\Users\Administrator\Downloads\DelphixConnectorInstaller.msi /quiet /qn /log C:\delphix_msi_log.txt TARGETDIR="D:\DelphixConnector"

Note that if the installation requires the default TCP port for the connector (9100) to be altered, the current GUI installation must be leveraged.  This behavior may be altered in a future release.

The uninstallation can be completed silently from PowerShell using msiexec:

C:\Users\Administrator> msiexec /x {5FA36D43-10B7-4CA4-ADA0-9781E5BF70C8} /qn /l* uninstall.log

EXE Silent Install and Uninstall

The installation can be completed silently from PowerShell.

To execute a complete installation in quiet mode, with logging, an example is provided below (spaces between options and values are not required): 

C:\Users\Administrator>C:\Users\Administrator\Downloads\DelphixConnectorInstaller.exe /s /id"C:\Program Files\Delphix\DelphixConnector" /cp"9100" /nfv"3.5" 

Explanation of options (all the options listed for command line operation are case insensitive):

  • /s: For Silent installation, mandatory for silent installation from command line
  • /id: To specify install directory, optional, default will be "C:\Program  Files\Delphix\DelphixConnector"
  • /cp: Connector Port, mandatory.
  • /nfv: .NET Framework version, to be used during installation. optional, If not provided, it will be read from the registry.
  • /jp: Custom Java Path, optional, default will be part of connector

The uninstall can be completed silently from PowerShell:

C:\Users\Administrator>C:\Program Files\Delphix\uninstall.exe /s

All the options listed above for command line operation are case insensitive.