### Hierarchy

- Shell

## Index

### Properties

- connRefusedFlag
- expiredPasswordFlag
- startCmdFlag

### Methods

- authenticationHandler
- connect
- executeSsh
- executeSshCwd
- isConnectionValid

## Properties

### Static Readonly connRefusedFlag

connRefusedFlag: "ECONNREFUSED" = "ECONNREFUSED"

- Defined in @zowe/zos-uss-for-zowe-sdk/src/Shell.ts:20

### Static Readonly expiredPasswordFlag

expiredPasswordFlag: "FOTS1668" = "FOTS1668"

- Defined in @zowe/zos-uss-for-zowe-sdk/src/Shell.ts:22

### Static Readonly startCmdFlag

startCmdFlag: "@@START OF COMMAND@@" = "@@START OF COMMAND@@"

- Defined in @zowe/zos-uss-for-zowe-sdk/src/Shell.ts:18

## Methods

### Static Private authenticationHandler

- authenticationHandler(authsAllowed: string[]): (Anonymous function)

- - Defined in @zowe/zos-uss-for-zowe-sdk/src/Shell.ts:186

  #### Parameters

  - ##### authsAllowed: string[]

  #### Returns (Anonymous function)

### Static Private connect

- connect(connection: Client, session: SshSession): void

- - Defined in @zowe/zos-uss-for-zowe-sdk/src/Shell.ts:142

  #### Parameters

  - ##### connection: Client

  - ##### session: SshSession

  #### Returns void

### Static executeSsh

- executeSsh(session: SshSession, command: string, stdoutHandler: (data: string) => void, removeExtraCharactersFromOutput?: boolean): Promise<any>

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

  #### Parameters

  - ##### session: SshSession

  - ##### command: string

  - ##### stdoutHandler: (data: string) => void

    - - (data: string): void

      - #### Parameters

        - ##### data: string

        #### Returns void

  - ##### Default value removeExtraCharactersFromOutput: boolean = false

  #### Returns Promise<any>

### Static executeSshCwd

- executeSshCwd(session: SshSession, command: string, cwd: string, stdoutHandler: (data: string) => void, removeExtraCharactersFromOutput?: boolean): Promise<any>

- - Defined in @zowe/zos-uss-for-zowe-sdk/src/Shell.ts:168

  #### Parameters

  - ##### session: SshSession

  - ##### command: string

  - ##### cwd: string

  - ##### stdoutHandler: (data: string) => void

    - - (data: string): void

      - #### Parameters

        - ##### data: string

        #### Returns void

  - ##### Default value removeExtraCharactersFromOutput: boolean = false

  #### Returns Promise<any>

### Static isConnectionValid

- isConnectionValid(session: SshSession): Promise<boolean>

- - Defined in @zowe/zos-uss-for-zowe-sdk/src/Shell.ts:178

  #### Parameters

  - ##### session: SshSession

  #### Returns Promise<boolean>

Generated using TypeDoc