@zowe/zos-uss-for-zowe-sdk/lib/SshSession.d.ts

Zowe SDK to interact with USS on z/OS

import { ICommandArguments, ICommandOptionDefinition } from "@zowe/imperative";
import { ISshSession } from "./doc/ISshSession";
/**
 * Utility Methods for Zowe
 * @export
 */
export declare class SshSession {
    private mISshSession;
    /**
     * Default ssh port 22
     * @static
     * @memberof AbstractSession
     */
    static readonly DEFAULT_SSH_PORT = 22;
    /**
     * Obtain session info and defaults
     * @readonly
     * @type {ISession}
     * @memberof AbstractSession
     */
    get ISshSession(): ISshSession;
    static SSH_CONNECTION_OPTION_GROUP: string;
    /**
     * Option used in profile creation and commands for hostname for z/OS SSH
     */
    static SSH_OPTION_HOST: ICommandOptionDefinition;
    /**
     * Option used in profile creation and commands for port for z/OS SSH
     */
    static SSH_OPTION_PORT: ICommandOptionDefinition;
    /**
     * Option used in profile creation and commands for username / ID  for z/OS SSH
     */
    static SSH_OPTION_USER: ICommandOptionDefinition;
    /**
     * Option used in profile creation and commands for password/passphrase for z/OS SSH
     */
    static SSH_OPTION_PASSWORD: ICommandOptionDefinition;
    /**
     * Option used in profile creation and commands for private key path
     */
    static SSH_OPTION_PRIVATEKEY: ICommandOptionDefinition;
    /**
     * Option used in profile creation and commands for passphrase for private key
     */
    static SSH_OPTION_KEYPASSPHRASE: ICommandOptionDefinition;
    /**
     * Option used in profile creation to set handshake timeout. If unset, defaults to no timeout.
     */
    static SSH_OPTION_HANDSHAKETIMEOUT: ICommandOptionDefinition;
    /**
     * Options related to connecting to z/OS SSH
     * These options can be filled in if the user creates a profile
     */
    static SSH_CONNECTION_OPTIONS: ICommandOptionDefinition[];
    /**
     * Given command line arguments, create an SSH session configuration object.
     * @param {ICommandArguments} args - The arguments specified by the user
     * @returns {ISshSession} - A session configuration to be used for an SSH session.
     */
    static createSshSessCfgFromArgs(args: ICommandArguments): ISshSession;
    /**
     * Creates an instance of AbstractSession.
     * @param {ISshSession} session: SshSession parameter object
     */
    constructor(mISshSession: ISshSession);
    private static get log();
    /**
     * Builds an ISshSession so all required pieces are filled in
     * @private
     * @param {ISession} session - the fully populated session
     * @memberof AbstractSession
     */
    private buildSession;
}
//# sourceMappingURL=SshSession.d.ts.map