List of Plugins¶

Many of the available plugins have RPM and Debian packages available from our plugin repositories. See Install a Plugin in the Foreman manual for more information.

If you'd like to see a plugin packaged, either file an issue, write to the mailing list, or best, send a pull request to foreman-packaging.

• Table of contents
• List of Plugins
  • Foreman plugins
    • Compute resources
    • Configuration management
    • Provisioning extensions
    • Other software package integrations
    • Uncategorized plugins
    • Plugins for plugins
    • Unmaintained plugins
  • Plugins for Foreman in other software
  • Foreman-related tools

Foreman plugins¶

Compute resources¶

These plugins add new compute resources for provisioning hosts to Foreman.

Name	URL	Description	RPM?	Deb?
foreman_azure_rm	https://github.com/theforeman/foreman_azure_rm	Azure Resource Manager as a Compute Resource of Foreman	no	no
foreman_digitalocean	https://github.com/theforeman/foreman-digitalocean	Enables provisioning and managing of DigitalOcean droplets in Foreman	yes	yes
foreman_docker	https://github.com/theforeman/foreman_docker	Docker container management and provisioning	yes	yes
foreman_fog_proxmox	https://github.com/theforeman/foreman_fog_proxmox	Proxmox as Compute Resource in Foreman	yes	yes
foreman_hyperv	https://github.com/ananace/foreman_hyperv	Microsoft Hyper-V as a Compute Resource in Foreman
foreman_xen	https://github.com/theforeman/foreman-xen	Provision and manage Xen Server in Foreman	yes	yes
foreman_scaleway	https://github.com/theforeman/foreman_scaleway	Enabled provisioning and managing of Scaleway server in Foreman	no	no

Configuration management¶

These plugins integrate with or extend Foreman's support for configuration management tools.

Name	URL	Description	RPM?	Deb?
foreman_ansible	https://github.com/theforeman/foreman_ansible	Ansible integration in Foreman	yes	yes
foreman_chef	https://github.com/theforeman/foreman_chef	Chef configuration management integration	yes	yes
foreman_salt	https://github.com/theforeman/foreman_salt	Salt configuration management integration	yes	yes
puppetdb_foreman	https://github.com/theforeman/puppetdb_foreman	Deactivates puppetdb nodes associated with a host when the host is deleted	yes	yes

Provisioning extensions¶

These plugins provide new ways to provision hosts.

Name	URL	Description	RPM?	Deb?
foreman_bootdisk	https://github.com/theforeman/foreman_bootdisk	Creates iPXE-based ISO and USB boot disks to provision hosts without the need for PXE infrastructure	yes	yes
foreman_discovery	https://github.com/theforeman/foreman_discovery	Metal-as-a-Service functionality for Foreman	yes	yes
foreman_setup	https://github.com/theforeman/foreman_setup	It helps set up provisioning in two parts using a wizard: a) helps you enter network info and then tells you how to run Foreman installer to set up DHCP and DNS management, b) sets up an OS with templates, installation media and everything you need	yes	yes
foreman_rescue	https://github.com/dm-drogeriemarkt/foreman_rescue	Boot systems directly into a rescue system

Other software package integrations¶

These plugins add support into Foreman for integrating with other applications.

Name	URL	Description	RPM?	Deb?
foreman_abrt	https://github.com/theforeman/foreman_abrt	Foreman plugin for displaying reports from Automatic Bug Reporting Tool	yes
foreman_memcache	https://github.com/theforeman/foreman_memcache	Adds memcache support for foreman	yes	yes
foreman_monitoring	https://github.com/theforeman/foreman_monitoring	Integrates with monitoring systems	yes
foreman_openscap	https://github.com/theforeman/foreman_openscap	Displays vulnerability and compliance reports from OpenSCAP	yes
foreman_scc_manager	https://github.com/ATIX-AG/foreman_scc_manager	Foreman plugin to sync SUSE Customer Center products and repositories into Katello
foreman_snapshot_management	https://github.com/ATIX-AG/foreman_snapshot_management	A plugin to manage vmware vSphere snapshots from foreman UI
foreman_spacewalk	https://github.com/dm-drogeriemarkt/foreman_spacewalk	Integrates Foreman with Spacewalk
foreman_vault	https://github.com/dm-drogeriemarkt/foreman_vault	Integrates Foreman with Vault
foreman_git_templates	https://github.com/dm-drogeriemarkt/foreman_git_templates	Allows to store templates for host provisioning in git

Uncategorized plugins¶

