Skip to main content

CLI tool for managing PIKVM device

Project description

pikvm-cli

A command-line interface (CLI) for controlling PIKVM devices.

Installation

You can install the pikvm-cli package from PyPI:

$ pip install pikvm-cli

Usage

To use the pikvm-cli tool, you must first configure it with the URL, username, and password of your PIKVM device:

$ pikvm-cli configure --url https://example.com --username admin --password password

Note: configuration file is located at ~/.pikvm-cli

Once the tool is configured, you can use it to retrieve information about your device:

$ pikvm-cli info

You can also use it to control the power of your device:

$ pikvm-cli atx on
$ pikvm-cli atx off
$ pikvm-cli atx off_hard
$ pikvm-cli atx reset

Note: for the full list of available commands, run pikvm-cli --help

Multiple Devices

If you have multiple PIKVM devices, you can configure the tool to use a specific device by passing the --name flag:

$ pikvm-cli info --name pikvm-1

Note: if --name is not passed, "default" configuration will be used

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pikvm-cli-1.0.1.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

pikvm_cli-1.0.1-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file pikvm-cli-1.0.1.tar.gz.

File metadata

  • Download URL: pikvm-cli-1.0.1.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for pikvm-cli-1.0.1.tar.gz
Algorithm Hash digest
SHA256 9f372536456120b005f5934a197b942c4bdc4b04d73f231a00ae28db7fc31be0
MD5 976ac65b0c188cd1f94002199acced3f
BLAKE2b-256 8b6135aa5d49a930ade615bae8e2e71497a3312a5f366e04bf98a3ebc02fa357

See more details on using hashes here.

File details

Details for the file pikvm_cli-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pikvm_cli-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for pikvm_cli-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d80370fff9f6407256cdbf20a3514e96bbc537c79f02baa69122332fd011facf
MD5 587a4acebd270fcb3139c7b237da5e4a
BLAKE2b-256 7106441f4f05c5b5b693440a5ba8de088143bf58919db38878185209cd5eaf4a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page