See "crm cluster help add" or "crm cluster add --help"

Copy file to other cluster nodes.

Copies the given file to all other nodes unless given a list of nodes to copy to as argument.

Usage:

Example:

Displays the difference, if any, between a given file on different nodes. If the second argument is --checksum, a checksum of the file will be calculated and displayed for each node.

Usage:

Example:

Disable the cluster-related system services on this node.

Usage:

Enable the cluster-related system services on this node.

Usage:

See "crm cluster help geo_init" or "crm cluster geo_init --help"

See "crm cluster help geo_init_arbitrator" or "crm cluster geo_init_arbitrator --help"

See "crm cluster help geo_join" or "crm cluster geo_join --help"

Runs a larger set of tests and queries on all nodes in the cluster to verify the general system health and detect potential problems.

Usage:

See "crm cluster help init" or "crm cluster init --help"

See "crm cluster help join" or "crm cluster join --help"

See "crm cluster help remove" or "crm cluster remove --help"

See "crm cluster help crash_test" or "crm cluster crash_test --help"

Restarts the cluster-related system services on this node.

Usage:

Rename the cluster name

Usage:

This command takes a shell statement as argument, executes that statement on all nodes in the cluster or a specific node, and reports the result.

Usage:

Example:

Starts the cluster-related system services on this node.

Usage:

Reports the status for the cluster messaging layer on the local node.

Usage:

Stops the cluster-related system services on this node.

Usage:

Mostly useful in scripts or automated workflows, this command will attempt to connect to the local cluster node repeatedly. The command will keep trying until the cluster node responds, or the timeout elapses. The timeout can be changed by supplying a value in seconds as an argument.

Usage:

This command provides a JSON API for the cluster scripts, intended for use in user interface tools that want to interact with the cluster via scripts.

The command takes a single argument, which should be a JSON array with the first member identifying the command to perform.

The output is line-based: Commands that return multiple results will return them line-by-line, ending with a terminator value: "end".

When providing parameter values to this command, they should be provided as nested objects, so virtual-ip:ip=192.168.0.5 on the command line becomes the JSON object {"virtual-ip":{"ip":"192.168.0.5"}}.

API:

Lists the available scripts, sorted by category. Scripts that have the special Script category are hidden by default, since they are mainly used by other scripts or commands. To also show these, pass all as argument.

To get a flat list of script names, not sorted by category, pass names as an extra argument.

Usage:

Example:

Given a list of parameter values, this command will execute the actions specified by the cluster script. The format for the parameter values is the same as for the verify command.

Can optionally take at least two parameters: * nodes=<nodes>: List of nodes that the script runs over * dry_run=yes|no: If set, the script will not perform any modifications.

Additional parameters may be available depending on the script.

Use the show command to see what parameters are available.

Usage:

Example:

Prints a description and short summary of the script, with descriptions of the accepted parameters.

Advanced parameters are hidden by default. To show the complete list of parameters accepted by the script, pass all as argument.

Usage:

Example:

Checks the given parameter values, and returns a list of actions that will be executed when running the script if provided the same list of parameter values.

Usage:

Example:

Adds a node to the corosync configuration. This is used with the udpu type configuration in corosync.

A nodeid for the added node is generated automatically.

Note that this command assumes that only a single ring is used, and sets only the address for ring0.

Usage:

Removes a node from the corosync configuration. The argument given is the ring0_addr address set in the configuration file.

Usage:

Diffs the corosync configurations on different nodes. If no nodes are given as arguments, the corosync configurations on all nodes in the cluster are compared.

diff takes an option argument --checksum, to display a checksum for each file instead of calculating a diff.

Usage:

Opens the Corosync configuration file in an editor.

Usage:

Returns the value configured in corosync.conf, which is not necessarily the value used in the running configuration. See reload for telling corosync about configuration changes.

The argument is the complete dot-separated path to the value.

If there are multiple values configured with the same path, the command returns all values for that path. For example, to get all configured ring0_addr values, use this command:

Example:

Opens the log file specified in the corosync configuration file. If no log file is configured, this command returns an error.

The pager used can be configured either using the PAGER environment variable or in crm.conf.

Usage:

Gets the corosync configuration from another node and copies it to this node.

Usage:

Pushes the corosync configuration file on this node to the list of nodes provided. If no target nodes are given, the configuration is pushed to all other nodes in the cluster.

It is recommended to use csync2 to distribute the cluster configuration files rather than relying on this command.

Usage:

Example:

Tells all instances of corosync in this cluster to reload corosync.conf.

After pushing a new configuration to all cluster nodes, call this command to make corosync use the new configuration.

Usage:

Sets the value identified by the given path. If the value does not exist in the configuration file, it will be added. However, if the section containing the value does not exist, the command will fail.

Usage:

Displays the corosync configuration on the current node.

Displays the corosync ring status(default), also can display quorum/qdevice/qnetd status.

Usage:

Enter edit and manage the CIB status section level. See the CIB status management section.

Apply a shadow CIB to the cluster. If the shadow name is omitted then the current shadow CIB is applied.

Temporary shadow CIBs are removed automatically on commit.

Usage:

Delete an existing shadow CIB.

Usage:

Print differences between the current cluster configuration and the active shadow CIB.

Usage:

At times it may be useful to create a shadow file from the existing CIB. The CIB may be specified as file or as a PE input file number. The shell will look up files in the local directory first and then in the PE directory (typically /var/lib/pengine). Once the CIB file is found, it is copied to a shadow and this shadow is immediately available for use at both configure and cibstatus levels.

If the shadow name is omitted then the target shadow is named after the input CIB file.

