SNMP Driver
jumpstarter-driver-snmp provides functionality for controlling power via
SNMP-enabled PDUs (Power Distribution Units).
Installation
:substitutions:
$ pip3 install --extra-index-url {{index_url}} jumpstarter-driver-snmp
Configuration
Example configuration:
export:
power:
type: jumpstarter_driver_snmp.driver.SNMPServer
config:
host: "pdu.mgmt.com"
user: "labuser"
plug: 32
port: 161
oid: "1.3.6.1.4.1.13742.6.4.1.2.1.2.1"
auth_protocol: "NONE"
auth_key: null
priv_protocol: "NONE"
priv_key: null
timeout: 5.0
Config parameters
| Parameter | Description | Type | Required | Default |
|---|---|---|---|---|
| host | Hostname or IP address of the SNMP-enabled PDU | str | yes | |
| user | SNMP v3 username | str | yes | |
| plug | PDU outlet number to control | int | yes | |
| port | SNMP port number | int | no | 161 |
| oid | Base OID for power control | str | no | "1.3.6.1.4.1.13742.6.4.1.2.1.2.1" |
| auth_protocol | Authentication protocol ("NONE", "MD5", "SHA") | str | no | "NONE" |
| auth_key | Authentication key when auth_protocol is not "NONE" | str | no | null |
| priv_protocol | Privacy protocol ("NONE", "DES", "AES") | str | no | "NONE" |
| priv_key | Privacy key when priv_protocol is not "NONE" | str | no | null |
| timeout | SNMP timeout in seconds | float | no | 5.0 |
API Reference
.. autoclass:: jumpstarter_driver_snmp.client.SNMPServerClient()
:members:
:show-inheritance:
Examples
Power cycling a device:
snmp_client.cycle(wait=3)
Basic power control:
snmp_client.off()
snmp_client.on()
Using the CLI:
j power on
j power off
j power cycle --wait 3
Release files for jumpstarter-driver-snmp 0.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jumpstarter_driver_snmp-0.9.0.tar.gz | 7.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jumpstarter_driver_snmp-0.9.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.7 kB
Release files / jumpstarter_driver_snmp-0.9.0.tar.gz
| Download URL | jumpstarter_driver_snmp-0.9.0.tar.gz |
|---|---|
| Size | 7.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
864d68d6aeacb24f24d639123297a0df7ecadef32b3de286a199b961d57cfbc7
|
|
BLAKE2b-256 checksum How to use checksums |
125cda904ba6d09f0f6a2b7cc423cd9e1c3814e8c0f3e9e1d0357eee6c087e9e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.22
|
Release files / jumpstarter_driver_snmp-0.9.0-py3-none-any.whl
| Download URL | jumpstarter_driver_snmp-0.9.0-py3-none-any.whl |
|---|---|
| Size | 6.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c9c36d78cb0b1b06964434c35276faf5044b06cbc9edc71732cc2978893c7bf8
|
|
BLAKE2b-256 checksum How to use checksums |
8f2b663c63ad383ae2e54a3a195035d69291a9d1f42f98fb86c5cf972bd2b2f6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.22
|
