support_tasks

pdk

supported

tasks

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

Project URL RSS Feed Report issues

Module Stats

76,318 downloads

534 latest version

5.0 quality score

Version information

released Dec 20th 2019

This version is compatible with:

Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x
Puppet >= 5.3.2 < 7.0.0
CentOS
,
OracleLinux
,
RedHat
,
Scientific
,
Debian
,
Ubuntu
,
windows
,
Fedora
,
Darwin
,
SLES
,
Solaris

Tasks:

kb0267_clear_file_sync_locks

kb0009_change_pe_service_loglevel

kb00361a_uploading_facts

kb00361b_uploading_facts

kb00362_download_latest_pe_in_stream

kb0149_resolve_stack_level_too_deep

kb0236_set_cache_paths_to_default

and 20 more. See all tasks

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'puppetlabs-support_tasks', '1.1.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 1.1.0

Documentation

puppetlabs/support_tasks — version 1.1.0 Dec 20th 2019

support_tasks

Description
Setup - The basics of getting started with support_tasks
- Beginning with support_tasks
Usage - Configuration options and additional functionality
Reference - An under-the-hood peek at what the module is doing and how
- Tasks
Getting Help

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. The task name corresponds to the KB article number, for instance, article KB#9999 corresponds to task kb9999.

Usage

Support customers should follow the instructions in the corresponding knowledge base articles linked below.

Reference

To view the available actions and parameters for each task, on the command line, run puppet task show <task_name> or see the support_tasks module page on the Forge.

Tasks:

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

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.

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

kb0009_change_pe_service_loglevel

KB0009 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

Parameters
loglevel	The level to which the logging will be set `Enum[trace, debug, info, warn, error]`
service	PE service `Enum[puppetserver, puppetdb, console-services, orchestration-services]`

kb00361a_uploading_facts

KB0361 Uploading Facts To the Puppet Master Outside of a Puppet Run - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0361 - https://support.puppet.com/hc/en-us/articles/360036136533

kb00361b_uploading_facts

kb00362_download_latest_pe_in_stream

KB0362 Download Latest PE Z release in the currently installed stream - This task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB00362 - https://support.puppet.com/hc/en-us/articles/360036141593

Parameters
dlpath	The Path to Download PE too `String`

kb0149_resolve_stack_level_too_deep

KB0149 Resolve Stack Level Too Deep - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0149 - https://support.puppet.com/hc/en-us/articles/218763948

kb0236_set_cache_paths_to_default

KB0236 Set Cache Paths To Default - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0236 - https://support.puppet.com/hc/en-us/articles/360001060434

kb0244_disable_mco_logrotate

KB0244 Disable MCO Logrotate - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0244 - https://support.puppet.com/hc/en-us/articles/360002051354

kb0263_rename_pe_master

KB0263 Rename PE Master - This task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0263 - https://support.puppet.com/hc/en-us/articles/360003489634

kb0267_clear_file_sync_locks

KB0267 Clear File Sync Locks - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0267 - https://support.puppet.com/hc/en-us/articles/360003883933

kb0285_find_disabled_agents

KB0285 Find Disabled Agents - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0285 - https://support.puppet.com/hc/en-us/articles/360006717334

kb0285a_bash_find_disabled_agents

KB0285 Find Disabled Agents - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0285 - https://support.puppet.com/hc/en-us/articles/360006717334

kb0285b_powershell_find_disabled_agents

KB0285 Find Disabled Agents - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0285 - https://support.puppet.com/hc/en-us/articles/360006717334

kb0286_change_puppet_daemon_runmode

KB0286 Change Puppet Daemon Runmode - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0286 - https://support.puppet.com/hc/en-us/articles/360006721014

Parameters
puppet_mode	Can be either `enable` or `disable`, the mode to put the daemon in `Enum['enable','disable']`
reason	An optional message string to pass that will be added to disabled agents. Shows up in syslog. `Optional[String[1]]`

kb0287_check_db_table_sizes

KB0287 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

Parameters
dbname	The name of the db to connect to `Enum['pe-puppetdb', 'pe-postgres', 'pe-classifier', 'pe-rbac', 'pe-activity', 'pe-orchestrator', 'postgres', all]`

kb0298_run_code_deploy

KB0298 Run Code Deploy - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0298 - https://support.puppet.com/hc/en-us/articles/360008192734

Parameters
environment	The name of the environment to deploy `String[1]`

