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.
Please check a change log for list of changes.
Download a compiled version of DxToolkit for required platform from a releases page. Create a configuration file dxtools.conf based on dxtools.conf.example or a Wiki page.
Check a documentation for more details
Run dxtoolkit using a docker image:
- Create configuration file dxtools.conf based on dxtools.conf.example or a Wiki page.
- Run a docker image with the following parameters:
- path redirection:
-v /path/to/your/configfile:/config - image name:
pioro/dxtoolkit:develop dxtoolkit_command dxtoolkit_command_params
ex: docker run -v /configdir:/config pioro/dxtoolkit:latest dx_get_appliance -d myengine
Perl version 5.16 or higher
Required packages
- JSON
- Date::Manip
- DateTime::Event::Cron::Quartz
- DateTime::Format::DateParse
- Crypt::CBC
- Crypt::Blowfish
- Text::CSV
- Try::Tiny
- LWP::UserAgent
- Net::SSLeay
- IO::Socket::SSL
- LWP::Protocol::https
- Term::ReadKey
- Log::Syslog::Fast
There is no script dx_syslog on Windows and AIX due to lack of support of Log::Syslog::Fast Perl module
New releases of dxtoolkit are tested with Delphix Engines, which are in primary or extended support. Ex. 2.4.14 release was tested with version 5.3.9 and 6.0.X engines.
Dxtoolkit is designed to support many versions of Delphix Engines, although if a new version is released after dxtoolkit release it may stop working due to API changes. To mitigate this issue until next dxtoolkit version will be release, please add -dever parameter to your commands with the following values:
| parameter | Delphix Engine version | API version |
|---|---|---|
| -dever 6.0.11 | Delphix Engine 6.0.11 | API 1.11.11 |
| -dever 6.0 | Delphix Engine 6.0 | API 1.11.00 |
| -dever 5.3 | Delphix Engine 5.3 | API 1.10.00 |
| -dever 5.2 | Delphix Engine 5.2 | API 1.9.00 |
- Fork the project.
- Make your bug fix or new feature.
- Add tests for your code.
- Send a pull request.
Contributions must be signed as User Name <user@email.com>. Make sure to set up Git with user name and email address. Bug fixes should branch from the current stable branch. New features should be based on the master branch.
This project operates under the Delphix Code of Conduct. By participating in this project you agree to abide by its terms.
All contributors are required to sign the Delphix Contributor agreement prior to contributing code to an open source repository. This process is handled automatically by cla-assistant. Simply open a pull request and a bot will automatically check to see if you have signed the latest agreement. If not, you will be prompted to do so as part of the pull request process.
Issues should be reported in the GitHub repo's issue tab. Include a link to it.
This software is provided as-is, without warranty of any kind or commercial support through Delphix. See the associated license for additional details. Questions, issues, feature requests, and contributions should be directed to the community as outlined in the Delphix Community Guidelines.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Copyright (c) 2014, 2016 by Delphix. All rights reserved.