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.1.0.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

pikvm_cli-1.1.0-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file pikvm_cli-1.1.0.tar.gz.

File metadata

  • Download URL: pikvm_cli-1.1.0.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for pikvm_cli-1.1.0.tar.gz
Algorithm Hash digest
SHA256 ba87d6228daa488f2d7d31c21213af8aa54edf753def237f85dfa9530fbcbd07
MD5 806d80d68cc81c0a0e751324f92f0666
BLAKE2b-256 0e3a23ee454825048075be86a87790099403630dad2a920d5a4fd36ed6721a83

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pikvm_cli-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for pikvm_cli-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9513983578cc36b7d76125bcf93e878c27235abbfb77d15d38247cea72af138b
MD5 b16ed1b772da08d6f2ef55586ada0c49
BLAKE2b-256 6b6664e6d576b776c1f5d2d8e7870815c865bda3e774d9b9cee6bc455764c352

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