Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Corsinvest/cv4pve-pepper
Launching SPICE remote-viewer for Proxmox VE VDI client
https://github.com/Corsinvest/cv4pve-pepper
proxmox proxmox-cluster proxmox-ve spice spice-client vdi virt-viewer
Last synced: 6 days ago
JSON representation
Launching SPICE remote-viewer for Proxmox VE VDI client
- Host: GitHub
- URL: https://github.com/Corsinvest/cv4pve-pepper
- Owner: Corsinvest
- License: gpl-3.0
- Created: 2019-10-14T14:12:53.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-07T08:08:26.000Z (5 months ago)
- Last Synced: 2024-08-02T06:13:04.632Z (3 months ago)
- Topics: proxmox, proxmox-cluster, proxmox-ve, spice, spice-client, vdi, virt-viewer
- Language: C#
- Homepage: https://www.corsinvest.it/cv4pve
- Size: 82 KB
- Stars: 98
- Watchers: 5
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-proxmox-ve - cv4pve-pepper - viewer having access VM running on Proxmox VE (Tools)
README
# cv4pve-pepper
[](LICENSE.md)
```text
______ _ __
/ ____/___ __________(_)___ _ _____ _____/ /_
/ / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
/ /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_
\____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/
Launching SPICE remote-viewer for Proxmox VE (Made in Italy)
cv4pve-pepper is a part of suite cv4pve.
For more information visit https://www.corsinvest.it/cv4pve
Usage:
cv4pve-pepper [options]
Options:
--api-token Api token format 'USER@REALM!TOKENID=UUID'. Require Proxmox VE 6.2 or later
--username User name @
--password The password. Specify 'file:path_file' to store password in file.
--validate-certificate Validate SSL Certificate Proxmox VE node.
--host (REQUIRED) The host name host[:port],host1[:port],host2[:port]
--vmid The id or name VM/CT
--proxy SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs
'spiceproxy', so it is up to the client to choose one. By default, we return the node to connect. If specify
http(s)://[host]:[port] then replace proxy option in file .vv. E.g. for reverse proxy.
--viewer (REQUIRED) Executable SPICE client remote viewer (remote-viewer executable)
--viewer-options Send options directly SPICE Viewer (quote value).
--start-or-resume Run stopped or paused VM
--wait-for-startup Wait sec. for startup VM [default: 5]
--version Show version information
--debug Show debug information
-?, -h, --help Show help and usage information
```
## Copyright and License
Copyright: Corsinvest Srl
For licensing details please visit [LICENSE.md](LICENSE.md)
## Commercial Support
This software is part of a suite of tools called cv4pve-tools. If you want commercial support, visit the [site](https://www.corisnvest.it/cv4pve)
## Introduction
Launching SPICE remote-viewer having access VM running on Proxmox VE.
this software aims to simplify run SPICE client from Proxmox VE using command line. The reasons are:
* Proxmox VE uses tickets that expire
* do not use graphical interface (GUI)
* no download .vv file to run remove viewer
* use a simple client
## Main features
* Completely written in C#
* Use native api REST Proxmox VE (library C#)
* Independent os (Windows, Linux, Macosx)
* Installation unzip file extract binary
* Not require installation in Proxmox VE
* Execute out side Proxmox VE
* Not require Web login
* Support multiple host for HA in --host parameter es. host[:port],host1[:port],host2[:port]
* Start or Resume VM on connection
* Check-Update and Upgrade application
* Use Api token --api-token parameter
* Send options directly to viewer
* Execution with file parameter e.g. @FileParameter.parm
* Validate certificate SSL, default not validate
## Api token
From version 6.2 of Proxmox VE is possible to use [Api token](https://pve.proxmox.com/pve-docs/pveum-plain.html).
This feature permit execute Api without using user and password.
If using **Privilege Separation** when create api token remember specify in permission.
## Configuration and use
E.g. install on linux 64
Download last package e.g. Debian cv4pve-pepper-linux-x64.zip, on your os and install:
```sh
root@debian:~# unzip cv4pve-pepper-linux-x64.zip
```
This tool need basically no configuration.
## Run
```sh
root@debian:~# cv4pve-pepper --host=192.168.0.100 --username=root@pam --password=fagiano --vmid 100 --viewer path-spice-viewer
```
## SPICE client
* [Windows: virt-viewer 0.5.6 or higher,](http://www.spice-space.org/download.html)
* Linux: virt-viewer 0.5.6 or higher
* [OS X (not yet working as expected): virt-viewer 0.5.7 or higher](https://www.spice-space.org/osx-client.html)
## Topical path of remote viewer
* Linux /usr/bin/remote-viewer
* Windows C:\Program Files\VirtViewer v?.?-???\bin\remote-viewer.exe
## Options of remote viewer
Use --viewer-options to send options to viewer.
E.g. --viewer-options "-f" for full screen.
## Error
* **no spice port**: This error appears when you have not configured the display hardware on SPICE.
## Execution with file parameter
Is possible execute with file parameter
```sh
root@debian:~# cv4pve-pepper @FileParameter.parm
```
File **FileParameter.parm**
```txt
--host=192.168.0.100
--username=root@pam
--password=fagiano
--vmid 100
--viewer path-spice-viewer
```