Name	URL	Description	RPM?	Deb?
foreman_column_view	https://github.com/GregSutcliffe/foreman_column_view	Adds a new column to the Hosts view. The user can define what the column should display	yes	yes
foreman_datacenter	https://github.com/cloudevelops/foreman_datacenter	A plugin that lets you document your servers in a datacenter		yes
foreman_default_hostgroup	https://github.com/theforeman/foreman_default_hostgroup	Add newly-created hosts to a default host group when they check in through Puppet	yes	yes
foreman_dhcp_browser	https://github.com/theforeman/foreman_dhcp_browser	List, create, update and delete dhcp records outside of foreman host creation	yes	yes
foreman_expire_hosts	https://github.com/theforeman/foreman_expire_hosts	Foreman plugin for limiting host lifetime	yes
foreman_hooks	https://github.com/theforeman/foreman_hooks	Executes hook scripts on lifecycle events in Foreman, allowing you to integrate Foreman quickly into other systems	yes	yes
foreman_host_extra_validator	https://github.com/theforeman/foreman_host_extra_validator	Adds extra validations to a foreman host object	yes
foreman_omaha	https://github.com/theforeman/foreman_omaha	Provides CoreOS updates via Omaha protocol without public infrastructure	yes
foreman_radiator	https://github.com/isratrade/foreman_radiator	This plugin allows users to view from within Foreman the radiator page found in Puppet Dashboard
foreman_remote_execution	https://github.com/theforeman/foreman_remote_execution	Brings multi-provider (SSH built in, more by other plugins) remote execution capabilities into foreman	yes	yes
foreman_templates	https://github.com/theforeman/foreman_templates	Sync templates from the Foreman Community Templates repo (or your own git repo, optionally) to Foreman's provisioning templates	yes	yes
foreman_dlm	https://github.com/dm-drogeriemarkt/foreman_dlm	Distributed Lock Manager for Foreman, great for patching a cluster of hosts
foreman_wreckingball	https://github.com/dm-drogeriemarkt/foreman_wreckingball	VMWare vSphere status checks

Plugins for plugins¶

These plugins tend not to provide much/any user-facing functionality, but may be dependencies of other plugins that do.

Name	URL	Description	RPM?	Deb?
bastion	https://github.com/katello/bastion	AngularJS-based single page UI framework for other plugins	yes
foreman-tasks	https://github.com/theforeman/foreman-tasks	Background task management engine for Foreman, used by other plugins	yes	yes

Unmaintained plugins¶

A list of plugins that no longer seem to work with current versions of Foreman. Don't install these!

If you're interested in taking over maintenance of one of these plugins, please contact us on the development community board.

