Forge Home

oxidized

Oxidized Puppet module
Project URLRSS FeedReport issues

14,596 downloads

367 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

  • 3.0.0 (latest)
  • 2.0.0
  • 1.1.0
  • 1.0.0
  • 0.7.3
  • 0.7.2
  • 0.7.1
  • 0.7.0
  • 0.6.2
  • 0.6.1
  • 0.6.0
  • 0.5.1
  • 0.5.0
  • 0.4.0
  • 0.3.0
  • 0.2.0
  • 0.1.0
released Oct 20th 2024
This version is compatible with:
  • Puppet Enterprise 2025.3.x, 2025.2.x, 2025.1.x, 2023.8.x, 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
  • Puppet >= 7.0.0 < 9.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'treydock-oxidized', '3.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add treydock-oxidized
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install treydock-oxidized --version 3.0.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

treydock/oxidized — version 3.0.0 Oct 20th 2024

Reference

Table of Contents

Classes

Public Classes

Private Classes

  • oxidized::config: Manage oxidized configs
  • oxidized::install: Manage oxidized packages
  • oxidized::repo: Manage repos needed for oxidized
  • oxidized::service: Manage oxidized service
  • oxidized::user: Manage Oxidzed user

Defined types

Classes

oxidized

Manage Oxidized

Examples

include oxidized

Parameters

The following parameters are available in the oxidized class:

manage_repo

Data type: Boolean

Sets if repos needed for oxidize are managed.

Default value: true

ruby_dependencies

Data type: Array

Ruby dependencies

Default value: []

install_dependencies

Data type: Array

Additional install dependencies

Default value: []

with_web

Data type: Boolean

Sets if the oxidized web should be installed and configured

Default value: false

package_ensure

Data type: String

Ensure value for main oxidized package

Default value: 'installed'

script_package_ensure

Data type: String

Ensure value for oxidized-script package

Default value: 'installed'

web_package_ensure

Data type: Optional[String]

Ensure value for oxidized web package Defaults to installed when with_web is true

Default value: undef

rugged_version

Data type: String

Version of rugged to install with SSH support

Default value: '1.6.3'

user

Data type: String

Oxidize user

Default value: 'oxidized'

user_group

Data type: String

Oxidize user's group

Default value: 'oxidized'

user_uid

Data type: Optional[Integer]

Oxidize user's UID

Default value: undef

user_group_gid

Data type: Optional[Integer]

Oxidize user's group GID

Default value: undef

user_home

Data type: Stdlib::Absolutepath

Oxidize user's home directory path

Default value: '/home/oxidized'

user_home_mode

Data type: Stdlib::FileMode

The permissions of oxidized user's home directory

Default value: '0700'

config

Data type: Hash

Oxidize config hash

Default value: {}

config_mode

Data type: Stdlib::FileMode

Oxidized config file permission mode

Default value: '0600'

source_type

Data type: Enum['csv']

Sets type of source to be used

Default value: 'csv'

devices

Data type: Array[Hash]

Information about devices. Only used when source_type is csv

Default value: []

devices_map

Data type: Hash[String, Integer]

Map of CSV fields for devices Only used when source_type is csv

Default value: { 'name' => 0, 'model' => 1 }

devices_vars_map

Data type: Optional[Hash[String, Integer]]

Set vars_map for device CSV configuration Only used when source_type is csv

Default value: undef

with_service

Data type: Boolean

Sets if the oxidized service should be installed and running

Default value: false

service_start

Data type: String

The command to use to start oxidized service

Default value: '/usr/local/bin/oxidized'

show_diff

Data type: Boolean

Boolean that sets show_diff property for files

Default value: true

log

Data type: Optional[String]

Path to oxidized log file

Default value: undef

log_mode

Data type: Stdlib::FileMode

The permissions of oxidized log file

Default value: '0644'

models

Data type: Hash

Hash of models passed to oxidized::model

Default value: {}

Defined types

oxidized::model

Manage oxidized models

Parameters

The following parameters are available in the oxidized::model defined type:

source

Data type: String

Source of model