REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• oxidized: Manage Oxidized

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

• oxidized::model: Manage oxidized models

Classes

oxidized

Manage Oxidized

Examples

include oxidized

Parameters

The following parameters are available in the oxidized class:

• manage_repo
• ruby_dependencies
• install_dependencies
• with_web
• package_ensure
• script_package_ensure
• web_package_ensure
• user
• user_group
• user_uid
• user_group_gid
• user_home
• user_home_mode
• config
• config_mode
• source_type
• devices
• devices_map
• devices_vars_map
• with_service
• service_start
• show_diff
• log
• log_mode
• models

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

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

source

Data type: String

Source of model