Agent Technology Commands › agentctrl-Agent Technology Control Utility

agentctrl-Agent Technology Control Utility

Valid on UNIX/Linux, Windows, z/OS

agentctrl sends Agent Technology control messages to an agent.

Windows

install-path\services\bin

UNIX/Linux, z/OS

install-path/services/bin

z/OS JCL

prefix.CAW0JCL(AGENTCTL)

Syntax

agentctrl [-h hostname]  [-s] [-c] mibName:agentName ctrlMessage  [-a | -m]

Parameters

-h hostname

Host name or IP address of the system on which the agent is running.

Default: local node

-s

Extracts the information from the store, not the agent.

-c

Prints in ConfigSet (ldconfig utility) format.

mibName

Top-level OID in the agent MIB (as registered with the setup registration function AWF_RegName). This value is the name of the MIB you want to browse. This name is often (but not always) the same as the agent name.

agentName

Name of the agent the control message is sent to (as registered with the setup registration function AWF_RegName, usually the agent executable name).

ctrlMessage

Control message text string.

-a

Lists all objects (services and agents) registered with aws_orb.

-m

Lists all MIBs loaded in the store.

The following list shows all the control messages that can be sent to the agent, with explanations for non-intuitive messages.

CONTROL:AgentExit

CONTROL:AgentPause

CONTROL:AgentResume

CONTROL:AgentRestart

Exits the agent and automatically restarts it. A restart command must have been registered.

CONTROL:TaskPause:taskName

CONTROL:TaskResume:taskName

CONTROL:TaskDelete:taskName

Removes the task from the scheduled task list.

CONTROL:TaskInterval:taskName:interval

CONTROL:StoreAgent

Stores all the MIB values for the agent in Object Store.

CONTROL:RestoreAgent

Restores all the MIB values for the agent from Object Store.

CONTROL:RemoveAgent

Removes all the MIB values for the agent from Object Store.

CONTROL:StoreConfigSet:configSetName:
objectName

Stores the values in a group or table as a configuration set in Object Store.

CONTROL:RestoreConfigSet:configSetName

Restores the values in a configuration set into the memory for the agent.

CONTROL:RemoveConfigSet:configSetName

Removes the values in a configuration set from Object Store.

CONTROL:StoreGroup:groupName

Stores all the attribute values for the specified group.

CONTROL:RestoreGroup:groupName

Restores all the attribute values for the specified group.

CONTROL:RemoveGroup:groupName

Removes all the attribute values for the specified group.

CONTROL:StoreTable:tableName

Stores all the attribute values for the specified table.

CONTROL:RestoreTable:tableName

Restores all the attribute values for the specified table.

CONTROL:RemoveTable:tableName

Removes all the attribute values for the specified table.

CONTROL:StoreVariable:varName

Stores the variable value for the specified variable.

CONTROL:RestoreVariable:varName

Restores the variable value for the specified variable.

CONTROL:RemoveVariable:varName

Removes the variable value for the specified variable.

PRINT:Table:tblName[:fileName]

Prints all attribute values for the specified table.

PRINT:Group:grpName[:fileName]

Prints all attribute values for the specified group.

PRINT:Registrations[:fileName]

PRINT:Variable[:fileName]

PRINT:Agent[:fileName]

Prints all attribute values for the entire MIB for the agent.

PRINT:ConfigSet:configSetName[:fileName]

Prints from Object Store all the attribute values for the specified configuration set.

LOGMSG:LogStart:filename

LOGMSG:LogStop

LOGMSG:SetPattern:pattern

Filters logging on the specified pattern.

LOGMSG:DelPattern:pattern

Deletes the specified filter pattern.

LOGMSG:ListPatterns

Lists all patterns being filtered on.

LOGMSG:SetLevel:level

LOGMSG:SetFile:filename

LOGMSG:GetFile

Returns the name of the log file.

LOGMSG:GetLevel

Returns the current log level.

GETATTR: parName:varName:index

Gets the specified attribute value.

SETATTR: parName:varName:index:value

Sets the specified attribute.

ADDATTR: parName:varName:index:value

Adds an instance of the specified attribute.

GETVAR: varName

Gets the specified variable value.

SETVAR: varName:value

Sets the specified variable.