Forge Home

serial_console

System serial console setup

20,018 downloads

1,795 latest version

4.5 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

  • 0.9.13 (latest)
  • 0.9.12
  • 0.9.11
  • 0.9.10
  • 0.9.9
  • 0.9.8
  • 0.9.7
  • 0.9.6
  • 0.9.5
  • 0.9.3
  • 0.9.2
  • 0.9.1
  • 0.9.0
released Mar 8th 2021
This version is compatible with:
  • Puppet Enterprise 3.x
  • Puppet >= 3.3.0 < 7.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'ceritsc-serial_console', '0.9.13'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install ceritsc-serial_console --version 0.9.13

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

ceritsc/serial_console — version 0.9.13 Mar 8th 2021

Puppet module for system serial console setup

This module configures system for serial console access (boot loader, kernel and login)

Requirements

Module has been tested on:

  • Puppet 3.6
  • OS:
  • Debian 6,7,8,9
  • RHEL/CentOS 6,7

Required modules:

  • puppetlabs-stdlib
  • herculesteam-augeasproviders_grub

Quick Start

Setup

include serial_console

Full configuration options:

class { 'serial_console':
  enable                 => false|true,  # enable configuration
  enable_kernel          => false|true,  # enable kernel config.
  enable_bootloader      => false|true,  # enable bootloader config.
  enable_login           => false|true,  # enable login over serial config.
  tty                    => '...',       # text console name
  ttys                   => '...',       # serial device name without path, e.g. ttyS0
  speed                  => ...,         # serial port speed, e.g. 115200
  term_type              => ...,         # serial terminal type, e.g. vt100
  runlevels              => '...',       # run levels for login over serial
  bootloader_timeout     => '...'        # bootloader timeout
  logout_timeout         => '...',       # interactive session timeout
  cmd_refresh_init       => '...',       # command to refresh init
  cmd_refresh_bootloader => '...',       # command to refresh bootloader
}

Facts

$::serialports, $::usbserialports

Returns list of available (USB) serial port device names (without /dev prefix). E.g.:

["ttyS0","ttyS1"]

$::grub1conf

Returns absolute path to GRUB 1 configuration file.

Contributors


CERIT Scientific Cloud, support@cerit-sc.cz