.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH PACEMAKER "8" "March 2024" "Pacemaker 2.1.7" "System Administration Utilities"
.SH NAME
Pacemaker \- Part of the Pacemaker cluster resource manager
.SH SYNOPSIS
crm_attribute -n <attribute> <command> [options]
.SH DESCRIPTION
crm_attribute \- query and update Pacemaker cluster options and node attributes
.SH OPTIONS
.SS "Help Options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help options
.TP
\fB\-\-help\-all\fR
Show all help options
.TP
\fB\-\-help\-output\fR
Show output help
.TP
\fB\-\-help\-selections\fR
Show selecting options
.TP
\fB\-\-help\-command\fR
Show command options
.TP
\fB\-\-help\-additional\fR
Show additional options
.SS "Output Options:"
.TP
\fB\-\-output\-as\fR=\fI\,FORMAT\/\fR
Specify output format as one of: text (default), xml
.TP
\fB\-\-output\-to\fR=\fI\,DEST\/\fR
Specify file name for output (or "\-" for stdout)
.TP
\fB\-\-text\-fancy\fR
Use more highly formatted output (requires \fB\-\-output\-as\fR=\fI\,text\/\fR)
.SS "Selecting attributes:"
.TP
\fB\-i\fR, \fB\-\-id\fR=\fI\,XML_ID\/\fR
(Advanced) Operate on instance of specified attribute with this
XML ID
.TP
\fB\-n\fR, \fB\-\-name\fR=\fI\,NAME\/\fR
Operate on attribute or option with this name.  For queries, this
is optional, in which case all matching attributes will be
returned.
.TP
\fB\-P\fR, \fB\-\-pattern\fR=\fI\,PATTERN\/\fR
Operate on all attributes matching this pattern
(with \fB\-v\fR, \fB\-D\fR, or \fB\-G\fR)
.TP
\fB\-p\fR, \fB\-\-promotion\fR=\fI\,RESOURCE\/\fR
Operate on node attribute used as promotion score for specified
resource, or resource given in OCF_RESOURCE_INSTANCE environment
variable if none is specified; this also defaults \fB\-l\fR/\-\-lifetime
to reboot (normally invoked from an OCF resource agent)
.TP
\fB\-s\fR, \fB\-\-set\-name\fR=\fI\,NAME\/\fR
(Advanced) Operate on instance of specified attribute that is
within set with this XML ID
.SS "Commands:"
.TP
\fB\-D\fR, \fB\-\-delete\fR
Delete the attribute/option
.TP
\fB\-G\fR, \fB\-\-query\fR
Query the current value of the attribute/option.
See also: \fB\-n\fR, \fB\-P\fR
.TP
\fB\-v\fR, \fB\-\-update\fR=\fI\,VALUE\/\fR
Update the value of the attribute/option
.SS "Additional options:"
.TP
\fB\-d\fR, \fB\-\-default\fR=\fI\,VALUE\/\fR
(Advanced) Default value to display if none is found in configuration
.TP
\fB\-l\fR, \fB\-\-lifetime\fR=\fI\,LIFETIME\/\fR
Lifetime of the node attribute.
Valid values: reboot, forever
.TP
\fB\-N\fR, \fB\-\-node\fR=\fI\,NODE\/\fR
Set a node attribute for named node (instead of a cluster option).
See also: \fB\-l\fR
.TP
\fB\-t\fR, \fB\-\-type\fR=\fI\,SECTION\/\fR
Which part of the configuration to update/delete/query the option in.
Valid values: crm_config, rsc_defaults, op_defaults, tickets
.TP
\fB\-W\fR, \fB\-\-wait\fR=\fI\,UNTIL\/\fR
Wait for some event to occur before returning.  Values are 'no' (wait
only for the attribute daemon to acknowledge the request),
\&'local' (wait until the change has propagated to where a local
query will return the request value, or the value set by a
later request), or 'cluster' (wait until the change has propagated
to where a query anywhere on the cluster will return the requested
value, or the value set by a later request).  Default is 'no'.
(with \fB\-N\fR, and one of \fB\-D\fR or \fB\-u\fR)
.TP
\fB\-z\fR, \fB\-\-utilization\fR
Set an utilization attribute for the node.
.SS "Application Options:"
.TP
\-$, \fB\-\-version\fR
Display software version and exit
.TP
\fB\-V\fR, \fB\-\-verbose\fR
Increase debug output (may be specified multiple times)
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Print only the value on stdout
.SH EXAMPLES
Add new node attribute called 'location' with the value of 'office' for host 'myhost':
.IP
crm_attribute \-\-node myhost \-\-name location \-\-update office
.PP
Query the value of the 'location' node attribute for host 'myhost':
.IP
crm_attribute \-\-node myhost \-\-name location \-\-query
.PP
Change the value of the 'location' node attribute for host 'myhost':
.IP
crm_attribute \-\-node myhost \-\-name location \-\-update backoffice
.PP
Delete the 'location' node attribute for host 'myhost':
.IP
crm_attribute \-\-node myhost \-\-name location \-\-delete
.PP
Query the value of the 'cluster\-delay' cluster option:
.IP
crm_attribute \-\-type crm_config \-\-name cluster\-delay \-\-query
.PP
Query value of the 'cluster\-delay' cluster option and print only the value:
.IP
crm_attribute \-\-type crm_config \-\-name cluster\-delay \-\-query \-\-quiet
.SH AUTHOR
Written by Andrew Beekhof and the Pacemaker project contributors