Command 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
(v2.0) DataStage Capture Command	datastage	capture	datastage	dm-dsdeploy-plugin.jar	IS/DS	-
(v2.0) ISX Cat Command	isx	cat	isx	dm-isxexport-plugin.jar	-	-
(v2.0) DataStage Connector Migration Command	datastage	ccmt	datastage	dm-ccmigrate-plugin.jar	IS/DS	Y
(v2.0) DataStage Cleanup-Projects Command	datastage	cleanup-projects	datastage	[data-colorid=bw4k84ipi1]{color:#333333} html[data-color-mode=dark] [data-colorid=bw4k84ipi1]{color:#cccccc}dm-dsadmin-plugin.jar	[data-colorid=bw4k84ipi1]{color:#333333} html[data-color-mode=dark] [data-colorid=bw4k84ipi1]{color:#cccccc}IS/DS	[data-colorid=bw4k84ipi1]{color:#333333} html[data-color-mode=dark] [data-colorid=bw4k84ipi1]{color:#cccccc}-
(v2.0) DataStage Compile Command	datastage	compile	datastage	[data-colorid=hrkw25z16r]{color:#333333} html[data-color-mode=dark] [data-colorid=hrkw25z16r]{color:#cccccc}dm-dscompile-plugin.jar	[data-colorid=hrkw25z16r]{color:#333333} html[data-color-mode=dark] [data-colorid=hrkw25z16r]{color:#cccccc}IS/DS	[data-colorid=hrkw25z16r]{color:#333333} html[data-color-mode=dark] [data-colorid=hrkw25z16r]{color:#cccccc}Y
(v2.0) Properties Config Command	properties	config	properties	dm-properties-config-plugin.jar	-	-
(v2.0) Compliance Console Command 🔒	compliance	console	compliance	dm-compliance-plugin.jar	-	-
(v2.0) DataStage Create-Project Command	datastage	create-project	datastage	dm-dsadmin-plugin.jar	IS/DS	-
(v2.0) ISX Cut Command	isx	cut	isx	dm-isxexport-plugin.jar	-	-
(v2.0) DSParams Delete Command	dsparams	delete	dsparams	[data-colorid=yopoknkyle]{color:#333333} html[data-color-mode=dark] [data-colorid=yopoknkyle]{color:#cccccc}dm-dsadmin-plugin.jar	[data-colorid=yopoknkyle]{color:#333333} html[data-color-mode=dark] [data-colorid=yopoknkyle]{color:#cccccc}-	[data-colorid=yopoknkyle]{color:#333333} html[data-color-mode=dark] [data-colorid=yopoknkyle]{color:#cccccc}-
(v2.0) DataStage Delete-Project Command	datastage	delete-project	datastage	dm-dsadmin-plugin.jar	IS/DS	-
(v2.0) DataStage Deploy Command	datastage	deploy	datastage	dm-dsdeploy-plugin.jar	IS/DS	Y
(v2.0) DSParams Diff Command	dsparams	diff	dsparams	[data-colorid=k3hsbueoun]{color:#333333} html[data-color-mode=dark] [data-colorid=k3hsbueoun]{color:#cccccc}dm-dsadmin-plugin.jar	[data-colorid=k3hsbueoun]{color:#333333} html[data-color-mode=dark] [data-colorid=k3hsbueoun]{color:#cccccc}-	[data-colorid=k3hsbueoun]{color:#333333} html[data-color-mode=dark] [data-colorid=k3hsbueoun]{color:#cccccc}-
(v2.0) Remote Download Command	remote	download	remote	dm-bamboo-sftp-plugin.jar	OS	-
(v2.0) DataStage Execute Command	datastage	execute	datastage	[data-colorid=a79sg5xtw5]{color:#333333} html[data-color-mode=dark] [data-colorid=a79sg5xtw5]{color:#cccccc}dm-dsexecute-plugin.jar	[data-colorid=a79sg5xtw5]{color:#333333} html[data-color-mode=dark] [data-colorid=a79sg5xtw5]{color:#cccccc}IS/DS	[data-colorid=a79sg5xtw5]{color:#333333} html[data-color-mode=dark] [data-colorid=a79sg5xtw5]{color:#cccccc}-
(v2.0) Remote Execute Command	remote	execute	remote	dm-bamboo-sftp-plugin.jar	OS	-
(v2.0) ISX Export Command	isx	export	isx	dm-isxexport-plugin.jar	IS/DS	Y
(v2.0) UnitTest Generate Command	unittest	generate	unittest	dm-dstest-plugin.jar	IS/DS	-
(v2.0) ISX Import Command	isx	import	isx	dm-isximport-plugin.jar	IS/DS	Y
(v2.0) UnitTest Install-Server-Test-Harness Command	unittest	install-server-test-harness	unittest	dm-dstest-plugin.jar	IS/DS	-
(v2.0) Fabrication List Command	fabrication	list	fabrication	dm-fabrication-plugin.jar	-	-
(v2.0) Compliance List-Tags Command	compliance	list-tags	compliance	dm-compliance-plugin.jar	-	-
(v2.0) DSParams Merge Command	dsparams	merge	dsparams	dm-dsadmin-plugin.jar	-	-
(v2.0) ISX Message-Handlers Command	isx	message-handlers	isx	dm-dsmsgh-plugin.jar	-	-
(v2.0) UnitTest Migrate Command	unittest	migrate	unittest	dm-dstest-plugin.jar	IS/DS	-
(v2.0) Compliance Query Command	compliance	query	compliance	dm-compliance-plugin.jar	-	-
(v2.0) Workbench Set-Branch Command	workbench	set-branch	workbench	dm-workbench-plugin.jar	IS/DS	-
(v2.0) ISX Set-Params Command	isx	set-params	isx	dm-isxexport-plugin.jar	-	-
(v2.0) Compliance Test Command	compliance	test	compliance	dm-compliance-plugin.jar	-	-
(v2.0) UnitTest Test Command	unittest	test	unittest	dm-dstest-plugin.jar	IS/DS	-
(v2.0) UnitTest Uninstall-Server-Test-Harness Command	unittest	uninstall-server-test-harness	unittest	dm-dstest-plugin.jar	IS/DS	-
(v2.0) 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
(v2.0) DataStage Compile Command	datastage	compile	IS/DS
(v2.0) DataStage Connector Migration Command	datastage	ccmt	IS/DS
(v2.0) DataStage Deploy Command	datastage	deploy	IS/DS
(v2.0) ISX Export Command	isx	export	IS/DS
(v2.0) ISX Import Command	isx	import	IS/DS