Host Template: Infrastructure - Cisco UCS - Custom

Overview Copied

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 (Metric: Warning, 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.

Usage Instructions Copied

Please review the overall Infrastructure - Cisco UCS Opspack documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.

Add this Host Template Copied

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.

Add and configure Variables Copied

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:

Note

For more information, refer to the documentation on Adding Variables to Hosts.

Apply Changes Copied

Apply Changes and the system will now be monitored:

View Output

Available Variables Copied

UCS_CREDENTIALS Copied

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

Plugin Parameter Position 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 Copied

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

SSL Certificates: UCS_CERTIFICATES Copied

Opsview Cloud

For Opsview Cloud customers, please contact ITRS Support 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:

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 Copied

Plugin: check_cisco_ucs

Secure Args

This plugin uses the Secure Args 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 Check Name Mode
UCS - Custom - Query UCS.Custom.Query
["Opsview On-Premises"] ["Opsview > Opspacks"] ["User Guide", "Technical Reference"]

Was this topic helpful?