from vbox_operator.operations import *

vm_list = list_vms() # returns a dict of lists
for vm in vm_list["running"]:
    vm_name = vm["name"]
    print(f'Running: {vm_name}')
    vm_state = state_vm(vm["uuid"])
    print(f'  > {vm_state}')

# returns dict of lists: 
# {"all": [], "running": []}
# while each list is a list of dicts: {"name": "VM NAME", "uuid": "VM UUID}
list_vms()

### For all methods below which take param "vm",
# you may pass the VM name or UUID as a VM identifier.
# However, it is best to provide the VM UUID, as it may prevent some issues.
start_vm_headless(vm)
start_vm(vm)
state_vm(vm)
# Pull power plug on the VM
poweroff_vm(vm)
# Send ACPI shutdown signal to VM (power button)
acpipower_vm(vm)
# restart VM
reset_vm(vm)
pause_vm(vm)

# Returns a list of dicts: [{"name": "SNAPSHOT NAME", "uuid": "SNAPSHOT UUID},]
list_snapshots(vm)

# param snapshot is expected to be a snapshot identifier,
# it is best to pass the snapshot UUID instead of the VM name.
restore_vm(vm, snapshot)

### The methods below expect the username and password of the guest VM,
# and the direction of the operations is Host to Guest.
mkdir_vm(username, password, vm, directory)
copyfile_vm(username, password, vm, src_file, dst)
copydir_vm(username, password, vm, src_dir, dst)