Session interface for maintaining cookie and protocol information

export
interface

  ISshSession

### Hierarchy

- ISshSession

## Index

### Properties

- handshakeTimeout
- hostname
- keyPassphrase
- password
- port
- privateKey
- user

## Properties

### Optional handshakeTimeout

handshakeTimeout: number

- Defined in @zowe/zos-uss-for-zowe-sdk/src/doc/ISshSession.ts:67

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

memberof

  ISession

### Optional hostname

hostname: string

- Defined in @zowe/zos-uss-for-zowe-sdk/src/doc/ISshSession.ts:24

Host to connect ssh to

memberof

  ISession

### Optional keyPassphrase

keyPassphrase: string

- Defined in @zowe/zos-uss-for-zowe-sdk/src/doc/ISshSession.ts:60

password to unlock the private key.

memberof

  ISession

### Optional password

password: string

- Defined in @zowe/zos-uss-for-zowe-sdk/src/doc/ISshSession.ts:46

Password

memberof

  ISession

### Optional port

port: number

- Defined in @zowe/zos-uss-for-zowe-sdk/src/doc/ISshSession.ts:32

Port to obtain data from 22 is the default for ssh

memberof

  ISession

### Optional privateKey

privateKey: string

- Defined in @zowe/zos-uss-for-zowe-sdk/src/doc/ISshSession.ts:53

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

memberof

  ISession

### Optional user

user: string

- Defined in @zowe/zos-uss-for-zowe-sdk/src/doc/ISshSession.ts:39

User name for logging in

memberof

  ISession

Generated using TypeDoc