SysAdmin

Instance

Tasks related to a Tamr instance

tamr_toolbox.sysadmin.instance.start_tamr(*, tamr_install_dir, include_dependencies=True, remote_client=None, impersonation_username=None, impersonation_password=None, verbose=False)[source]

Starts the Tamr software and the Tamr dependencies if include_dependencies is true.

Runs in a remote environment if an ssh client is specified otherwise runs in the local shell. If an impersonation_username is provided, the command is run as the provided user. If an impersonation_password is provided, password authentication is used for impersonation, otherwise sudo is used.

Parameters

  • tamr_install_dir (str) – Full path to directory where Tamr is installed

  • include_dependencies (bool) – Whether Tamr dependencies should be started

  • remote_client (Optional[SSHClient]) – An ssh client providing a remote connection

  • impersonation_username (Optional[str]) – A bash user to run the command as, this should be the tamr install user

  • impersonation_password (Optional[str]) – The password for the impersonation_username

  • verbose – Whether the full command, stdout, and stderr should be logged at INFO level

Return type

None

Returns

None

Raises

RuntimeError – Raised if Tamr start script(s) fail

tamr_toolbox.sysadmin.instance.stop_tamr(*, tamr_install_dir, include_dependencies=True, remote_client=None, impersonation_username=None, impersonation_password=None, verbose=False)[source]

Stops the Tamr software and the Tamr dependencies if include_dependencies is true.

Runs in a remote environment if an ssh client is specified otherwise runs in the local shell. If an impersonation_username is provided, the command is run as the provided user. If an impersonation_password is provided, password authentication is used for impersonation, otherwise sudo is used.

Parameters

  • tamr_install_dir (str) – Full path to directory where Tamr is installed

  • include_dependencies (bool) – Whether Tamr dependencies should be stopped

  • remote_client (Optional[SSHClient]) – An ssh client providing a remote connection

  • impersonation_username (Optional[str]) – A bash user to run the command as, this should be the tamr install user

  • impersonation_password (Optional[str]) – The password for the impersonation_username

  • verbose – Whether the full command, stdout, and stderr should be logged at INFO level

Return type

None

Returns

None

Raises

RuntimeError – Raised if Tamr stop script(s) fail

tamr_toolbox.sysadmin.instance.restart_tamr(*, tamr_install_dir, include_dependencies=True, remote_client=None, impersonation_username=None, impersonation_password=None, verbose=False)[source]

Restarts the Tamr software and the Tamr dependencies if include_dependencies is true.

Runs in a remote environment if an ssh client is specified otherwise runs in the local shell. If an impersonation_username is provided, the command is run as the provided user. If an impersonation_password is provided, password authentication is used for impersonation, otherwise sudo is used.

Parameters

  • tamr_install_dir (str) – Full path to directory where Tamr is installed

  • include_dependencies (bool) – Whether Tamr dependencies should be restarted

  • remote_client (Optional[SSHClient]) – An ssh client providing a remote connection

  • impersonation_username (Optional[str]) – A bash user to run the command as, this should be the tamr install user

  • impersonation_password (Optional[str]) – The password for the impersonation_username

  • verbose – Whether the full command, stdout, and stderr should be logged at INFO level

Return type

None

Returns

None

Raises

RuntimeError – Raised if Tamr start or stop script(s) fail