Version information
This version is compatible with:
- Puppet Enterprise 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, 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
Add this module to your Puppetfile:
mod 'm4ce-mcollective_agent_shell', '0.0.2-4'
Learn more about managing modules with a PuppetfileDocumentation
mcollective_agent_shell version 0.0.2-4
Table of Contents
Overview
Run commands with the local shell
The mcollective_agent_shell module is based on the source from https://github.com/puppetlabs/mcollective-shell-agent.
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::plugin_classes:
- 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
mcollective_agent_shell::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_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 onmcollective_agent_shell::manage_gem_dependencies
- disable managing of gem dependenciesmcollective_agent_shell::package_dependencies
- Deep Merged Hash of package name and version this module depends onmcollective_agent_shell::manage_package_dependencies
- disable managing of packages dependenciesmcollective_agent_shell::class_dependencies
- Array of classes to include when installing this modulemcollective_agent_shell::package_dependencies
- disable managing of class dependenciesmcollective_agent_shell::config
- Deep Merged Hash of common config items for this modulemcollective_agent_shell::server_config
- Deep Merged Hash of config items specific to managed nodesmcollective_agent_shell::client_config
- Deep Merged Hash of config items specific to client nodesmcollective_agent_shell::policy_default
-allow
ordeny
mcollective_agent_shell::policies
- List ofactionpolicy
policies to deploy with an agentmcollective_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
orabsent
Dependencies
- ripienaar/mcollective (>= 0.0.17 < 2.0.0)