MettleCI Command Line Reference
Refer to the MettleCI Command Line Interface to understand how the interface works, and what each of the columns in the table below means.
Available Namespaces
Available Commands
| Command Documentation | Namespace | Command | Plugin Name | Plugin File | Credentials | Windows Client |
|---|---|---|---|---|---|---|
| DataStage Capture Command | datastage | capture | datastage | dm-dsdeploy-plugin.jar | IS/DS | - |
| ISX Cat Command | isx | cat | isx | dm-isxexport-plugin.jar | - | - |
| DataStage Connector Migration Command | datastage | ccmt | datastage | dm-ccmigrate-plugin.jar | IS/DS | Y |
| DataStage Cleanup-Projects Command | datastage | cleanup-projects | datastage | dm-dsadmin-plugin.jar | IS/DS | - |
| DataStage Compile Command | datastage | compile | datastage | dm-dscompile-plugin.jar | IS/DS | Y |
| Properties Config Command | properties | config | properties | dm-properties-config-plugin.jar | - | - |
| DataStage Create-Project Command | datastage | create-project | datastage | dm-dsadmin-plugin.jar | IS/DS | - |
| ISX Cut Command | isx | cut | isx | dm-isxexport-plugin.jar | - | - |
| (v1.3) DSParams Delete Command | dsparams | delete | dsparams | dm-dsadmin-plugin.jar | - | - |
| DataStage Delete-Project Command | datastage | delete-project | datastage | dm-dsadmin-plugin.jar | IS/DS | - |
| DataStage Deploy Command | datastage | deploy | datastage | dm-dsdeploy-plugin.jar | IS/DS | Y |
| (v1.3) DSParams Diff Command | dsparams | diff | dsparams | dm-dsadmin-plugin.jar | - | - |
| Remote Download Command | remote | download | remote | dm-bamboo-sftp-plugin.jar | OS | - |
| Remote Execute Command | remote | execute | remote | dm-bamboo-sftp-plugin.jar | OS | - |
| DataStage Execute Command | datastage | execute | datastage | dm-dsexecute-plugin.jar | IS/DS | - |
| ISX Export Command | isx | export | isx | dm-isxexport-plugin.jar | IS/DS | Y |
| UnitTest Generate Command | unittest | generate | unittest | dm-dstest-plugin.jar | IS/DS | - |
| ISX Import Command | isx | import | isx | dm-isximport-plugin.jar | IS/DS | Y |
| UnitTest Install-Server-Test-Harness Command | unittest | install-server-test-harness | unittest | dm-dstest-plugin.jar | IS/DS | - |
| Compliance List-Tags Command | compliance | list-tags | compliance | dm-compliance-plugin.jar | - | - |
| DSParams Merge Command | dsparams | merge | dsparams | dm-dsadmin-plugin.jar | - | - |
| ISX Message-Handlers Command | isx | message-handlers | isx | dm-dsmsgh-plugin.jar | - | - |
| UnitTest Migrate Command | unittest | migrate | unittest | dm-dstest-plugin.jar | IS/DS | - |
| Compliance Query Command | compliance | query | compliance | dm-compliance-plugin.jar | - | - |
| Workbench Set-Branch Command | workbench | set-branch | workbench | dm-workbench-plugin.jar | IS/DS | - |
| ISX Set-Params Command | isx | set-params | isx | dm-isxexport-plugin.jar | - | - |
| Compliance Test Command | compliance | test | compliance | dm-compliance-plugin.jar | - | - |
| UnitTest Test Command | unittest | test | unittest | dm-dstest-plugin.jar | IS/DS | - |
| UnitTest Uninstall-Server-Test-Harness Command | unittest | uninstall-server-test-harness | unittest | dm-dstest-plugin.jar | IS/DS | - |
| Remote Upload Command | remote | upload | remote | dm-bamboo-sftp-plugin.jar | OS | - |
Some command invocations will require credentials. For more on credentials, see Mettle CI User Accounts.
Types of credentials
Code | Meaning |
IS/DS | This command requires credentials of an IS user that has the DataStage Admin permission and is bound/mapped to a valid DataStage user |
OS | This command requires credentials of an Operating System user that has sufficient authority to ssh/scp and to write in the project and other project related directories and invoke scripts. |
IGC | This command requires credentials of an IGC user (an IS user that has IGC user permissions) |
JIRA | This command requires credentials of an Atlassian Jira user that has sufficient permission to create, view and delete issues and comments. |
- | This command does not need any credentials |
Windows-Only Commands
Note from the ‘Windows Client’ column of the command list above that the following MettleCI commands rely on functionality only available on the DataStage Client tier, and as such can only be executed on a Windows-based DataStage Client tier.
| Title | Namespace | Command | Credentials |
|---|---|---|---|
| DataStage Compile Command | datastage | compile | IS/DS |
| DataStage Connector Migration Command | datastage | ccmt | IS/DS |
| DataStage Deploy Command | datastage | deploy | IS/DS |
| ISX Export Command | isx | export | IS/DS |
| ISX Import Command | isx | import | IS/DS |