Multiplataform Hyper-V Manager using Python and FreeRDP
Hypy uses winrm to comunicate with hyper-v server shell and sends powershell commands to interact with the virtual machines. Using Powershell, HYPY can get Name, ID and state of virtual machines. Therefore, HYPY call freeRDP with vm-id and credentials, using settings in .conf file to connect the vm.
Hypy uses winrm to communicate with the hyper-v host, so it must be enabled and accepting connections. https://github.com/diyan/pywinrm has a session explaining how to Enable WinRM on the remote host.
FreeRDP binary must be in path (windows, linux and mac). Make sure FreeRDP is working before using hypy or it will not open the session to the virtual machine. If you are using Linux, you package manager should have freerdp avaiable or look into https://github.com/FreeRDP/FreeRDP for install instructions.
To configure Hypy, change the file 'hypy.conf'
[credentials]
host = <server name in domain>
domain = <domain name>
user = <user name in server>
pass = <password>
[options]
cache_file = <name of cache file>
sync_interval = <interval in hours to make new cache file>You must have write permissions to the path pointed by cache_file
If you don't know how to use hypy, you can use hypy.py --help
hypy.py --help
Usage: hypy.py [OPTIONS] COMMAND [ARGS]...
Multiplataform Hyper-V Manager using Python and FreeRDP
Options:
--help Show this message and exit.
Commands:
connect Connect to virtual machine identified by...
create Create a new snapshot with vm's current state
delete Delete a machine's snapshot by name
list List virtual machines and its indexes
pause Pause virtual machine identified by index
restore Restore virtual machine snapshot
resume Resume (paused) virtual machine identified by...
snaps List virtual machine snapshots
start Start virtual machine identified by index
stop Stop virtual machine identified by index
If you need help on any subcommand, run hypy.py COMMAND --help
hypy.py list --help
Usage: hypy.py list [OPTIONS]
List virtual machines and its indexes
Options:
-s, --sync Syncronize with server updating local cache
--help Show this message and exit.
Hypy will create a cache with indexes for each machine. These indexes are used by other hypy commands to interact with the virtual machines. If your cache is older than the duration specified in sync_interval, a new cache will be created, so the machine's states will be updated. To force an cache update use the sync parameter.
A machine listing would look like this:
-- Hyper-V Virtual Machine Listing --
Index State Name Uptime
[ 0] saved MACHINE 001 0:00:00
[ 1] saved MACHINE 002 0:00:00
[ 2] running MACHINE 003 1:23:46
[ 3] running MACHINE 004 9:01:33
[ 4] paused MACHINE 005 34 days, 17:58:52
[ 5] off MACHINE 006 0:00:00
[ 6] running MACHINE 007 23 days, 0:46:56
[ 7] running MACHINE 008 0:18:43
[ 8] running MACHINE 009 4 days, 2:16:29
[ 9] off MACHINE 010 0:00:00
[ 10] off MACHINE 011 0:00:00
hypy connect --help
Usage: hypy.py connect [OPTIONS] INDEX
Connect to virtual machine identified by index
Options:
--help Show this message and exit.
hypy create --help
Usage: hypy.py create [OPTIONS] INDEX SNAP_NAME
Create a new snapshot with vm's current state
Options:
--help Show this message and exit.
hypy delete --help
Usage: hypy.py delete [OPTIONS] INDEX SNAP_NAME
Delete a machine's snapshot by name
Options:
-r Remove snapshot's children as well
--help Show this message and exit.
hypy restore --help
Usage: hypy.py restore [OPTIONS] INDEX SNAP_NAME
Restore virtual machine snapshot
Options:
--help Show this message and exit.
hypy snaps --help
Usage: hypy.py snaps [OPTIONS] INDEX
List virtual machine snapshots
Options:
--help Show this message and exit
hypy start --help
Usage: hypy.py start [OPTIONS] INDEX
Start virtual machine identified by index
Options:
--help Show this message and exit.
hypy stop --help
Usage: hypy.py stop [OPTIONS] INDEX
Stop virtual machine identified by index
Options:
-f, --force Hyper-V gives the guest five minutes to save data, then forces
a shutdown
--help Show this message and exit.
hypy pause --help
Usage: hypy.py pause [OPTIONS] INDEX
Pause virtual machine identified by index
Options:
--help Show this message and exit.
hypy resume --help
Usage: hypy.py resume [OPTIONS] INDEX
Resume (paused) virtual machine identified by index
Options:
--help Show this message and exit.