---
name: "ocf_heartbeat_NodeUtilization"
section: "7"
platform: "linux"
package: "resource-agents"
version: "1:4.16.0-3+deb13u2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/ocf_heartbeat_NodeUtilization"
---

# ocf\_heartbeat\_NodeUtilization(7)

Node Utilization

## 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. Suggested interval: 60s.

**meta-data**

Retrieves resource agent metadata (internal use only). Suggested minimum 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)](/crm/8.md) 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/8.md)

```
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)**