Platform Libraries¶

Set of functions that plugins can use these for executing remote commands, etc.

run_bash¶

Executes a bash command on a remote Unix host.

Signature¶

def run_bash(remote_connection, command, variables=None, use_login_shell=False, check=False)

Arguments¶

Argument	Type	Description
remote_connection	RemoteConnection	Connection associated with the remote host to run the command on.
command	String	Command to run on the host.
variables	dict[String, String]	Optional. Environement variables to set when running the command.
use_login_shell	boolean	Optional. Whether to use a login shell.
check	boolean	Optional. Whether or not to raise an exception if the `exit_code` in the `RunBashResponse` is non-zero.

Returns¶

An object of RunBashResponse

Field	Type	Description
exit_code	Integer	Exit code from the command.
stdout	String	Stdout from the command.
stderr	String	Stderr from the command.

Examples¶

Calling bash with an inline command.

from dlpx.virtualization import libs

command = "echo 'Hi' >> /tmp/debug.log"
variables = {"var": "val"}

response = libs.run_bash(connection, command, variables)

print response.exit_code
print response.stdout
print response.stderr

Using parameters to construct a bash command.

from dlpx.virtualization import libs

name = virtual_source.parameters.username
port = virtual_source.parameters.port
command = "mysqldump -u {} -p {}".format(name,port)

response = libs.run_bash(connection, command)

Running a bash script that is saved in a directory.

 import pkgutil
 from dlpx.virtualization import libs

 script_content = pkgutil.get_data('resources', 'get_date.sh')

 # Execute script on remote host
 response = libs.run_bash(direct_source.connection, script_content)

For more information please go to Managing Scripts for Remote Execution section.

run_expect¶

Executes a tcl command or script on a remote Unix host.

Signature¶

def run_expect(remote_connection, command, variables=None)

Arguments¶

Argument	Type	Description
remote_connection	RemoteConnection	Connection associated with the remote host to run the command on.
command	String	Expect(Tcl) command to run.
variables	dict[String, String]	Optional. Environement variables to set when running the command.

Returns¶

An object of RunExpectResponse

Field	Type	Description
exit_code	Integer	Exit code from the command.
stdout	String	Stdout from the command.
stderr	String	Stderr from the command.

Example¶

Calling expect with an inline command.

from dlpx.virtualization import libs

command = "puts 'Hi'"
variables = {"var": "val"}

repsonse = libs.run_expect(connection, command, variables)

print response.exit_code
print response.stdout
print response.stderr

run_powershell¶

Executes a powershell command on a remote Windows host.

Signature¶

def run_powershell(remote_connection, command, variables=None, check=False)

Arguments¶

Argument	Type	Description
remote_connection	RemoteConnection	Connection associated with the remote host to run the command on.
command	String	Command to run to the remote host.
variables	dict[String, String]	Optional. Environement variables to set when running the command.
check	boolean	Optional. Whether or not to raise an exception if the `exit_code` in the `RunPowershellResponse` is non-zero.

Returns¶

An object of RunPowershellResponse

Field	Type	Description
exit_code	Integer	Exit code from the command.
stdout	String	Stdout from the command.
stderr	String	Stderr from the command.

Example¶

Calling powershell with an inline command.

from dlpx.virtualization import libs

command = "Write-Output 'Hi'"
variables = {"var": "val"}

response = libs.run_powershell(connection, command, variables)

print response.exit_code
print response.stdout
print response.stderr

run_sync¶

Copies files from the remote source host directly into the dSource, without involving a staging host.

Signature¶

def run_sync(remote_connection, source_directory, rsync_user=None, exclude_paths=None, sym_links_to_follow=None)

Arguments¶

Argument	Type	Description
remote_connection	RemoteConnection	Connection associated with the remote host to run the command on.
source_directory	String	Directory of files to be synced.
rsync_user	String	Optional User who has access to the directory to be synced.
exclude_paths	list[String]	Optional Paths to be excluded.
sym_links_to_follow	list[String]	Optional Symbollic links to follow if any.

Returns¶

None

Example¶

from dlpx.virtualization import libs

source_directory = "sourceDirectory"
rsync_user = "rsyncUser"
exclude_paths = ["/path1", "/path2"]
sym_links_to_follow = ["/path3", "/path4"]

libs.run_sync(connection, source_directory, rsync_user, exclude_paths, sym_links_to_follow)