pybenparallels 1.1.0

PyBEN Parallels repository is an easy to use python utility class for Parallels server solution

PyBenParallels

Introduction

PyBEN Parallels repository is an easy to use python utility class for Parallels server solution

Installation

python -m pip install pybenparallels

Use

Cli module activation

Run for a full help printout:

python -m pybenparallels -h

The class can be run on remote location via SSH or Locally by leaving the PARALLELS_HOST empty

• pybenparallels is the name of the module
• pprint is a function to print the returned dict nicely in console
• get_vms is a function to return all vms (or request a specific one)

Example use for LOCAL to get all vms and a specific one:

python -m pybenparallels pprint get_vms 
python -m pybenparallels pprint get_vms vm_name=ventura

Example for REMOTE SERVER use of global variables to get all vms: Use PARALLELS_CLI_EXEC when you need to override the execution line to overcome ssh context restrictions.

set PARALLELS_HOST='1.1.1.1'
set PARALLELS_HOST_USER='root'
set PARALLELS_HOST_PASS='1234'
set PARALLELS_CLI_EXEC='. ~/.zprofile; prlctl'

python -m pybenparallels pprint get_vms

Example for passing variables directly for REMOTE SERVER:

• pybenparallels is the name of the module
• get_vms is a function to return all vms (or request a specific one)

python -m pybenparallels host=1.1.1.1 host_user=root host_password=1234 get_vms vm_name=ventura

Python import ProxmoxCls class

from pybenparallels import ParallelsCLI

# For remote server (connection via ssh)
server = ParallelsCLI(host='1.1.1.1', host_user='root', host_password='1234')
server.cli_exec = '. ~/.zprofile; prlctl'  # Sometimes the ssh user does not have the correct python3 in PATH
print(server.get_vms())

# For local use, when you are running on the parallel server
print(ParallelsCLI().get_vms())

Some of the included functions:

• get_vms: Returns a full list of vms, or list with matching vms by uuid or name
• run_command: Execute a command on the parallels cli
• send_vm_command: prlctl exec ...
• send_vm_command_by_ssh
• create_vms
• delete_vm
• start_vm
• stop_vm
• pause_vm
• resume_vm
• snapshot handling
• and more ...