5.1

Method Returns Description
getFile(String,String) : Number Number
Copies a file from a remote host to the
Orchestrator server.
getStatus() : String String
Provides the status information
returned by the server.
getString(String) : String String
Gets the contents of a remote file.
isAvailable() : boolean Boolean
Checks the socket to test whether it is
available for use.
isConnected() : boolean Boolean
Provides information about whether
the client is currently connected to a
server.
listAll(String) : String[]
Array of String Lists all files and directories in a path.
listDir(String) : String[]
Array of String Lists directories in a path.
listFile(String) : String[]
Array of String Lists files in a path.
login(String,String,String) :
boolean
Boolean
Logs in to an FTP server.
putFile(String,String) : Number Number
Copies a file from the Orchestrator
server to a remote host.
putString(String,String) :
Number
Number
Adds a string of content to a remote file.
POP3Client Class
The POP3Client class is the main class for implementing POP3 functionality into workflows.
The POP3Client class defines the POP3Client():POP3Client constructor.
The POP3Client class defines the following attributes.
Attribute Returns Description
connectTimeout Number
Socket connect timeout
output String
Command output if any
soLinger Number
Socket SO Linger (null if disabled)
state String
Connection state
tcpNoDelay Boolean
Socket TCP no delay
timeout Number
Socket timeout
The POP3Client class defines the following methods.
Method Returns Description
connect(String,number):Object Object
Connects the client to a host.
disconnect():Object Object
Disconnects the client from the server.
enableSSL(boolean):Object Object
Enables SSL.
isAvailable():Boolean Boolean
Makes checks on the socket to test if it is
available for use.
isConnected():Boolean Boolean
Provides information if the client is
currently connected to a server.
Using VMware vCenter Orchestrator Plug-Ins
66 VMware, Inc.