support_tasks
Version information
This version is compatible with:
- Puppet Enterprise 2025.5.x, 2025.4.x, 2025.3.x, 2025.2.x, 2025.1.x, 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x
- Puppet >= 7.18.0 < 9.0.0
- CentOS,OracleLinux,RedHat,Scientific,Debian,Ubuntu,windows,Fedora,SLES,Solaris
Tasks:
- st0009_change_pe_service_loglevel
- st0287_check_db_table_sizes
- st0346_herd_resolver
- st0346a_bash_herd_resolver
- st0346b_powershell_herd_resolver
- st0361_uploading_facts
- st1096_db_commands
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-support_tasks', '5.1.0'Learn more about managing modules with a PuppetfileDocumentation
support_tasks
Table of Contents
Description
This is the companion module used to deliver the tasks for the solutions and configurations described in Puppet Support knowledge base https://support.puppet.com/hc/en-us.
The knowledge base, available to our support customers, offers a range of self service solutions, ranging from fixes to known issues to useful configuration and deployment options. Some of the knowledge base articles include an accompanying Puppet task to automate the configuration of these self service solutions, this module delivers these tasks.
Setup
Beginning with support_tasks
Tasks in this module should only be executed by PE support customers in accompaniment with the corresponding knowledge base article.
Usage
Support customers should follow the instructions in the corresponding knowledge base articles linked below.
Removal Notice
The following tasks are no longer being developed and where removed:
| Task Name | Alternative |
|---|---|
| st0236_set_cache_paths_to_default | Use puppet conf |
| st0267_clear_file_sync_locks | See knowledge article for manual steps |
| st0285_find_disabled_agents | This task can be handled manually in a custom task by running the following code: if [ -e "$LOCKFILE" ] then echo "Puppet agent is disabled" cat "$(puppet config print statedir)/agent_disabled.lock" else echo "Puppet agent is enabled" exit 1 fi |
| st0286_change_puppet_daemon_runmode | To enable or disable puppet agent, see documentation |
| st0298_run_code_deploy | See documentation for suitable solution |
| st0305_support_script_and_upload | See documentation for upload methods. SFTP and MFT are preferred |
| st0362_download_latest_pe_in_stream | See documentation for latest version of PE |
| st0317a_clean_cert | Use certificate clean API to remove certifications |
| st0317b_purge_node | Use certificate clean API to purge nodes |
| st0370_generate_token | Use puppet access CLI |
| st0371_puppet_commands | Use Pe status check |
| st0372_os_commands | See documentation on system configuration |
| st0373_api_calls | See docomentation on CD4PE and Tokens Endpoint |
| st1105_primary_server_port_check | See documentation for checking TCP port configuration |
Getting Help
Puppet Enterprise Support customers can open a ticket with us at our portal for assistance https://support.puppet.com/hc/en-us, this module is officially supported by the Puppet Enterprise Support Team
To display help for the support_tasks task, run puppet task show support_tasks::<task_name>
To display a list of all tasks provided by this module run puppet task show --all | grep support_tasks
How to Report an issue or contribute to the module
If you are a PE user and need support using this module or are encountering issues, our Support team would be happy to help you resolve your issue and help reproduce any bugs. Just raise a ticket on the support portal. If you have a reproducible bug or are a community user you can raise it directly on the Github issues page of the module here. We also welcome PR contributions to improve the module. Please see further details about contributing here
Supporting Content
Articles
The Support Knowledge base is a searchable repository for technical information and how-to guides for all Puppet products.
Videos
The Support Video Playlist is a resource of content generated by the support team
Copyright and License
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Reference
Table of Contents
Tasks
st0009_change_pe_service_loglevel: ST0009 Change PE Service Loglevel - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0009 - https://supporst0287_check_db_table_sizes: ST0287 Check DB Table Sizes - This task is to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0287 - https://support.pst0346_herd_resolver: This Task will restart the puppet agent process in a randomised period between 0 and the currently set runintervalst0346a_bash_herd_resolver: This Task will restart the puppet agent process in a randomised period between 0 and the currently set runintervalst0346b_powershell_herd_resolver: powershell thundering herd scriptst0361_uploading_facts: ST0361 Uploading Facts To the Puppet Primary Server Outside of a Puppet Run - This Task to be used in conjunction with Puppet Enterprise Knowst1096_db_commands: ST1096 PDB Commands - This Task to be used in conjunction with Puppet Enterprise Guide Article - https://support.puppet.com/hc/en-us/articles
Tasks
st0009_change_pe_service_loglevel
ST0009 Change PE Service Loglevel - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0009 - https://support.puppet.com/hc/en-us/articles/115000177368
Supports noop? false
Parameters
loglevel
Data type: Enum[trace, debug, info, warn, error]
The level to which the logging will be set
service
Data type: Enum[puppetserver, puppetdb, console-services, orchestration-services]
PE service
st0287_check_db_table_sizes
ST0287 Check DB Table Sizes - This task is to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0287 - https://support.puppet.com/hc/en-us/articles/360006922673
Supports noop? false
Parameters
dbname
Data type: Enum['pe-puppetdb', 'pe-postgres', 'pe-classifier', 'pe-rbac', 'pe-activity', 'pe-orchestrator', 'postgres', all]
The name of the db to connect to
st0346_herd_resolver
This Task will restart the puppet agent process in a randomised period between 0 and the currently set runinterval
Supports noop? false
st0346a_bash_herd_resolver
This Task will restart the puppet agent process in a randomised period between 0 and the currently set runinterval
Supports noop? false
st0346b_powershell_herd_resolver
powershell thundering herd script
Supports noop? false
st0361_uploading_facts
ST0361 Uploading Facts To the Puppet Primary Server Outside of a Puppet Run - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article - https://support.puppet.com/hc/en-us/articles/360036136533
Supports noop? false
st1096_db_commands
ST1096 PDB Commands - This Task to be used in conjunction with Puppet Enterprise Guide Article - https://support.puppet.com/hc/en-us/articles/4403877435927
Supports noop? false
Parameters
command
Data type: Enum[resource_events_per_resource,longest_resource_titles,postgres_replication_slots,postgres_replication_status,postgres_activity,database_table_sizes,database_sizes]
The PDB or PostgreSQL command to perform
database
Data type: Enum[pe-puppetdb,pe-classifier,pe-orchestrator,pe-activity,pe-inventory,pe-rbac,pe-postgres]
The database name for the PDB command. Default is pe-puppetdb
What are tasks?
Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Tasks in this module release
st0346_herd_resolver
This Task will restart the puppet agent process in a randomised period between 0 and the currently set runinterval
st0346a_bash_herd_resolver
This Task will restart the puppet agent process in a randomised period between 0 and the currently set runinterval
st0346b_powershell_herd_resolver
powershell thundering herd script
st0361_uploading_facts
ST0361 Uploading Facts To the Puppet Primary Server Outside of a Puppet Run - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article - https://support.puppet.com/hc/en-us/articles/360036136533
Change log
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v5.1.0 (2025-02-03)
Added
- (CAT-2207) Remove legacy facts #194 (amitkarsale)
- Remove deprecated tasks #193 (MartyEwings)
v5.0.0 (2023-11-14)
Changed
- (SUP-3952) Remove Puppet 6 as a supported platform #156 (elainemccloskey)
Added
- SUP-4604 - Deprecation of primary_server_port_check task [st1105] #186 (Aaronoftheages)
- SUP-4603 - Deprecation of Api_calls task [st0373] #185 (Aaronoftheages)
- SUP-4602 - Deprecation of OS-Commands task [st0372] #184 (Aaronoftheages)
- SUP-4601 - Deprecation of Puppet_Commands task [st0371] #183 (Aaronoftheages)
- Sup 4600 - Deprecation of generate_token task [st0370] #182 (Aaronoftheages)
- SUP-4598 - Deprecation of Purge_Node task [st0317b] #181 (Aaronoftheages)
- SUP-4599 - Deprecation of download latest pe in stream task [St0362] #180 (Aaronoftheages)
- SUP-4593 - Deprecation of find_disabled_agents [st0285] #179 (Aaronoftheages)
- SUP-4565 - Deprecation of change_puppet_daemon_runmode [st0286] #178 (Aaronoftheages)
- SUP-4596 - Deprecation of run_code_deploy task [st0298] #177 (Aaronoftheages)
- Sup-4597 - Deprecation of support_script_and_upload task [st0305] #175 (Aaronoftheages)
- SUP-4591 - Deprecation of clear_file_sync_locks [st0267] #172 (Aaronoftheages)
- SUP-4423 - Deprecation of clean_certs task [st0317a] #170 (Aaronoftheages)
- Sup-4590 - Deprecation of set_cache_paths_to_default task [st0236] #169 (Aaronoftheages)
- Fixes:164 Report failure when code-deploy fails #165 (pillarsdotnet)
- (SUP-4277) Update bash helper functions to support V2 #162 (elainemccloskey)
- (SUP-4199) Puppet 8 release prep #159 (MartyEwings)
v4.1.0 (2022-09-29)
Added
- SUP-3551 Change password to sensitive #150 (elainemccloskey)
v4.0.0 (2022-05-17)
Changed
- (SUP-2836) Remove st0149_resolve_stack_level_too_deep #140 (MartyEwings)
Added
- (SUP-2844) Update upload support script task #142 (elainemccloskey)
v3.1.0 (2022-04-29)
Added
- (SUP-2843) Update code deploy task to use bash helper #136 (MartyEwings)
v3.0.0 (2022-02-03)
Changed
- (SUP-2838) Remove rename pe primary server task #132 (MartyEwings)
- (SUP-2856) Bash Task helper module added to dependancies #124 (MartyEwings)
- (SUP-2739) Remove Support Task kb0299_regen_master_cert #123 (henrywangpuppet)
Added
- (SUP-2839) Acceptance tests and structured task returns for st0267_clear_file_sync_locks #130 (MartyEwings)
- (SUP-2847) Structured Returns for Herd resolver #129 (MartyEwings)
- (SUP-2848) st0361a_uploading_facts convert to ruby #127 (MartyEwings)
- (Sup-2837) st0236_set_cache_paths_to_default Audit and Update #125 (MartyEwings)
v2.0.0 (2021-08-20)
Changed
- (SUP-2539) Update terminology and refactor #121 (m0dular)
- (SUP-2502) Remove harmful terminology #109 (elainemccloskey)
- Remove Tasks that are for EOL PE (SUP-2431) #101 (MartyEwings)
Added
v1.1.3 (2021-05-06)
Fixed
- [SUP-1835] duplicate token task fix #84 (MartyEwings)
- [SUP-1642] add opensource split arch support (SUP-1642) #83 (MartyEwings)
V1.1.2 (2020-03-26)
Added
Fixed
- Update st0346a_bash_herd_resolver.sh #79 (elainemccloskey)
- (SUP-1533) #77 (pgrant87)
- (SUP-1643) Open Source Compatibility #76 (pgrant87)
V1.1.1 (2020-01-17)
Added
- Task naming change #72 (MartyEwings)
1.1.0 (2019-12-20)
Added
- 1.1 release prep #69 (MartyEwings)
- Add windows find disabled agents ps1 #66 (cwebster61083)
- Console Command Line Tasks [SUP-1383] #62 (MartyEwings)
- [SUP-1531] #61 (pgrant87)
- [SUP-1408] Update Changelog and Readme for Release 1.0.9 #60 (MartyEwings)
- Remove ca_extend plans and tasks from this module. #58 (m0dular)
Fixed
UNCATEGORIZED PRS; LABEL THEM ON GITHUB
1.0.9 (2019-10-10)
Added
- (SUP-624) Execute the PE Support Script and upload it via SFTP #57 (tkishel)
- [SUP-1408] Added cross-platform task metatdata where applicable #56 (MartyEwings)
1.0.8 (2019-09-23)
Added
- (SUP-1376) (SUP-1375) #55 (MartyEwings)
- Acceptance for kb0286 (SUP-1355) #54 (MartyEwings)
1.0.7 (2019-08-29)
Fixed
- (bug) Replace servername if in user_data.conf [SUP-1217] #53 (MartyEwings)
UNCATEGORIZED PRS; LABEL THEM ON GITHUB
- Acceptance for kb0236 #52 (MartyEwings)
- pdk 1.12 update #51 (MartyEwings)
- (maint) Add a CODEOWNERS file #50 (jarretlavallee)
v1.0.6 (2019-07-01)
UNCATEGORIZED PRS; LABEL THEM ON GITHUB
- 1.0.6 release prep #49 (MartyEwings)
- thundering herd Tasks and tests #48 (MartyEwings)
v1.0.5 (2019-05-10)
Added
- (KB20267) Add a task to clean up index locks #5 (jarretlavallee)
- kb0149 task added #3 (MartyEwings)
- (maint) Update to PDK 1.6.0 with some basic checks #2 (jarretlavallee)
UNCATEGORIZED PRS; LABEL THEM ON GITHUB
- (maint) Update CHANGELOG for 1.0.5 release #46 (jarretlavallee)
- Add a reference.md for kb0337 #45 (misseuropa)
- Check for the correct string in results.values.all? #44 (m0dular)
- (maint) Prepare for travis to deploy the module to the forge #43 (jarretlavallee)
- systemd containers / kb0244 spec test #41 (MartyEwings)
- Litmus addtions #40 (MartyEwings)
- Merge m0dular/ca_extend into support_tasks #39 (m0dular)
- (SUP-2054) Update module to support PE 2019.x. #38 (jarretlavallee)
- Bump version #37 (m0dular)
- Release v1.0.4 #36 (m0dular)
- New task to clean and purge certs #35 (m0dular)
- Updating kb0263 script for 2019.0.0 #34 (abottchen)
- Updating kb0299 for Puppet 6 #33 (abottchen)
- (maint) Add task KB number to display on the forge #32 (jarretlavallee)
- Cutting 1.0.3 release #31 (abottchen)
- (SUP-602) Update task for changing log level #30 (abottchen)
- Update metadata and readme for a release 1.0.2 #29 (MartyEwings)
- (maint) Upgrade PDK to 1.7.0 and Fix shellcheck issues with new tasks #28 (jarretlavallee)
- Add master certificate regeneration task #27 (abottchen)
- Code Deploy Task #26 (daniel5119)
- Adding SSL dir backup to task kb0263 #25 (abottchen)
- Add a script for KB 263 fixing a PE master whose hostname has been changed #23 (abottchen)
- (maint) Clean up output messages in 236 and 267 #22 (jarretlavallee)
- Edit cleanup for the readme SMB 2018-07-25 #21 (misseuropa)
- Release v1.0.1 #19 (MartyEwings)
- (PDK-1090) Test task names #18 (jarretlavallee)
- Release v1.0 #17 (MartyEwings)
- Release v1.0 - Fix capital Letters in task names #16 (MartyEwings)
- Prep for V1.0 Release #15 (MartyEwings)
- (maint) change task names for kb0285 and kb0286 #14 (suckatrash)
- (maint) Rename kb0236 and kb0267 #13 (jarretlavallee)
- update task titles for 0244 and 0149 #12 (MartyEwings)
- Adding kb0287.json and kb0287.sh #11 (daniel5119)
- (kb0286) Add task to change puppet daemon runmode enabled | disabled #10 (suckatrash)
- (KB0285) Task for identifying disabled agents #9 (suckatrash)
- (KB0236) Add a task for KB0236 #8 (jarretlavallee)
- KB#0244 added #7 (MartyEwings)
- KB#0009 #6 (halimwi)
- PDK Init and Readme #1 (MartyEwings)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs-bash_task_helper (>= 1.0.0 < 3.0.0)
Quality checks
We run a couple of automated scans to help you assess a module’s quality. Each module is given a score based on how well the author has formatted their code and documentation and select 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.
Malware scan results
The malware detection service on Puppet Forge is an automated process that identifies known malware in module releases before they’re published. It is not intended to replace your own virus scanning solution.
Learn more about malware scans- Module name:
- puppetlabs-support_tasks
- Module version:
- 5.1.0
- Scan initiated:
- February 3rd 2025, 7:30:33
- Detections:
- 0 / 60
- Scan stats:
- 60 undetected
- 0 harmless
- 0 failures
- 0 timeouts
- 0 malicious
- 0 suspicious
- 15 unsupported
- Scan report:
- View the detailed scan report