.TH PCS "8" "November 2016" "pcs 0.9.155" "System Administration Utilities" .SH NAME pcs \- pacemaker/corosync configuration system .SH SYNOPSIS .B pcs [\fI\-f file\fR] [\fI\-h\fR] [\fIcommands\fR]... .SH DESCRIPTION Control and configure pacemaker and corosync. .SH OPTIONS .TP \fB\-h\fR, \fB\-\-help\fR Display usage and exit. .TP \fB\-f\fR file Perform actions on file instead of active CIB. .TP \fB\-\-debug\fR Print all network traffic and external commands run. .TP \fB\-\-version\fR Print pcs version information. .SS "Commands:" .TP cluster Configure cluster options and nodes. .TP resource Manage cluster resources. .TP stonith Configure fence devices. .TP constraint Set resource constraints. .TP property Set pacemaker properties. .TP acl Set pacemaker access control lists. .TP qdevice Manage quorum device provider on the local host. .TP quorum Manage cluster quorum settings. .TP booth Manage booth (cluster ticket manager). .TP status View cluster status. .TP config View and manage cluster configuration. .TP pcsd Manage pcs daemon. .TP node Manage cluster nodes. .TP alert Manage pacemaker alerts. .SS "resource" .TP [show [] | \fB\-\-full\fR | \fB\-\-groups\fR | \fB\-\-hide\-inactive\fR] Show all currently configured resources or if a resource is specified show the options for the configured resource. If \fB\-\-full\fR is specified, all configured resource options will be displayed. If \fB\-\-groups\fR is specified, only show groups (and their resources). If \fB\-\-hide\-inactive\fR is specified, only show active resources. .TP list [filter] [\fB\-\-nodesc\fR] Show list of all available resource agents (if filter is provided then only resource agents matching the filter will be shown). If --nodesc is used then descriptions of resource agents are not printed. .TP describe [:[:]] Show options for the specified resource. .TP create [:[:]] [resource options] [op [ ]...] [meta ...] [\fB\-\-clone\fR | \fB\-\-master\fR | \fB\-\-group\fR [\fB\-\-before\fR | \fB\-\-after\fR ]] [\fB\-\-disabled\fR] [\fB\-\-wait\fR[=n]] Create specified resource. If \fB\-\-clone\fR is used a clone resource is created. If \fB\-\-master\fR is specified a master/slave resource is created. If \fB\-\-group\fR is specified the resource is added to the group named. You can use \fB\-\-before\fR or \fB\-\-after\fR to specify the position of the added resource relatively to some resource already existing in the group. If \fB\-\-disabled\fR is specified the resource is not started automatically. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the resource to start and then return 0 if the resource is started, or 1 if the resource has not yet started. If 'n' is not specified it defaults to 60 minutes. Example: Create a new resource called 'VirtualIP' with IP address 192.168.0.99, netmask of 32, monitored everything 30 seconds, on eth2: pcs resource create VirtualIP ocf:heartbeat:IPaddr2 ip=192.168.0.99 cidr_netmask=32 nic=eth2 op monitor interval=30s .TP delete Deletes the resource, group, master or clone (and all resources within the group/master/clone). .TP enable [\fB\-\-wait\fR[=n]] Allow the cluster to start the resource. Depending on the rest of the configuration (constraints, options, failures, etc), the resource may remain stopped. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the resource to start and then return 0 if the resource is started, or 1 if the resource has not yet started. If 'n' is not specified it defaults to 60 minutes. .TP disable [\fB\-\-wait\fR[=n]] Attempt to stop the resource if it is running and forbid the cluster from starting it again. Depending on the rest of the configuration (constraints, options, failures, etc), the resource may remain started. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the resource to stop and then return 0 if the resource is stopped or 1 if the resource has not stopped. If 'n' is not specified it defaults to 60 minutes. .TP restart [node] [\fB\-\-wait\fR=n] Restart the resource specified. If a node is specified and if the resource is a clone or master/slave it will be restarted only on the node specified. If \fB\-\-wait\fR is specified, then we will wait up to 'n' seconds for the resource to be restarted and return 0 if the restart was successful or 1 if it was not. .TP debug\-start [\fB\-\-full\fR] This command will force the specified resource to start on this node ignoring the cluster recommendations and print the output from starting the resource. Using \fB\-\-full\fR will give more detailed output. This is mainly used for debugging resources that fail to start. .TP debug\-stop [\fB\-\-full\fR] This command will force the specified resource to stop on this node ignoring the cluster recommendations and print the output from stopping the resource. Using \fB\-\-full\fR will give more detailed output. This is mainly used for debugging resources that fail to stop. .TP debug\-promote [\fB\-\-full\fR] This command will force the specified resource to be promoted on this node ignoring the cluster recommendations and print the output from promoting the resource. Using \fB\-\-full\fR will give more detailed output. This is mainly used for debugging resources that fail to promote. .TP debug\-demote [\fB\-\-full\fR] This command will force the specified resource to be demoted on this node ignoring the cluster recommendations and print the output from demoting the resource. Using \fB\-\-full\fR will give more detailed output. This is mainly used for debugging resources that fail to demote. .TP debug\-monitor [\fB\-\-full\fR] This command will force the specified resource to be moniored on this node ignoring the cluster recommendations and print the output from monitoring the resource. Using \fB\-\-full\fR will give more detailed output. This is mainly used for debugging resources that fail to be monitored. .TP move [destination node] [\fB\-\-master\fR] [lifetime=] [\fB\-\-wait\fR[=n]] Move the resource off the node it is currently running on by creating a \-INFINITY location constraint to ban the node. If destination node is specified the resource will be moved to that node by creating an INFINITY location constraint to prefer the destination node. If \fB\-\-master\fR is used the scope of the command is limited to the master role and you must use the master id (instead of the resource id). If lifetime is specified then the constraint will expire after that time, otherwise it defaults to infinity and the constraint can be cleared manually with 'pcs resource clear' or 'pcs constraint delete'. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the resource to move and then return 0 on success or 1 on error. If 'n' is not specified it defaults to 60 minutes. If you want the resource to preferably avoid running on some nodes but be able to failover to them use 'pcs location avoids'. .TP ban [node] [\fB\-\-master\fR] [lifetime=] [\fB\-\-wait\fR[=n]] Prevent the resource id specified from running on the node (or on the current node it is running on if no node is specified) by creating a \-INFINITY location constraint. If \fB\-\-master\fR is used the scope of the command is limited to the master role and you must use the master id (instead of the resource id). If lifetime is specified then the constraint will expire after that time, otherwise it defaults to infinity and the constraint can be cleared manually with 'pcs resource clear' or 'pcs constraint delete'. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the resource to move and then return 0 on success or 1 on error. If 'n' is not specified it defaults to 60 minutes. If you want the resource to preferably avoid running on some nodes but be able to failover to them use 'pcs location avoids'. .TP clear [node] [\fB\-\-master\fR] [\fB\-\-wait\fR[=n]] Remove constraints created by move and/or ban on the specified resource (and node if specified). If \fB\-\-master\fR is used the scope of the command is limited to the master role and you must use the master id (instead of the resource id). If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the operation to finish (including starting and/or moving resources if appropriate) and then return 0 on success or 1 on error. If 'n' is not specified it defaults to 60 minutes. .TP standards List available resource agent standards supported by this installation (OCF, LSB, etc.). .TP providers List available OCF resource agent providers. .TP agents [standard[:provider]] List available agents optionally filtered by standard and provider. .TP update [resource options] [op [ ]...] [meta ...] [\fB\-\-wait\fR[=n]] Add/Change options to specified resource, clone or multi\-state resource. If an operation (op) is specified it will update the first found operation with the same action on the specified resource, if no operation with that action exists then a new operation will be created. (WARNING: all existing options on the updated operation will be reset if not specified.) If you want to create multiple monitor operations you should use the 'op add' & 'op remove' commands. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the changes to take effect and then return 0 if the changes have been processed or 1 otherwise. If 'n' is not specified it defaults to 60 minutes. .TP op add [operation properties] Add operation for specified resource. .TP op remove [...] Remove specified operation (note: you must specify the exact operation properties to properly remove an existing operation). .TP op remove Remove the specified operation id. .TP op defaults [options] Set default values for operations, if no options are passed, lists currently configured defaults. .TP meta [\fB\-\-wait\fR[=n]] Add specified options to the specified resource, group, master/slave or clone. Meta options should be in the format of name=value, options may be removed by setting an option without a value. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the changes to take effect and then return 0 if the changes have been processed or 1 otherwise. If 'n' is not specified it defaults to 60 minutes. Example: pcs resource meta TestResource failure\-timeout=50 stickiness= .TP group add [resource id] ... [resource id] [\fB\-\-before\fR | \fB\-\-after\fR ] [\fB\-\-wait\fR[=n]] Add the specified resource to the group, creating the group if it does not exist. If the resource is present in another group it is moved to the new group. You can use \fB\-\-before\fR or \fB\-\-after\fR to specify the position of the added resources relatively to some resource already existing in the group. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the operation to finish (including moving resources if appropriate) and then return 0 on success or 1 on error. If 'n' is not specified it defaults to 60 minutes. .TP group remove [resource id] ... [resource id] [\fB\-\-wait\fR[=n]] Remove the specified resource(s) from the group, removing the group if it no resources remain. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the operation to finish (including moving resources if appropriate) and then return 0 on success or 1 on error. If 'n' is not specified it defaults to 60 minutes. .TP ungroup [resource id] ... [resource id] [\fB\-\-wait\fR[=n]] Remove the group (note: this does not remove any resources from the cluster) or if resources are specified, remove the specified resources from the group. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the operation to finish (including moving resources if appropriate) and the return 0 on success or 1 on error. If 'n' is not specified it defaults to 60 minutes. .TP clone [clone options]... [\fB\-\-wait\fR[=n]] Setup up the specified resource or group as a clone. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the operation to finish (including starting clone instances if appropriate) and then return 0 on success or 1 on error. If 'n' is not specified it defaults to 60 minutes. .TP unclone [\fB\-\-wait\fR[=n]] Remove the clone which contains the specified group or resource (the resource or group will not be removed). If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the operation to finish (including stopping clone instances if appropriate) and then return 0 on success or 1 on error. If 'n' is not specified it defaults to 60 minutes. .TP master [] [options] [\fB\-\-wait\fR[=n]] Configure a resource or group as a multi\-state (master/slave) resource. If \fB\-\-wait\fR is specified, pcs will wait up to 'n' seconds for the operation to finish (including starting and promoting resource instances if appropriate) and then return 0 on success or 1 on error. If 'n' is not specified it defaults to 60 minutes. Note: to remove a master you must remove the resource/group it contains. .TP manage ... [resource n] Set resources listed to managed mode (default). .TP unmanage ... [resource n] Set resources listed to unmanaged mode. .TP defaults [options] Set default values for resources, if no options are passed, lists currently configured defaults. .TP cleanup [] [\fB\-\-node\fR ] Cleans up the resource in the lrmd (useful to reset the resource status and failcount). This tells the cluster to forget the operation history of a resource and re-detect its current state. This can be useful to purge knowledge of past failures that have since been resolved. If a resource id is not specified then all resources/stonith devices will be cleaned up. If a node is not specified then resources on all nodes will be cleaned up. .TP failcount show [node] Show current failcount for specified resource from all nodes or only on specified node. .TP failcount reset [node] Reset failcount for specified resource on all nodes or only on specified node. This tells the cluster to forget how many times a resource has failed in the past. This may allow the resource to be started or moved to a more preferred location. .TP relocate dry-run [resource1] [resource2] ... The same as 'relocate run' but has no effect on the cluster. .TP relocate run [resource1] [resource2] ... Relocate specified resources to their preferred nodes. If no resources are specified, relocate all resources. This command calculates the preferred node for each resource while ignoring resource stickiness. Then it creates location constraints which will cause the resources to move to their preferred nodes. Once the resources have been moved the constraints are deleted automatically. Note that the preferred node is calculated based on current cluster status, constraints, location of resources and other settings and thus it might change over time. .TP relocate show Display current status of resources and their optimal node ignoring resource stickiness. .TP relocate clear Remove all constraints created by the 'relocate run' command. .TP utilization [ [= ...]] Add specified utilization options to specified resource. If resource is not specified, shows utilization of all resources. If utilization options are not specified, shows utilization of specified resource. Utilization option should be in format name=value, value has to be integer. Options may be removed by setting an option without a value. Example: pcs resource utilization TestResource cpu= ram=20 .SS "cluster" .TP auth [node] [...] [\fB\-u\fR username] [\fB\-p\fR password] [\fB\-\-force\fR] [\fB\-\-local\fR] Authenticate pcs to pcsd on nodes specified, or on all nodes configured in corosync.conf if no nodes are specified (authorization tokens are stored in ~/.pcs/tokens or /var/lib/pcsd/tokens for root). By default all nodes are also authenticated to each other, using \fB\-\-local\fR only authenticates the local node (and does not authenticate the remote nodes with each other). Using \fB\-\-force\fR forces re-authentication to occur. .TP setup [\fB\-\-start\fR [\fB\-\-wait\fR[=]]] [\fB\-\-local\fR] [\fB\-\-enable\fR] \fB\-\-name\fR [] [...] [\fB\-\-transport\fR udpu|udp] [\fB\-\-rrpmode\fR active|passive] [\fB\-\-addr0\fR [[[\fB\-\-mcast0\fR
] [\fB\-\-mcastport0\fR ] [\fB\-\-ttl0\fR ]] | [\fB\-\-broadcast0\fR]] [\fB\-\-addr1\fR [[[\fB\-\-mcast1\fR
] [\fB\-\-mcastport1\fR ] [\fB\-\-ttl1\fR ]] | [\fB\-\-broadcast1\fR]]]] [\fB\-\-wait_for_all\fR=<0|1>] [\fB\-\-auto_tie_breaker\fR=<0|1>] [\fB\-\-last_man_standing\fR=<0|1> [\fB\-\-last_man_standing_window\fR=