'\" t
.\"     Title: ocf_heartbeat_NodeUtilization
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_NODEUT" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_NodeUtilization \- Node Utilization
.SH "SYNOPSIS"
.HP \w'\fBNodeUtilization\fR\ 'u
\fBNodeUtilization\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
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\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBdynamic\fR
.RS 4
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\&.
.sp
(optional, boolean, default
true)
.RE
.PP
\fButilization_cpu\fR
.RS 4
Enable setting node CPU utilization limit\&.
.sp
(optional, boolean, default
true)
.RE
.PP
\fButilization_cpu_reservation\fR
.RS 4
Subtract this value when setting the CPU utilization parameter\&.
.sp
(optional, integer, default
1)
.RE
.PP
\fButilization_host_memory\fR
.RS 4
Enable setting available host memory\&.
.sp
(optional, boolean, default
true)
.RE
.PP
\fButilization_host_memory_reservation\fR
.RS 4
Subtract this value when setting host memory utilization, in MB\&.
.sp
(optional, integer, default
512)
.RE
.PP
\fButilization_hv_memory\fR
.RS 4
Enable setting available hypervisor memory\&.
.sp
(optional, boolean, default
true)
.RE
.PP
\fButilization_hv_memory_reservation\fR
.RS 4
Subtract this value when setting hypervisor memory utilization, in MB\&.
.sp
(optional, integer, default
512)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 90s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 100s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 60s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 30s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a NodeUtilization resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_NodeUtilization ocf:heartbeat:NodeUtilization \e
  op monitor timeout="20s" interval="60s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a NodeUtilization resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_NodeUtilization ocf:heartbeat:NodeUtilization \e
  op monitor timeout="20s" interval="60s" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR