Skip to content

Home

Jump to bottom
Marcin Przepiorowski edited this page Oct 6, 2017 · 20 revisions

Overview

DxToolkit is a set of scripts, which are delivered by Delphix professional services team. DxToolkit scripts look and feel like UNIX executables, following the typical conventions of using flags for arguments. DxToolkit is written in Perl, but no knowledge of Perl is required unless you want to extend it. In fact, no programming experience whatsoever is required to use the DxToolkit.

Working with DxToolkit

Configuration

DxToolkit reads the configuration file in JSON format. By default it's looking for dxtools.conf file in location of dxtoolkit script. Configuration file location can specified by -configfile parameter or value of environment variable DXTOOLKIT_CONF.

Field description

  • hostname Delphix identifier
  • ip__address Delphi appliance IP address or hostname
  • username Delphix username
  • password Delphix username password [ if password is blank or not specified script will ask for it and create a session ]
  • port Delphix port no
  • default true|false
  • encrypted true|false <true – encrypted password in dxtools.conf>
  • protocol http|https

Example

{
	"data":[
	{
		"hostname" : "Landshark",
		"ip_address" : "delphix01",
		"username" : "delphix_admin",
		"password" : "delphix",
		"port" : "80",
		"default" : "false",
		"encrypted" : "false",
		"timeout" : "60"
	},
	{
		"hostname" : "Landshark2",
		"ip_address" : "delphix02",
		"username" : "delphix_admin",
		"password" : "delphix",
		"port" : "443",
		"default" : "true",
		"protocol" : "https",
		"encrypted" : "false"
	},
	{
		"hostname" : "Delphix32",
		"ip_address" : "192.168.1.32",
		"username" : "delphix_admin",
		"password" : "#papapaewiru32472931u12",
		"port" : "80",
		"default" : "true",
		"encrypted" : "true"
	}
	]
}

Connecting to Delphix engines

DxToolkit can run an operation on one or all engines configured in configuration file. After successful connection to the Delphix Engine a session is saved for a future usage. Default expired time for a session is set to 30 min and it's a Delphix Engine not a DxToolkit parameter. An existing user session can be destroyed using dx_logout command.

  • -d name or –engine name Run command for one Delphix Engine specified by name
  • -all Run command for all Delphix Engines defined in configuration file
  • -dever Set version of API to particular Delphix Engine version. Supported values are 4.1, 4.2, 4.3, 5.0

Common parameters

  • -configfile file Location of configuration file
  • -version Display version
  • -debug n Enable debug mode at level n
  • -help Display help
  • -format Format ( [pretty] | csv | json )
  • -nohead Turns off header

DxToolkit commands

List of DxToolkit command can be found here

Examples

Delphix

Clone this wiki locally