Configure PXP agent parameters

Puppet Execution Protocol (PXP) is a message format used to request task execution and receive task statuses. PXP agents runs the PXP service. You can configure pxp_agent parameters with Hiera or in the PE console.

puppet_enterprise::profile::agent::pxp_enabled

Boolean used to enable or disable the Puppet Execution Protocol (PXP) service.

Set to true to enable the PXP service, which is required to use the orchestrator and run Puppet from the console.

Set to false to disable the PXP service. If false, you can’t use the orchestrator or the Run Puppet button in the console.

Default: true

puppet_enterprise::pxp_agent::ping_interval

An integer specifying the frequency, in seconds, that PXP agents ping PCP brokers. If the broker doesn't respond, the agent tries to reconnect.

Default: 120

puppet_enterprise::pxp_agent::pxp_logfile

The path, as a string, to the PXP agent log file. This file can be used to debug orchestrator issues.

The default value varies by OS.

  • *nix: "/var/log/puppetlabs/pxp-agent/pxp-agent.log"
  • Windows: "C:\Program Data\PuppetLabs\pxp-agent\var\log\pxp-agent.log"

puppet_enterprise::pxp_agent::spool_dir_purge_ttl

A string representing the amount of time to retain records of Puppet or task runs on agents.

Format the value as a string consisting of a number and one of the following suffixes: m (minutes), h (hours), or d (days).

Default: "14d" (14 days)

puppet_enterprise::pxp_agent::task_cache_dir_purge_ttl

A string representing the amount of time that task files are cached after use.

Format the value as a string consisting of a number and one of the following suffixes: m (minutes), h (hours), or d (days).

Default: "14d" (14 days)

puppet_enterprise::pxp_agent::broker_proxy

Optional. Set a proxy URI to use to connect to the pcp-broker to listen for task and Puppet run requests.

puppet_enterprise::pxp_agent::master_proxy

Optional. Set a proxy URI to use to connect to the primary server to download task implementations.

puppet_enterprise::pcp_max_message_size_mb

An integer specifying the maximum message size, in MB, for pcp_broker, pxp_agent, and the orchestrator.

The maximum message size cannot be higher than the default size of 64 MB. You can only specify a smaller value.

Default: 64

Don't change the pcp_max_message_size_mb parameter if you send or receive large payloads, because this can cause errors for large task and plan run parameters and output.

Related information