Note that there are often more than one PE input file, so you may need to specify the full name.

Usage:

Examples:

List existing shadow CIBs.

Usage:

Create a new shadow CIB. The live cluster configuration and status is copied to the shadow CIB.

If the name of the shadow is omitted, we create a temporary CIB shadow. It is useful if multiple level sessions are desired without affecting the cluster. A temporary CIB shadow is short lived and will be removed either on commit or on program exit. Note that if the temporary shadow is not committed all changes in the temporary shadow are lost.

Specify withstatus if you want to edit the status section of the shadow CIB (see the cibstatus section). Add force to force overwriting the existing shadow CIB.

To start with an empty configuration that is not copied from the live CIB, specify the empty keyword. (This also allows a shadow CIB to be created in case no cluster is running.)

Usage:

Copy the current cluster configuration into the shadow CIB.

Usage:

Choose a CIB source. If you want to edit the status from the shadow CIB specify withstatus (see cibstatus). Leave out the CIB name to switch to the running CIB.

Usage:

Print all resource agents' classes and, where appropriate, a list of available providers.

Usage:

Show the meta-data of a resource agent type. This is where users can find information on how to use a resource agent. It is also possible to get information from some programs: pengine, crmd, cib, and stonithd. Just specify the program name instead of an RA.

Usage:

Example:

List available resource agents for the given class. If the class is ocf, supply a provider to get agents which are available only from that provider.

Usage:

Example:

List providers for a resource agent type. The class parameter defaults to ocf.

Usage:

Example:

If the resource agent supports the validate-all action, this calls the action with the given parameters, printing any warnings or errors reported by the agent.

Usage:

Ban a resource from running on a certain node. If no node is given as argument, the resource is banned from the current location.

See move for details on other arguments.

Usage:

If resource has any past failures, clear its history and fail count. Typically done after the resource has temporarily failed.

If a node is omitted, cleanup on all nodes.

(Pacemaker 1.1.14) Pass force to cleanup the resource itself, otherwise the cleanup command will apply to the parent resource (if any).

Usage:

Remove any relocation constraint created by the move, migrate or ban command.

Usage:

Display the location and colocation constraints affecting the resource.

Usage:

Demote a master-slave resource using the target-role attribute.

Usage:

Show/edit/delete the failcount of a resource. When set a non-zero value, operation and interval should be provided when multiple operation failcount entries exist. interval is a value in seconds.

Usage:

Example:

Show the current location of one or more resources.

Usage:

Enables or disables the per-resource maintenance mode. When this mode is enabled, no monitor operations will be triggered for the resource. maintenance attribute conflicts with the is-managed. When setting the maintenance attribute, the user is proposed to remove the is-managed attribute if it exists.

Usage:

Example:

Manage a resource using the is-managed attribute. If there are multiple meta attributes sets, the attribute is set in all of them. If the resource is a clone, all is-managed attributes are removed from the children resources. is-managed attribute conflicts with the maintenance. When setting the is-managed attribute, the user is proposed to remove the maintenance attribute if it exists.

For details on group management see options manage-children.

Usage:

Show/edit/delete a meta attribute of a resource. Currently, all meta attributes of a resource may be managed with other commands such as resource stop.

Usage:

Example:

Move a resource away from its current location.

If the destination node is left out, the resource is migrated by creating a constraint which prevents it from running on the current node. For this type of constraint to be created, the force argument is required.

A lifetime may be given for the constraint. Once it expires, the location constraint will no longer be active.

Usage:

Show active operations, optionally filtered by resource and node.

Usage:

Show/edit/delete a parameter of a resource.

Usage:

Example:

Promote a master-slave resource using the target-role attribute.

Usage:

Delete resource’s history (including failures) so its current state is rechecked.

Usage:

Restart one or more resources. This is essentially a shortcut for resource stop followed by a start. The shell is first going to wait for the stop to finish, that is for all resources to really stop, and only then to order the start action. Due to this command entailing a whole set of operations, informational messages are printed to let the user see some progress.

For details on group management see options manage-children.

Usage:

Example:

Display the allocation scores for all resources.

Usage:

Sensitive parameters can be kept in local files rather than CIB in order to prevent accidental data exposure. Use the secret command to manage such parameters. stash and unstash move the value from the CIB and back to the CIB respectively. The set subcommand sets the parameter to the provided value. delete removes the parameter completely. show displays the value of the parameter from the local file. Use check to verify if the local file content is valid.

Usage:

Example:

Start one or more resources by setting the target-role attribute. If there are multiple meta attributes sets, the attribute is set in all of them. If the resource is a clone, all target-role attributes are removed from the children resources.

For details on group management see options manage-children.

Usage:

Print resource status. More than one resource can be shown at once. If the resource parameter is left out, the status of all resources is printed.

Usage:

Stop one or more resources using the target-role attribute. If there are multiple meta attributes sets, the attribute is set in all of them. If the resource is a clone, all target-role attributes are removed from the children resources.

For details on group management see options manage-children.

Usage:

Start tracing RA for the given operation. The trace files are stored in $HA_VARLIB/trace_ra. If the operation to be traced is monitor, note that the number of trace files can grow very quickly.

If no operation name is given, crmsh will attempt to trace all operations for the RA. This includes any configured operations, start and stop as well as promote/demote for multistate resources.

To trace the probe operation which exists for all resources, either set a trace for monitor with interval 0, or use probe as the operation name.

Note: RA tracing is only supported by OCF resource agents; The pacemaker-execd daemon does not log recurring monitor operations unless an error occurred.

Usage:

Example:

