To view the parameters supported by unify-admin.sh, change to the directory <tamr-home-directory>/tamr/utils and run:

unify-admin.sh config:get --help
unify-admin.sh config:set --help
unify-admin.sh config:reset --help
unify-admin.sh upgrade --help
unify-admin.sh auxiliary:install --help

The --help flag returns a list of supported parameters for config:get, config:set, config:reset, upgrade, and auxiliary:install commands, as follows.

config:get

Use the unify-admin.sh config:get module to obtain a list of all configuration variables used by Tamr and their values. For more information, see Configuring Tamr.

Syntax

config:get [--userDefined] [-h] [--help] [--help] [name]...

Usage

• name Returns individual values for the specified individual variables. You must know their names and separate them by spaces. The format is as follows: unify-admin.sh config:get [name1 name2 name3...]. For example, you can run: unify-admin.sh config:get TAMR_LICENSE_KEY TAMR_TOTAL_CORES.
• userDefined Returns a list of all user-defined (overridden) configuration variables that Tamr uses.
• -h, --help Provides help for this command (this information).

config:set

Use the unify-admin.sh config:set to provide configuration values for Tamr. You can set individual configuration property key value pairs, or set the values in bulk using a YAML file.

Syntax

config:set [--dry-run] [--file <file>] [-h] [--help] [--skip-validation] (name=value)...

Usage

• --dry-run Performs a dry run of the changes, prompting you whether to proceed before committing.
• --file <file> Sets configuration values for Tamr in bulk using a YAML file that you create. The file can have multiple configuration parameters in the format: name: value, each listed on a separate line. If you use this option, the command ignores individual key/value pairs if you specify them as command line arguments.
• name=value Sets individual values, for example: unify-admin.sh config:set <NAME>=<VALUE>.
• --skip-validation Skips validation of the new values when loading property definitions or setting values. Warnings are provided.
• -h, --help Provides help for this command (this information).

config:reset

Use the unify-admin.sh config:reset module to reset all user-defined configuration values to their defaults.

Syntax

config:reset [-h] [--help][--skip-validation] [name]...

Usage

• name Resets individually-specified configuration properties to their defaults. Specify individual variables and separate them by spaces. For example: unify-admin.sh config:reset TAMR_LICENSE_KEY TAMR_TOTAL_CORES.
• --skip-validation Skips validation of the reset values or values that depend on them.

upgrade

Use the unify-admin.sh upgrade to specify the ZIP file and a different directory for unzipping it. For more information, see Upgrading.

Syntax

upgrade (--installDir <path>) (--tempZipDir <path>) [-h] [--help]

Usage

• --installDir Specifies the location of your current installation. For example: upgrade --installDir </path/to/install/dir> --zipFile </path/to/file>.
• --zipFile Specifies a ZIP file for upgrades. For example: upgrade --installDir </path/to/install/dir> --zipFile </path/to/file>.
• --upgradeDir Instead of specifying a ZIP file, you can specify a directory to upgrade from. For example: upgrade --installDir </path/to/install/dir> --upgradeDir </path/to/upgrade/dir>.
• --tempZipDir Sets the temporary directory for unzipping the file. For example: upgrade --tempZipDir </path/to/folder>.
• -h, --help Provides help for this command (this information).

auxiliary:install

Use the unify-admin.sh auxiliary:install module to install auxiliary services in Tamr. For more information, see Auxiliary Services.

Syntax

auxiliary:install [--appName <appName>] [--configDefinitions <configDefinitions>] [-h] [--help] [--jarFile <jarFile>] [--runtimeConfig <runtimeConfig>]

Usage

• --appName The name of the auxiliary service in Tamr, such as connect.
• --configDefinitions The path to the definitions file of the auxiliary service, such as <directory-path-of-definitions-file>/definitions.yaml.
• --jarFile The path to the JAR file of the auxiliary service, such as <directory-path-of-jar-file>/connect.jar.
• --runtimeConfig The path to the yaml file of the auxiliary service, such as <directory-path-of-jar-file>/connect.yaml.
• -h, --help Provides help for this command (this information).