theforeman.foreman.puppetclasses_import – Import Puppet Classes from a Proxy

Note

This plugin is part of the theforeman.foreman collection (version 2.1.1).

To install it use: ansible-galaxy collection install theforeman.foreman.

To use it in a playbook, specify: theforeman.foreman.puppetclasses_import.

New in version 2.0.0: of theforeman.foreman

Synopsis

  • Import Puppet Classes from a Proxy

Requirements

The below requirements are needed on the host that executes this module.

  • requests

Parameters

Parameter Choices/Defaults Comments
environment
string
Puppet Environment to import Puppet Classes from
except
list / elements=string
    Choices:
  • new
  • updated
  • obsolete
Which types of Puppet Classes to exclude from the import.
password
string / required
Password of the user accessing the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_PASSWORD will be used instead.
server_url
string / required
URL of the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_SERVER_URL will be used instead.
smart_proxy
string / required
Smart Proxy to import Puppet Classes from
username
string / required
Username accessing the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_USERNAME will be used instead.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether or not to verify the TLS certificates of the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_VALIDATE_CERTS will be used instead.

Examples

- name: Import Puppet Classes
  theforeman.foreman.puppetclasses_import:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    smart_proxy: "foreman.example.com"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
result
dictionary
success
Details about the Puppet Class import
 
environments_ignored
integer
when environment not specificed
Number of ignored Puppet Environments
 
environments_obsolete
integer
when environment not specificed
Number of Puppet Environments with removed Puppet Classes
 
environments_updated_puppetclasses
integer
when environment not specificed
Number of Puppet Environments with updated Puppet Classes
 
environments_with_new_puppetclasses
integer
when environment not specificed
Number of Puppet Environments with new Puppet Classes
 
results
list / elements=string
success
List of Puppet Environments and the changes made to them


Authors

  • Evgeni Golov (@evgeni)