virt-wrapper 0.8.1

Wrapper that was developed in order to manage libvirt virtual machines

Description

Python wrapper for managing virtual infrastructure based on Hyper-V or KVM (libvirt)

Example usage

Get access to particular VM by UUID

from virt_wrapper import *
import asyncio

def main():
    kvm = await VirtualMachine.connect(
        host="linux-server.lan",
        uuid="c7c2f567-064f-464e-9843-1ed55c04f35e",
        platform=HypervisorPlatform.KVM,
        auth=("user", "123456")
    )
    kvm_name = await kvm.name()

    hvm = await VirtualMachine.connect(
        host="windows-server.lan",
        uuid="37a6cee8-f6ce-48c4-a635-7145e8770cca",
        platform=HypervisorPlatform.HYPERV,
        auth=("user", "123456")
    )
    hvm_name = await hvm.name()

    print(f"Virtual machine on Linux has name: {kvm_name}\nVirtual machine on Windows has name: {hvm_name}")

if __name__ == "__main__":
    asyncio.run(main())

Get all VMs on particular hypervisor

from virt_wrapper import *

hypervisor = Hypervisor(
    host="windows-server.lan",
    platform=HypervisorPlatform.HYPERV,
    auth=("user", "123456")
)

# OR

hypervisor = Hypervisor(
    host="linux-server.lan",
    platform=HypervisorPlatform.KVM,
    auth=("user", "123456")
)

for vm in hypervisor.virtual_machines():
    print(vm.name())

Requirements

KVM

• SSH-key must be imported on target server
• User must have full access to libvirt

usermod <your_user> -aG libvirt
systemctl restart libvirtd

Hyper-V

• User must have full access to Hyper-V
• WinRM must be enabled with this parameters
  • HTTPS
  • Basic auth

# Enables the WinRM service and sets up the HTTP listener
Enable-PSRemoting -Force

# Create HTTPS listener
$httpsParams = @{
    ResourceURI = 'winrm/config/listener'
    SelectorSet = @{
        Transport = "HTTPS"
        Address   = "*"
    }
    ValueSet = @{
        CertificateThumbprint = ""
        Enabled               = $true
    }
}
New-WSManInstance @httpsParams

# Enable basic auth
Set-Item -Path WSMan:\localhost\Service\Auth\Basic -Value $true

# Opens port 5986 for all profiles
$firewallParams = @{
    Action      = 'Allow'
    Description = 'Inbound rule for Windows Remote Management via WS-Management. [TCP 5986]'
    Direction   = 'Inbound'
    DisplayName = 'Windows Remote Management (HTTPS-In)'
    LocalPort   = 5986
    Profile     = 'Any'
    Protocol    = 'TCP'
}
New-NetFirewallRule @firewallParams

Available functions:

• Managing snapshots
• Managing virtual disks
• Managing networks
• Getting info about VM (state, description, guest OS, etc.)
• Controling VM (run, shutdown, pause, etc)
• Export/Import virtual machines
• Migrating
• Cloning