Puppet.com
Forge
Compass
Try Puppet

Products
Puppet Enterprise
Open Source Puppet
Bolt
Puppet Development Kit
Puppet DB
Puppet Remediate
Puppet Plugin for VMware

Get
Technical Support Plans
Support Lifecycle Policy
New Puppet Enterprise Customer?

About Puppet
TBD...
TBD...
Community
Puppet Champions
Puppet Test Pilots
Community Office Hours
Slack Channel

PRODUCT AND VERSION

Welcome to Puppet Enterprise® 2019.7

Release notes
- PE release notes
- PE known issues

Getting started with Puppet Enterprise

Installing

Upgrading
- Upgrading Puppet Enterprise
- Upgrading agents

Configuring Puppet Enterprise

Configuring disaster recovery
- Disaster recovery
- Configure disaster recovery

Accessing the console

Managing access

Inspecting your infrastructure

Managing nodes

Orchestrating Puppet, tasks, and plans

Managing and deploying Puppet code

Provisioning with Razor

SSL and certificates

Maintenance
- Backing up and restoring Puppet Enterprise
- Database maintenance

Troubleshooting

Node classifier API v1

These are the endpoints for the node classifier v1 API.

Tip: In addition to these endpoints, you can use the status API to check the health of the node classifier service.

Forming node classifier requests
Requests to the node classifier API must be well-formed HTTP(S) requests.
Groups endpoint
The groups endpoint is used to create, read, update, and delete groups.
Groups endpoint examples
Use example requests to better understand how to work with groups in the node classifier API.
Classes endpoint
Use the classes endpoints to retrieve lists of classes, including classes with specific environments. The output from this endpoint is especially useful for creating new node groups, which usually contain a reference to one or more classes.
Classification endpoint
The classification endpoint takes a node name and a set of facts, and returns information about how that node is classified. The output can help you test your classification rules.
Commands endpoint
Use the commands endpoint to unpin specified nodes from all groups they’re pinned to.
Environments endpoint
Use the environments endpoint to retrieve information about environments in the node classifier. The output tells you either which environments are available or whether a named environment exists. The output can be helpful when creating new node groups, which must be associated with an environment. The node classifier gets its information about environments from Puppet, so do not use this endpoint to create, update, or delete them.
Nodes check-in history endpoint
Use the nodes endpoint to retrieve historical information about nodes that have checked into the node classifier.
Group children endpoint
Use the group children endpoint to retrieve a specified group and its descendents.
Rules endpoint
Use the rules endpoint to translate a group’s rule condition into PuppetDB query syntax.
Import hierarchy endpoint
Use the import hierarchy endpoint to delete all existing node groups from the node classifier service and replace them with the node groups in the body of the submitted request.
Last class update endpoint
Use the last class update endpoint to retrieve the time that classes were last updated from the Puppet master.
Update classes endpoint
Use update classes endpoint to trigger the node classifier to update class and environment definitions from the Puppet master.
Validation endpoints
Use validation endpoints to validate groups in the node classifier.
Node classifier errors
Familiarize yourself with error responses to make working the node classifier service API easier.

Related information

API index

Puppet automates the delivery and operation of the software that powers some of the biggest brands in the world.

Legal
Privacy Policy
Terms of Use
Security

Sitemap © 2021
Puppet