Using the PE docs
Review these tips to get the most out of the PE docs.
Using example commands
These guidelines can help you understand and customize example commands included in the Puppet Enterprise (PE) docs.
puppet commands generate cURL arguments
puppet commands to populate some cURL arguments and take
the guesswork out of providing those values. For
example:url="http://$(puppet config print server):4433"
curl "$url"puppet commands can return different values depending
on various conditions. To use cURL examples successfully, run the entire example
(including setting the environment variables and the curl command) as root, Administrator, or with equivalent elevated privileges.
To run commands 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 reasonable default values.
Authentication tokens in cURL commands
curl command requires authentication, the
example might contain this line:
auth_header="X-Authentication: $(puppet-access show)"auth_header="X-Authentication: <TOKEN>"Modifications for Windows
While the commands in the PE docs are primarily *nix-based, Windows-specific commands are provided in topics focusing exclusively on Windows systems.
curl commands
directly in Windows, such as:- Installing the curl executable for Windows.
- Using built-in curl functionality included with Git for Windows.
- Using the GNU Bash shell.
curl commands for use in Windows:Native curl
|
PowerShell equivalent |
|---|---|
curl |
Invoke-WebRequest |
-k or --insecure
|
[System.Net.ServicePointManager]::ServerCertificateValidationCallback
= $true |
-H |
-Headers |
-X |
-Method |
-d |
-Body |
\ (line-continuation
character) |
` |
Invoke-WebRequest
and the arguments it accepts in the Microsoft
PowerShelldocumentation.Commands with elevated privileges
Some commands in PE require elevated privileges.
Depending on the operating system, youc an use either sudo,
runas, or a root or admin user.
- root (or administrator)
- In *nix systems, the root user 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. The equivalent in Windows is the administrator.
- sudo
- The
sudocommand, which means super user do, allows a user to execute a command from a personal user account with temporarily elevated privileges. Withsudo, you can do most of the things the root user can do without actually logging in as the root user. - Run as administrator or runas
- Using the
runascommand or running a program as an administrator (for example, by right-clicking the program and selecting Run as administrator) is the Windows equivalent ofsudo– It allows you to temporarily perform administrator functions without actually logging in as the administrator.
sudo to run almost all commands in Puppet with the exception of puppet infrastructure commands, which require you to be logged in as the
root user (or administrator). You can run puppet infrastructure
help <ACTION> to get information about puppet
infrastructure commands.puppet
infrastructure commands.In Windows systems, use runas or open the command prompt as an administrator (recommended for PowerShell commands) instead of using sudo.
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.