Mapping to the Node Classifier and RBAC APIs

A newer version is available; see the version menu above for details.

The Node Classifier’s REST API is a more flexible alternative to the Console Rake API. This page provides a mapping from the Console Rake API to the Node Classifier and RBAC REST endpoints that most closely replicate its functionality. For more detailed information on how to use the Node Classifier REST API, see the REST API documentation.

Rake REST Description
node:add[name,groups,classes,onexists] Uses the /v1/groups endpoint and pins the node to the group Creates a group with the same name as the node, and adds a rule that matches the host name of the node being added. The node is pinned to the group. This rake task has been deprecated. In PE3.8, nodes are included in node groups when they match a node group’s rules. They are then classified with the node group’s classes. See Adding Nodes to a Node Group.
node:addclass[name,class] Uses the /v1/groups endpoint and pins the node to the group Creates a class in the group that the node is pinned to. This rake task has been deprecated. In PE3.8, classes are added to node groups rather than assigned directly to nodes. Nodes are assigned classes based on the node groups that they match. See Adding Classes to a Node Group.
node:addclassparam[name,class,param,value] Uses the /v1/groups endpoint and pins the node to the group Adds a class parameter to the group that the node is pinned to. The class must already exist in the group. This rake task has been deprecated. In PE3.8, class parameters are added to node groups rather than directly to nodes. Nodes are assigned class parameters based on the node groups that they match. See Setting Class Parameters.
node:addgroup[name,group] Uses the /v1/groups endpoint and pins the node to the group This rake task has been deprecated. In PE3.8, groups are no longer added to nodes. Instead, nodes are included in node groups when they match a node group’s rules. See Adding Nodes to a Node Group.
node:classes[name,classes] Uses the /v1/groups endpoint and pins the node to the group Replaces the classes in the node group that the node is pinned to. This rake task has been deprecated. In PE3.8, classes are added to and removed from node groups rather than assigned directly to nodes. Nodes are assigned classes based on the node groups that they match. See Adding Classes to a Node Group.
node:delgroup[name] Uses the /v1/groups endpoint Deletes the group that the node is pinned to. This rake task has been deprecated.
node:del[name] No equivalent This rake task has been deprecated.
node:delclassparam[name,class,param] Uses the /v1/groups endpoint and pins the node to the group Removes the class parameter from the group that the node is pinned to. This rake task has been deprecated. In PE3.8, class parameters are deleted from node groups rather than from nodes. See Deleting Parameters.
node:groups[name,groups] Uses the /v1/groups endpoint and pins the node to the group This rake task has been deprecated. In PE3.8, you add nodes to node groups rather than add groups to nodes. The recommended workflow for including nodes in a node group is to create node group rules. See Adding Nodes to a Node Group.
node:list[match] GET /v1/nodes This rake task gives the same results as nodegroup:list. It returns a list of nodes that have been checked in with Puppet and match the string given as the parameter.
node:listclasses[name] GET /v1/classified/nodes/<node_name> This rake task lists the classes that have been assigned to a node.
node:listclassparams[name,class] GET /v1/classified/nodes/<node_name> This rake task lists the class parameters assigned to a node.
node:listgroups[name] No equivalent This rake task has been deprecated and does not do anything in PE3.8.
node:variables[name,variables] GET /v1/groups This rake task creates a variable in the group that the node is pinned to. In PE3.8, variables are added to node groups rather than directly to nodes. Nodes are assigned variables based on the node groups that they match. See Setting Variables.
nodeclass:add[name,onexists] No equivalent This rake task has been deprecated and does not do anything in PE3.8. In PE3.8, classes are added to node groups rather than assigned directly to nodes. Nodes are assigned classes based on the node groups that they match. See Adding Classes to a Node Group.
nodeclass:del[name] No equivalent This rake task has been deprecated and does not do anything in PE3.8. In PE3.8, classes are removed from node groups rather than from nodes. See Removing Classes from a Node Group.
nodeclass:list[match] GET /v1/classes This rake task returns all classes in every environment that match the string given as the parameter.
nodegroup:add[name,classes,onexists] POST /v1/groups/<id> Creates a new node group and adds the specified classes.
nodegroup:add_all_nodes[name] No equivalent This rake task has been deprecated and does not do anything in PE3.8. In PE3.8, nodes are included in node groups when they match a node group’s rules. See Adding Nodes to a Node Group.
nodegroup:addclass[name,class] POST /v1/groups/<id> Adds a class to a node group.
nodegroup:addclassparam[name,class,param,value] POST /v1/groups/<id> Adds a class parameter to a node group.
nodegroup:addgroup[name,group] POST /v1/groups/<id> This rake task adds a child group.
nodegroup:del[name] DELETE /v1/groups/<id> Deletes a node group.
nodegroup:delclass[name,class] POST /v1/groups/<id> Sets the class to null.
nodegroup:delclassparam[name,class,param] POST /v1/groups/<id> Sets the class parameter to null.
nodegroup:delgroup[name,group] POST /v1/groups/<id> This rake task resets the parent link to the default group.
nodegroup:edit[name,classes] POST /v1/groups/<id> Replaces existing classes with the specified classes.
nodegroup:list[match] GET /v1/groups Returns a list of node groups that match the string given as the parameter.
nodegroup:listclasses[name] GET /v1/groups/<id> Returns the classes that belong to the node group.
nodegroup:listclassparams[name,class] GET /v1/groups/<id> Returns the class parameters that belong to the node group.
nodegroup:listgroups[name] No equivalent This rake task has been deprecated and does not do anything in PE3.8. Child groups can no longer be identified.
nodegroup:variables[name,variables] GET /v1/groups/<id> Edits and adds variables.
db:create_user POST /users Creates a new user.
db:users:list GET /users Lists the current users.
db:users:remove[username] PUT /users/:sid (is_revoked:true) If the user exists, sets the is_revoked flag to true.

↑ Back to top