Forge Home

support_tasks

A module used to deliver Tasks for the solutions & configurations described in the PE Support Knowledgebase https://support.puppet.com/hc/en-us

67,630 downloads

1,441 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
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.

Version information

  • 5.0.0 (latest)
  • 4.1.0
  • 4.0.0
  • 3.1.0
  • 3.0.0
  • 2.0.0
  • 1.1.3
  • 1.1.2
  • 1.1.1
  • 1.1.0
  • 1.0.9
  • 1.0.8
  • 1.0.7
  • 1.0.6
  • 1.0.5
  • 1.0.4
  • 1.0.3
  • 1.0.2
  • 1.0.1
  • 1.0.0
released Nov 14th 2023
This version is compatible with:
  • Puppet Enterprise 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
  • , , , , , , , , ,
Tasks:
  • st0009_change_pe_service_loglevel
  • st0236_set_cache_paths_to_default
  • st0267_clear_file_sync_locks
  • st0285_find_disabled_agents
  • st0285a_bash_find_disabled_agents
  • st0285b_powershell_find_disabled_agents
  • st0286_change_puppet_daemon_runmode
  • and 16 more. See all tasks

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppetlabs-support_tasks', '5.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-support_tasks
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-support_tasks --version 5.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

puppetlabs/support_tasks — version 5.0.0 Nov 14th 2023

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.

Deprecation Notice

The following tasks are no longer being developed and will be deprecated in a future version:

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.