remote Package

Installer Module

exception cbtestlib.remote.Installer.BuildException(build)

Bases: cbtestlib.remote.Installer.MembaseInstallationException

class cbtestlib.remote.Installer.InstallerHelper

Bases: object

static install_membase(ip, username, key_location, build)
exception cbtestlib.remote.Installer.MembaseInstallationException(message, type, parameters)

Bases: exceptions.Exception

class cbtestlib.remote.Installer.MembaseInstallationExceptionTypes

Bases: object

BUILD_ERROR = 1001
NODE_ALREADY_JOINED = 1002
UNAUTHORIZED = 1000
exception cbtestlib.remote.Installer.UnauthorizedException(username='', password='')

Bases: cbtestlib.remote.Installer.MembaseInstallationException

remote_util Module

class cbtestlib.remote.remote_util.RemoteMachineHelper(remote_shell)

Bases: object

is_process_running(process_name)
monitor_process(process_name, duration_in_seconds=120)
remote_shell = None
class cbtestlib.remote.remote_util.RemoteMachineInfo

Bases: object

class cbtestlib.remote.remote_util.RemoteMachineProcess

Bases: object

class cbtestlib.remote.remote_util.RemoteMachineShellConnection(serverInfo)
copy_file_local_to_remote(src_path, des_path)
copy_files_local_to_remote(src_path, des_path)
couchbase_single_install(build)
couchbase_single_uninstall()
couchbase_uninstall()
couchbase_win_uninstall(product, version, os_name, query)
create_directory(remote_path)
create_file(remote_path, file_data)
create_multiple_dir(dir_paths)
delete_files(file_location)
disable_firewall()
disconnect()
download_binary(url, deliverable_type, filename)
download_binary_in_win(url, name, version)
download_build(build)
execute_cbcollect_info(file)
execute_cbdocloader(username, password, bucket, memory_quota, file)
execute_cbepctl(bucket, persistence, param_type, param, value)
execute_cbtransfer(source, destination)
execute_cluster_backup(login_info, backup_location, command_options)
execute_command(command, info=None, debug=True)
execute_command_raw(command, debug=True)
extract_remote_info()
file_exists(remotepath, filename)
file_starts_with(remotepath, pattern)
find_build_version(path_to_version, version_file, product)
find_file(remote_path, file)
find_windows_info()
flush_os_caches()
get_cpu_info()
get_data_file_size(path=None)
get_disk_info()
get_file(remotepath, filename, todir)
get_hostname()
get_process_statistics(process_name=None, process_pid=None)

Gets process statistics for windows nodes WMI is required to be intalled on the node stats_windows_helper should be located on the node

get_process_statistics_parameter(parameter, process_name=None, process_pid=None)
get_ram_info()
get_running_processes()
is_couchbase_installed()
list_files(remote_path)
log_command_output(output, error)
membase_install(build, startserver=True, path='/tmp', vbuckets=None)
membase_install_win(build, version, startserver=True)
membase_uninstall(save_upgrade_config=False)
membase_upgrade(build, save_upgrade_config=False)
membase_upgrade_win(architecture, windows_name, version, initial_version='')
modify_bat_file(remote_path, file_name, name, version, task)
pause_beam()
pause_memcached()
remove_directory(remote_path)
remove_folders(list)
restore_backupFile(login_info, backup_location, buckets)
set_environment_variable(name, value)

Request an interactive shell session, export custom variable and restart Couchbase server.

Shell session is necessary because basic SSH client is stateless.

set_node_name(name)

Edit couchbase-server shell script in place and set custom node name. This is necessary for cloud installations where nodes have both private and public addresses.

It only works on Unix-like OS.

Reference: http://bit.ly/couchbase-bestpractice-cloud-ip

start_couchbase()
start_membase()
start_moxi(ip, bucket, port, user=None, threads=4, log_file='/var/log/moxi.log')
start_server(os='unix')
stop_couchbase()
stop_membase()
stop_moxi()
stop_schedule_tasks()
stop_server(os='unix')
terminate_process(info=None, process_name='')
terminate_processes(info, list)
unpause_beam()
unpause_memcached()
wait_till_compaction_end(rest, bucket, timeout_in_seconds=60)
wait_till_file_added(remotepath, filename, timeout_in_seconds=180)
wait_till_file_deleted(remotepath, filename, timeout_in_seconds=180)
class cbtestlib.remote.remote_util.RemoteUtilHelper

Bases: object

static common_basic_setup(servers)
static enable_firewall(servers, node, bidirectional=False)

stats_windows_helper Module

Table Of Contents

Previous topic

libstats Package

Next topic

tasks Package

This Page