Table of Contents

• Description
  • This is a SIMP module
• Setup
  • Beginning with simp_banners
• Usage
• Development

Description

This module provides the content of many common login banners, and the Puppet function simp_banners::fetch() to access them.

This is a SIMP module

This module is a component of the System Integrity Management Platform, a compliance-management framework built on Puppet. If you find any issues, they may be submitted to our bug tracker.

This module is optimally designed for use within a larger SIMP ecosystem, but it can be used independently.

Setup

Beginning with simp_banners

$banner_text = simp_banners::fetch('us/department_of_commerce')

Usage

This module provides the simp_banners::fetch() function. See REFERENCE.md for more details.

Development

Please read our Contribution Guide.

Reference

Table of Contents

Functions

• simp_banners::fetch: Retrieve a banner from the known list and format it according to the passed options

Functions

simp_banners::fetch

Type: Ruby 4.x API

Retrieve a banner from the known list and format it according to the passed options

`simp_banners::fetch(String[1] $name, Optional[Struct[{

    "cr_escape"   => Optional[Boolean],
    "file_source" => Optional[Boolean]
  }]] $format)`

Retrieve a banner from the known list and format it according to the passed options

Returns: String The banner formatted according to the format options

Raises:

• An error containing a list of supported banners will be raised if the requested banner cannot be found

name

Data type: String[1]

The banner to fetch

• This may need to include the relative path to the file. For example, the US Department of Commerce banner would be named 'us/department_of_commerce'

format

Data type:

Optional[Struct[{
        "cr_escape"   => Optional[Boolean],
        "file_source" => Optional[Boolean]
      }]]

Formatting options

Options:

• 'file_source' Boolean: Return a String suitable for a File source option

• Takes precedence over all other formatting options if set

• Wed Oct 11 2023 Steven Pritchard steve@sicura.us - 0.5.0

• [puppetsync] Updates for Puppet 8
  • These updates may include the following:
    • Update Gemfile
    • Add support for Puppet 8
    • Drop support for Puppet 6
    • Update module dependencies

• Mon Jun 12 2023 Chris Tessmer chris.tessmer@onyxpoint.com - 0.4.0

• Add RockyLinux 8 support

• Sat Jan 22 2022 Dan Barr drb45@arl.psu.edu - 0.3.1

• Update DoD banner text

• Wed Jun 16 2021 Chris Tessmer chris.tessmer@onyxpoint.com - 0.3.0

• Removed support for Puppet 5
• Ensured support for Puppet 7 in requirements and stdlib

• Tue Jan 28 2020 Trevor Vaughan tvaughan@onyxpoint.com - 0.2.0

• Remove all OS support statements from metadata.json since this is simply a data-only module

• Fri Aug 02 2019 Robert Vincent pillarsdotnet@gmail.com - 0.2.0

• Drop Puppet 4 support
• Add Puppet 6 support
• Add puppetlabs-stdlib 6 support

• Tue Jul 23 2019 Liz Nemsick lnemsick.simp@gmail.com - 0.1.2

• Remove unnecessary data_provider key in the metadata.json file.

• Thu Mar 07 2019 Liz Nemsick lnemsick.simp@gmail.com - 0.1.1

• Update the upper bound of stdlib to < 6.0.0
• Update a URL in the README.md

• Wed Jun 27 2018 Trevor Vaughan tvaughan@onyxpoint.com - 0.1.0

• First release