Executing mzcli Commands (4.3)

To execute the mzcli commands you can either run:

java -jar mzcli.jar mzcli <options> <command>

or, omit the mzcli :

java -jar <name of jar file> <options> <command>

It is mandatory to state the --host and --port options, see the Options section below for more information.

If no <command> is stated, mzcli will go into an interactive mode session, for example:

java -jar mzcli.jar [mzcli] --host --port

You can then run the commands directly without starting them with java -jar mzcli.jar mzcli --host --port.

In non-interactive mode, the command and its arguments can be stated in the same command, for example:

java -jar mzcli.jar [mzcli] --host --port <command> [<arguments>]

Example - mzcli command

Below are a few examples of how you can use mzcli provided you have done one of the following:

configured properties
created a profile
entered interactive mode

To list all available workflows:

$ java -jar mzcli.jar wflist
Default.HTTP2.workflow_1 (1)
prep_csv.export_csv.win (1)
prep_csv.import_csv.win (1)
SystemTask.Configuration_Cleaner.Configuration_Cleaner (1)
SystemTask.DataVeracity_Maintenance.DataVeracity_Maintenance (1)
SystemTask.System_Backup.System_Backup (1)
SystemTask.System_Log_Cleaner.System_Log_Cleaner (1)

To list only valid workflows:

$ java -jar mzcli.jar wflist -valid
Default.HTTP2.workflow_1 (1)
SystemTask.Configuration_Cleaner.Configuration_Cleaner (1)
SystemTask.DataVeracity_Maintenance.DataVeracity_Maintenance (1)
SystemTask.System_Backup.System_Backup (1)
SystemTask.System_Log_Cleaner.System_Log_Cleaner (1)