Cisco UCS - Custom

Host Template: Infrastructure - Cisco UCS - Custom

Monitor a specific object and field from the UCS component hierarchy.

This Host Template includes the following Service Checks:

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

Usage Instructions

Step 1: 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.

For more information, refer to Opsview Knowledge Center - Adding Host Templates to Hosts.

Step 2: Add and configure variables required for this Host Template

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

UCS_CREDENTIALS

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

Parameter	Position in Variable	Name	Description
--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.

Parameter	Position 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.

For more information, refer to Opsview Knowledge Center - Adding Variables to Hosts.

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 Check Name	Mode
UCS - Custom - Query	`UCS.Custom.Query`

SSL Certificates

Additionally, if ssl verification is required, you can use the following variable to pass in your SSL certificates for use when connecting to the service provider to gather metrics:

UCS_CERTIFICATES

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. Optional, only required if server verification is needed
--client-cert	Arg2	Client Certificate Path	Path to the Client Certificate. Optional, only required if client verification is needed
--client-key	Arg3	Client Key Path	Path to the Client Key. Optional, only required if client verification is needed