Unmanage a resource using the is-managed attribute. If there are multiple meta attributes sets, the attribute is set in all of them. If the resource is a clone, all is-managed attributes are removed from the children resources.

For details on group management see options manage-children.

Usage:

Stop tracing RA for the given operation. If no operation name is given, crmsh will attempt to stop tracing all operations in resource.

Usage:

Example:

Show/edit/delete a utilization attribute of a resource. These attributes describe hardware requirements. By setting the placement-strategy cluster property appropriately, it is possible then to distribute resources based on resource requirements and node size. See also node utilization attributes.

Usage:

Example:

Edit node attributes. This kind of attribute should refer to relatively static properties, such as memory size.

Usage:

Example:

Resets and clears the state of the specified node. This node is afterwards assumed clean and offline. This command can be used to manually confirm that a node has been fenced (e.g., powered off).

Be careful! This can cause data corruption if you confirm that a node is down that is, in fact, not cleanly down - the cluster will proceed as if the fence had succeeded, possibly starting resources multiple times.

Usage:

Delete a node. This command will remove the node from the CIB and, in case the cluster stack is running, use the appropriate program (crm_node or hb_delnode) to remove the node from the membership.

If the node is still listed as active and a member of our partition we refuse to remove it. With the global force option (-F) we will try to delete the node anyway.

Usage:

Make CRM fence a node. This functionality depends on stonith resources capable of fencing the specified node. No such stonith resources, no fencing will happen.

Usage:

Set the node status to maintenance. This is equivalent to the cluster-wide maintenance-mode property but puts just one node into the maintenance mode. If there are maintenaned resources on the node, the user will be proposed to remove the maintenance property from them.

The node parameter defaults to the node where the command is run.

Usage:

Set a node to online status.

The node parameter defaults to the node where the command is run.

Usage:

Set the node’s maintenance status to off. The node should be now again fully operational and capable of running resource operations.

The node parameter defaults to the node where the command is run.

Usage:

Remote nodes may have a configured server address which should be used when contacting the node. This command prints the server address if configured, else the node name.

If no parameter is given, the addresses or names for all nodes are printed.

Usage:

Show a node definition. If the node parameter is omitted then all nodes are shown.

Usage:

Set a node to standby status. The node parameter defaults to the node where the command is run.

Additionally, you may specify a lifetime for the standby---if set to reboot, the node will be back online once it reboots. forever will keep the node in standby after reboot. The life time defaults to forever.

Usage:

Example:

Edit node attributes which are in the CIB status section, i.e. attributes which hold properties of a more volatile nature. One typical example is attribute generated by the pingd utility.

Usage:

Example:

Edit node utilization attributes. These attributes describe hardware characteristics as integer numbers such as memory size or the number of CPUs. By setting the placement-strategy cluster property appropriately, it is possible then to distribute resources based on resource requirements and node size. See also resource utilization attributes.

Usage:

Examples:

Tickets are cluster-wide attributes. They can be managed at the site where this command is executed.

It is then possible to constrain resources depending on the ticket availability (see the rsc_ticket command for more details).

Usage:

Example:

The shell (as in /bin/sh) parser strips quotes from the command line. This may sometimes make it really difficult to type values which contain white space. One typical example is the configure filter command. The crm shell will supply extra quotes around arguments which contain white space. The default is yes.

Semantic check of the CIB or elements modified or created may be done on every configuration change (always), when verifying (on-verify) or never. It is by default set to always. Experts may want to change the setting to on-verify.

The checks require that resource agents are present. If they are not installed at the configuration time set this preference to never.

See Configuration semantic checks for more details.

Semantic check of the CIB or elements modified or created may be done in the strict mode or in the relaxed mode. In the former certain problems are treated as configuration errors. In the relaxed mode all are treated as warnings. The default is strict.

See Configuration semantic checks for more details.

With output set to color, a comma separated list of colors from this option are used to emphasize:

crm can show colors only if there is curses support for python installed (usually provided by the python-curses package). The colors are whatever is available in your terminal. Use normal if you want to keep the default foreground color.

This user preference defaults to yellow,normal,cyan,red,green,magenta which is good for terminals with dark background. You may want to change the color scheme and save it in the preferences file for other color setups.

Example:

The edit command invokes an editor. Use this to specify your preferred editor program. If not set, it will default to either the value of the EDITOR environment variable or to one of the standard UNIX editors (vi,emacs,nano).

Usage:

Example:

Some resource management commands, such as resource stop, when the target resource is a group, may not always produce desired result. Each element, group and the primitive members, can have a meta attribute and those attributes may end up with conflicting values. Consider the following construct:

Even though the element svc should be stopped, the group is actually running because all its members have the target-role set to Started:

Hence, if the user invokes resource stop svc the intention is not clear. This preference gives the user an opportunity to better control what happens if attributes of group members have values which are in conflict with the same attribute of the group itself.

Possible values are ask (the default), always, and never. If set to always, the crm shell removes all children attributes which have values different from the parent. If set to never, all children attributes are left intact. Finally, if set to ask, the user will be asked for each member what is to be done.

crm can adorn configurations in two ways: in color (similar to for instance the ls --color command) and by showing keywords in upper case. Possible values are plain, color-always, color, and uppercase. It is possible to combine uppercase with one of the color values in order to get an upper case xmass tree. Just set this option to color,uppercase or color-always,uppercase. In case you need color codes in pipes, color-always forces color codes even in case the terminal is not a tty (just like ls --color=always).

The view command displays text through a pager. Use this to specify your preferred pager program. If not set, it will default to either the value of the PAGER environment variable or to one of the standard UNIX system pagers (less,more,pg).

