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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pikvm-cli-1.0.3.tar.gz
  • Upload date:
  • Size: 3.2 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.3.tar.gz
Algorithm Hash digest
SHA256 c2770cd50339f93c09325a7b220903e5709bcc32f0d271c8574c6ad76700678d
MD5 9c67e860e26ee5c7873860601c499363
BLAKE2b-256 4f8dbdb1a1441b8787f0ec7cd075d405683ef350149fbdf0c834f97dc87cdd51

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pikvm_cli-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 3.7 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a06ef21388cae7dc5ed78e3fd0cc24ad13b84ab51fdef245d7390d0d2b787039
MD5 fd15239c9311fce2e5589066c13f27cf
BLAKE2b-256 a4414e25f67be1e0fc6dda0f04f4559f9e32c0de58a0acc4895d50dc01eb1121

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