Universal Agent Utilities Configuration

Owned by Stonebranch (Deactivated)
Last updated: Feb 01, 2024

Overview

Configuration consists of:

  • Setting default options and preferences for all executions of a utility.
  • Setting options and preferences for a single execution of a utility.

Configuration Sources

Configuration options are read from the following sources:

  1. Command line
  2. Command file
  3. Environment variables
  4. Configuration file

The order of precedence is the same as the list above; command line being the highest, and configuration file being the lowest. That is, options specified via a command line override options specified via a command file, and so on.

Detailed information on these methods of configuration can be found in Configuration Management.

Configuration File

The configuration file provides the simplest method of specifying configuration options whose values you do not want changed with each command invocation. These default values are used if the options are not read from one or more other sources.

Some options only can be specified in the configuration file; they have no corresponding command line equivalent. Other options cannot be specified in the configuration file; they must be specified via one or more other sources for a single execution.

Configuration Options Information

For each Universal Agent utility configuration option, the following information is provided.

Description

Describes the configuration option and how it is used.

Usage

Provides a table of one or more of the following types of information:

Method

Syntax

IBM i

HP NonStop

UNIX

Windows

z/OS

Command Line, Short Form

<Format / Value>






Command Line, Long Form

<Format / Value>






Environment Variable

<Format / Value>






Configuration File Keyword

<Format / Value>






STRUCM Parameter

<Format / Value>






Method

Identifies the different methods used to specify Universal Agent Utilities configuration options:

  • Command Line Option, Short Form
  • Command Line Option, Long Form
  • Environment Variable
  • Configuration File Keyword
  • <IBM i> Parameter

Note

Each option can be specified using one or more methods.

Syntax

Identifies the syntax of each method that can be used to specify the option:

  • Format: Specific characters that identify the option.
  • Value: Type of value(s) to be supplied for this method.

Note

If a Method is not valid for specifying the option, the Syntax field contains n/a.

(Operating System)

Identifies the operating systems for which each method of specifying the option is valid:

  • IBM i
  • UNIX
  • Windows
  • z/OS

Values

Identifies all possible values for the specified value type.

Defaults are identified in bold type.

<Additional Information>

Identifies any additional information specific to the option.