.. meta:: :antsibull-docs: 2.10.0 .. _plugins_in_theforeman.foreman: Theforeman.Foreman ================== Collection version 4.1.0-dev .. contents:: :local: :depth: 1 Description ----------- Ansible Modules to manage Foreman and Katello installations **Authors:** * @lessfoobar <59063885+lessfoobar@users.noreply.github.com> * Adam Růžička * Alan.Wong * AlanCoding * Andrea Perotti * Andrew Kofink * Anthony Green * Anton * Baptiste Agasse * Bernhard Hopfenmüller * Bernhard Suttner * Bryan Kearney * Chris Forkner * Chris Hindman * Chris Snell * Christoffer Reijer * Dave Thomas <11580510+dthomastx@users.noreply.github.com> * Deric Crago * Eric D. Helms * Eric L * Ethan * Evgeni Golov * Ewoud Kohl van Wijngaarden * Felix Fontein * Francesco Trentini * Gerald Vogt * Greg Swift * Griffin Sullivan * Hideki Saito * Ismael Puerto * Jameer Pathan * James Jeffers * James Stuart * Jan Jansky * Jeffrey van Pelt * Jeremy Albinet * Jeremy Lenz * Jesper Reenberg * John Berninger * Josh Swanson * Julien Godin * Kenny Tordeurs * Kirill Shirinkin * Leos Stejskal * Lester Cheung * Lester Claudio * Lucas Bickel * Lukas Kallies * Lukas Magauer * Lukáš Zapletal * Manisha Singhal * Manuel Bonk * Marcelo Moreira de Mello * Marek Czernek * Mark Hlawatschek * Markus Bucher * Martin Schlossarek * Matthias Dellweg <2500@gmx.de> * Miikka Joutsenvirta * Nikhil Jain * Olivier * Ondrej Prazak * Ondřej Ezr * Ondřej Gajdušek * Patrick C. F. Ernzer * Patrick Creech * Paul Armstrong * Paul Belanger * Paul Gration * Peter Ondrejka * Philipp * Quirin Pamp * Richard Stempfl * Richard Waax <40852459+riwael@users.noreply.github.com> * Sam * Samir Jha * Sean O'Keeffe * Sorin Sbarnea * Steffen Frömer * Steffen Scheib * Stoned Elipot * Sven Meeus * TTherouanne * Thomas Mueller * William Bradford Clark * Yifat Makias * achevalet * alesc * bob <57952350+TheRedGreek@users.noreply.github.com> * calvingsmith <4283930+calvingsmith@users.noreply.github.com> * divialth <65872926+divialth@users.noreply.github.com> * furhouse * gardar * igramic <36156377+igramic@users.noreply.github.com> * jerrejkw <43955357+jerrejkw@users.noreply.github.com> * linuxonfire * marco * metalcated * russianguppie <46544650+russianguppie@users.noreply.github.com> * willtome * yuqo2450 <79540477+yuqo2450@users.noreply.github.com> **Supported ansible-core versions:** * 2.9.17 or newer .. ansible-links:: - title: "Issue Tracker" url: "https://github.com/theforeman/foreman-ansible-modules/issues" external: true - title: "Homepage" url: "https://theforeman.org/" external: true - title: "Repository (Sources)" url: "https://github.com/theforeman/foreman-ansible-modules" external: true .. toctree:: :maxdepth: 1 Plugin Index ------------ These are the plugins in the theforeman.foreman collection: Modules ~~~~~~~ * :ansplugin:`activation_key module ` -- Manage Activation Keys * :ansplugin:`architecture module ` -- Manage Architectures * :ansplugin:`auth_source_ldap module ` -- Manage LDAP Authentication Sources * :ansplugin:`bookmark module ` -- Manage Bookmarks * :ansplugin:`compute_attribute module ` -- Manage Compute Attributes * :ansplugin:`compute_profile module ` -- Manage Compute Profiles * :ansplugin:`compute_resource module ` -- Manage Compute Resources * :ansplugin:`config_group module ` -- Manage (Puppet) Config Groups * :ansplugin:`content_credential module ` -- Manage Content Credentials * :ansplugin:`content_export_info module ` -- List content exports * :ansplugin:`content_export_library module ` -- Manage library content exports * :ansplugin:`content_export_repository module ` -- Manage repository content exports * :ansplugin:`content_export_version module ` -- Manage content view version content exports * :ansplugin:`content_import_info module ` -- List content imports * :ansplugin:`content_import_library module ` -- Manage library content imports * :ansplugin:`content_import_repository module ` -- Manage repository content imports * :ansplugin:`content_import_version module ` -- Manage content view version content imports * :ansplugin:`content_upload module ` -- Upload content to a repository * :ansplugin:`content_view module ` -- Manage Content Views * :ansplugin:`content_view_filter module ` -- Manage Content View Filters * :ansplugin:`content_view_filter_info module ` -- Fetch information about a Content View Filter * :ansplugin:`content_view_filter_rule module ` -- Manage content view filter rules * :ansplugin:`content_view_filter_rule_info module ` -- Fetch information about a Content View Filter Rule * :ansplugin:`content_view_info module ` -- Fetch information about Content Views * :ansplugin:`content_view_version module ` -- Manage Content View Versions * :ansplugin:`content_view_version_info module ` -- Fetch information about Content Views * :ansplugin:`discovery_rule module ` -- Manage Host Discovery Rules * :ansplugin:`domain module ` -- Manage Domains * :ansplugin:`domain_info module ` -- Fetch information about Domains * :ansplugin:`external_usergroup module ` -- Manage External User Groups * :ansplugin:`global_parameter module ` -- Manage Global Parameters * :ansplugin:`hardware_model module ` -- Manage Hardware Models * :ansplugin:`host module ` -- Manage Hosts * :ansplugin:`host_collection module ` -- Manage Host Collections * :ansplugin:`host_errata_info module ` -- Fetch information about Host Errata * :ansplugin:`host_info module ` -- Fetch information about Hosts * :ansplugin:`host_power module ` -- Manage Power State of Hosts * :ansplugin:`hostgroup module ` -- Manage Hostgroups * :ansplugin:`hostgroup_info module ` -- Get information about hostgroup(s) * :ansplugin:`http_proxy module ` -- Manage HTTP Proxies * :ansplugin:`image module ` -- Manage Images * :ansplugin:`installation_medium module ` -- Manage Installation Media * :ansplugin:`job_invocation module ` -- Invoke Remote Execution Jobs * :ansplugin:`job_template module ` -- Manage Job Templates * :ansplugin:`lifecycle_environment module ` -- Manage Lifecycle Environments * :ansplugin:`location module ` -- Manage Locations * :ansplugin:`operatingsystem module ` -- Manage Operating Systems * :ansplugin:`organization module ` -- Manage Organizations * :ansplugin:`organization_info module ` -- Get information about organization(s) * :ansplugin:`os_default_template module ` -- Manage Default Template Associations To Operating Systems * :ansplugin:`partition_table module ` -- Manage Partition Table Templates * :ansplugin:`product module ` -- Manage Products * :ansplugin:`provisioning_template module ` -- Manage Provisioning Templates * :ansplugin:`puppet_environment module ` -- Manage Puppet Environments * :ansplugin:`puppetclasses_import module ` -- Import Puppet Classes from a Proxy * :ansplugin:`realm module ` -- Manage Realms * :ansplugin:`redhat_manifest module ` -- Interact with a Red Hat Satellite Subscription Manifest * :ansplugin:`registration_command module ` -- Manage Registration Command * :ansplugin:`repository module ` -- Manage Repositories * :ansplugin:`repository_info module ` -- Fetch information about Repositories * :ansplugin:`repository_set module ` -- Enable/disable Red Hat Repositories available through subscriptions * :ansplugin:`repository_set_info module ` -- Fetch information about Red Hat Repositories * :ansplugin:`repository_sync module ` -- Sync a Repository or Product * :ansplugin:`resource_info module ` -- Gather information about resources * :ansplugin:`role module ` -- Manage Roles * :ansplugin:`scap_content module ` -- Manage SCAP content * :ansplugin:`scap_tailoring_file module ` -- Manage SCAP Tailoring Files * :ansplugin:`scc_account module ` -- Manage SUSE Customer Center Accounts * :ansplugin:`scc_product module ` -- Subscribe SUSE Customer Center Account Products * :ansplugin:`setting module ` -- Manage Settings * :ansplugin:`setting_info module ` -- Fetch information about Settings * :ansplugin:`smart_class_parameter module ` -- Manage Smart Class Parameters * :ansplugin:`smart_class_parameter_override_value module ` -- Manage Smart Class Parameter Override Values * :ansplugin:`smart_proxy module ` -- Manage Smart Proxies * :ansplugin:`snapshot module ` -- Manage Snapshots * :ansplugin:`snapshot_info module ` -- Fetch information about Foreman Snapshots * :ansplugin:`status_info module ` -- Get status info * :ansplugin:`subnet module ` -- Manage Subnets * :ansplugin:`subnet_info module ` -- Fetch information about Subnets * :ansplugin:`subscription_info module ` -- Fetch information about Subscriptions * :ansplugin:`subscription_manifest module ` -- Manage Subscription Manifests * :ansplugin:`sync_plan module ` -- Manage Sync Plans * :ansplugin:`templates_import module ` -- Sync Templates from a repository * :ansplugin:`user module ` -- Manage Users * :ansplugin:`usergroup module ` -- Manage User Groups * :ansplugin:`wait_for_task module ` -- Wait for a task * :ansplugin:`webhook module ` -- Manage Webhooks .. toctree:: :maxdepth: 1 :hidden: activation_key_module architecture_module auth_source_ldap_module bookmark_module compute_attribute_module compute_profile_module compute_resource_module config_group_module content_credential_module content_export_info_module content_export_library_module content_export_repository_module content_export_version_module content_import_info_module content_import_library_module content_import_repository_module content_import_version_module content_upload_module content_view_module content_view_filter_module content_view_filter_info_module content_view_filter_rule_module content_view_filter_rule_info_module content_view_info_module content_view_version_module content_view_version_info_module discovery_rule_module domain_module domain_info_module external_usergroup_module global_parameter_module hardware_model_module host_module host_collection_module host_errata_info_module host_info_module host_power_module hostgroup_module hostgroup_info_module http_proxy_module image_module installation_medium_module job_invocation_module job_template_module lifecycle_environment_module location_module operatingsystem_module organization_module organization_info_module os_default_template_module partition_table_module product_module provisioning_template_module puppet_environment_module puppetclasses_import_module realm_module redhat_manifest_module registration_command_module repository_module repository_info_module repository_set_module repository_set_info_module repository_sync_module resource_info_module role_module scap_content_module scap_tailoring_file_module scc_account_module scc_product_module setting_module setting_info_module smart_class_parameter_module smart_class_parameter_override_value_module smart_proxy_module snapshot_module snapshot_info_module status_info_module subnet_module subnet_info_module subscription_info_module subscription_manifest_module sync_plan_module templates_import_module user_module usergroup_module wait_for_task_module webhook_module Callback Plugins ~~~~~~~~~~~~~~~~ * :ansplugin:`foreman callback ` -- Sends events to Foreman .. toctree:: :maxdepth: 1 :hidden: foreman_callback Filter Plugins ~~~~~~~~~~~~~~ * :ansplugin:`cp_label filter ` -- Convert strings to Candlepin labels .. toctree:: :maxdepth: 1 :hidden: cp_label_filter Inventory Plugins ~~~~~~~~~~~~~~~~~ * :ansplugin:`foreman inventory ` -- Foreman inventory source .. toctree:: :maxdepth: 1 :hidden: foreman_inventory