Git Product home page Git Product logo

netbox-ipmi-ovh's Introduction

Netbox IPMI OVH Plugin

A plugin used to add a button in the dcim.device to allow easier access to the IPMI for OVH managed bare metal servers. Tested on NetBox v2.11.12, v3.0.0 and v3.1.7.

Installation

This follow the process of installing a plugin in NetBox [https://netbox.readthedocs.io/en/stable/plugins/]

Package Installation from PyPi, from the netbox virtualenv

source /opt/netbox/venv/bin/activate
pip install netbox-ipmi-ovh
cd /opt/netbox/netbox/
python3 manage.py migrate

Package Installation from source

git clone https://github.com/sanecz/netbox-ipmi-ovh
cd netbox-ipmi-ovh
source /opt/netbox/venv/bin/activate
pip3 install .
cd /opt/netbox/netbox/
python3 manage.py migrate

Enable the plugin

To enable the plugin, add/update in the configuration.py file

PLUGINS = [
    'netbox_ipmi_ovh',
]
PLUGINS_CONFIG = {
    'netbox_ipmi_ovh': {
        'ovh_server_name_field': 'existing field or custom field',
	'ovh_endpoint_field': 'existing or custom field',
        'endpoints': {
            'account1-ovh-eu': {
	        'endpoint': 'ovh-eu',
	        'application_key': 'xxxx',
		'application_secret': 'yyyy',
		'consumer_key': 'zzzz'
	    },
	    'account2-soyoustart-ca': {
	        'endpoint': 'soyoustart-ca',
	        'application_key': 'xxxx',
		'application_secret': 'yyyy',
		'consumer_key': 'zzzz'	    
	    }
        }
    }
}

The fields ovh_server_name_field, ovh_endpoint_field and endpoints are mandatory.

Restart Netbox

sudo systemctl restart netbox

Required permissions

To be able to use the plugin, a user should have the following permissions:

  • netbox_ipmi_ovh.view_ipmi

Usage

A button will be present in dcim.devices to select the type of IPMI access you want to use. As of 01/02/2022, only kvmipHtml5URL, kvmipJnlp, serialOverLanURL and serialOverLanSshKey are available.

You can create custom fields to store required informations for the plugin to work (i.e the server name from OVH and the endpoint used for the api calls) or use existing fields (like asset tag or serial number or the name), but be careful to fill correctly ovh_endpoint_field and ovh_server_name_field with the name of the fields you want to use, there is no default value.

netbox-ipmi-ovh's People

Contributors

sanecz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

galaxydata

netbox-ipmi-ovh's Issues

use managmentonly interface as connection

Hi,
Stumbled across this when checking what new modules there is.
We are using custom links to have a button for IPMI, what we did where we set the IPM*I interface to be management only and then use that to populate the button with the proper link.
This might be a something to test out if it would make it simpler to configuring the plugin.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.