fteCreateEnvironment: set up environment for Redistributable Managed File Transfer Agent

The fteCreateEnvironment command sets the environment variable for the configuration and transfer of files for the Redistributable Managed File Transfer Agent.

Purpose

Use the fteCreateEnvironment command to set up the environment for using the Redistributable Managed File Transfer Agent. We can run this command with the -d parameter to specify the location for the MFT Agent data files. If we do not specify the -d parameter, the command creates the data files in the Redistributable Managed File Transfer Agent download location and sets the data path.

From IBM MQ Version 9.2.0, the -n parameter gives you the option of specifying an IBM MQ installation name. The value you specify for this option is used for the rest of the MFT commands run from the same console session.

Syntax

fteCreateEnvironment

Parameters

-d (data path)

Optional. This parameter is used for specifying the location of the data files at the time when the environment is set up.

If we do not specify this parameter, the data directory (if it does not already exist) is created in the location where the Redistributable Managed File Transfer Agent is extracted and the environment variable (BFG_DATA) is set for this location.

-? or -h

Optional. Displays command syntax.

-n installation name

Optional. This parameter is used for specifying the name of an IBM MQ installation, or a unique name.

Examples of situations in which you might want to use this parameter are:

• To quickly test a new function or feature using the redistributable package with the existing configuration where agents have been configured to connect to queue manager in clients mode only. (Note that this parameter does not apply to any agent that is configured connect to a queue manager in bindings mode.)
• If we are migrating from a standard Managed File Transfer installation to a Redistributable Managed File Transfer Agent package, and we want to use the same configuration as the one that was created by the standard installation. This is the case where standard Managed File Transfer has been installed but is connecting to an agent queue manager running on another machine.

The default installation name variable is BFG_INSTALLATION_NAME.

Examples

In this example, on Windows, the -d parameter specifies the location where the data folders are created:

fteCreateEnvironment -d C:\mftRedistributable\mftData

On Linux, as a prerequisite, the command has to be run on a bash shell. In a bash shell, the command can be run in various ways, and the command file needs to be sourced:

source Path_of_MFTZipBin/fteCreateEnvironment

An alternative method is:

. Path_of_MFTZipBin/fteCreateEnvironment

or, if running from the directory where the command file is present:

. ./fteCreateEnvironment

Attention: Note the space following the first period character (.) This example creates an environment where you specify both the MFT configuration data path, and installation name environment variables:

fteCreateEnvironment -d C:/ProgramData/IBM/mq/mqft -n MFTPROD 

The output from this command is:

5724-H72 Copyright IBM Corp. 2008, 2020.  ALL RIGHTS RESERVED
BFG_DATA is C:\ProgramData\IBM\MQ
BFG_INSTALLATION_NAME is MFTPROD

Both the BFG_INSTALLATION_NAME and BFG_DATA environment variables get updated to new values. This example creates an new environment variable for the installation name only. The data path remains unchanged at C:\ProgramData\IBM\MQ.

fteCreateEnvironment -n MFTPROD

The output from the command is:

5724-H72 Copyright IBM Corp. 2008, 2020.  ALL RIGHTS RESERVED
BFG_DATA is C:\ProgramData\IBM\MQ
BFG_INSTALLATION_NAME is MFTPROD

The BFG_INSTALLATION_NAME environment variable is updated to the new value MFTPROD. This example creates a new environment variable for the path of the MFT configuration data only. The installation name remains unchanged at MFTPROD:

fteCreateEnvironment -d C:/ProgramData/IBM/MQ2

The output from the command is:

5724-H72 Copyright IBM Corp. 2008, 2020.  ALL RIGHTS RESERVED
BFG_DATA is C:\ProgramData\IBM\MQ2
BFG_INSTALLATION_NAME is MFTPROD

Return codes

0

Command completed successfully.

1

Command ended unsuccessfully.

Parent topic: MFT commands