fteSetupCoordination (set up coordination details)

The fteSetupCoordination command creates properties files and the coordination queue manager directory for IBM® MQ Managed File Transfer.

Important: On distributed systems, only users who are IBM MQ administrators (and members of the mqm group) can run this command. If you try to run this command as a user who is not an IBM MQ administrator, you will receive the error message BFGCL0502E: You are not authorized to perform the requested operation. and the command will not run.

On z/OS® systems, the user must satisfy (at least) one of these conditions in order to run the migrate command:

Be a member of the mqm group (if the mqm group is defined on the system).
Be a member of the group named in the BFG_GROUP_NAME environment variable (if one is named).
Have no value set in the BFG_GROUP_NAME environment variable when the command is run.

Purpose

Use the fteSetupCoordination command to create the following IBM MQ Managed File Transfer objects:

Coordination queue manager directory
Data directory mqft (if this does not exist)
installation.properties file
coordination.properties file

This command also provides you with the following MQSC commands that you must run against your coordination queue manager to configure IBM MQ Managed File Transfer. The MQSC commands create a topic, a topic string, the SYSTEM.FTE queue, and the default database logger queues. These commands also update a namelist and set the PSMODE attribute of the coordination queue manager to ENABLED.

If the coordination queue manager is on z/OS, before you run these MQSC commands, you must ensure that the following required objects already exist:

SYSTEM.BROKER.DEFAULT.STREAM queue
SYSTEM.QPUBSUB.QUEUE.NAMELIST namelist
SYSTEM.BROKER.DEFAULT.STREAM and SYSTEM.BROKER.ADMIN.STREAM streams


DEFINE TOPIC('SYSTEM.FTE') TOPICSTR('SYSTEM.FTE') REPLACE
ALTER TOPIC('SYSTEM.FTE') NPMSGDLV(ALLAVAIL) PMSGDLV(ALLAVAIL)
DEFINE QLOCAL(SYSTEM.FTE) LIKE(SYSTEM.BROKER.DEFAULT.STREAM) REPLACE
ALTER QLOCAL(SYSTEM.FTE) DESCR('Stream for WMQFTE Pub/Sub interface')
* Altering namelist: SYSTEM.QPUBSUB.QUEUE.NAMELIST
* Value prior to alteration:
DISPLAY NAMELIST(SYSTEM.QPUBSUB.QUEUE.NAMELIST)
ALTER NAMELIST(SYSTEM.QPUBSUB.QUEUE.NAMELIST) +
 NAMES(SYSTEM.BROKER.DEFAULT.STREAM+
 ,SYSTEM.BROKER.ADMIN.STREAM,SYSTEM.FTE)
* Altering PSMODE.  Value prior to alteration:
DISPLAY QMGR PSMODE
ALTER QMGR PSMODE(ENABLED)

For more information about properties files, see Configuration options.

If you are using z/OS, you can issue the fteSetupCoordination command and other commands from JCL with scripts generated from the IBM MQ Managed File Transfer command template PDSE library data set. For more information, see Creating an IBM MQ Managed File Transfer agent or logger command data set.

Syntax

fteSetupCoordination

Parameters

-coordinationQMgr (coordination_qmgr_name )

Required. The name of the coordination queue manager. This queue manager must be a WebSphere® MQ Version 7.0 or later queue manager.

-coordinationQMgrHost (coordination_qmgr_host)

Optional. The host name or IP address of the coordination queue manager.

If you do not specify the -coordinationQMgrHost parameter, a bindings mode connection is assumed.

If you specify a value for the -coordinationQMgrHost parameter but do not specify values for the -coordinationQMgrPort and -coordinationQMgrChannel parameters, a port number of 1414 and a channel of SYSTEM.DEF.SVRCONN are used by default.

-coordinationQMgrPort (coordination_qmgr_port)

Optional. The port number used for client connections to the coordination queue manager. If you specify the -coordinationQMgrPort parameter, you must also specify the -coordinationQMgrHost parameter.

-coordinationQMgrChannel (coordination_qmgr_channel)

Optional. The channel name used to connect to the coordination queue manager. If you specify the -coordinationQMgrChannel parameter, you must also specify the -coordinationQMgrHost parameter.

-credentialsFile(filePath)

Optional. The full file path of an existing or new credentials file, to which the IBM MQauthentication details are added.

This command supports the addition of a set of IBM MQ authentication details, to a named IBM MQ Managed File Transfer credentials file. Use this command when IBM MQ connection authentication has been enabled. If you update the existing details, you must use the -f force parameter.

-userid(username)

Optional. The user ID used to associate the credential details. If you do not specify a user ID, the credential details will apply to all users. You must also specify the -credentialsFile parameter.

-f

Optional. Forces an overwrite of the existing coordination queue manager configuration with the details specified in this command.

-default

Optional. Updates the default configuration options to the options associated with the coordination queue manager specified in this command.

-? or -h

Optional. Displays command syntax.

Example

In this example, the required objects are set up for a coordination queue manager called QM_SATURN, which is connected to in client mode:

fteSetupCoordination -coordinationQMgr QM_SATURN
-coordinationQMgrHost myhost.ibm.com -coordinationQMgrPort 1415
-coordinationQMgrChannel SYSTEM.DEF.SVRCONN

Return codes

0: Command completed successfully.
1: Command ended unsuccessfully.