/
Agent Functions

Agent Functions

Mar 11, 2025

Overview

The command line syntax for each execution of the CLI command, uagcmd, must specify a single CLI function, required / optional Global parameters, and required / optional function-specific parameters. You must use the required Global parameters to connect to OMS Servers and to log on to a Controller (User ID and Password).

Universal Controller supports the following CLI functions for Agents, which are listed alphabetically on this page.

Syntax, parameters, and examples for each function are provided.

Delete Agent

Description

Deletes an Agent record.

Syntax

uagcmd ops-delete-agent global parameters {agent-name=name | agent-id=ID }

Parameters

  • agent-name=
    Required if agent-id= is not specified; Agent name of the Agent to be deleted (agent-name= and agent-id= are mutually exclusive).

  • agent-id=
    Required if agent-name= is not specified; Agent ID of the Agent to be deleted (agent-id= and agent-name= are mutually exclusive).

Example

uagcmd ops-delete-agent -c config.cfg agent-name=agent A

List Agents Status

Description

Lists the status of one or more Agents.

Syntax

uagcmd ops-agent-status global parameters [agent-name=name] agent-type=type [options=v]
 

Note

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameters

  • agent-name=
    Optional; Name or partial name of one or more Agents. Wildcards are supported.

  • agent-type=
    Optional; One of the following (not case sensitive): windows, unix, linux, linux/unix, ibmi, zos, z/os. (If not specified, status of all Agents are listed.)

  • options=
    Optional; v (Return verbose results.)

Example

uagcmd ops-agent-status -c config.cfg agent-type=windows

Resume Agent

Description

Resumes the ability of the identified Agent to run tasks.

Syntax

uagcmd ops-resume-agent global parameters {agent-name=name | agent-id=id }
 

Note

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.

Parameters

  • agent-name=
    Required if agent-id= is not specified; Agent name of the Agent whose ability to run tasks is to be resumed (agent-name= and agent-id= are mutually exclusive).

  • agent-id=
    Required if agent-name= is not specified; Agent ID of the Agent whose ability to run tasks is to be resumed (agent-id= and agent-name= are mutually exclusive).

Example

uagcmd ops-resume-agent -c config.cfg agent-name=agent A