Forge Home


Run commands with the local shell


7,829 latest version

2.5 quality score

Version information

  • 0.0.2-4 (latest)
  • 0.0.2-3
  • 0.0.2-2 (deleted)
  • 0.0.2-1 (deleted)
  • 0.0.2 (deleted)
released Nov 9th 2016
This version is compatible with:
  • Puppet Enterprise 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, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.5.0

Start using this module

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

Add this module to your Puppetfile:

mod 'm4ce-mcollective_agent_shell', '0.0.2-4'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add m4ce-mcollective_agent_shell
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install m4ce-mcollective_agent_shell --version 0.0.2-4

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.



m4ce/mcollective_agent_shell — version 0.0.2-4 Nov 9th 2016

mcollective_agent_shell version 0.0.2-4

Table of Contents

  1. Overview
  2. Usage
  3. Configuration


Run commands with the local shell

The mcollective_agent_shell module is based on the source from

Available Actions:

  • kill - Kill a command by handle
  • list - Get a list of all running commands
  • run - Run a command
  • start - Spawn a command
  • status - Get status of managed command

## Usage

You can include this module into your infrastructure as any other module, but as it's designed to work with the ripienaar mcollective module you can configure it via Hiera:

  - mcollective_agent_shell

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