fteDefine (generate configuration scripts)

Use the fteDefine command to generate the configuration scripts necessary to define the specified Agent Queue Manager objects.

Purpose

You would expect to use the fteDefine command when some configuration steps need to be run on a system that is remote to the one containing the configuration data. For example, configuring the queues for an agent on a queue manager to be accessed over a client connection.

Syntax

fteDefine

Parameters

-t type: Required. The type of object to be defined. The options for type are agent.
-d output_dir: Optional. A directory path in which the scripts are written. If not provided, the scripts are written to the standard output stream.
name: Required. One or more names of the objects to be defined. To specify names for more than one object, separate them with a space. For example, name1 name2...
-? or -h: Optional. Displays command syntax.

Examples

In this example, the fteDefine command is specified with the -t agent parameter and a single agent name. The output is written to a file.

fteDefine -t agent EXAMPLE.AGENT >EXAMPLE.AGENT_create.mqsc

The output that is generated from this command are the MQSC command scripts to be run against the agent queue manager to create the necessary agent queues:

$ fteDefine -t agent EXAMPLE.AGENT
5724-H72 Copyright IBM Corp. 2008, 2026.  ALL RIGHTS RESERVED
DEFINE QLOCAL(SYSTEM.FTE.COMMAND.EXAMPLE.AGENT) +
 DEFPRTY(0) +
 DEFSOPT(SHARED) +
 GET(ENABLED) +
 MAXDEPTH(5000) +
 MAXMSGL(4194304) +
 MSGDLVSQ(PRIORITY) +
 PUT(ENABLED) +
 RETINTVL(999999999) +
 SHARE +
 NOTRIGGER +
 USAGE(NORMAL) +
 REPLACE
DEFINE QLOCAL(SYSTEM.FTE.DATA.EXAMPLE.AGENT) +
 DEFPRTY(0) +
 DEFSOPT(SHARED) +
 GET(ENABLED) +
 MAXDEPTH(5000) +
 MAXMSGL(4194304) +
 MSGDLVSQ(PRIORITY) +
 PUT(ENABLED) +
 RETINTVL(999999999) +
 SHARE +
 NOTRIGGER +
 USAGE(NORMAL) +
 REPLACE
...
etc.

In this example, the fteDefine command is specified with the -d outputDir parameter and several agent names.

fteDefine -t agent -d /tmp EXAMPLE.AGENT.1 EXAMPLE.AGENT.2 EXAMPLE.AGENT.3

The output that is generated from this command are the absolute file paths to the locations of the MQSC command scripts:

$ fteDefine -t agent -d /tmp EXAMPLE.AGENT.1 EXAMPLE.AGENT.2 EXAMPLE.AGENT.3
5724-H72 Copyright IBM Corp. 2008, 2026.  ALL RIGHTS RESERVED
BFGCM0239I: A file has been created containing the MQSC definitions to define the agent EXAMPLE.AGENT.1. 
The file can be found here: '/tmp/EXAMPLE.AGENT.1_create.mqsc'.
BFGCM0239I: A file has been created containing the MQSC definitions to define the agent EXAMPLE.AGENT.2. 
The file can be found here: '/tmp/EXAMPLE.AGENT.2_create.mqsc'.
BFGCM0239I: A file has been created containing the MQSC definitions to define the agent EXAMPLE.AGENT.3. 
The file can be found here: '/tmp/EXAMPLE.AGENT.3_create.mqsc'.

Return codes

Table 1. Return code identifiers and descriptions
Return code	Description
0	Command completed successfully
1	Command ended unsuccessfully