librarian v0.2.0 API Reference

Modules

SSH

SSH streams and SSH and basic SCP functionality

You might want to run mocked tests against a component that uses the SSH Api. Here is provided the behaviour module to support this testing pattern.

Implements erlang's :ssh_client_key_api behaviour so that you can log in using a pem key, instead of the default .ssh/id_rsa private/public pair.

handles parsing of SSH configuration files.

provides a basic way to generate passwordless SSH key files. More complex options should be implemented directly via the :public_key module.

API for rolling all of the SSH stream functions into a single module.

implements the data transactions involved in streaming SCP file transfer from the destination server.

implements the data transactions involved in unstreamed SCP file transfer to the destination server.

implements the data transactions involved in streaming a file to the the destination server.

Defines an SSH.Stream struct returned by SSH.stream!/3, as well as key functions that are involved in accessing the ssh data from the stream struct.