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

  
 
  

home | help
OCF_HEARTBEAT_NODEUT(7)        OCF resource agents	 OCF_HEARTBEAT_NODEUT(7)

NAME
     ocf_heartbeat_NodeUtilization - Node Utilization

SYNOPSIS
     NodeUtilization [start | stop | monitor | meta-data | validate-all]

DESCRIPTION
     The  Node	Utilization  agent detects system parameters like available CPU,
     host memory and hypervisor memory availability, and adds them into the  CIB
     for  each	node  using  crm_attribute. Run the agent as a clone resource to
     have it populate these parameters on each	node.  Note:  Setting  hv_memory
     only works with Xen at the moment, using the xl or xm command line tools.

SUPPORTED PARAMETERS
     dynamic
	 If set, parameters will be updated if there are differences between the
	 HA parameters and the system values when running the monitor action. If
	 not  set,  the  parameters  will be set once when the resource instance
	 starts.

	 (optional, boolean, default true)

     utilization_cpu
	 Enable setting node CPU utilization limit.

	 (optional, boolean, default true)

     utilization_cpu_reservation
	 Subtract this value when setting the CPU utilization parameter.

	 (optional, integer, default 1)

     utilization_host_memory
	 Enable setting available host memory.

	 (optional, boolean, default true)

     utilization_host_memory_reservation
	 Subtract this value when setting host memory utilization, in MB.

	 (optional, integer, default 512)

     utilization_hv_memory
	 Enable setting available hypervisor memory.

	 (optional, boolean, default true)

     utilization_hv_memory_reservation
	 Subtract this value when setting hypervisor memory utilization, in MB.

	 (optional, integer, default 512)

SUPPORTED ACTIONS
     This resource agent supports the following actions (operations):

     start
	 Starts the resource. Suggested minimum timeout: 90s.

     stop
	 Stops the resource. Suggested minimum timeout: 100s.

     monitor
	 Performs a detailed status check. Suggested minimum timeout: 20s.  Sug-
	 gested interval: 60s.

     meta-data
	 Retrieves  resource agent metadata (internal use only). Suggested mini-
	 mum timeout: 5s.

     validate-all
	 Performs a validation of the resource configuration. Suggested  minimum
	 timeout: 30s.

EXAMPLE CRM SHELL
     The  following  is  an example configuration for a NodeUtilization resource
     using the crm(8) shell:

	 primitive p_NodeUtilization ocf:heartbeat:NodeUtilization \
	   op monitor timeout="20s" interval="60s"

EXAMPLE PCS
     The following is an example configuration for  a  NodeUtilization	resource
     using pcs(8)

	 pcs resource create p_NodeUtilization ocf:heartbeat:NodeUtilization \
	   op monitor timeout="20s" interval="60s"

SEE ALSO
     http://clusterlabs.org/

AUTHOR
     ClusterLabs  contributors	(see  the  resource agent source for information
     about individual authors)

resource-agents 4.13.0		   08/27/2026		 OCF_HEARTBEAT_NODEUT(7)

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

home | help