This command resets all user options to the defaults. If used as a single-shot command, the rc file ($HOME/.config/crm/rc) is reset to the defaults too.

Save current settings to the rc file ($HOME/.config/crm/rc). On further crm runs, the rc file is automatically read and parsed.

Sets the value of an option. Takes the fully qualified name of the option as argument, as displayed by show all.

The modified option value is stored in the user-local configuration file, usually found in ~/.config/crm/crm.conf.

Usage:

Example:

Display all current settings.

Given an option name as argument, show will display only the value of that argument.

Given all as argument, show displays all available user options.

Usage:

Example:

Based on the skill-level setting, the user is allowed to use only a subset of commands. There are three levels: operator, administrator, and expert. The operator level allows only commands at the resource and node levels, but not editing or deleting resources. The administrator may do that and may also configure the cluster at the configure level and manage the shadow CIBs. The expert may do all.

Usage:

crm by default sorts CIB elements. If you want them appear in the order they were created, set this option to no.

Usage:

Example:

Sufficient privileges are necessary in order to manage a cluster: programs such as crm_verify or crm_resource and, ultimately, cibadmin have to be run either as root or as the CRM owner user (typically hacluster). You don’t have to worry about that if you run crm as root. A more secure way is to run the program with your usual privileges, set this option to the appropriate user (such as hacluster), and setup the sudoers file.

Usage:

Example:

In normal operation, crm runs a command and gets back immediately to process other commands or get input from the user. With this option set to yes it will wait for the started transition to finish. In interactive mode dots are printed to indicate progress.

Usage:

Example:

Defines an ACL target.

Usage:

Example:

Event-driven alerts enables calling scripts whenever interesting events occur in the cluster (nodes joining or leaving, resources starting or stopping, etc.).

The path is an arbitrary file path to an alert script. Existing external scripts used with ClusterMon resources can be used as alert scripts, since the interface is compatible.

Each alert may have a number of receipients configured. These will be passed to the script as arguments. The first recipient will also be passed as the CRM_alert_recipient environment variable, for compatibility with existing scripts that only support one recipient.

The available meta attributes are timeout (default 30s) and timestamp-format (default "%H:%M:%S.%06N").

Some configurations may require each recipient to be delimited by brackets, to avoid ambiguity. In the example alert-2 below, the meta attribute for timeout is defined after the recipient, so the brackets are used to ensure that the meta attribute is set for the alert and not just the recipient. This can be avoided by setting any alert attributes before defining the recipients.

Usage:

Example:

A bundle is a single resource specifying the settings, networking requirements, and storage requirements for any number of containers generated from the same container image.

Pacemaker bundles support Docker (since version 1.1.17) and rkt (since version 1.1.18) container technologies.

A bundle must contain exactly one docker or rkt element.

The bundle definition may contain a reference to a primitive resource which defining the resource running inside the container.

Example:

This level is for management of shadow CIBs. It is available at the configure level to enable saving intermediate changes to a shadow CIB instead of to the live cluster. This short excerpt shows how:

Note how the current CIB in the prompt changed from live to test-2 after issuing the cib new command. See also the CIB shadow management for more information.

Enter edit and manage the CIB status section level. See the CIB status management section.

The clone command creates a resource clone. It may contain a single primitive resource or one group of resources.

Usage:

Example:

This constraint expresses the placement relation between two or more resources. If there are more than two resources, then the constraint is called a resource set.

The score is used to indicate the priority of the constraint. A positive score indicates that the resources should run on the same node. A negative score that they should not run on the same node. Values of positive or negative infinity indicate a mandatory constraint.

In the two resource form, the cluster will place <with-rsc> first, and then decide where to put the <rsc> resource.

Collocation resource sets have an extra attribute (sequential) to allow for sets of resources which don’t depend on each other in terms of state. The shell syntax for such sets is to put resources in parentheses.

Sets cannot be nested.

The optional node-attribute can be used to colocate resources on a set of nodes and not necessarily on the same node. For example, by setting a node attribute color on all nodes and setting the node-attribute value to color as well, the colocated resources will be placed on any node that has the same color.

For more details on how to configure resource sets, see Syntax: Resource sets.

Usage:

Example:

Commit the current configuration to the CIB in use. As noted elsewhere, commands in a configure session don’t have immediate effect on the CIB. All changes are applied at one point in time, either using commit or when the user leaves the configure level. In case the CIB in use changed in the meantime, presumably by somebody else, the crm shell will refuse to apply the changes.

If you know that it’s fine to still apply them, add force to the command line.

To disable CIB patching and apply the changes by replacing the CIB completely, add replace to the command line. Note that this can lead to previous changes being overwritten if some other process concurrently modifies the CIB.

Usage:

This command takes the timeouts from the actions section of the resource agent meta-data and sets them for the operations of the primitive.

Usage:

Delete one or more objects. If an object to be deleted belongs to a container object, such as a group, and it is the only resource in that container, then the container is deleted as well. Any related constraints are removed as well.

If the object is a started resource, it will not be deleted unless the --force flag is passed to the command, or the force option is set.

Usage:

This command invokes the editor with the object description. As with the show command, the user may choose to edit all objects or a set of objects.

If the user insists, he or she may edit the XML edition of the object. If you do that, don’t modify any id attributes.

Usage:

The erase clears all configuration. Apart from nodes. To remove nodes, you have to specify an additional keyword nodes.

Note that removing nodes from the live cluster may have some strange/interesting/unwelcome effects.

Usage:

If multiple fencing (stonith) devices are available capable of fencing a node, their order may be specified by fencing_topology. The order is specified per node.

