Forge Home

bios

Puppet module for managing BIOS settings

9,641 downloads

8,873 latest version

0.4 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.0.3 (latest)
  • 0.0.2
  • 0.0.1
released Nov 28th 2013

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'KyleAnderson-bios', '0.0.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add KyleAnderson-bios
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install KyleAnderson-bios --version 0.0.3

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: dell, intel, bios

Documentation

KyleAnderson/bios — version 0.0.3 Nov 28th 2013

Puppet-Bios

Build Status

A puppet module for configuring bios settings.

Requirements / Supported Platforms


Not all hardware platforms can have their bios changed in a programmatic way. The sad truth is that most platforms require a warm body to change bios settings. You are in luck though if you have something like:

  • Intel based platforms (using the syscfg tool)
  • Dell C-series Servers (using the setupbios tool)
  • More platforms with your help! Pull request me!

Important: This module assumes you have the proper tool installed and in the path. This is left as an exercise to the reader. I suggest finding the tool appropriate for your platform, pick a place to put it, write a wrapper script for /usr/bin and use fpm to package it all together.

Configuration


As long as you have the tool installed in the default path, there shouldn't need to be any configuration. It sets up a defined type that you can use over and over for each bios setting you need.

Examples

 # Easy to set on a dell
 bios::setting { 'turbo_mode': value => 'disabled' }
 
 # Intel requires some more hand holding with turbo. You set 1/0 and expect Enabled/Disabled..
 bios::setting { 'Intel(R) Turbo Boost Technology':
   value   => '0',
   expect  => 'Disabled',
   section => 'Processor Configuration'
 }
 
 # Set fan speed on intel:
 bios::setting { 'Fan PWM Offset':
   value   => '100',
   section => 'System Acoustic and Performance Configuration'
 }
 
 # Disabled Cstates on dell:
 bios::setting { 'c_states': value => 'disabled' }

What?

Where did I get these magic words? How do I know what section to use? How do I know what valid inputs are for "value" and when to "expect" something different?

I don't have a good answer. You can look in the docs folder for some example outputs of these commands. At first I attempted to have puppet validate inputs to abstract over some of this, but there are just so many possible combinations of platform/bios revision/hardware/etc. It is much more sane to let the tool itself validate your inputs. (the tool is the single point of truth)

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Contact

Kyle Anderson kyle@xkyle.com