maaspower

Power control webhook server for Canonical’s MAAS. The requirements for such webhooks are defined here:

• https://maas.io/docs/snap/3.1/ui/power-management#heading–webhook

PyPI	pip install maaspower
Source code	https://github.com/gilesknap/maaspower
Documentation	https://gilesknap.github.io/maaspower
Releases	https://github.com/gilesknap/maaspower/releases

This project implements MAAS power control for machines that do not already have a BMC type supported by MAAS. It uses webhooks to control any number of remote switching devices that can power cycle such machines.

The project uses an extensible architecture so more switching device types may be added, see How to add support for a new API.

At present it supports two flavours of switching control:

• Command line interface. Anything that is controllable by a command line utility that can be installed on the machine running this webhook service.

• SmartThings API: a popular Samsung IoT protocol that is supported by thousands of devices

How the documentation is structured

Documentation is split into four categories, also accessible from links in the side-bar.

Tutorials

Tutorials for installation, configuration and command line usage. New users start here.

Tutorials

• Installation
  • Install using python and pip
    • Check your version of python
    • Create a virtual environment
    • Running the application
  • Install using the container
• How to use MaasPower
  • Configuration
  • Launch the Web Hook server
  • Configure MAAS to connect to the webhook
• Using Regular Expressions in Device Names
  • Simple Example
  • Use of Capture Groups

How-to Guides

Practical step-by-step guides for the more experienced user.

How-to Guides

• How to add support for a new API
  • Steps
• YAML schema
• UUGear MEGA4 USB Hub
• TP Link Tapo Smart Plug
• Netgear GS308EP PoE 8 port switch

Explanations

Explanation of how the library works and why it works that way.

Explanations

• Supported Types of Device Control
  • Examples
  • Command Line Control
  • SmartThings Control
  • Web GUI Control
    • Per Control Device Configuration
      • Commands
      • Field Identifiers
    • Per Control Device Configuration
  • Working with another Web GUI
• Security
  • Code Execution
  • Login
  • Network
• Purpose of this Package
• TODO: Outstanding Work

Reference

Practical step-by-step guides for the more experienced user.

Reference

• Code
  • maaspower package
  • maaspower
    • maaspower.__version__
    • massconfig.py
    • maaspower.maasconfig
      • SwitchDevice
        • SwitchDevice.copy()
      • RegexSwitchDevice
        • RegexSwitchDevice.run_query()
        • RegexSwitchDevice.query_state()
      • MaasConfig
        • MaasConfig.find_device()
    • webhook.py
    • maaspower.webhook
      • command()
      • load_web_hook()
      • run_web_hook()
  • devices package
  • maaspower.devices
    • smart_thing.py
    • maaspower.devices.smart_thing
      • SmartThing
    • shell_cmd.py
    • maaspower.devices.shell_cmd
      • CommandLine
• Contributing
  • Running the tests
  • Code Styling
  • Documentation
  • Release Process
  • Updating the tools
• Notes on Using a PoE switch With maaspower
• Releases
• Index

About the documentation

Why is the documentation structured this way?