Related Documentation | \nVersion of up.time \naffected | \nAffected Platforms | \n
\n | \n4.5 or newer | \nAll | \n
There are two main scenarios for using the agentcmd utility:
\n \n-
\n
- With an agent on a system that has been added to up.time. In this case, the hostname is in the up.time DataStore. \n
- With an agent that has been deployed on a system that has not been added to up.time. If there is no agent on the system, or there are network problems, agentcmd returns the following error message:
\n
\nERR Unable to contact Agent (10.1.2.34 on port 9998)
\n
You can use agentcmd in two ways: from the command line or in an agent-side script.
\n \nUsing agentcmd at the command line
\n \nThe command line syntax of agentcmd is:
\n \nagentcmd <-/+s> <-p #> hostname command
Where:
\n \n-
\n
-s
= do not use an SSL connection to the agent (default).
\n+s
= connect to the agent using SSL. \nIf SSL is not enabled on the host, the following error message appears:
\n
\nERR The host was not configured to use SSL
\n-p #
= connect to the agent on the specified port (default is 9998).
\nhostname
= the name or IP address of the host on which the agent is running.
\ncommand
= the agent command to run.
\n
For example, to get basic system information from an agent running on the server Solaris1, type the following command:
\n \nagentcmd +s Solaris1 sysinfo
The agent will return output similar to the following:
\n \n\nSYSNAME=Solaris1 \nDOMAIN=myDomain.com \nARCH="SunOS Solaris1 5.9 Generic_118558-03 sun4u sparc SUNW,Ultra-Enterprise" \nOSVER=5.9 \nNUMCPUS=4 \nMEMSIZE=1048576 \nPAGESIZE=8192 \nSWAPSIZE=1021624 \nGPGSLO=25 \nVXVM="" \nSDS="YES" \nHOSTID="808cf673" \nCPU0=" 0 - - 168 - UltraSPARC - " \nCPU1=" 1 - - 168 - UltraSPARC - " \nCPU4=" 4 - - 168 - UltraSPARC - " \nCPU5=" 5 - - 168 - UltraSPARC - " \nNET0=lo0=127.0.0.1 \nNET1=hme0=10.0.0.010 \n\n \n
Using agentcmd in an agent-side script
\n \nAs with netcat, agentcmd is typically used in a script on the monitoring station to perform the following tasks:
\n \n-
\n
- Contact an agent system. \n
- Attempt to run a predefined agent-side script. \n
- Return the results of an agent-side script. \n
- Validate the status of those results. \n
- Return the status to up.time. \n
The following example illustrates how to run agentcmd in an agent side script:
\n \nNOTE: The rexec
in the command below does not indicate use of the rexec system utility. It is a keyword that is used to indicate to the agent that you are attempting to run a pre-defined command.
\n/usr/local/uptime4/scripts/agentcmd [-s/+s] -p [agent port] [agent hostname] rexec [password] [path] \n\n \n
If you use netcat in your scripts, see the following Knowledge Base articles for information on replacing netcat with agentcmd:
\n \n