`sshd`¶

SSHD daemon factory implementation

class saltfactories.daemons.sshd.Sshd(*, display_name=None, cwd=None, environ=None, script_name, base_script_args=NOTHING, slow_stop=True, check_ports=None, factories_manager=None, start_timeout, max_start_attempts=3, extra_cli_arguments_after_first_start_failure=NOTHING, config_dir, listen_address=None, listen_port=None, authorized_keys=None, sshd_config_dict=None)[source]¶

Bases: saltfactories.bases.Daemon

Return type: None

get_base_script_args()[source]¶: Returns any additional arguments to pass to the CLI script

after_start(callback, *args, **kwargs)¶

Parameters

callback (Callable) – The function to call back
args – The arguments to pass to the callback
kwargs – The keyword arguments to pass to the callback

after_terminate(callback, *args, **kwargs)¶

Parameters

callback (Callable) – The function to call back
args – The arguments to pass to the callback
kwargs – The keyword arguments to pass to the callback

before_start(callback, *args, **kwargs)¶

Parameters

callback (Callable) – The function to call back
args – The arguments to pass to the callback
kwargs – The keyword arguments to pass to the callback

before_terminate(callback, *args, **kwargs)¶

Parameters

callback (Callable) – The function to call back
args – The arguments to pass to the callback
kwargs – The keyword arguments to pass to the callback

cmdline(*args)¶

Construct a list of arguments to use when starting the subprocess

Parameters: args (str) – Additional arguments to use when starting the subprocess
Return type: list

get_check_ports()¶: Return a list of ports to check against to ensure the daemon is running

get_display_name()¶: Returns a human readable name for the factory

get_script_args()¶: Returns any additional arguments to pass to the CLI script

get_script_path()¶: Returns the path to the script to run

is_running()¶: Returns true if the sub-process is alive

property pid¶: The pid of the running process. None if not running.

run_start_checks(started_at, timeout_at)¶: Run checks to confirm that the daemon has started

start(*extra_cli_arguments, max_start_attempts=None, start_timeout=None)¶: Start the daemon

started(*extra_cli_arguments, max_start_attempts=None, start_timeout=None)¶: Start the daemon and return it’s instance so it can be used as a context manager

stopped(before_stop_callback=None, after_stop_callback=None, before_start_callback=None, after_start_callback=None)¶

Parameters

before_stop_callback (Callable) – A callable to run before stopping the daemon. The callback must accept one argument, the daemon instance.
after_stop_callback (Callable) – A callable to run after stopping the daemon. The callback must accept one argument, the daemon instance.
before_start_callback (Callable) – A callable to run before starting the daemon. The callback must accept one argument, the daemon instance.
after_start_callback (Callable) – A callable to run after starting the daemon. The callback must accept one argument, the daemon instance.

This context manager will stop the factory while the context is in place, it re-starts it once out of context.

For example:

assert factory.is_running() is True

with factory.stopped():
    assert factory.is_running() is False

assert factory.is_running() is True

terminate()¶: Terminate the started daemon

sshd¶

`sshd`¶