Forge Home


Interact with users on a system


1,731 latest version

4.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

  • 0.4.0 (latest)
  • 0.3.0
  • 0.2.2
released Jan 12th 2020
This version is compatible with:
  • Puppet Enterprise 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

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

Add this module to your Puppetfile:

mod 'exaldraen-mcollective_agent_user', '0.4.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add exaldraen-mcollective_agent_user
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install exaldraen-mcollective_agent_user --version 0.4.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.



exaldraen/mcollective_agent_user — version 0.4.0 Jan 12th 2020

mcollective_agent_user version 0.4.0

Table of Contents

  1. Overview
  2. Usage
  3. Configuration


Interact with users on a system

The mcollective_agent_user module is generated automatically, based on the source from

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_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

   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 on
  • mcollective_agent_user::manage_gem_dependencies - disable managing of gem dependencies
  • mcollective_agent_user::package_dependencies - Deep Merged Hash of package name and version this module depends on
  • mcollective_agent_user::manage_package_dependencies - disable managing of packages dependencies
  • mcollective_agent_user::class_dependencies - Array of classes to include when installing this module
  • mcollective_agent_user::package_dependencies - disable managing of class dependencies
  • mcollective_agent_user::config - Deep Merged Hash of common config items for this module
  • mcollective_agent_user::server_config - Deep Merged Hash of config items specific to managed nodes
  • mcollective_agent_user::client_config - Deep Merged Hash of config items specific to client nodes
  • mcollective_agent_user::policy_default - allow or deny
  • mcollective_agent_user::policies - List of actionpolicy policies to deploy with an agent
  • mcollective_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 or absent


To contribute to this Choria.IO plugin please visit

This module was generated using the Choria Plugin Packager based on templates found at the GitHub Project.