Stonith resources can be separated by , in which case all of them need to succeed. If they fail, the next stonith resource (or set of resources) is used. In other words, use comma to separate resources which all need to succeed and whitespace for serial order. It is not allowed to use whitespace around comma.

If the node is left out, the order is used for all nodes. That should reduce the configuration size in some stonith setups.

From Pacemaker version 1.1.14, it is possible to use a node attribute as the target in a fencing topology. The syntax for this usage is described below.

From Pacemaker version 1.1.14, it is also possible to use regular expression patterns as the target in a fencing topology. The configured fencing sequence then applies to all devices matching the pattern.

Usage:

Example:

This command filters the given CIB elements through an external program. The program should accept input on stdin and send output to stdout (the standard UNIX filter conventions). As with the show command, the user may choose to filter all or just a subset of elements.

It is possible to filter the XML representation of objects, but probably not as useful as the configuration language. The presentation is somewhat different from what would be displayed by the show command---each element is shown on a single line, i.e. there are no backslashes and no other embelishments.

Don’t forget to put quotes around the filter if it contains spaces.

Usage:

Examples:

Show the value of the given property. If the value is not set, the command will print the default value for the property, if known.

If no property name is passed to the command, the list of known cluster properties is printed.

If the property is set multiple times, for example using multiple property sets with different rule expressions, the output of this command is undefined.

Pass the argument -t or --true to get-property to translate the argument value into true or false. If the value is not set, the command will print false.

Usage:

Example:

Create a graphviz graphical layout from the current cluster configuration.

Currently, only dot (directed graph) is supported. It is essentially a visualization of resource ordering.

The graph may be saved to a file which can be used as source for various graphviz tools (by default it is displayed in the user’s X11 session). Optionally, by specifying the format, one can also produce an image instead.

For more or different graphviz attributes, it is possible to save the default set of attributes to an ini file. If this file exists it will always override the builtin settings. The exportsettings subcommand also prints the location of the ini file.

Usage:

Example:

The group command creates a group of resources. This can be useful when resources depend on other resources and require that those resources start in order on the same node. A common use of resource groups is to ensure that a server and a virtual IP are located together, and that the virtual IP is started before the server.

Grouped resources are started in the order they appear in the group, and stopped in the reverse order. If a resource in the group cannot run anywhere, resources following it in the group will not start.

group can be passed the "container" meta attribute, to indicate that it is to be used to group VM resources monitored using Nagios. The resource referred to by the container attribute must be of type ocf:heartbeat:Xen, ocf:heartbeat:VirtualDomain or ocf:heartbeat:lxc.

Usage:

Example:

Load a part of configuration (or all of it) from a local file or a network URL. The replace method replaces the current configuration with the one from the source. The update method tries to import the contents into the current configuration. The push method imports the contents into the current configuration and removes any lines that are not present in the given configuration. The file may be a CLI file or an XML file.

If the URL is -, the configuration is read from standard input.

Usage:

Example:

location defines the preference of nodes for the given resource. The location constraints consist of one or more rules which specify a score to be awarded if the rule matches.

The resource referenced by the location constraint can be one of the following:

The resource-discovery attribute allows probes to be selectively enabled or disabled per resource and node.

The syntax for resource sets is described in detail for colocation.

For more details on how to configure resource sets, see Syntax: Resource sets.

For more information on rule expressions, see Syntax: Rule expressions.

Usage:

Examples:

Add or remove primitives in a group. The add subcommand appends the new group member by default. Should it go elsewhere, there are after and before clauses.

Usage:

Examples:

Monitor is by far the most common operation. It is possible to add it without editing the whole resource. Also, long primitive definitions may be a bit uncluttered. In order to make this command as concise as possible, less common operation attributes are not available. If you need them, then use the op part of the primitive command.

Usage:

Example:

Note that after executing the command, the monitor operation may be shown as part of the primitive definition.

The ms command creates a master/slave resource type. It may contain a single primitive resource or one group of resources.

Usage:

Example:

The node command describes a cluster node. Nodes in the CIB are commonly created automatically by the CRM. Hence, you should not need to deal with nodes unless you also want to define node attributes. Note that it is also possible to manage node attributes at the node level.

Usage:

Example:

Set defaults for the operations meta attributes.

For more information on rule expressions, see Syntax: Rule expressions.

Usage:

Example:

This constraint expresses the order of actions on two resources or more resources. If there are more than two resources, then the constraint is called a resource set.

Ordered resource sets have an extra attribute to allow for sets of resources whose actions may run in parallel. The shell syntax for such sets is to put resources in parentheses.

If the subsequent resource can start or promote after any one of the resources in a set has done, enclose the set in brackets ([ and ]).

Sets cannot be nested.

Three strings are reserved to specify a kind of order constraint: Mandatory, Optional, and Serialize. It is preferred to use one of these settings instead of score. Previous versions mapped scores 0 and inf to keywords advisory and mandatory. That is still valid but deprecated.

For more details on how to configure resource sets, see Syntax: Resource sets.

Usage:

Example:

The primitive command describes a resource. It may be referenced only once in group, clone, or master-slave objects. If it’s not referenced, then it is placed as a single resource in the CIB.

Operations may be specified anonymously, as a group or by reference:

Operation attributes which are not recognized are saved as instance attributes of that operation. A typical example is OCF_CHECK_LEVEL.

For multistate resources, roles are specified as role=<role>.

A template may be defined for resources which are of the same type and which share most of the configuration. See rsc_template for more information.

