Internal documentation only

This page has been marked as draft.

How to hide server credentials from the UI

There may be a requirement to hide your hosts connection credentials such as username and password from the UI.

OP5 allows this using the USER macro. You can define multiple $USER$ macros within /opt/monitor/etc/resource.cfg which become global variables. Use macros $USER11$ through $USER256$ in your configuration.

The $USER$ macro can be used to define any variable whether that is username, password, port etc on any hosts that requires connection details such as VMware, Microsoft SQL Server.

Example scenario:

Below is a VMware ESXI host which needs username and password in order to connect to it. Notice that these login details are stored in their respective variables. The variables are then referenced in each check command. The issue is that the values are visible for anyone that has access.

Using your favourite text edior open /opt/monitor/etc/resource.cfg to add new variables. Note resources.cfg allows the creation of 245 variables from $USER11$ to $USER256$. You cannot name the variables to anything other than $USER$ so worth leaving a comment.

## resource.cfg - Sample Resource File for op5 Monitor
## In this file you can define variables to be used in scripts and so on.
## Note:
## Macros $USER1$ through $USER10$ are reserved for future op5 use.
## Use macros $USER11$ through $USER256$ in your configuration.

## Sets $USER1$ to be the path to the plugins
$USER1$=/opt/plugins

## Path to plugins that require the suid bit to be set.
## (these should all be symlinked to $USER1$ dir)
$USER2$=/opt/plugins/suid

## Path to OP5 specific addons
$USER3$=/opt/monitor/op5

## ESXi Host details
$USER11$=username
$USER12$=password

1. Make sure title does not finish with a question mark (if you come across any FAQ that doesn’t meet the guideline correct it)
2. Please include pictures and attach xml setup if possible.
3. If you are linking to a documentation link, make sure you replace the version with “current” i.e.: https://docs.itrsgroup.com/docs/geneos/5.10.0/index.html , replace 5.10.0 with “current”. This will make sure the url is linked to latest documentation.
4. On the right side panel, make sure you select the correct visibility to the intended audience (Agents and Managers if ITRS and Everyone if is to be client facing).
5. On the right side panel, make sure you create the article for the appropriate section of Product and Sub-Category (Please, remember to place FAQ’s that are ONLY for CS in the ‘ITRS internal only’).
6. On the right side panel, make sure you leave the ‘open for comments’ ticked.
7. On the right side panel, make sure you set yourself as ‘owner’ of the article.
8. Make sure you enter keywords labels as the words the client might use to search and find the article
9. Make sure you get a peer review before publishing it.
10. For each new FAQ created (ALL PRODUCTS) create TCP > Documentation issue in JIRA.
    • for the new FAQ, use the TCP > Documentation project type.
    • Select FAQ on the Documentation Type menu.
    • Assign it to the Tech Comms Team group.
    • use the FAQ title as the JIRA and provide a link to the FAQ in the comment of the JIRA