Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The mzcli command line tool has a number of options to be added for it to know which installation to run the command on.

Comment for below

Rw ui textbox macro
typeinfo

mzcli Usage

Code Block
java -jar mzcli.jar [mzcli] [<username/password>] <command> [<arguments>]
       [--schema <http|https> : default http]
       [--user <username> : default mzadmin]
       [--password <pass>]
       [--host <host> : default localhost]
       [--port <port> : default 9000]
       [--profile <profile-name> : default can be specified in mzcli_configuration.xml with --set-default-profile option]
       
java -jar mzcli.jar [mzcli] --set-default-profile <default-profile-name>

java -jar mzcli.jar [mzcli] --get-default-profile

java -jar mzcli.jar [mzcli] --help

Options

The options specified with double-dashes (--) can also be specified via:

  • Environment variables: MZCLI_PORT, MZCLI_HOST, MZCLI_USER, MZCLI_PASSWORD, and MZCLI_SCHEMA. The environment variables need to be set for the machine that is running the mzcli client.

  • A property file called mzcli.properties with these property names and default values:

    • mzcli.user=mzadmin

    • mzcli.schema=http

    • mzcli.port=9000

    • mzcli.host=localhost

      mzcli searches for this file in MZ_HOME/etc (if MZ_HOME exists) or in the local folder (if MZ_HOME does not exist). If the mzcli.properties file is not present, it is created with default values.

      If an option is not specified, its default value is used.

  • A profile containing one or several installations with different options:

...

typeinfo

...

You can also use a simplified user/password syntax, just enter the username and password in a single parameter together with the command. When the command is executed, the command prompt is returned to the Unix shell.

...

Lower priority means that it can be overridden by anything with higher priority.

Overwrite option

If a command generates files, mzcli saves them to disk. Use theĀ -overwrite option to save a file to disk even if a file with the same name already exists. If the -overwrite option is not specified, and a file with the same file name exists, mzcli displays an error message and terminates without saving the file.