Attributes containing time values, such as the interval attribute on operations, are configured either as a plain number, which is interpreted as a time in seconds, or using one of the following suffixes:

Usage:

Example:

Set cluster configuration properties. To list the available cluster configuration properties, use the ra info command with pengine, crmd, cib and stonithd as arguments. When setting the maintenance-mode property, it will inform the user if there are nodes or resources that have the maintenance property.

For more information on rule expressions, see Syntax: Rule expressions.

Usage:

Example:

Show PE (Policy Engine) motions using ptest(8) or crm_simulate(8).

A CIB is constructed using the current user edited configuration and the status from the running CIB. The resulting CIB is run through ptest (or crm_simulate) to show changes which would happen if the configuration is committed.

The status section may be loaded from another source and modified using the cibstatus level commands. In that case, the ptest command will issue a message informing the user that the Policy Engine graph is not calculated based on the current status section and therefore won’t show what would happen to the running but some imaginary cluster.

If you have graphviz installed and X11 session, dotty(1) is run to display the changes graphically.

Add a string of v characters to increase verbosity. ptest can also show allocation scores. utilization turns on information about the remaining capacity of nodes. With the actions option, ptest will print all resource actions.

The ptest program has been replaced by crm_simulate in newer Pacemaker versions. In some installations both could be installed. Use simulate to enfore using crm_simulate.

Usage:

Examples:

Refresh the internal structures from the CIB. All changes made during this session are lost.

Usage:

Rename an object. It is recommended to use this command to rename a resource, because it will take care of updating all related constraints and a parent resource. Changing ids with the edit command won’t have the same effect.

If you want to rename a resource, it must be in the stopped state.

Usage:

An ACL role is a set of rules which describe access rights to CIB. Rules consist of an access right read, write, or deny and a specification denoting part of the configuration to which the access right applies. The specification can be an XPath or a combination of tag and id references. If an attribute is appended, then the specification applies only to that attribute of the matching element.

There is a number of shortcuts for XPath specifications. The meta, params, and utilization shortcuts reference resource meta attributes, parameters, and utilization respectively. The location may be used to specify location constraints most of the time to allow resource move and unmove commands. The property references cluster properties. The node allows reading node attributes. nodeattr and nodeutil reference node attributes and node capacity (utilization). The status shortcut references the whole status section of the CIB. Read access to status is necessary for various monitoring tools such as crm_mon(8) (aka crm status).

For more information on rule expressions, see Syntax: Rule expressions.

Usage:

Example:

Set defaults for the resource meta attributes.

For more information on rule expressions, see Syntax: Rule expressions.

Usage:

Example:

The rsc_template command creates a resource template. It may be referenced in primitives. It is used to reduce large configurations with many similar resources.

Usage:

Example:

This constraint expresses dependency of resources on cluster-wide attributes, also known as tickets. Tickets are mainly used in geo-clusters, which consist of multiple sites. A ticket may be granted to a site, thus allowing resources to run there.

The loss-policy attribute specifies what happens to the resource (or resources) if the ticket is revoked. The default is either stop or demote depending on whether a resource is multi-state.

See also the site set of commands.

Usage:

Example:

Test resources with current resource configuration. If no nodes are specified, tests are run on all known nodes.

The order of resources is significant: it is assumed that later resources depend on earlier ones.

If a resource is multi-state, it is assumed that the role on which later resources depend is master.

Tests are run sequentially to prevent running the same resource on two or more nodes. Tests are carried out only if none of the specified nodes currently run any of the specified resources. However, it won’t verify whether resources run on the other nodes.

Superuser privileges are obviously required: either run this as root or setup the sudoers file appropriately.

Note that resource testing may take some time.

Usage:

Examples:

Save the current configuration to a file. Optionally, as XML. Use - instead of file name to write the output to stdout.

The save command accepts the same selection arguments as the show command. See the help section for show for more details.

Usage:

Example:

CIB’s content is validated by a RNG schema. Pacemaker supports several, depending on version. At least the following schemas are accepted by crmsh:

Use this command to display or switch to another RNG schema.

Usage:

Example:

Set the value of a configured attribute. The attribute must configured previously, and can be an agent parameter, meta attribute, utilization value or operation value.

The first argument to the command is a path to an attribute. This is a dot-separated sequence beginning with the name of the resource or object, and ending with the name of the attribute to set. To set operation value, op_type should be specified; when multi operations exist like multi monitors, interval should be specified.

Usage:

Examples:

The show command displays CIB objects. Without any argument, it displays all objects in the CIB, but the set of objects displayed by show can be limited to only objects with the given IDs or by using one or more of the special prefixes described below.

The XML representation for the objects can be displayed by passing xml as the first argument.

To show one or more specific objects, pass the object IDs as arguments.

To show all objects of a certain type, use the type: prefix.

To show all objects in a tag, use the tag: prefix.

To show all constraints related to a primitive, use the related: prefix.

To show all modified objects, pass the argument changed.

The prefixes can be used together on a single command line. For example, to show both the tag itself and the objects tagged by it the following combination can be used: show tag:my-tag my-tag.

To refine a selection of objects using multiple modifiers, the keywords and and or can be used. For example, to select all primitives tagged foo, the following combination can be used: show type:primitive and tag:foo.

To hide values when displaying the configuration, use the obscure:<glob> argument. This can be useful when sending the configuration over a public channel, to avoid exposing potentially sensitive information. The <glob> argument is a bash-style pattern matching attribute keys.

In /etc/crm/crm.conf, obscure_pattern option is the persisent configuration of CLI. Example, for the high security concern,

Which makes crm configure show is equal to

The default suggestion is passw* If you don’t want to obscure, change the value to blank.

