Chapter 7 TIBCO Runtime Agent MicroAgents Microagents communicate with objects such as operating system subsystems, agent components, log files, event logs, or applications. Each micro agent exposes a set of methods to the agent that the agent uses to collect information and take action. A collection of default micro agents is included with TIBCO Runtime Agent. The micro agents can be accessed from TIBCO Administrator and TIBCO Hawk console. The complete list varies based on the environment, but the following standard micro agents are available for all the platforms: Name of the Microagent Description Arguments deactivateMachineMonitoring Uninstall or unload rulebase for the machine monitoring. No arguments getAdminDeployedComponentsInfo Get the admin deployable components list. No arguments getComponentInstanceCommand This method returns a command string that can start up this component instance. Deployment and Component Instance getComponentInstanceStatus This method returns the component instance status. Deployment and Component Instance getDeploymentStatus This method returns the deployment status. Deployment getFileStatusForComponentFile This method returns the status for component instance file. Deployment , Component Instance , and File path getInstalledTIBCOProducts Get Installed TIBCO products on the machine. No arguments getMicroAgents This method returns a table listing all loaded microagents. No arguments getProcesses This method returns a table listing all processes. No arguments getReleaseVersion This method returns the TSM version. No arguments getTIBCOHome This method returns the TIBCO home directory. No arguments getTraceFileNames This method returns a list of trace file names corresponding to this deployment and component. Deployment and Component Instance onNewStatusOrCmd Returns machine/instance status or returned data by issuing a command Parameters(Timeinterval(min) and FullStatusOnly flag) and History(edit box) refresh This method returns the time interval to be used to repeatedly publish component status or machine status. Refresh Type(dropdown Machine/Component) and Time Interval(seconds) setRvMsgEnabled Instruct TSM to publish component runtime status through rv. Parameters(Enable RV(true/false)) setTraceLevel Set TSM trace level. Trace Level startComponentInstance This method starts a component instance for a particular deployment. Deployment and Component Instance startComponentInstanceFromUAC This method starts a component instance for a particular deployment. Deployment, Component Instance, home path unloadDeployment Unload the deployment. Deployment Obtain the deployment and component instance values from tsm.log after enabling the tracing to -1. Set the -tsm_traceLevel to -1 in hawkagent.cfg that is present in the domain location and restart the hawk agent.
