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)

This command has the following format:

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

-h hostname

Specifies the 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

Specifies the 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

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

ctrlMessage

Specifies the 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.

CONTROL:AgentExit

Exits the agent.

CONTROL:AgentPause

Pauses the agent.

CONTROL:AgentResume

Resumes the agent.

CONTROL:AgentRestart

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

CONTROL:TaskPause:taskName

Pauses the specified task.

CONTROL:TaskResume:taskName

Resumes the specified task.

CONTROL:TaskDelete:taskName

Removes the task from the scheduled task list.

CONTROL:TaskInterval:taskName:interval

Changes the interval of the specified task.

CONTROL:StoreAgent

Stores all the agent's MIB values in Object Store.

CONTROL:RestoreAgent

Restores all the agent's MIB values from Object Store.

CONTROL:RemoveAgent

Removes all the agent's MIB values 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 agent's memory.

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]

Prints all registrations.

PRINT:Variable[:fileName]

Prints all variables.

PRINT:Agent[:fileName]

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

PRINT:ConfigSet:configSetName[:fileName]

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

LOGMSG:LogStart:filename

Starts logging into the specified file.

LOGMSG:LogStop

Stops logging.

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

Sets the logging level.

LOGMSG:SetFile:filename

Sets the log file.

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.