Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rosineygp/proxmox-pci-switcher

Switch among Guest VMs organized by Resource Pool
https://github.com/rosineygp/proxmox-pci-switcher

proxmox switch

Last synced: 3 days ago
JSON representation

Switch among Guest VMs organized by Resource Pool

Host: GitHub
URL: https://github.com/rosineygp/proxmox-pci-switcher
Owner: rosineygp
License: mit
Created: 2021-04-10T01:29:38.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-04-05T18:40:08.000Z (7 months ago)
Last Synced: 2024-10-05T01:17:40.973Z (about 1 month ago)
Topics: proxmox, switch
Language: Python
Homepage: https://rosineygp.github.io/proxmox-pci-switcher/
Size: 311 KB
Stars: 137
Watchers: 7
Forks: 6
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-proxmox-ve - proxmox-pci-switcher

README

        ![logo](assets/logo.png)

# Proxmox PCI Switcher 

![GitHub all releases](https://img.shields.io/github/downloads/rosineygp/proxmox-pci-switcher/total?label=snippet)

![PyPI - Downloads](https://img.shields.io/pypi/dm/proxmox-pci-switcher?label=pypi)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rosineygp_proxmox-pci-switcher&metric=alert_status)](https://sonarcloud.io/dashboard?id=rosineygp_proxmox-pci-switcher)

Switch among Guest VMs organized by `Resource Pool`.

main features:

- `ONE` GPU card, `N` OS (at once)

- Guest VM command client

- Handler power off

- Reset framebuffer

**TOC**

- [Proxmox Configuration](#proxmox-configuration)

  - [Create Resource Pool](#create-resource-pool)

  - [Assign Guest VM](#assign-guest-vm)

- [Install Proxmox Snippet](#install-proxmox-snippet)

  - [Proxmox Config](#proxmox-config)

    - [Snippet Variables](#snippet-variables)

    - [Assign VM to Snippet](#assign-vm-to-snippet)

- [Guest Client Switcher](#guest-client-switcher)

  - [List Resources](#list-resources)

  - [Switch Resource](#switch-resource)

  - [Using GUI](#using-gui)

## Proxmox Configuration

### Create Resource Pool

![Resource Pool](assets/create_resource_pool.png)

### Assign Guest VM

![Assign Guest VM](assets/assign_guest_vm.png)

## Install Proxmox Snippet

```bash

curl -fsSL https://github.com/rosineygp/proxmox-pci-switcher/releases/latest/download/pci-group-switcher.sh > pci-group-switcher.sh

# set execution permission

chmod +x pci-group-switcher.sh

# move for your snippets /

```

### Proxmox Config

#### Snippet Variables

| NAME                   | Default           | Description                                                        |

| ---------------------- | ----------------- | ------------------------------------------------------------------ |

| _POOL_NAME *           | \ | The name of `Resource Pool`                                        |

| _SHUTDOWN_TIMEOUT      | 300               | Checking if resource was released (Current VM Running is down)     |

| _RESET_GPU_FRAMEBUFFER | true              | Reset GPU framebuffer                                              |

| _PIN_CPU_IDS           | false             | Pin CPU using `taskset` (syntax equals taskset cpu-list parameter) |

| _RENICE_PRIORITY       | false             | Renice process using `renice`                                      |

> All variables must be changed in `pci-group-switcher.sh` at proxmox ve.

>

> `_POOL_NAME` * By default it will scan for VMID in all Resource Pools, in case of long delays replace function call to Resource Pool name (eg. desktop, gpu, ...).

The following variables can be passed using `/etc/pve/qemu-server/.vars` file, the script will load variables from file if it exists.

> If you need to overwrite an Default value set at `/etc/environment` the variable name without the `_` prefix. (eg. RESET_GPU_FRAMEBUFFER=false)

#### Assign VM to Snippet

```bash

qm set  -hookscript :snippets/pci-group-switcher.sh

```

> After proxmox configuration is possible to switch using proxmox api or web interface.

## Guest Client Switcher

- requirements: python 3

```bash

pip install proxmox-pci-switcher

# create config folder

mkdir -p ~/.config/proxmox-pci-switcher/

# create config file

cat < ~/.config/proxmox-pci-switcher/config.yaml

proxmox:

  host: ''

  user: '@'

  password: ''

  api_id: ''          # only for api access

  api_token: ''      # only for api access

  verify_ssl: false

gui:                        # optional

  theme: Dark               # Light or Dark

pools:

  - ''

  - ''

  - ''

EOF

```

> Edit `config.yaml` with your proxmox credentials and pools.

> API access has priority over user and password access.

### List Resources

```bash

proxmox-pci-switcher list

pool(s)       vmid  name             status    type

----------  ------  ---------------  --------  ------

desktop        119  catalina         stopped   qemu

desktop        116  win10-desktop    stopped   qemu

desktop        117  mini-desktop     stopped   qemu

desktop        103  u20-desktop      running   qemu

desktop        115  u20-srv-desktop  stopped   qemu

```

### Switch Resource

```bash

# run command directly

proxmox-pci-switcher switch win10-desktop

# create a alias for better experience

alias windows="proxmox-pci-switcher switch win10-desktop"

# and just run

windows

```

### Using GUI

```bash

proxmox-pci-switcher gui

```

![GUI](assets/gui.png)