Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
PACEMAKER(8)		System Administration Utilities		  PACEMAKER(8)

NAME
       Pacemaker - Part	of the Pacemaker cluster resource manager

SYNOPSIS
       crm_attribute -n	<attribute> <command> [options]

DESCRIPTION
       crm_attribute - query and update	Pacemaker cluster options and node at-
       tributes

OPTIONS
   Help	Options:
       -h, --help
	      Show help	options

       --help-all
	      Show all help options

       --help-output
	      Show output help

       --help-selections
	      Show selecting options

       --help-command
	      Show command options

       --help-additional
	      Show additional options

   Output Options:
       --output-as=FORMAT
	      Specify output format as one of: text (default), xml

       --output-to=DEST
	      Specify file name	for output (or "-" for stdout)

       --text-fancy
	      Use more highly formatted	output (requires --output-as=text)

   Selecting attributes:
       -i, --id=XML_ID
	      (Advanced)  Operate on instance of specified attribute with this
	      XML ID

       -n, --name=NAME
	      Operate on attribute or option with  this	 name.	 For  queries,
	      this  is optional, in which case all matching attributes will be
	      returned.

       -P, --pattern=PATTERN
	      Operate on all attributes	matching this pattern (with -v,	-D, or
	      -G)

       -p, --promotion=RESOURCE
	      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 -l/--lifetime
	      to reboot	(normally invoked from an OCF resource agent)

       -s, --set-name=NAME
	      (Advanced) Operate on instance of	specified  attribute  that  is
	      within set with this XML ID

   Commands:
       -D, --delete
	      Delete the attribute/option

       -G, --query
	      Query  the current value of the attribute/option.	 See also: -n,
	      -P

       -v, --update=VALUE
	      Update the value of the attribute/option

   Additional options:
       -d, --default=VALUE
	      (Advanced) Default value to display if none is found in configu-
	      ration

       -l, --lifetime=LIFETIME
	      Lifetime of the node attribute.  Valid values: reboot, forever

       -N, --node=NODE
	      Set a node attribute for named node (instead of  a  cluster  op-
	      tion).  See also:	-l

       -t, --type=SECTION
	      Which  part  of the configuration	to update/delete/query the op-
	      tion in.	Valid values: crm_config,  rsc_defaults,  op_defaults,
	      tickets

       -W, --wait=UNTIL
	      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 -N,	and one	of -D or -u)

       -z, --utilization
	      Set an utilization attribute for the node.

   Application Options:
       -$, --version
	      Display software version and exit

       -V, --verbose
	      Increase debug output (may be specified multiple times)

       -q, --quiet
	      Print only the value on stdout

EXAMPLES
       Add new node attribute called 'location'	with the value of 'office' for
       host 'myhost':

	      crm_attribute --node myhost --name location --update office

       Query the value of the 'location' node attribute	for host 'myhost':

	      crm_attribute --node myhost --name location --query

       Change the value	of the 'location' node attribute for host 'myhost':

	      crm_attribute --node myhost --name location --update backoffice

       Delete the 'location' node attribute for	host 'myhost':

	      crm_attribute --node myhost --name location --delete

       Query the value of the 'cluster-delay' cluster option:

	      crm_attribute --type crm_config --name cluster-delay --query

       Query value of the 'cluster-delay' cluster option and  print  only  the
       value:

	      crm_attribute  --type  crm_config	 --name	 cluster-delay --query
	      --quiet

AUTHOR
       Written by Andrew Beekhof and the Pacemaker project contributors

Pacemaker 2.1.7			   May 2025			  PACEMAKER(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=crm_attribute&sektion=8&manpath=FreeBSD+Ports+14.3.quarterly>

home | help