Class SSHCredentialGuard

Index

Constructors

Properties

credentialManager ssh

Methods

registerCredential validatePrivateAccount

Constructors

constructor

new SSHCredentialGuard(): SSHCredentialGuard
Returns SSHCredentialGuard

Properties

`Private` credentialManager

credentialManager: CredentialManager = ...

`Private` ssh

ssh: NodeSSH = ...

Methods

registerCredential

registerCredential(user?, password?): Promise<string>
Registers a credential onto the redis store with a generated Id as the key.
Parameters
- Optional user: string
  username
- Optional password: string
Returns Promise<string>
the assigned redis key/id
- Defined in src/SSHCredentialGuard.ts:46

validatePrivateAccount

validatePrivateAccount(hpcName, user?, password?): Promise<void>
Tries to establish an SSH connection with the hpc.
Parameters
- hpcName: string
  name of the hpc to check with
- Optional user: string
  username (not used)
- Optional password: string
Returns Promise<void>
Throws
may be unable to cross check crecdentials with a given hpc
- Defined in src/SSHCredentialGuard.ts:19

Generated using TypeDoc