Puppet Discovery tasks are single, ad hoc actions that run on your target Linux and Windows hosts, enabling you to install a Puppet agent, manage packages or system services, and run shell commands.

Important: To run tasks on Linux hosts, your SSH credentials must be for the root account on each target host. See Secure Shell (SSH).
  1. Select Menu > Run task, and select the task:
    • Install Puppet agent on Linux.

    • Install Puppet agent on Windows.

    • Manage package on Linux.

    • Manage package on Windows.

    • Manage service on Linux.

    • Manage service on Windows.

    • Run a shell command on Linux.

    • Run a shell command on Windows.

  2. Enter the values for the task parameters (see below).
  3. Click Select hosts
  4. Select the hosts to run the task on, and click Select credentials.
  5. Select the credentials for accessing the hosts, and click Review task summary.
  6. Review the tasks details, your credentials, the list of target hosts, and click Run task.
    Tip: To view the status of the task run, click Activity feed , and select Status. For more information, see View discovery and task status.

Install Puppet agents

Install a Puppet Enterprise agent to regularly pull configuration catalogs from a Puppet master, and apply them to your target Linux or Windows hosts. The agent maintains the host configuration you want.

Restriction: If you enter an invalid value for the optional cacert_content parameter, the task fails, and you must enter a valid value for the task to run. An empty value is not accepted.
ParameterDescription
master The required hostname for the Puppet master. The FQDN must be fully resolvable by the node on which you're installing the agent.
cacert_content The master CA certificate content (optional). If not specified, the master's identity is not verified during the agent installation.
certname The unique certificate name for the Puppet agent (optional).
dns_alt_names The alternative DNS names for generating the agent certificate.
custom_attribute The custom attribute setting added to puppet.conf and included in the custom_attributes section of csr_attributes.yaml. For more information, see custom attributes.
extension_request The extension attribute setting added to puppet.conf and included in the extension_requests section of csr_attributes.yaml. For more information, see extension requests.

Manage packages

Install, upgrade, or uninstall packages on discovered hosts without installing an agent.

Remember: To run the manage package task on target hosts, the following package management systems are required:
  • APT or YUM for Linux hosts.

  • Chocolatey for Windows hosts.

ParameterDescription
action The action to be applied to the package:
  • install the package. To install a specific version of the package, specify the value in the version parameter. If installing the package for the first time, the package repository on each target host must have the package stored.

  • uninstall the package. To uninstall a specific version of the package, specify the value in the version parameter.

  • upgrade the version of the package. This is particularly useful for upgrading vulnerable packages to secure versions. To upgrade to a specific version, choose install, and specify the value in the version parameter.

name The name of the package.
version The version, and if applicable, the release value of the package. A version number range or a semver pattern are not permitted. For example, to install the bash-4.1.2-29.el6.x86_64.rpm package, enter 4.1.2-29.el6.
Tip: To install or upgrade to the latest version of a package, leave the version parameter blank.

Run commands

Execute an arbitrary shell command on discovered hosts without installing an agent.

ParamterDescription
commandThe command to execute on the target hosts.

Linux example:

echo "Hello, World ${USER}" > /hello.txt

Windows example:

echo "Hello, World $env:UserName" > C:\hello.txt

Windows tasks use Command Prompt to execute commands. To run PowerShell commands, you must invoke PowerShell, for example:

powershell Get-Process

Manage system services

Stop, start, or restart services on discovered hosts.

ParameterDescription
action The action to be applied to the service:
  • stop the service.

  • start the service.

  • restart the service.

  • View the current status of the service (Windows only).

name The name of the service.
Back to top