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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pikvm-cli-1.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 bc952dadb4f11f9a89d53b4459fbcce822269ebecc23fb2fff02d751786d2120
MD5 1419bd231db522dbac87cbd1e73a19f5
BLAKE2b-256 4a6fde7fc7e096fb0a62a7211c0cc60b8afc9d0f343618b25776ffd3f0276397

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pikvm_cli-1.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fbbbae6cf1b724c3a8cfab9d085e480dbc427308ef42a37a121c44cec3850b5d
MD5 150efe12cd403511d479680a50b48eea
BLAKE2b-256 d6686cfc6b7af0259781a56079a30fa9d10fc749e0bbc1bfcf85ce5c978c4cfa

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