Forge Home

serial_console

System serial console setup for SOL

5,918 downloads

171 latest version

5.0 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.

Version information

  • 1.4.0 (latest)
  • 1.3.0
  • 1.2.1
  • 1.2.0
  • 1.1.0
  • 1.0.1
  • 1.0.0
  • 0.10.0
released Oct 7th 2023
This version is compatible with:
  • Puppet Enterprise 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
  • Puppet >= 5.5.0 < 9.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'mindhive-serial_console', '1.4.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add mindhive-serial_console
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install mindhive-serial_console --version 1.4.0

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

Documentation

mindhive/serial_console — version 1.4.0 Oct 7th 2023

Puppet module for system serial console setup

This module configures system for serial console access (boot loader and kernel), usable through Serial-over-LAN (SOL).

Requirements

Module has been tested on:

  • Puppet:
    • 5.5
    • 6.14
  • OSes:
    • Ubuntu 18.04
    • Debian 8 - 9
    • RHEL/CentOS 7

Quick Start

Setup

include serial_console

Full configuration options:

class { serial_console:
  ensure            => present,  # add or remove configuration
  enable_kernel     => true,     # enable kernel config
  enable_bootloader => true,     # enable bootloader config
  reboot            => false,    # reboot if kernel parameters are changed (SOL won't work until reboot)
  tty               => 'tty0',   # text console name
  ttys              => 'ttyS0',  # serial device name without path, defaults to last ttyS* with a UART 
  speed             => 115200,   # serial port speed
  logout_timeout    => undef,    # interactive session timeout in seconds (sets TMOUT)
}

Facts

serialports, usbserialports

List of available serial port device names (without /dev prefix). For example:

["ttyS0","ttyS1"]

Contributors