Version information
This version is compatible with:
- Puppet Enterprise 2025.4.x, 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, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0
Start using this module
Add this module to your Puppetfile:
mod 'exaldraen-mcollective_agent_user', '0.4.0'
Learn more about managing modules with a PuppetfileDocumentation
mcollective_agent_user version 0.4.0
Table of Contents
Overview
Interact with users on a system
The mcollective_agent_user module is generated automatically, based on the source from https://github.com/exaldraen/choria-plugin-user-agent.
Available Actions:
- kill - Kill all sessions belonging to the given user
- list - List logged-in users on a system
## Usage
You can include this module into your infrastructure as any other module, but as it's designed to work with the choria mcollective module you can configure it via Hiera:
mcollective::plugin_classes:
- mcollective_agent_user
## Configuration
Server and Client configuration can be added via Hiera and managed through tiers in your site Hiera, they will be merged with any included in this module
mcollective_agent_user::config:
example: value
This will be added to both the client.cfg
and server.cfg
, you can likewise configure server and client specific settings using mcollective_agent_user::client_config
and mcollective_agent_user::server_config
.
These settings will be added to the /etc/puppetlabs/mcollective/plugin.d/
directory in individual files.
For a full list of possible configuration settings see the module source repository documentation.
Data Reference
mcollective_agent_user::gem_dependencies
- Deep Merged Hash of gem name and version this module depends onmcollective_agent_user::manage_gem_dependencies
- disable managing of gem dependenciesmcollective_agent_user::package_dependencies
- Deep Merged Hash of package name and version this module depends onmcollective_agent_user::manage_package_dependencies
- disable managing of packages dependenciesmcollective_agent_user::class_dependencies
- Array of classes to include when installing this modulemcollective_agent_user::package_dependencies
- disable managing of class dependenciesmcollective_agent_user::config
- Deep Merged Hash of common config items for this modulemcollective_agent_user::server_config
- Deep Merged Hash of config items specific to managed nodesmcollective_agent_user::client_config
- Deep Merged Hash of config items specific to client nodesmcollective_agent_user::policy_default
-allow
ordeny
mcollective_agent_user::policies
- List ofactionpolicy
policies to deploy with an agentmcollective_agent_user::client
- installs client files when true - defaults to$mcollective::client
mcollective_agent_user::server
- installs server files when true - defaults to$mcollective::server
mcollective_agent_user::ensure
-present
orabsent
Development:
To contribute to this Choria.IO plugin please visit https://github.com/exaldraen/choria-plugin-user-agent.
This module was generated using the Choria Plugin Packager based on templates found at the GitHub Project.
Dependencies
- choria/mcollective (>= 0.9.3 < 2.0.0)