Setting the agent description

All MainView Middleware Monitor agents from version 8 or later have a Description property. There are three ways in which this can be set, as described in the following sections.

Related topics

Common-tasks-when-customizing-policies

Getting-started-with-policies 

Creating-a-policy

Setting the agent description in the browser download of the Bootstrap agent during installation

You can set the description when you download the Bootstrap agent through a web browser during installation.

First navigate to the http(s)://MVMMServerHostname:BMMAppServicePort page in a web browser. Then click the Download Agents link. As shown below, you can directly enter the value for the Agent Description. 

ZENG-298430-agent-desc.png

In this case, the description is specifying an Agent in the TEST environment. More importantly, this sets the TECH to indicate that the supplied policies (if copied and enabled, see Getting-started-with-policies) for MQ, IBM Integration Bus / IBM App Connect Enterprise, and DataPower will be applied to this agent.

Setting the agent description in the scriptable download of the Bootstrap agent during installation

The agent description can also be set in the value of the agent-desc URL parameter when downloading the Bootstrap agent through a scriptable utility. For example, using curl, the syntax would be:



curl --user USER:PASSWORD --output bmmAgent.zip
"https://MVMMServerHostname:MVMMAppServicePort/agentdist/bootstrap/pkg-windows-x86-64-bootstrap.zip?agent-tunnel-init=0&agent-desc=ENV%3DTEST%3BTECH%3DIBM_MQ%2CIBM_ACE%2CDataPower%2CActiveMQ"



Important

URL substitutions have been performed for the special characters in the description string.

 Setting the agent description at any time using agentpref

At any time, You can set the agent description when you want. For more information, see Using-agentpref. To do this, from a command line on the agent system change to the ?BMM_Agent_HOME/agentpref directory and enter the following:



 agentpref.bat --set-agent Description ENV=TEST,TECH=IBM_MQ,IBM_ACE,DataPower,ActiveMQ

It is also possible to run agentpref remotely from the MainView Middleware Monitor server using the same command. In this case, from a command line on the MainView Middleware Monitor server you would change to the MainView Middleware Monitor_Server_Home directory and run the following:



agentpref.bat --host AgentHostname --port AgentPort --set-agent Description ENV=TEST,TECH=IBM_MQ,IBM_ACE,DataPower,ActiveMQ

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*