Name	URL	Description	RPM?	Deb?
foreman_audited_notifications	https://github.com/frimik/foreman_audited_notifications	Sends Audit notifications to Email and IRC (Currently via rbot) for all (most) changes happening in Foreman
foreman_azure	https://github.com/theforeman/foreman_azure	Azure as a Compute Resource of Foreman	yes	yes
foreman_cockpit	https://github.com/theforeman/foreman_cockpit	Show cockpit components (terminal, system, journald..) on Foreman host view.	yes	yes
foreman_content	https://github.com/theforeman/foreman_content	(Unmaintained) Provides repository synchronization and management in Foreman using Pulp
foreman_cpp_cloudstack	https://github.com/bytemine/foreman_cpp_cloudstack	Enables provisioning and managing a Cloudstack Server in Foreman
foreman_custom_banner	https://github.com/jcmcken/foreman_custom_banner	Adds a configurable, custom banner to the Foreman UI
foreman_custom_parameters	https://github.com/theforeman/foreman_custom_parameters	Implements "custom fields" functionality by defining default parameters	yes
foreman_deployments	https://github.com/theforeman/foreman_deployments	(Unmaintained) Multi-Host deployment support
foreman_epel_release	https://github.com/frimik/foreman_epel_release	This plugin exposes a new route /epel-release/:version/:arch which redirects to the latest Fedora EPEL release RPM package
foreman_graphite	https://github.com/theforeman/foreman_graphite	Send foreman rails application performance metrics to graphite in real time	yes	yes
foreman_host_overview	https://github.com/sfu-rcg/foreman_host_overview	Extends the properties table for a host to include VNC & RDP links, as well as the host's certificate name
foreman_host_rundeck	https://github.com/theforeman/foreman_host_rundeck	(Unmaintained) Creates a yaml representation of rundeck on host.	yes	yes
foreman_icinga	https://github.com/timogoebel/foreman_icinga	(Unmaintained, replaced by foreman_monitoring) This plugin integrates Foreman with Icinga 2 in several ways.
foreman_mco	https://github.com/witlessbird/foreman_mco	(Unmaintained) Manage remote execution using Foreman + MCollective	yes
foreman_noenv	https://github.com/joshuabaird/foreman_noenv	Allows a hosts Puppet agent to specify a local environment	yes
foreman_one	https://github.com/theforeman/foreman-one	A foreman plugin to provision and manage OpenNebula virtual machines from Foreman	yes	yes
foreman_openstack_cluster	https://github.com/GregSutcliffe/foreman_openstack_cluster	(Unmaintained) Sets up host groups for provisioning hosts in OpenStack clusters	yes
foreman_ovirt	https://github.com/oourfali/foreman_ovirt	This plugin allows oVirt users to view Foreman data from within the oVirt Administration Portal
foreman_param_lookup	https://github.com/domcleal/foreman_param_lookup	Exposes smart class parameters lookups as an API, used with foreman_data_binding and automatic Puppet 3 data lookups	yes
foreman_pipeline	https://github.com/theforeman/foreman_pipeline	(Unmaintained) Allows Foreman to cooperate with Jenkins CI
foreman_plugin_computeresource_add_remove_interface	https://github.com/MarcGrimme/foreman_plugin_computeresource_add_remove_interface	Adds or removes a given interface to a VMware guest when build and removes it afterwards
foreman_plugin_exec_cmd	https://github.com/MarcGrimme/foreman_plugin_exec_cmd	Executes a configured command on host events in Foreman
foreman_reserve	https://github.com/david-caro/foreman_reserve	This plugin implements a new custom API call at /api/hosts_reserve that returns the name of available host(s) and updates the host's parameters	yes
foreman_resources	https://github.com/arnoudj/foreman_resources	Manages individual Puppet resources in Foreman, for use with create_resources
foreman_sentry	https://github.com/brandonweeks/foreman_sentry	Track exceptions using Sentry
foreman_slack	https://github.com/shlomizadok/foreman_slack	Sends events from Foreman to a Slack channel
hostgroup_extra_validator_foreman	https://github.com/cernops/hostgroup_extra_validator_foreman	Adds a new customizable validator for hostgroups
hubot_notify	https://github.com/GregSutcliffe/hubot_notify	Sends an HTTP message (via POST) to a webservice (hubot) for reposting to an IRC channel on build events
ovirt_provision_plugin	https://github.com/theforeman/ovirt_provision_plugin	(Unmaintained) Ovirt provision plugin sends API request to oVirt management to reinstall host id after discovered hosts are first provisioned by oVirt engine (Using foreman provider integration).
staypuft	https://github.com/theforeman/staypuft	(Unmaintained) Staypuft is the name of the OpenStack Foreman Installer plugin for The Foreman.

Plugins for Foreman in other software¶

Name	URL	Description
foreman-ansible	https://github.com/romeotheriault/foreman-ansible	An Ansible ENC (external node classifier) to get, group and classify nodes based on the Puppet facts in The Foreman
foreman_ansible_inventory	https://github.com/theforeman/foreman_ansible_inventory	Foreman dynamic inventory script for ansible
foreman_data_binding	https://github.com/domcleal/foreman_data_binding	Uses Foreman's smart class parameters with Puppet 3's data binding feature
mcollective-foreman	https://github.com/cernops/mcollective-foreman	Uses foreman as a discovery agent for Marionette Collective
foreman-wimaging	https://github.com/kireevco/foreman-wimaging	Create windows server images for Foreman with Wimaging
rex-foreman	https://github.com/RexOps/rex-foreman	Foreman support for (R)?ex Remote Execution (rexify.org)
stackstorm-foreman	https://github.com/StackStorm-Exchange/stackstorm-foreman	StackStorm Pack that implements the Foreman and Katello APIs for controlling Foreman from StackStorm

Foreman-related tools¶

Name	URL	Description
foreman-host-builder	https://github.com/xnaveira/foreman-host-builder	Use python-foreman to build sets of hosts in Foreman
foreman-architect	https://github.com/bronto/foreman-architect	Automation scripts for Foreman to create a complete virtual machine environment using Foreman.
YAFCT	https://github.com/ITV/YAFCT	Foreman CLI in Python
docker-foreman	https://github.com/riskable/docker-foreman	A set of scripts and Dockerfile to run a Foreman Docker container
foreman-yml	https://github.com/adfinis-sygroup/foreman-yml	CLI tool to automatically configure Foreman based on a YAML file
foreman-ansible (Playbook)	https://github.com/adfinis-sygroup/foreman-ansible	Foreman Ansible playbook to deploy complete Foreman instances including DHCP, TFTP, etc.
ansible-module-foreman	https://github.com/Nosmoht/ansible-module-foreman	Ansible module to manage Foreman's configuration (compute resources, hostgroups, images, LDAP, …)