Usage:

Example:

Define a resource tag. A tag is an id referring to one or more resources, without implying any constraints between the tagged resources. This can be useful for grouping conceptually related resources.

Usage:

Example:

The specified template is loaded into the editor. It’s up to the user to make a good CRM configuration out of it. See also the template section.

Usage:

Example:

Attempts to upgrade the CIB to validate with the current version. Commonly, this is required if the error CIB not supported occurs. It typically means that the active CIB version is coming from an older release.

As a safety precaution, the force argument is required if the validation-with attribute is set to anything other than 0.6. Thus in most cases, it is required.

Usage:

Example:

Users which normally cannot view or manage cluster configuration can be allowed access to parts of the CIB. The access is defined by a set of read, write, and deny rules as in role definitions or by referencing roles. The latter is considered best practice.

For more information on rule expressions, see Syntax: Rule expressions.

Usage:

Example:

Call the validate-all action for the resource, if possible.

Limitations:

Usage:

Verify the contents of the CIB which would be committed.

Usage:

Even though we promissed no xml, it may happen, but hopefully very very seldom, that an element from the CIB cannot be rendered in the configuration language. In that case, the element will be shown as raw xml, prefixed by this command. That element can then be edited like any other. If the shell finds out that after the change it can digest it, then it is going to be converted into the normal configuration language. Otherwise, there is no need to use xml for configuration.

Usage:

Copy the current or given configuration to the current CIB. By default, the CIB is replaced, unless the method is set to "update".

Usage:

Remove a configuration. The loaded (active) configuration may be removed by force.

Usage:

Edit current or given configuration using your favourite editor.

Usage:

When called with no argument, lists existing templates and configurations.

Given the argument templates, lists the available templates.

Given the argument configs, lists the available configurations.

Usage:

Load an existing configuration. Further edit, show, and apply commands will refer to this configuration.

Usage:

Create a new configuration from one or more templates. Note that configurations and templates are kept in different places, so it is possible to have a configuration name equal a template name.

If you already know which parameters are required, you can set them directly on the command line.

The parameter name id is set by default to the name of the configuration.

If no parameters are being set and you don’t want a particular name for your configuration, you can call this command with a template name as the only parameter. A unique configuration name based on the template name will be generated.

Usage:

Example:

Process the current or given configuration and display the result.

Usage:

Load a status section from a file, a shadow CIB, or the running cluster. By default, the current (live) status section is modified. Note that if the live status section is modified it is not going to be updated if the cluster status changes, because that would overwrite the user changes. To make crm drop changes and resume use of the running cluster status, run load live.

All CIB shadow configurations contain the status section which is a snapshot of the status section taken at the time the shadow was created. Obviously, this status section doesn’t have much to do with the running cluster status, unless the shadow CIB has just been created. Therefore, the ptest command by default uses the running cluster status section.

Usage:

Example:

Change the node status. It is possible to throw a node out of the cluster, make it a member, or set its state to unclean.

Usage:

Example:

Edit the outcome of a resource operation. This way you can tell CRM that it ran an operation and that the resource agent returned certain exit code. It is also possible to change the operation’s status. In case the operation status is set to something other than done, the exit code is effectively ignored.

Usage:

Example:

Show the origin of the status section currently in use. This essentially shows the latest load argument.

Usage:

Set the quorum value.

Usage:

Example:

Run the policy engine with the edited status section.

Add a string of v characters to increase verbosity. Specify scores to see allocation scores also. utilization turns on information about the remaining capacity of nodes.

If you have graphviz installed and X11 session, dotty(1) is run to display the changes graphically.

Usage:

Example:

The current internal status section with whatever modifications were performed can be saved to a file or shadow CIB.

If the file exists and contains a complete CIB, only the status section is going to be replaced and the rest of the CIB will remain intact. Otherwise, the current user edited configuration is saved along with the status section.

Note that all modifications are saved in the source file as soon as they are run.

Usage:

Example:

Show the current status section in the XML format. Brace yourself for some unreadable output. Add changed option to get a human readable output of all changes.

Usage:

Run the policy engine with the edited status section and simulate the transition.

Add a string of v characters to increase verbosity. Specify scores to see allocation scores also. utilization turns on information about the remaining capacity of nodes.

If you have graphviz installed and X11 session, dotty(1) is run to display the changes graphically.

Usage:

Example:

Modify the ticket status. Tickets can be granted and revoked. Granted tickets could be activated or put in standby.

Usage:

Example:

This command takes a list of primitives as argument, and creates a new rsc_template for these primitives. It can only do this if the primitives do not already share a template and are of the same type.

Usage:

A colocation between a group of resources says that the resources should be located together, but it also means that those resources are dependent on each other. If one of the resources fails, the others will be restarted.

If this is not desired, it is possible to circumvent: By placing the resources in a non-sequential set and colocating the set with a dummy resource which is not monitored, the resources will be placed together but will have no further dependency on each other.

This command creates both the constraint and the dummy resource needed for such a colocation.

Usage:

Invokes the given action for the resource. This is done directly via the resource agent, so the command must be issued while the cluster or the resource is in maintenance mode.

Unless the action is start or monitor, the action must be invoked on the same node as where the resource is running. If the resource is running on multiple nodes, the command will fail.

To use SSH for executing resource actions on multiple nodes, append ssh after the action name. This requires SSH access to be configured between the nodes and the parallax python package to be installed.

Usage:

Example:

Disables maintenances mode, either for the whole cluster or for the given resource.

Usage:

Example:

Enables maintenances mode, either for the whole cluster or for the given resource.

Usage:

