theforeman.foreman.puppetclasses_import module – Import Puppet Classes from a Proxy
Note
This module is part of the theforeman.foreman collection (version 5.11.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install theforeman.foreman. You need further requirements to be able to use this module, see Requirements for details.
To use it in a playbook, specify: theforeman.foreman.puppetclasses_import.
New in theforeman.foreman 2.0.0
Synopsis
- Import Puppet Classes from a Proxy
Requirements
The below requirements are needed on the host that executes this module.
- requests
Parameters
Parameter | Comments |
|---|---|
ca_path path | PEM formatted file that contains a CA certificate to be used for validation. If the value is not specified in the task, the value of environment variable |
environment string | Puppet Environment to import Puppet Classes from |
except list / elements=string | Which types of Puppet Classes to exclude from the import. Choices:
|
oauth1_consumer_key string | OAuth1 consumer key for accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
oauth1_consumer_secret string | OAuth1 consumer secret for accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
password string | Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
server_url string / required | URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
smart_proxy string / required | Smart Proxy to import Puppet Classes from |
use_gssapi boolean | Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library requests-gssapi to be installed. If the value is not specified in the task, the value of environment variable Choices:
|
username string | Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
validate_certs boolean | 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 Choices:
|
Attributes
Attribute | Support | Description |
|---|---|---|
check_mode | Support: none | Can run in check_mode and return changed status prediction without modifying the entity |
diff_mode | Support: none | Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
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 | Description |
|---|---|
result dictionary | Details about the Puppet Class import Returned: success |
|
environments_ignored integer |
Number of ignored Puppet Environments Returned: when environment not specificed |
|
environments_obsolete integer |
Number of Puppet Environments with removed Puppet Classes Returned: when environment not specificed |
|
environments_updated_puppetclasses integer |
Number of Puppet Environments with updated Puppet Classes Returned: when environment not specificed |
|
environments_with_new_puppetclasses integer |
Number of Puppet Environments with new Puppet Classes Returned: when environment not specificed |
|
results list / elements=string |
List of Puppet Environments and the changes made to them Returned: success |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/theforeman/foreman/puppetclasses_import_module.html
