rudder(8)

NAME

rudder - execute commands to control the Rudder configuration management tool.

SYNOPSIS

rudder component [option] command

rudder component help

DESCRIPTION

A tool to trigger actions or get information about a running rudder-agent, whether on agent or server. It only targets administration actions, for all node configuration tasks you can use the rudder-cli tool.

OPTIONS

-h
Print command-line syntax and command options.
-v
Print detailed information.
-d
Print all available information.

COMMANDS

====== agent

commands for rudder agent, run with rudder agent command

disable
forbid rudder-agent to be run by cron or service. This is useful when you want to temporarily prevent your Rudder agent from doing any modification to your system.
enable

re-enable a disabled rudder-agent.

Options:

-s: start rudder-agent in addition to enabling it

inventory

force the agent to create and send a new inventory. This will trigger a new inventory creation and send it to the policy server. Even if the agent will do it regularly, it can be used to force the update after a modification on the node. This won’t affect the node state, but only update server-side information.

Options:

-q: run the agent in quiet mode (display only error messages)

reinit

re-initialise the agent to make it be seen as a new node on the server. This command will delete all local agent data, including its uuid and keys, and also reset the agent internal state. The only configuration kept is the server hostname or ip configured in policy_server.dat. It will also send an inventory to the server, which will treat it as a new node inventory.

WARNING: This command will permanently delete your node uuid and keys, and no configuration will be applied before re-accepting and configuring the node on the server.

reset
reset agent status and cache. Remove all locks and state cache of the agent, and restore initial promises. This won’t affect the desired state of the node, but will only reset the internal state of the agent. It is useful to test a rule without caching interference or when you have trouble with the promises updates.
run

force run agent promises. This command will force the agent to enforce current policies. You can run rudder agent update before to update the promises.

Options:

-v: run the agent in verbose mode

-q: run the agent in quiet mode (display only error messages)

update

update promises on agent. The agent will fetch the last version of its promises from its configured policy server.

Options:

-f: force full update

version
get the agent version. Displays the version of the Rudder agent and of the underlying CFEngine agent.

====== server

commands for rudder server, run with rudder server command

debug

run a debug cf-serverd intended for a specific node. This command targets a specific node and does not affect the running infrastructure. It uses iptables to redirect the specific node communications to the port the debug server is listening on (5310 by default).

Use Ctrl+C to stop the debug server.

Arguments:

node: IP or hostname of the host you want to debug

AUTHOR

Normation SAS (contact@normation.com)

RESOURCES

Main web site: https://rudder-project.org/

Sources of the rudder command-line: https://github.com/Normation/rudder-agent/

COPYING

Copyright (C) 2014-2015 Normation SAS.