Session Controls and VIs
Owning Palette: Toolkit
Requires: LIBSSH2
Represents the underlying session resource for the libssh2lv shared library.
| Class Item | Description |
|---|---|
| Type Definitions | Groups related files into a folder |
| Utility | Groups related files into a folder |
| Read Timeout | Gets the current timeout in milliseconds (ms) used during communication with the a remote SSH/SFTP server. |
| Write Timeout | Sets the timeout in milliseconds (ms) for reading and writing during the communication with a remote SSH/SFTP server. |
| Read Authenticated | Determines if this session has been authenticated with the remote SSH server. |
| Connect | Connects a sesssion to a remote SSH server. This is typically called immediately after creating the session, and this must be called BEFORE authenticating a user with the remote SSH server. |
| Disconnect | Disconnects a session from a remote SSH server. The user will need to be re-authenticated after the session is disconnected. This is typically called immediate BEFORE destroying the session. This does NOT free the underlying resource within the libssh2lv shared library. |
| Read Mode | Gets the communication mode for this session with the remote SSH server. |
| Write Mode | Sets the communication mode for this session with the remote SSH server. |
| Authenticate | Authenticates a user with a remote SSH/SFTP server. |
| Authentication Schemes | Gets a list of authentication methods supported by the remote SSH server for a user. |
| Create | Creates a new Session object that represents a libssh2lv shared library Session struct. This VI must be called, or executed, before using any other Session-related VIs. This VI allocates memory within the libssh2lv shared library that must be explicitly deallocated, or freed, at the end of the application using the Destroy VI to avoid memory leaks or running Out-of-Memory (OOM) on a resource contrained system. A Session object represents a connection to a remote SSH/SFTP server. |
| Destroy | Deallocates, or frees, the memory allocated for the libssh2lv shared library Session struct represented by this Session object. After this is called, the object can no longer be used in the application without causing a segmentation fault, i.e. crashing LabVIEW. This VI must be called to avoid leaking memory or running Out-of-Memory (OOM) on resource-constrained systems. |
| Fingerprint | Gets a hash of the remote SSH server's host key. This is an unique identifier for the remote SSH server, typically referred to as a "fingerprint". The server's host key hash can be used to ensure the remote SSH server is valid, recognized, and geninue. If the fingerprint does not match an existing, known remote SSH server's host key hash, then do NOT proceed with authentication. |
| Host Key | Gets the remote SSH server's host key. |