jumpstarter-driver-snmp 0.8.1

SNMP driver

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