Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/portellam/powerstate-virtmanager

Set the power state of a Virtual Machine (VM). Does what virt-manager doesn't; includes missing features like sleep, hibernate, and wake. Bash TUI and Python GUI application.
https://github.com/portellam/powerstate-virtmanager

bash bash-script glade gtk gtk3 gui libvirt libvirtd python python3 qemu qemu-kvm terminal tui virt-manager virtual-machine virtualization

Last synced: 5 days ago
JSON representation

Set the power state of a Virtual Machine (VM). Does what virt-manager doesn't; includes missing features like sleep, hibernate, and wake. Bash TUI and Python GUI application.

Host: GitHub
URL: https://github.com/portellam/powerstate-virtmanager
Owner: portellam
License: gpl-3.0
Created: 2023-07-17T04:54:20.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-08-12T19:11:57.000Z (3 months ago)
Last Synced: 2024-10-25T09:11:49.218Z (13 days ago)
Topics: bash, bash-script, glade, gtk, gtk3, gui, libvirt, libvirtd, python, python3, qemu, qemu-kvm, terminal, tui, virt-manager, virtual-machine, virtualization
Language: Shell
Homepage:
Size: 275 KB
Stars: 6
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Power State Virtual Machine Manager

### v1.0.0-alpha

Set the power state of a QEMU/KVM Virtual Machine (VM). Wake from Sleep or

Hibernation. Does what `virt-manager` doesn't.

**[Latest release](https://github.com/portellam/powerstate-virtmanager/releases/latest)**

## Table of Contents

- [1. Why?](#1-why)

- [2. Related Projects](#2-related-projects)

- [3. Documentation](#3-documentation)

- [4. Host Requirements](#4-host-requirements)

    - [4.1. Operating System](#41-operating-system)

    - [4.2. Software](#42-software)

    - [4.3. Hardware](#43-hardware)

- [5. Download](#5-download)

- [6. Usage](#6-usage)

    - [6.1. Install](#61-install)

    - [6.2. Run](#62-run)

- [7. Contact](#7-contact)

- [8. References](#8-references)

## Contents

### 1. Why?

The virtual machine manager application `virt-manager` does not (currently) have

the option to wake a VM from Sleep. In other words, as a VM cannot be awaken by

an input device, unfortunately. For example, a physical or virtual "power on",

button, keyboard input, or network activity. This application includes the

ability to wake from Sleep and Hibernation, and the other related features from

`virt-manager`.

### 2. Related Projects

| Project                                 | Codeberg          | GitHub          |

| :---                                    | :---:             | :---:           |

| Deploy VFIO                             | [link][codeberg1] | [link][github1] |

| Auto X.Org                              | [link][codeberg2] | [link][github2] |

| Generate Evdev                          | [link][codeberg3] | [link][github3] |

| Guest Machine Guide                     | [link][codeberg4] | [link][github4] |

| Libvirt Hooks                           | [link][codeberg5] | [link][github5] |

| **Power State Virtual Machine Manager** | [link][codeberg6] | [link][github6] |

[codeberg1]: https://codeberg.org/portellam/deploy-VFIO

[github1]:   https://github.com/portellam/deploy-VFIO

[codeberg2]: https://codeberg.org/portellam/auto-xorg

[github2]:   https://github.com/portellam/auto-xorg

[codeberg3]: https://codeberg.org/portellam/generate-evdev

[github3]:   https://github.com/portellam/generate-evdev

[codeberg4]: https://codeberg.org/portellam/guest-machine-guide

[github4]:   https://github.com/portellam/guest-machine-guide

[codeberg5]: https://codeberg.org/portellam/libvirt-hooks

[github5]:   https://github.com/portellam/libvirt-hooks

[codeberg6]: https://codeberg.org/portellam/powerstate-virtmanager

[github6]:   https://github.com/portellam/powerstate-virtmanager

### 3. Documentation

- [What is VFIO?](#2)

- [VFIO Discussion and Support](#3)

- [Hardware-Passthrough Guide](#1)

- [Virtual Machine XML Format Guide](#4)

### 4. Host Requirements

#### 4.1. Operating System

Linux.

#### 4.2. Software

- `QEMU` and `Libvirt` for Virtual Machines.

#### 4.3. Hardware

The following firmware options are supported and enabled (motherboard and CPU):

- System Power State S3 (Sleep).

- System Power State S4 (Hibernation).

### 5. Download

- Download the Latest Release: [Codeberg][codeberg-releases],

[GitHub][github-releases]

- Download the `.zip` file:

    1. Viewing from the top of the repository's (current) webpage, click the

        drop-down icon:

        - `···` on Codeberg.

        - `<> Code ` on GitHub.

    2. Click `Download ZIP` and save.

    3. Open the `.zip` file, then extract its contents.

- Clone the repository:

    1. Open a Command Line Interface (CLI).

        - Open a console emulator (for Debian systems: Konsole).

        - Open a existing console: press `CTRL` + `ALT` + `F2`, `F3`, `F4`, `F5`,  or

        `F6`.

            - **To return to the desktop,** press `CTRL` + `ALT` + `F7`.

            - `F1` is reserved for debug output of the Linux kernel.

            - `F7` is reserved for video output of the desktop environment.

            - `F8` and above are unused.

    2. Change your directory to your home folder or anywhere safe:

        - `cd ~`

    3. Clone the repository:

        - `git clone https://www.codeberg.org/portellam/powerstate-virtmanager`

        - `git clone https://www.github.com/portellam/powerstate-virtmanager`

[codeberg-releases]: https://codeberg.org/portellam/powerstate-virtmanager/releases/latest

[github-releases]:   https://github.com/portellam/powerstate-virtmanager/releases/latest

### 6. Usage

#### 6.1. Install

```bash

sudo bash installer.sh

```

#### 6.2. Run

Installer will copy required files to `/usr/bin/local/`. You may run executable

from any directory.

```bash

sudo powerstate-virtmanager

```

### 7. Contact

Did you encounter a bug? Do you need help? Please visit the

**Issues page** ([Codeberg][codeberg-issues], [GitHub][github-issues]).

[codeberg-issues]: https://codeberg.org/portellam/powerstate-virtmanager/issues

[github-issues]:   https://github.com/portellam/powerstate-virtmanager/issues

### 8. References

#### 1.

**PCI passthrough via OVMF**. ArchWiki. Accessed June 14, 2024.

^{https://wiki.archlinux.org/title/PCI_passthrough_via_OVMF.}

#### 2.

**VFIO - ‘Virtual Function I/O’ - The Linux Kernel Documentation**.

The linux kernel. Accessed June 14, 2024.

^{https://www.kernel.org/doc/html/latest/driver-api/vfio.html.}

#### 3.

**VFIO Discussion and Support**. Reddit. Accessed June 14, 2024.

^{https://www.reddit.com/r/VFIO/.}

#### 4.

**XML Design Format** GitHub - libvirt/libvirt. Accessed June 18, 2024.

^{https://github.com/libvirt/libvirt/blob/master/docs/formatdomain.rst.}