4.2.1

Attribute Returns Description
path String
Full folder path
port Number
SSH port
SSHSession Class
The SSHSession class is the main class for SSH session management.
The SSHSession class defines the following constructors.
Constructor Description
SSHSession(string,string):SSHSession
Creates a new SSHSession.
SSHSession(string,string,number):SSHSession
Creates a new SSHSession.
The SSHSession class defines the following attributes.
Attribute Returns Description
cmd String
Command to run
error String
Command error, if any
NOTE The error message depends on
your operating system. The operating
system returns a string from the error
messages buffer.
exitCode Number
Exit code of the last command
NOTE The exit code depends on your
operating system. Refer to your
operating system's documentation for
descriptions.
output String
Command output, if any
pty Boolean
Requesting a pseudo-terminal
state String
Run state
terminal String
Terminal type
The SSHSession class defines the following methods.
Method Returns Description
addEnvironment(string,string):O
bject
Object
Fills a property list of environment
variables that are set prior to opening a
channel.
connectWithIdentity(Path,Secure
String):Object
Object
Connects the session using public key
authentication.
connectWithPassword(SecureStrin
g):Object
Object
Connects the session using simple
password authentication.
connectWithPasswordOrIdentity
(boolean,SecureString,Path):Obj
ect
Object
Connects the session using either
password or public key authentication.
disconnect():Object Object
Disconnects the current session.
execute():Object Object
Runs a single command and returns
immediately. Leaves an open session.
You can disconnect the session
manually.
Chapter 5 Using the SSH Plug-In
VMware, Inc. 45