kb0299_regen_master_cert

KB0299 Regen Master Cert - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0299 - https://support.puppet.com/hc/en-us/articles/360008505193

Parameters
dnsaltname_override	Override to prevent existing DNS alt name carryover. Will force the use of only the DNS alt names present in pe.conf. `Optional[Boolean]`

kb0305_support_script_and_upload

Execute the PE Support Script and upload it via SFTP

Parameters
logage	Log age (in days) to collect. Defaults to '3' `Optional[Pattern[/^[0-9]$/]]`
scope	Scope (comma-delimited) of diagnostics to collect. Defaults to 'enterprise,etc,log,networking,resources,system' `Optional[Pattern[/^[a-z,]+$/]]`
ticket	Support ticket number. Required `Pattern[/^[0-9]+$/]`

Input method

environment

kb0317a_clean_cert

Clean (remove) a Puppet agent's certificate from your Master

Parameters
agent_certnames	A comma-separated list of agent certificate to clean `Pattern[/^([A-Za-z0-9._-]+,?)+$/]`

kb0317b_purge_node

Purge Puppet agent nodes

Parameters
agent_certnames	A comma-separated list of agent certificate names `Pattern[/^([A-Za-z0-9._-]+,?)+$/]`

kb0346_herd_resolver

This Task will restart the puppet agent process in a randomised period between 0 and the currently set runinterval

kb0346a_bash_herd_resolver

This Task will restart the puppet agent process in a randomised period between 0 and the currently set runinterval

kb0346b_powershell_herd_resolver

powershell thundering herd script

kb0361_uploading_facts

kb0370_generate_token

KB0370_Generate_Token This task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0370 - https://support.puppet.com/hc/en-us/articles

Parameters
password	PE RBAC User Password `String`
user	PE RBAC User `String`

kb0371_puppet_commands

KB0371 Puppet Commands - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0371 - https://support.puppet.com/hc/en-us/articles/

Parameters
command	The Puppet Master Command Line action to perform `Enum[config_print, module_list, infrastructure_status, tune]`

kb0372_os_commands

KB0372 OS Commands - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0372 - https://support.puppet.com/hc/en-us/articles/

Parameters
command	The Puppet Master Command Line action to perform `Enum[puppet_port_status, puppetserver_log, puppetdb_log, console_log, orchestrator_log, syslog_log, ssldir_permissions ]`

kb0373_api_calls

KB0373 API Calls - This Task to be used in conjunction with Puppet Enterprise Knowledge Base Article KB0373 - https://support.puppet.com/hc/en-us/articles/

support_tasks

Version information

This version is compatible with:

Tasks:

Start using this module

Documentation

support_tasks

Table of Contents

Description

Setup

Beginning with support_tasks

Usage

Reference

Getting Help

Copyright and License

What are tasks?

Tasks in this module release

kb0009_change_pe_service_loglevel

kb00361a_uploading_facts

kb00361b_uploading_facts

kb00362_download_latest_pe_in_stream

kb0149_resolve_stack_level_too_deep

kb0236_set_cache_paths_to_default

kb0244_disable_mco_logrotate

kb0263_rename_pe_master

kb0267_clear_file_sync_locks

kb0285_find_disabled_agents

kb0285a_bash_find_disabled_agents

kb0285b_powershell_find_disabled_agents

kb0286_change_puppet_daemon_runmode

kb0287_check_db_table_sizes

kb0298_run_code_deploy

kb0299_regen_master_cert

kb0305_support_script_and_upload

kb0317a_clean_cert

kb0317b_purge_node

kb0346_herd_resolver

kb0346a_bash_herd_resolver

kb0346b_powershell_herd_resolver

kb0361_uploading_facts

kb0370_generate_token

kb0371_puppet_commands

kb0372_os_commands

kb0373_api_calls

Change Log

[1.1] - 2019-12-1020

Added

Changed

Fixed

[1.0.9] - 2019-10-10

Added

Changed

Fixed

[1.0.8] - 2019-09-20

Added

Changed

Fixed

[1.0.8] - 2019-09-20

Added

Changed

Fixed

[1.0.7] - 2019-09-01

Added

Changed

Fixed

[1.0.6] - 2019-07-01

Added

Changed

Fixed

[1.0.5] - 2018-05-09

Added

Changed

Fixed

[1.0.4] - 2018-12-19

Added

Changed

Fixed

[1.0.3] - 2018-09-05

Added

Changed