Using the PE docs
Review these tips to get the most out of the PE docs.
Archived PE docs
PE docs for recent end-of-life (EOL) or superseded product versions are archived in place, meaning that we continue to host them at their original URLs, but we limit their visibility on the main docs site and no longer update them. You can access archived-in-place docs using their original URLs, or from the links here.
PE docs for EOL versions earlier than those listed here are archived in our PE docs GitHub archive.
Usage notes for example commands
Review these guidelines to help you understand and use example commands throughout PE docs.
puppet commands to generate cURL
puppetcommands to populate some cURL arguments, taking the guesswork out of providing those values. For example, you might see something like this:
url="http://$(puppet config print server):4433" curl "$url"
Puppet commands can return different values depending on
various conditions. In order for the cURL examples to work as intended, run the entire
example (including setting the environment variables and calling the
curl command) as root, Administrator, or with equivalent
To run the command on a machine without elevated privileges, replace the inline
puppet commands with hard-coded values. If you’re unsure
about the correct values, run the
puppet commands to get
Alternative ways to include authentication tokens
curlexample that contains this line:
can instead use an actual token if you have one available:
auth_header="X-Authentication: $(puppet-access show)"
Commands with elevated privileges
Some commands in PE require elevated privileges, using
sudo, root access, or "run as admin".
rootuser has virtually unlimited access to read, write, or change files and system configurations, install/uninstall and upgrade software, or perform any operation as any user.
sudouser, which stands for "super use do", allows a user to run most things the root user can without actually logging in as the root user.
- "Run as admin"
- "Run as admin" is the Windows equivalent of root.
Almost all commands in Puppet can be run using
sudo privileges. Using
is the most common way we recommend running commands in the docs because it is easier to
copy and paste
sudo in a command than log in as root.
There is an exception to this. All
commands must be run while you are logged in as root. For more details about the
puppet infrastructure command, run
puppet infrastructure help <ACTION>