---
title: "Host Template: Export - Capacity Planner Server"
description: ""
url: "https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/export-capacity-planner-opspack/export-capacity-planner-server-host-template/index.html"
---## Overview

Monitor your physical server with the required information for ITRS Capacity Planner, including CPU and Memory capacity
and utilization, hardware details, and filesystem information. Works with both supported Linux and Windows systems.

This Host Template includes the following Service Checks:

| Service&nbsp;Check&nbsp;Name | Description | Check Interval |
|:-----------------------------|:------------|:---------------|
| Cap Plan Export - Server - Specification   | The number of physical and logical cores, the average CPU clock speed (MHz) and the memory capacity (B) of the server.
**NOTE:** Visual check output units for memory capacity will match the implementation of `free -h` on the monitored system.  | 1 day          |
| Cap Plan Export - Server - Utilization     | The current CPU utilization (%) and memory utilization (%) of the server.                                                                                                                                                                                                                  | 5 mins         |
| Cap Plan Export - Filesystem - Capacity    | The total storage capacity (B) of all filesystems on the server. Supports exclusion of specific filesystem types or mount points.
**NOTE:** Visual check output units will match the implementation of `df -h` on the monitored system. | 1 day          |
| Cap Plan Export - Filesystem - Utilization | The current storage utilization (%) of all filesystems on the server. Supports exclusion of specific filesystem types or mount points.                                                                                                                                                     | 5 mins         |
| Cap Plan Export - Tag                      | Allows attaching custom tags to the exported data to categorise servers.                                                                                                                                                                                                                   | 1 day          |

## Usage Instructions

Please review the overall [Export - Capacity Planner Opspack](https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/export-capacity-planner-opspack/export-capacity-planner-opspack/index.html) documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.

### Add the Host Template

Add the **Export - Capacity Planner - Server** Host Template to your Opsview Monitor host.


**Note**


For more information, refer to the documentation on [Adding Host Templates to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/host/index.html#host-templates).



### Add Variables if appropriate

The following variables can be used to configure communication with the Agent (see [Agent Security](https://docs.itrsgroup.com/docs/opsview/6.11.7/agent-security/index.html#host-variables)):

- **NRPE_CERTIFICATES**
- **NRPE_CIPHERS**
- **NRPE_EXTRA_ARGS**

The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance alongside the Host Template:

- [**CAPACITY_PLANNER_EXCLUDE**](#capacity_planner_exclude)
- [**CAPACITY_PLANNER_TAG**](#capacity_planner_tag)


**Note**


For more information, refer to the documentation on [Adding Variables to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/adding-a-new-variable/index.html#adding-a-variable-to-a-host).



### Apply Changes

Apply Changes and the system will be monitored:

![View Output](https://docscdn.itrsgroup.com/opsview/images/opspacks-export-capacity-planner-view_server_checks.png)

**NOTE:** If Checks report an **UNKNOWN** state, the output will indicate that the integration to ITRS Capacity Planner
for the respective monitored physical server is **broken**, as this data is required for ITRS Capacity Planner to work.
The "Cap Plan Export - Tag" Service Check is an exception, and will report that the integration is **impacted**, as this
data is not required for ITRS Capacity Planner to work, but not having it available will decrease the efficacy of ITRS
Capacity Planner.

## Available Variables

### CAPACITY_PLANNER_EXCLUDE

The "Cap Plan Export - Filesystem - Capacity" and "Cap Plan Export - Filesystem - Utilization" Service Checks can use
the following variable to exclude filesystems from being exported:

| Position in Variable | Name                    | Description                                                                                                    | Default                       |
|:---------------------|:------------------------|:---------------------------------------------------------------------------------------------------------------|:------------------------------|
| Arg1                 | Filesystems to exclude  | Comma-separated list of filesystem types to exclude from being exported.                                       | tmpfs,devtmpfs,squashfs,CDRom |
| Arg2                 | Mountpoints to exclude  | Comma-separated list of mountpoints whose linked filesystems will not be exported. Supports regex expressions. | N/A                           |

![View Output](https://docscdn.itrsgroup.com/opsview/images/opspacks-export-capacity-planner-add_exclude_variable.png)

### CAPACITY_PLANNER_TAG

The "Cap Plan Export - Tag" Service Check will be added to the Host once for each instance of the following Variable,
which will then attach the Tag Name and Tag Value as a key-value pair to the exported server details:

| Position in Variable | Name      | Description                                                                                            | Default |
|:---------------------|:----------|:-------------------------------------------------------------------------------------------------------|:--------|
| Value                | Tag Name  | The name of the tag to be applied to the exported server e.g. "Location".                              | N/A     |
| Arg1                 | Tag Value | The value of the tag to be applied to the exported server e.g. "New York". Limited to 1000 characters. | N/A     |

![View Output](https://docscdn.itrsgroup.com/opsview/images/opspacks-export-capacity-planner-add_tag_variable.png)

Each Tag added will be listed as a separate Service Check:

![View Output](https://docscdn.itrsgroup.com/opsview/images/opspacks-export-capacity-planner-view_tag_variable.png)

## Known Issues

- If using RRD as a timeseries provider, then the "Cap Plan Export - Server - Specification" and "Cap Plan Export - Filesystem - Capacity" Service Checks will display no data in their timeseries graphs. However, the integration to ITRS Capacity Planner will still work as expected.
- If a monitored server uses a filesystem with subvolumes e.g. btrfs, then each filesystem will be duplicated in ITRS Analytics and ITRS Capacity Planner as `<filesystem name>`, `<filesystem name>2`, `<filesystem name>3` etc. for each subvolume using it.


