---
title: "Host Template: Infrastructure - Cisco UCS - Custom"
description: ""
url: "https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/infrastructure-cisco-ucs-opspack/infrastructure-cisco-ucs-custom-host-template/index.html"
---## Overview

Monitor a specific object and field from the UCS component hierarchy

This Host Template includes the following Service Checks:

| Service&nbsp;Check&nbsp;Name | Description | Default&nbsp;Thresholds (Metric:&nbsp;Warning,&nbsp;Critical) | UOM |
|:-----------------------------|:------------|:------------------------------------------------:|:---:|
| UCS - Custom - Query | User-defined query against an object in the UCS component hierarchy | N/A | N/A |


**Note**


See details about [Monitoring Plugin thresholds here](https://www.monitoring-plugins.org/doc/guidelines.html#THRESHOLDFORMAT).



## Usage Instructions

Please review the overall [Infrastructure - Cisco UCS Opspack](https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/infrastructure-cisco-ucs-opspack/infrastructure-cisco-ucs-opspack/index.html) documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.

### Add this Host Template

Add the **Infrastructure - Cisco UCS - Custom** Host Template to your Opsview Monitor host.
If the resource you're monitoring has no hostname or public IP, then open the **Advanced** settings pane and change **Host Check Command** to **Always assumed to be UP**.


**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 and configure Variables

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:

- [**UCS_CREDENTIALS**](#ucs_credentials)
- [**UCS_CUSTOM_QUERY**](#ucs_custom_query)
- [**UCS_CERTIFICATES**](#ssl-certificates-ucs_certificates)


**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 now be monitored:

![View Output](https://docscdn.itrsgroup.com/opsview/images/opspacks-infrastructure-cisco-ucs-output-infrastructure-cisco-ucs-custom.png)

## Available Variables

### UCS_CREDENTIALS

The Value is not used and therefore can be set to anything. Override the arguments with your credentials.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | UCS Credentials | The credentials for your Cisco UCS |
| `--api-server-url` | Arg1 | UCS API Server URL | The server URL for your Cisco UCS Manager or CIMC Supervisor |
| `--username` | Arg2 | UCS Username | The username for your Cisco UCS user |
| `--password` | Arg3 | UCS Password | The password for your Cisco UCS user |

### UCS_CUSTOM_QUERY

This variable can be added multiple times to create multiple custom service checks. The Value of the variable denotes the name of the custom service check.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| `--custom-display-name` | Value | UCS Custom Query | Display name of the metric to monitor |
| `--custom-name` | Arg1 | UCS Custom Name | Name of the object to monitor in the custom query |
| `--custom-field` | Arg2 | UCS Custom Field | Name of the field to monitor in the custom query |
| `--custom-unit` | Arg3 | UCS Custom Unit | This argument is optional. Unit of measurement for the data returned from the object to monitor in the custom query. Units supplied in their correct abbreviation will be converted automatically, e.g. B for Bytes. |

### SSL Certificates: UCS_CERTIFICATES


**Opsview Cloud**


For Opsview Cloud customers, please contact [ITRS Support](https://www.itrsgroup.com/about/contact) for assistance with setting up certificate files, as they require Orchestrator access.



Additionally, you can use the **UCS_CERTIFICATES** variable to pass in your SSL certificates for use when connecting to the service provider to gather metrics:

The Value is not used and therefore can be set to anything. Override the arguments with your certificates.

| Parameter | Position in Variable | Name | Description |
|:---------:|:--------------------:|:-----|:------------|
| `--ca-path` | Arg1 | CA Certificate Path | Path to the CA Certificate |
| `--client-cert` | Arg2 | Client Certificate Path | Path to the Client Certificate |
| `--client-key` | Arg3 | Client Key Path | Path to the Client Key |

## Plugin help

Plugin: `check_cisco_ucs`


**Secure Args**


This plugin uses the [Secure Args](https://docs.itrsgroup.com/docs/opsview/6.11.7/configuration/secure-arguments/index.html) feature for argument passing.



For mode-specific help, run the plugin with the `-h -m <mode>` flags. This will list the required and optional Variable Arguments for that mode.
The appropriate mode for each Service Check is listed here:

| Service&nbsp;Check&nbsp;Name | Mode |
|:-----------------------------|:-----|
| UCS - Custom - Query | `UCS.Custom.Query` |


