Version information
This version is compatible with:
- Puppet Enterprise 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, 2017.3.x, 2017.2.x, 2016.4.x
- Puppet >= 4.10.0 < 7.0.0
- , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'dodevops-ocsinventoryagent', '1.0.0'
Learn more about managing modules with a PuppetfileDocumentation
dodevops/ocsinventoryagent
Table of Contents
Description
This puppet module installs and configures the linux agent for OCS-Inventory.
Requirements
Package repo for non Debian based operating systems
You need to care for the ocsinventory-agent package repository by yourself on non Debian based operating systems.
On Debian based operating systems, the pacakge is part of the repositories.
SLES requirements
On SLES (only SLES 15 tested so far) the "Desktop Applications" and the "Development Tools" software modules need to be activated in order for dependencies to be available. Some of the dependencies are not available in the the software pools for SLES and need to be provided separatly. Recommended is the opensuse software portal https://software.opensuse.org/. Recommended is the "devel:languages:perl" project there, where most of the packages are available. Every infrastructure is different, so please take care of providing these pacakges on your own. This module only has package install definitions for those packages.
The affected packages in detail are:
- perl-Data-UUID
- perl-Proc-Daemon
- perl-Proc-ProcessTable
- perl-Proc-Simple
Sysconfig file
The packages for non Debian based operating systems are very fragmented. For RedHat/Centos there are packages in EPEL but also on the repo of the OCS inventory project itself, both are structured very different. Also for SLES you can find many different packages in the OpenSUSE build service.
Nearly all (exception is f.e. the EPEL package) of those packages have in common, that you have to configure a sysconfig file in order for the agent (or to be specific: its cronjob) to do something. Some of them provide templates for it, some not. And the config flags in those differ. So please take care about the sysconfig file on your own, if required.
CA
If your OCS server has the complete chain (root CA, intermediate, certificate), your agent should work without a CA set. However if you don't configure the root CA on your OCS server, you need to provide the root CA on the agent. If your server uses a certificate signed by a usual CA, the CA bundle of the specific OS has proven to work fine. You can spot that something is wrong with your CA setup if your agent looks for a CAcert.pem file in its /var directory and cant find it.
Usage
Use the class ocsinventoryagent to install and configure the agent. See the reference section for details.
class {
'ocsinventoryagent':
server => 'https://ocs.company.com',
}
Reference
Table of Contents
Classes
ocsinventoryagent
: Installs and configures the OCS inventory agent package for the operating system
Classes
ocsinventoryagent
Installs and configures the OCS inventory agent package for the operating system
- See also https://forge.puppet.com/puppet/zypprepo Used component module for Zypper Repository
Parameters
The following parameters are available in the ocsinventoryagent
class.
ensure
Data type: Enum['present', 'absent']
Ensure wether the package is installed or not
Default value: 'present'
package_name
Data type: String
The name of the ocsinventory-agent package
Default value: 'ocsinventory-agent'
daemon
Data type: Enum['0', '1']
detach the agent in background
Default value: '0'
debug
Data type: Enum['0', '1']
debug mode
Default value: '0'
devlib
Data type: Enum['0', '1']
search for Backend mod in ./lib only
Default value: '0'
force
Data type: Enum['0', '1']
always send data to server (Don't ask before)
Default value: '0'
info
Data type: Enum['0', '1']
verbose mode
Default value: '1'
lazy
Data type: Enum['0', '1']
do not contact the server more than one time during the PROLOG_FREQ
Default value: '0'
local
Data type: String
do not contact server but write inventory in DIR directory in XML
Default value: ''
logfile
Data type: String
log message in this file
Default value: ''
password
Data type: String
password for server auth
Default value: ''
proxy
Data type: String
proxy address. e.g: http://user:pass\@proxy:port
Default value: ''
realm
Data type: String
realm for server auth. e.g: 'Restricted Area'
Default value: ''
server
Data type: String
server uri
Default value: 'http://ocsinventory-ng/ocsinventory'
stdout
Data type: Enum['0', '1']
do not write or post the inventory but print it on STDOUT
Default value: '0'
ocstag
Data type: String
Use tag for ocs
Default value: ''
user
Data type: String
user for server auth
Default value: ''
wait
Data type: String
wait a random period before contacting server like --daemon does
Default value: ''
nosoftware
Data type: Enum['0', '1']
do not return installed software list
Default value: '0'
delaytime
Data type: String
set a max delay time (in second) if no PROLOG_FREQ is set
Default value: '3600'
backendCollectTimeout
set a max delay time of one action (search package id, ...) is set
scanhomedirs
Data type: Enum['0', '1']
permit to scan home user directories
Default value: '0'
ssl
Data type: Enum['0', '1']
disable or enable SSL communications check
Default value: '1'
ca
Data type: String
path to CA certificates file in PEM format
Default value: ''
repo_dependencies
Data type: Optional[Hash]
A list of package dependencies required to install before the dependencies
Default value: undef
dependencies
Data type: Optional[Hash]
A list of package dependencies required to install OCS inventory package
Default value: undef
zypper_repo_url
Data type: Optional[String]
URL of Zypper Repository for SLES systems
Default value: undef
backendcollecttimeout
Data type: String
Default value: '600'
Change log
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v1.0.0 (2021-07-22)
Fixed
- Fixing os family Suse and RedHat #5 (timdeluxe)
- fix: Fixing typo regarding dependencies #4 (timdeluxe)
v0.4.2 (2021-07-20)
v0.4.1 (2021-03-08)
Fixed
v0.4.0 (2021-03-05)
Added
v0.3.0 (2021-03-03)
Added
v0.2.0 (2020-02-20)
v0.1.0 (2020-02-19)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppet-zypprepo (>= 2.2.2)