Forge Home


Choria Management Backplane


5,456 latest version

2.4 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.2.0 (latest)
released Jul 14th 2018
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.4.x
  • Puppet >= 4.9.0

Start using this module

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

Add this module to your Puppetfile:

mod 'choria-mcollective_agent_backplane', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add choria-mcollective_agent_backplane
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install choria-mcollective_agent_backplane --version 0.2.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.



choria/mcollective_agent_backplane — version 0.2.0 Jul 14th 2018

Choria Embeddable Backplane Client

This prepared the Choria RPC CLI and Ruby API for communication with services managed by the Choria Embeddable Backplane.

A compiled client with no dependencies can be found on the above page, if you only wish to interact with the backplane from the CLI that is the recommended tool to use.


This agent provides the following actions, for details about each please run mco plugin doc agent/backplane

  • flip - Flip the Circuit Breaker
  • health - Checks the health of the managed service
  • info - Information about the managed service
  • pause - Pause the Circuit Breaker
  • ping - Backplane communications test
  • resume - Resume the Circuit Breaker
  • shutdown - Terminates the managed service

Managing Backplanes

The backplane services are grouped together using subcollectives, for example if you have a service notifications those services will all inhabit the notifications_backplane sub collective.

To configure the Choria client to be able to communicate with these add this to your Hiera data:

    - mcollective
    - notifications_backplane

You can then use any of the actions targeting the particular backplane, for example:

$ mco rpc backplane info -T notifications_backplane