Agent-Based Resources
From OpsWise Documentation Wiki
Contents |
Introduction
OpsWise agent-based resources refer to the OpsWise agent running and launching programs on one or more remote machines, along with the agent's related components. In OpsWise, these components are referred to as "outboard components." The set of outboard components includes the agent, message hub, and transporter. Click here to view a diagram and system overview.
Displaying Information About Outboard Components
When you start an agent for the first time, OpsWise automatically creates a database record for each outboard component. You can view these records for details and status information.
Displaying Status Information About Agents
Two methods are available for displaying agent status: from the browser interface and from the command line interface.
Display Agent Status from the Browser Interface
- Select Resources > All Agents (or select the specific type of agent). A screen similar to the one below displays:
- To display more details, click the Agent name. The full agent record displays. For field descriptions, click one of the following:
- Add a Member of Groups.
- Assign Credentials.
- Change the default logging level.
- Change the heartbeat level.The heartbeat is a status message sent from the agent to the core processor.
- Assign this agent to an agent cluster.
| Field Name | Description | |
|---|---|---|
| Agent Name | Required. Name used within OpsWise Automation Center to identify this resource. Up to 40 alphanumerics. It is the user’s responsibility to develop a workable naming scheme for resources. | |
| Host Name | System-supplied.. The IP address or domain/name of the host machine where the agent resides. | |
| Type | System-supplied. The platform where the agent is running. | |
| Agent ID | Required. The name of the communications server message queue. OpsWise Automation Center uses the communications server for communications between the core scheduler and OpsWise Automation Center agents. This name must match the name specified in the agent configuration file and must be unique within the OpsWise Automation Center communications network. | |
| Version | System-supplied. Version number of the agent program. | |
| Last Heartbeat | System-supplied. The date and time of the last heartbeat received from this agent. | |
| CPU Load | System-supplied.. The current CPU load, as a percent, of the agent machine. For example, 1 means 1% currently utilized. | |
| Status | System-supplied. The status of the agent. The green button with the checkmark means the agent is running. A red circle with an X means the agent is not running. | |
| Jobs Run | The number of jobs run on this agent since it was installed. | |
Linux/Unix Agent
Windows Agent
z/OS Agent
Indesca Agent
When you view an agent record, most fields are display-only; however, you can make the following changes:
Display Agent Status from the Command Line Interface
See Command Line Reference for instructions.
Displaying Information about Connectors
A connector is either a message hub or a transporter. You can view information about message hubs and transporters from the browser interface as follows:
From the navigation pane, select Resources > Connectors. The system displays a screen similar to the following:
| Field Name | Description |
|---|---|
| Connector Name | System-supplied. |
| Host Name | System-supplied.. The IP address or domain/name of the host machine where the connector resides. This may or may not be the same machine where the core or agent resides. |
| Type | System-supplied. Either msghub or transport. |
| Queue | System-supplied. Internal use only. |
| Version | System-supplied release number. Internal use only. |
| Last Heartbeat | System-supplied. The date and time of the last heartbeat received from this connector. |
| Status | System-supplied. The status of the connector. The green button with the checkmark means the connector is active. A red circle with an X means the connector is not active. |
Starting/Stopping Outboard Components
For instructions on starting and stopping outboard components, click here and select your platform.
Sending Notifications on Outboard Component Status
You can configure any or all of your outboard components (agents, hubs, transporters) to send a notification via email or SNMP when the component goes down (Offline) or comes back up (Active).
- Display the agent or connector for which you want to configure a notification.
- Click the Connector Notifications tab. This tab displays a list of all notifications configured for this component.
- Click New.
- Select the type of notification you want to configure, either Email Alert or SNMP Alert.
- Using the field descriptions provided below for guidance, complete the fields as needed.
- Click the Submit button to save the record.
- If appropriate, repeat these steps for any additional notifications you want to add.
Email Notifications
Shown below is the Email Alert screen.
The table below describes the fields and buttons on the Email Alert screen.
| Field Name | Description |
|---|---|
| Mode | Offline = Trigger the notification when the component goes offline. Active = Trigger the notification when the component comes up. |
| Email Template | Optional. The name of the Email template defined using the Email template screen. The Email template allows you to specify standard recipients and text for outgoing emails. Type in a name, or click the magnifying glass to browse to an existing Email template or create a new one. You must specify either an Email template or Email connection, or both. |
| Email Connection | Optional. The name of the Email server defined using the Email resource screen. Type in a name, or click the magnifying glass to browse to an existing Email server definition or create a new one. You must specify either an Email template or Email connection, or both. |
| To | Required. Specifies the email address of the recipient. Use commas to separate multiple recipients. |
| CC | Optional. Specifies the email address of the party being sent a copy of the email, if any. Use commas to separate multiple recipients. |
| BCC | Optional. Specifies the email address of the party being sent a blind (hidden) copy of the email, if any. Use commas to separate multiple recipients. |
| Subject | Optional. Specifies the subject line of the email. |
| Body | Optional. Contains the text of the email message. Variables supported. |
| Reply-To | Optional. Specifies the email address of the party identified as the sender of the notification, to whom the recipient can reply. Use commas to separate multiple email addresses. |
| Submit button | Submits the new record to the database. |
| Update button | Saves updates to the record. |
| Delete button | Deletes the current record. |
SNMP Notifications
Shown below is the SNMP Alert screen.
The table below describes the fields and buttons on the SNMP Alert screen.
| Field Name | Description |
|---|---|
| Mode | Offline = Trigger the notification when the component goes offline. Active = Trigger the notification when the component comes up. |
| SNMP Manager | Optional. The name of the SNMP manager defined using the SNMP Manager screen. Type in a name, or click the magnifying glass to browse to an existing Email server definition or create a new one. |
| Notification Severity | Specifies the severity of this alert. One of the following:
|
| Submit button | Submits the new record to the database. |
| Update button | Saves updates to the record. |
| Delete button | Deletes the current record. |
