IBM i Agent

IBM i Agent

Overview

The IBM i Agent resource provides information about Universal Agent for IBM i running on an IBM i platform. To run an IBM i task, you need an IBM i Agent installed and running on the target machine.

IBM i Agent Details

IBM i Agent Details provide the information necessary for the scheduler to locate and communicate with the machine where the Agent resides. Universal Controller creates this record automatically when the Agent connects with the Controller.

To view IBM i Agent Details:

Step 1

From the Agents & Connections navigation pane, select Agents > IBM i Agents. The IBM i Agents list displays a list of connected IBM i Agents.

Note

You also can select Agents > All Agents from the Agents & Connections navigation pane to display a list of all connected Agents: IBM i, Linux/Unix, Windows, and z/OS.

Step 2

Click the Details icon or click anywhere in the Agent row to display Details for that agent.
 


 
Most fields are read-only; however, you can make the following changes:

  1. Add a Member of Business Services.

  2. Assign Credentials.

  3. Change the heartbeat interval. The heartbeat is a status message sent from the Agent to the Controller.

  4. Change the Log Level (default is Informational).

  5. Select whether or not to apply a Task Execution Limit (and Limit Amount) on the Agent.



You also can choose to temporarily suspend the agent's ability to run tasks.
 
See the field descriptions, below, for details about all fields in the IBM i Agent Details.

IBM i Agent Details Field Descriptions

The following table describes the fields, buttons, and tabs in the IBM i Agent Details.

Field Name

Description

Field Name

Description

Configuration Details

This section contains detailed information about the configuration of the Agent.

Name

User-defined during installation; name used within the Controller to identify this Agent.

Agent ID

Unique ID for this Agent, created during installation.

Description

Description of this record. Maximum length is 255 characters.

Member of Business Services

User-defined; Allows you to select one or more Business Services that this record belongs to.  (You also can Check All or Uncheck All Business Services for this record.)

You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service.

If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted.

Status

System-supplied; status of the Agent.

Suspended

Indication that the Agent's ability to run tasks has been suspended.

Log Level

User-modifiable; level of logging that the Agent will perform.

Note

You cannot modify a Log Level from a non-active (Passive or Offline) mode.

Modifying this field changes the log level of the messages that appear in the agent.log file. 

Options:

  • Severe Error
  • Errors
  • Warning
  • Informational
  • Debug
  • Trace

Note

A Trace file is not created when the Trace option is selected.

Retrieve Output Prohibited


If enabled, disallows any Retrieve Output request (automatic or manual) from being performed.

Heartbeat Interval

Heartbeat Grace Period

Task Execution Limit

Limit Amount

Credentials Required 

Specifies if credentials are required to execute any task on the agent.

Credentials

Installation Details

This section contains detailed information about the installation of the Agent.

Host Name

IP Address

Operating System

Operating System Release

Version

Build ID

Build Date

CPU

Transient

If checked, the Agent is Transient and will be deleted or decommissioned when the Agent shuts down or goes offline.

Transient Agents are suspended from any Agent Clusters that they may belong to.

Note

An Agent is transient if it has been identified as transient in the TRANSIENT UAG configuration option.

Decommissioned

If checked, the Agent has been decommissioned and is not available for use. An Agent becomes Decommissioned if it is a Transient Agent and has shut down or gone offline and could not be removed/deleted from the system because it  is being referenced by a task.

Decommissioned Date

Date when the Agent was decommissioned.

System Details

This section contains detailed information about the Agent system.

Started Date

Last Heartbeat

CPU Load

OMS Server

Host name of the OMS Server.

PID

Jobs Run

Current Task Count

Authentication Version

Extension Details

This section contains detailed information about Universal Extensions.

API Level Minimum

Minimum extension API level supported.

API Level Maximum

Maximum extension API level supported.

Extensions

List of deployed Universal Extensions and their corresponding checksums.

Accept Extensions

Specification (true or false) for whether or not the Agent will accept deployment of Universal Extensions.

Accept List

If Accept Extensions true; list of specific Universal Extensions that are allowed to be deployed to the agent, or * for no deployment restrictions.

Metadata

This section contains Metadata information about this record.

UUID

Universally Unique Identifier of this record.

Updated By

Name of the user that last updated this record.

Updated

Date and time that this record was last updated.

Created By

Name of the user that created this record.

Created

Date and time that this record was created.

Buttons

This section identifies the buttons displayed above and below the Agent Details that let you perform various actions.

Update

Suspend Agent

Resume Agent

Delete

Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of this task.

Tabs

This section identifies the tabs across the top of the Agent Details that provide access to additional information about the Agent.

Note

For an Agent-Only installation of Universal Controller, the Agent Clusters, Task Instances, and Tasks tabs do not display.

Agent Clusters

Notifications

Lists all notifications that have been defined for this Agent.

Task Instances

Tasks