Options
All
  • Public
  • Public/Protected
  • All
Menu

Session interface for maintaining cookie and protocol information

export
interface

ISshSession

Hierarchy

  • ISshSession

Index

Properties

Optional handshakeTimeout

handshakeTimeout: number

How long in milliseconds to wait for the SSH handshake to complete. If unset, defaults to 0 - no timeout.

memberof

ISshSession

Optional hostKey

hostKey: string

Trusted host key of the z/OS SSH server, stored as the base64-encoded key blob presented by the server during the handshake. When set, the server's key is verified against this value before any credentials are sent. Populated automatically on first connect after the user accepts the key (trust on first use), or configured manually to pin a known key.

memberof

ISshSession

Optional hostname

hostname: string

Host to connect ssh to

memberof

ISshSession

Optional insecure

insecure: boolean

Skip verification of the SSH server's host key. Defaults to false, meaning the server's identity is verified before any credentials are sent. When true, host key verification is skipped entirely and credentials are sent without confirming the server's identity.

memberof

ISshSession

Optional keyPassphrase

keyPassphrase: string

password to unlock the private key.

memberof

ISshSession

Optional password

password: string

Password

memberof

ISshSession

Optional port

port: number

Port to obtain data from 22 is the default for ssh

memberof

ISshSession

Optional privateKey

privateKey: string

Path to a private key that matches with a public key stored in the server for authentication

memberof

ISshSession

Optional user

user: string

User name for logging in

memberof

ISshSession

Generated using TypeDoc