librarian v0.1.10 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 id_rsa private/public pair. It's pretty hard to believe that this is not an option, but there you go.

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 a SCP file transfer to 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.

Exceptions