Example:

How much detail to show from the logs. Valid detail levels are either 0 or 1, where 1 is the highest detail level. The default detail level is 0.

Usage:

Example:

A transition represents a change in cluster configuration or state. Use diff to see what has changed between two transitions.

If you want to specify the current cluster configuration and status, use the string live.

Normally, the first transition specified should be the one which is older, but we are not going to enforce that.

Note that a single configuration update may result in more than one transition.

Usage:

Examples:

By analysing the log output and looking for particular patterns, the events command helps sifting through the logs to find when particular events like resources changing state or node failure may have occurred.

This can be used to generate a combined list of events from all nodes.

Usage:

Example:

If a log is infested with irrelevant messages, those messages may be excluded by specifying a regular expression. The regular expressions used are Python extended. This command is additive. To drop all regular expressions, use exclude clear. Run exclude only to see the current list of regular expressions. Excludes are saved along with the history sessions.

Usage:

Example:

Create a graphviz graphical layout from the PE file (the transition). Every transition contains the cluster configuration which was active at the time. See also generate a directed graph from configuration.

Usage:

Example:

The info command provides a summary of the information source, which can be either a live cluster snapshot or a previously generated report.

Usage:

Example:

The latest command shows a bit of recent history, more precisely whatever happened since the last cluster change (the latest transition). If the transition is running, the shell will first wait until it finishes.

Usage:

Example:

This command can be used to modify the time span to examine. All history commands look at events within a certain time span.

For the live source, the default time span is the last hour.

There is no time span limit for the hb_report source.

The time period is parsed by the dateutil python module. It covers a wide range of date formats. For instance:

For more examples of valid time/date statements, please refer to the python-dateutil documentation:

If the dateutil module is not available, then the time is parsed using strptime and only the kind as printed by date(1) is allowed:

Usage:

Examples:

Show messages logged on one or more nodes. Leaving out a node name produces combined logs of all nodes. Messages are sorted by time and, if the terminal emulations supports it, displayed in different colours depending on the node to allow for easier reading.

The sorting key is the timestamp as written by syslog which normally has the maximum resolution of one second. Obviously, messages generated by events which share the same timestamp may not be sorted in the same way as they happened. Such close events may actually happen fairly often.

Usage:

Example:

Show important events that happened on a node. Important events are node lost and join, standby and online, and fence. Use either node names or extended regular expressions.

Usage:

Example:

Every event in the cluster results in generating one or more Policy Engine (PE) files. These files describe future motions of resources. The files are listed as full paths in the current report directory. Add v to also see the creation time stamps.

Usage:

Example:

This command makes sense only for the live source and makes crm collect the latest logs and other relevant information from the logs. If you want to make a completely new report, specify force.

Usage:

Show actions and any failures that happened on all specified resources on all nodes. Normally, one gives resource names as arguments, but it is also possible to use extended regular expressions. Note that neither groups nor clones or master/slave names are ever logged. The resource command is going to expand all of these appropriately, so that clone instances or resources which are part of a group are shown.

Usage:

Example:

Sometimes you may want to get back to examining a particular history period or bug report. In order to make that easier, the current settings can be saved and later retrieved.

If the current history being examined is coming from a live cluster the logs, PE inputs, and other files are saved too, because they may disappear from nodes. For the existing reports coming from hb_report, only the directory location is saved (not to waste space).

A history session may also be packed into a tarball which can then be sent to support.

Leave out subcommand to see the current session.

Usage:

Examples:

In case the host this program runs on is not part of the cluster, it is necessary to set the list of nodes.

Usage:

Example:

Every transition is saved as a PE file. Use this command to render that PE file either as configuration or status. The configuration output is the same as crm configure show.

Usage:

Examples:

Events to be examined can come from the current cluster or from a hb_report report. This command sets the source. source live sets source to the running cluster and system logs. If no source is specified, the current source information is printed.

In case a report source is specified as a file reference, the file is going to be unpacked in place where it resides. This directory is not removed on exit.

Usage:

Examples:

This command will print actions planned by the PE and run graphviz (dotty) to display a graphical representation of the transition. Of course, for the latter an X11 session is required. This command invokes ptest(8) in background.

The showdot subcommand runs graphviz (dotty) to display a graphical representation of the .dot file which has been included in the report. Essentially, it shows the calculation produced by pengine which is installed on the node where the report was produced. In optimal case this output should not differ from the one produced by the locally installed pengine.

The log subcommand shows the full log for the duration of the transition.

A transition can also be saved to a CIB shadow for further analysis or use with cib or configure commands (use the save subcommand). The shadow file name defaults to the name of the PE input file.

If the PE input file number is not provided, it defaults to the last one, i.e. the last transition. The last transition can also be referenced with number 0. If the number is negative, then the corresponding transition relative to the last one is chosen.

If there are warning and error PE input files or different nodes were the DC in the observed timeframe, it may happen that PE input file numbers collide. In that case provide some unique part of the path to the file.

After the ptest output, logs about events that happened during the transition are printed.

The tags subcommand scans the logs for the transition and return a list of key events during that transition. For example, the tag error will be returned if there are any errors logged during the transition.

Usage:

Examples:

A transition represents a change in cluster configuration or state. This command lists the transitions in the current timeframe.

Usage:

Example:

A transition represents a change in cluster configuration or state. Use wdiff to see what has changed between two transitions as word differences on a line-by-line basis.

If you want to specify the current cluster configuration and status, use the string live.

Normally, the first transition specified should be the one which is older, but we are not going to enforce that.

Note that a single configuration update may result in more than one transition.

Usage:

Examples: