Agent2 4 0 Admin Guide
Agent2 4 0 Admin Guide
Admin Guide
Version 2.4.0
Copyright Terms and Conditions
Copyright © Fortra, LLC and its group of companies. All trademarks and registered trademarks are the property of their respective
owners.
The content in this document is protected by the Copyright Laws of the United States of America and other countries worldwide. The
unauthorized use and/or duplication of this material without express and written permission from Fortra is strictly prohibited. Excerpts and
links may be used, provided that full and clear credit is given to Fortra with appropriate and specific direction to the original content.
202504020138
Table of Contents
2.0.0 70
Upgrading Agents 71
Java 11 Considerations 72
Agent Configuration 74
Advanced Configuration 77
Agent Permissions 79
Agent Features
l Secures file transfers to and from a central GoAnywhere MFT environment
l Monitors for new, modified, and deleted files on systems where the Agent is
installed
l Compresses and decompresses files on the Agent using Zip, Tar, and Gzip
technology
l Translates data from databases, CSV, Fixed Width, XML, and JSON
l Executes native commands on Agents
l Controls which folders are accessible on the Agent
The communication between each Agent and GoAnywhere MFT is encrypted using
SSL/TLS. The authentication is a multi-step secure process establishing trust between
GoAnywhere MFT automatically rolls out software upgrades to Agents as needed. This is
a seamless process in which GoAnywhere MFT will upgrade Agents while they are not
performing work to minimize disruption.
For more information about Agent features, see the GoAnywhere MFT User Guide.
Pre-Installation Notes
NOTE: The installation and startup times of Agents 2.2.3 for IBMi may take longer than
previous installations.
When an install package is created through the GoAnywhere MFT Software Library, the
installer ZIP file will include an agent_installer_settings.xml file that contains the Agent
configuration settings. When the installer is launched, the configuration settings from the
XML file will populate the settings in the Agent installation wizard.
Sample Configuration
<maxJobRuntime>20</maxJobRuntime>
<maxMonitorRuntime>20</maxMonitorRuntime>
<contextProtocol>TLSv1.2</contextProtocol>
<rootCert>PEM formatted certificate</rootCert>
<restrictTasks>false</restrictTasks>
<database>true</database>
<email>true</email>
<excel>true</excel>
<execNative>true</execNative>
<fileCatalyst>true</fileCatalyst>
<ftp>true</ftp>
<ftps>true</ftps>
<gofast>true</gofast>
<pgp>true</pgp>
<ssh>true</ssh>
<webService>true</webService>
<zip>true</zip>
<amazonS3File>true</amazonS3File>
<azureFile>true</azureFile>
<networkShareFile>true</networkShareFile>
<webdavFile>true</webdavFile>
<folders>
<folder alias="root" path="/" readOnly="true"/>
</folders>
<fipsEnabled>false</fipsEnabled>
<disabledProtocols/>
<disabledCiphers/>
<certificateValidationCABasicConstraintServer>true</certificateValidationCABasicConstra
intServer>
<certificateValidationCABasicConstraintEmail>true</certificateValidationCABasicConstrai
ntEmail>
<certificateValidationDateValidityServer>true</certificateValidationDateValidityServer>
<certificateValidationDateValidityEmail>true</certificateValidationDateValidityEmail>
<certificateValidationExtendedKeyUsageServer>true</certificateValidationExtendedKeyUsag
eServer>
<certificateValidationExtendedKeyUsageEmail>true</certificateValidationExtendedKeyUsage
Email>
<certificateRevocationListCheckServer>false</certificateRevocationListCheckServer>
<certificateRevocationListCheckEmail>false</certificateRevocationListCheckEmail>
<certificateRevocationListRefreshInterval>5</certificateRevocationListRefreshInterval>
<certificateRevocationListURLS/>
<allowImplicitTrust>false</allowImplicitTrust>
<localAddress>1.2.3.4</localAddress>
<localPortFrom>23000</localPortFrom>
<localPortTo>24000</localPortTo>
<localAddressRequestTimeout>30</localAddressRequestTimeout>
<reuseAddress>true</reuseAddress>
<socketLinger>10</socketLinger>
</settings>
Installing an Agent
The Agent installation wizard will prompt for the fields listed in the following table.
Field Definition
Agent Name The name of the Agent that will appear on the Agent Manager
page when the Agent connects. If a name is not specified, a
name will be created automatically using the Agent
Registration rules on the Agent Configuration Registration
page.
Registration Code The Agent Registration Code the Agent will use to register with
GoAnywhere MFT. If no registration codes are configured on
the Agent Service, then this field can be left blank.
Shutdown Port The TCP/IP port number the Agent uses to shutdown. The
default is 8015.
GoAnywhere MFT The host name or IP address of the GoAnywhere MFT Agent
Server Host Service the Agent will connect to.
GoAnywhere MFT The port number of the GoAnywhere MFT Agent Service the
Server Port Agent will connect to. The default is 8009.
Field Definition
SSL Context Protocol Specify the desired SSL protocol to be used for the connection
to GoAnywhere MFT. This setting should match the SSL
protocol on the SSL tab in the Agent Configuration in
GoAnywhere MFT. See the GoAnywhere MFT User Guide for
more information.
Agent Server CA Provide the GoAnywhere MFT Server CA certificate from the
Certificate SSL settings of the Agent Service in GoAnywhere MFT. The
Server certificate must be copied from the PEM Format tab
and then copied to the installation wizard. See the
GoAnywhere MFT User Guide for more information.
Path to Agent CA When configuring an Agent in command line mode, you will be
Certificate prompted for the path to the Agent Server CA Certificate. The
certificate must be accessible from the system the Agent is
being installed on.
Security
Enable FIPS 140-2 When FIPS 140-2 Compliance Mode is enabled, GoAnywhere
Compliance Mode MFT will only use FIPS 140-2 validated algorithms (ciphers)
for encrypting transmissions over SSH and SSL channels
including SFTP, SCP, FTPS, and HTTPS protocols.
Disabled Cipher Suites Specify the SSL/TLS cipher suites to disable globally. Some
cipher suites may forcibly be disabled depending on your JVM
and security provider. Values must be comma separated.
CA Basic Constraints Select check box to verify the Certificate Authority (CA) is
Validation marked as a CA with a valid path length in its basic
constraints.
Date Validation Select check box to apply date validity check to server and
email certificates.
Field Definition
Extended Key Usage Select check box to apply extended key usage check to server
Validation and email certificates. The check will validate the intended
purpose of the certificate - server authentication and email
protection.
Certificate Revocation Select check box to apply CRL check to server and email
Lists (CRL) certificates.
Certificate Revocation Specify the URLs to use for CRL checking. Must be a pipe '|'
Lists (CRL) URLs separated list.
Refresh Interval If CRLs are enabled, specify how often to refresh all CRLs.
Default Value: 5 minutes.
Implicit Trust Allow All Specify whether to allow implicit trust for certain connections
that support this configuration. If unchecked, implicit trust will
be globally disabled and all connections will be required to
validate certificates.
Permissions
Alias By default, the Agent cannot access any folders on the system
where the Agent is installed. To add a folder the Agent can
access, specify the Alias and Path for the folder location that
appears in the Agent file chooser.
Read Only Indicates if the Agent will have Read Only access to the folder
location.
Restrict Tasks When selected, the types of Tasks the Agent can execute are
restricted to the selected Task types.
Allow Amazon S3 File Allows the Agent to utilize the Amazon S3 Buckets Resource
Syntax on the server where the Agent is installed.
Allow Azure File Allows the Agent to utilize the Azure Blob Storage Resource
Syntax on the server where the Agent is installed.
Field Definition
Allow Network Share Allows the Agent to utilize the Network Shares Resource on
File Syntax the server where the Agent is installed.
Allow WebDAV File Allows the Agent to utilize the WebDAV Resource on the
Syntax server where the Agent is installed.
Allow Execute Native Allows the Agent to run Execute Native Command tasks on the
Command Agent system.
Allow FileCatalyst Allows the Agent to run FileCatalyst tasks on the Agent
Tasks system.
Allow Database Tasks Allows the Agent to run Database tasks on the Agent system.
Allow Email Tasks Allows the Agent to run Email tasks on the server where the
Agent is installed. Valid values are true or false.
Allow Excel Tasks Allows the Agent to run Excel tasks on the server where the
Agent is installed. Valid values are true or false.
Allow FTP Tasks Allows the Agent to run FTP tasks on the server where the
Agent is installed. Valid values are true or false.
Allow FTPS Tasks Allows the Agent to run FTPS tasks on the server where the
Agent is installed. Valid values are true or false.
Allow GoFast Tasks Allows the Agent to run GoFast tasks on the server where the
Agent is installed. Valid values are true or false.
Allow PGP Tasks Allows the Agent to run PGP tasks on the server where the
Agent is installed. Valid values are true or false.
Allow SSH Tasks Allows the Agent to run SSH tasks on the server where the
Agent is installed. Valid values are true or false.
Allow WebService Allows the Agent to run Web Service tasks on the server
Tasks where the Agent is installed. Valid values are true or false.
Allow Zip Tasks Allows the Agent to run File Compression tasks on the Agent
system.
On install, you have an option to specify a custom location for Agent config files. If a
custom location is specified, the path will be written to system.properties and the config
files will be moved to the user defined directory.
If you want to change the location of the Agent config files after installing or upgrading an
Agent, you will need to add the new path to the system.properties file and manually move
the config files to the user defined directory.
To create a user defined directory and to manually move the Agent config files, complete
the following steps:
com.linoma.config.directory=C:\\ProgramData\\Fortra\\GoAnywhere\\
NOTE:
All backslash ('\') characters need to be escaped in a given file path with an
additional backslash as noted in the example above.
3. Move the following Agent config files from the install directory into the user defined
config folder:
l agent.xml
l database.xml
l log4j2.xml
l permissions.xml
l security.xml
Port Configuration
There are two port numbers to configure when installing Agents, the Agent shutdown port
and the GoAnywhere MFT Agent Service port. The Agent shutdown port is locally bound
and used as part of the Agent shutdown process. The GoAnywhere MFT Agent Service
port is the port number of the Agent Service in GoAnywhere MFT that the Agent will
connect to.
Port Description
Number
These port numbers can be overridden either during the installation or at any time after the
installation.
Java Versions
Java version 11 is bundled with the Windows and Linux installers. Refer to the UNIX and
IBM i sections for their respective Java version requirements.
Agent Memory
You can adjust the maximum JVM memory usage for an Agent on a Windows or Linux
system by following the instructions below.
Installation − Windows
A Windows installation wizard is provided for GoAnywhere Agents which installs the
product files into the directory of your choice. Agents will be implemented as a Windows
Service which will automatically start (by default) when Windows starts.
The Windows Agent installer application can be pre-configured and generated through
GoAnywhere MFT via the Software Library manager. For instruction on how to configure
and generate a Windows Agent installer application .ZIP file, refer to the GoAnywhere
MFT User Guide. Otherwise, you can download the Agent installer through the
GoAnywhere Customer Portal.
Requirements
Operating Systems supported Windows Server 2012®
Windows 8®
Windows 10®
Windows 11®
2. Navigate to the file location of the Agent installer or pre-configured Agent ZIP file.
NOTE:
If you have a 64-bit operating system, make sure you have the 64-bit version.
3. If you are using the Agent ZIP file, extract the contents of the file.
5. The GoAnywhere Agent Setup Wizard will then guide you through the remainder of
the installation process.
6. When prompted, specify the Agent configuration settings. If your Agent installer
application was pre-configured, all required Agent Configuration settings will be
populated using data provided when the installer was initially configured in
GoAnywhere MFT.
NOTE:
Agents are configured in Windows as an automatic startup Service. This means that
the Agent will automatically start whenever Windows starts.
NOTE:
The agent_installer_settings.xml file must be in the same directory as the Agent
installer file or the silent install will fail.
2. Open the command prompt and use the cd command to navigate to the directory
containing the Agent installer.
3. Enter the command to execute the Agent installer in the desired location.
Parameters that begin with -V must be specified as a key=value pair. Separate each -V
parameter with a space.
EXAMPLE:
[installer file name].exe -q -Vgaagent.port=8009 -Vgaagent.shutdownPort=8015
For parameters for silent install on Windows, see the Parameters table.
2. Open the command prompt and use the cd command to navigate to the directory
containing the Agent installer.
3. Execute the following command where "[path]" is the location of the Agent
installation you want to update or repair:
EXAMPLE:
agent1_3_1_windows_x64.exe -q -dir "C:\Agents"
Installation – Linux
GoAnywhere Agents can be installed onto any Linux server including Red Hat, CentOS,
SUSE, Ubuntu, and others.
A graphical installation wizard is provided for Agents which installs the product files into the
directory of your choice.
Requirements
Disk space 160 MB
1. Create or designate a non-root user on the system that will be used to install and
run the Agent application. This user will be the owner of all files created during
installation as well as files written to the file system during use.
4. If you are using the Agent ZIP file, extract the contents of the file.
5. If needed, set the Executable bit on the file (e.g. chmod 755 filename.sh).
6. If you have a graphical desktop for Linux, execute the downloaded installer file and
follow the prompts on the screens. Otherwise, execute the downloaded installer file
with a –c option (e.g. installer_filename.sh -c) and follow the prompts.
NOTE:
When installing an Agent in command line mode, you will be prompted for the
path to the Agent Server CA Certificate. If you would like to use a certificate
other than one pre-configured, that certificate must be accessible from the
system the Agent is being installed on.
1. Specify the Agent configuration settings. If your Agent installer application was pre-
configured, all required Agent Configuration settings will be populated using data
provided when the installer was initially configured in GoAnywhere MFT.
b. Change the working directory to the directory where the Agent was installed
(for example, cd /usr/local/Fortra/GoAnywhere_Agent/bin)
NOTE:
You can setup an Agent so it starts automatically when the Linux system is booted.
Please refer to your operating system manual for more details on setting up auto-start
services.
NOTE:
The agent_installer_settings.xml file must be in the same directory as the Agent
installer file or the silent install will fail.
2. If you are using the Agent ZIP file, extract the contents of the file.
Parameters that begin with -V must be specified as a key=value pair. Separate each -V
parameter with a space.
EXAMPLE:
[installer file name].sh -q -Vgaagent.port=8009 -Vgaagent.shutdownPort=8015
For parameters for silent install on Windows, see the Parameters table.
1. Copy the new Agent Linux installer file to the Linux server.
2. If you are using the Agent ZIP file, extract the contents of the file.
3. Execute the downloaded installer file using the following command where "[path]" is
the location of the Agent installation you want to update or repair:
EXAMPLE:
agent0_9_0_linux_x64.sh -q -dir "/usr/local/Fortra/GoAnywhere_Agent"
Installation − Unix
This page includes Agent installation instructions for AIX, HP-UX, Solaris or non x86-
based Linux systems (Unix).
An installation wizard is provided which installs the product files into the directory of your
choice.
Requirements
Disk space 160 MB
Installing Agents
Perform the following steps to install Agents onto a Unix server.
1. Create or designate a non-root user on the system that will be used to install and
run the Agent application. This user will be the owner of all files created during
installation as well as files written to the file system during use.
4. If you are using the Agent ZIP file, extract the contents of the file.
6. Change the directory to where the installer file was downloaded (e.g. cd
/root/Desktop).
7. If needed, set the Executable bit on the file (e.g. chmod 755 ga5_x_x_unix.sh).
9. The installer will attempt to find a compatible JRE (Java Runtime Environment) for
the installation process. Follow the steps below if the installer cannot find a
compatible JRE:
b. Clear the Installer cache by removing the file named .install4j from your
home directory
(e.g. rm /root/.install4j).
10. Specify the Agent configuration settings. If your Agent installer application was pre-
configured, all required Agent Configuration settings will be populated using data
provided when the installer was initially configured in GoAnywhere MFT.
NOTE:
When installing an Agent in command line mode, you prompted for the path to
the Agent Server CA Certificate. If you would like to use a certificate other than
one pre-configured, that certificate must be accessible from the system the
Agent is being installed on.
2. Change the working directory to the directory where Agents is installed. (eg, cd
/usr/local/Fortra/GoAnywhere_Agent/bin)
4. If you receive an error indicating that no JRE could be found, set an environment
variable named JAVA_HOME to point to the JRE’s home directory
(e.g. export JAVA_HOME=/usr/lib/jvm/java-11-openjdk/jre) and try starting
Agents again.
NOTE:
You can setup Agents so it starts automatically when the system is booted. Please
refer to your operating system manual for more details on setting up auto-start
services. You can execute goanywhere.sh from your startup scripts.
NOTE:
The agent_installer_settings.xml file must be in the same directory as the Agent
installer file or the silent install will fail.
To perform a silent install of an Agent on AIX, HP-UX, Solaris or non x86-based Linux
systems (Unix):
2. If you are using the Agent ZIP file, extract the contents of the file.
Parameters that begin with -V must be specified as a key=value pair. Separate each -V
parameter with a space.
EXAMPLE:
[installer file name].sh -q -Vgaagent.port=8009 -Vgaagent.shutdownPort=8015
For parameters for silent install on Unix, see the Parameters table.
1. Copy the new Agent Unix installer file to the Unix server.
2. If you are using the Agent ZIP file, extract the contents of the file.
3. Execute the downloaded installer file using the following command where "[path]" is
the location of the Agent installation you want to update or repair:
EXAMPLE:
agent0_9_0_unix_x64.sh -q -dir "/usr/local/Fortra/GoAnywhere_Agent"
NOTE: This
parameter is used
only for silent install
on Windows.
NOTE: This
parameter is used
only for silent install
on Windows.
Requirements
Operating System IBM i V7R3 or higher
Disk Space 160 MB for product (does not include user data)
The following IBM i licensed programs are prerequisites to the installation of Agents, which
are dependent on IBM i release and your choice of supported Java version.
To check if the licensed programs (listed above) are installed on your IBM i, execute the
command GO LICPGM and select option 10 to display the installed licensed programs.
Press F11 twice from that screen to display the Product Options.
If these licensed programs are not loaded on your IBM i, they may be available on the IBM
software CDs that came with your IBM i. Otherwise, you will have to request those
licensed programs from IBM, which are normally provided at no charge.
Required PTFs
The following IBM i Program Temporary Fixes (PTFs) and Group PTFs are prerequisites
to installing Agents.
Use the command DSPPTF to verify that the required individual PTFs are applied. Use
the command
WRKPTFGRP to verify that the required group PTFs are applied.
The following components will be installed onto the IBM i by the Agents installation
process:
n A IBM i library will be created, which will contain the Agents commands and
program objects. The default library name is GAAGENT, which can be changed
during installation.
n An IFS folder will be created, which will contain the Agents software
components. The default IFS folder name is /fortra/gaagent, which can be
changed during installation.
1. Sign on to the IBM i with the QSECOFR user profile OR with a profile which has
*ALLOBJ authority.
2. Create a temporary Save file on your IBM i by executing the following IBM i
command:
CRTSAVF FILE(QGPL/GAAGENT)
3. The Agents software needs to be uploaded to your IBM i using FTP. Before
proceeding, ensure the FTP server is running on the IBM i. To start the native FTP
server on the IBM i, you can issue the IBM i command of STRTCPSVR SERVER
(*FTP).
4. Download the Agents installer (for IBM i) from the Customer Portal at
my.goanywhere.com or using the Software Library in GoAnywhere MFT.
5. Extract the files from the installer ZIP file into a new temporary folder on your
workstation. The extracted files will be named GAAGENT.SAVF and agent_
installer_settings.xml.
6. FTP the extracted GAAGENT.SAVF file from your PC to the Save file on the IBM i
(that was created in step 2). Listed below are instructions for a Windows user:
b. Enter the DOS command FTP <hostname>, where <hostname> is the host
name or IP address of your IBM i.
c. Login with your IBM i user id and password, then enter the following
highlighted FTP commands:
b. Enter the DOS command FTP <hostname>, where <hostname> is the host
name or IP address of your IBM i.
c. Login with your IBM i user id and password, then enter the following
highlighted FTP commands:
8. Restore the installation objects into QTEMP by executing the following IBM i
command:
RSTOBJ OBJ(*ALL) SAVLIB(QTEMP) DEV(*SAVF) SAVF(QGPL/GAAGENT)
9. Delete the temporary Save file by executing the following IBM i command
(optional):
DLTF FILE(QGPL/GAAGENT)
10. If QTEMP library is not in your library list, then add it by executing the following IBM
i command:
ADDLIBLE LIB(QTEMP) POSITION(*FIRST)
11. Prompt (F4) the command QTEMP/INSTALLGAA for installing Agents. The
following screen appears.
12. If NO is selected for Use settings from XML file, the following screens appear.
Parameter descriptions
Use Settings from Indicate whether to use the settings XML file that was
XML file created on the GoAnywhere MFT server.
Settings XML file Full IFS path of the settings XML file created by MFT to
use to install the Agent, the path designated in step 7.
Install Library The library to contain the Agents product objects. The
specified library name must not already exist.
Install IFS directory The directory to contain the Agents product files. The
specified directory name must not already exist.
Agent name The name of the Agent that will appear on the Agent
Manager page in GoAnywhere MFT.
Shutdown port The port number which the Agents will listen to for
shutdown requests. Default is 8015. *
GoAnywhere The port number of the GoAnywhere MFT server that the
MFT server port Agent will connect to. The default port is 8009.*
SSL context protocol Specify the desired SSL protocol to be used for the Agent
Control Channel. Some examples include TLSv1, TLSv1.1
and TLSv1.2
Server CA certificate The full IFS path of the file that holds the GoAnywhere
MFT server certificate.
Folder access Enter up to five IFS paths that the Agent will have access
to. Each path contains three parts: the alias name, alias
path and a read only indicator. Sub folders will inherit
permissions from the defined folder permissions.
Restrict usage If set to "true", the types of Tasks the Agent can execute
are restricted to the selected Task types that follow. Valid
values are true or false.
Allow Database tasks Allows the Agent to run Database tasks on the server
where the Agent is installed. Valid values are true or false.
Allow Email tasks Allows the Agent to run Email tasks on the server where
the Agent is installed. Valid values are true or false.
Allow Excel tasks Allows the Agent to run Excel tasks on the server where
the Agent is installed. Valid values are true or false.
Allow execute native Allows the Agent to run Execute Native Command tasks
command on the server where the Agent is installed. Valid values are
true or false.
Allow FileCatalyst Allows the Agent to run FileCatalyst tasks on the server
tasks where the Agent is installed. Valid values are true or false.
Allow FTP tasks Allows the Agent to run FTP tasks on the server where the
Agent is installed. Valid values are true or false.
Allow FTPS tasks Allows the Agent to run FTPS tasks on the server where
the Agent is installed. Valid values are true or false.
Allow GoFast tasks Allows the Agent to run GoFast tasks on the server where
the Agent is installed. Valid values are true or false.
Allow PGP tasks Allows the Agent to run PGP tasks on the server where the
Agent is installed. Valid values are true or false.
Allow SSH tasks Allows the Agent to run SSH tasks on the server where the
Agent is installed. Valid values are true or false.
Allow Webservice Allows the Agent to run Webservice tasks on the server
tasks where the Agent is installed. Valid values are true or false.
Allow ZIP tasks Allows the Agent to run File Compression tasks on the
server where the Agent is installed. Valid values are true
or false.
Allow Amazon file Allows the Agent to utilize the Amazon S3 Buckets
permissions Resource on the server where the Agent is installed.
Allow Azure file Allows the Agent to utilize the Azure Blob Storage
permissions Resource on the server where the Agent is installed.
Allow Network Share Allows the Agent to utilize the Network Shares Resource
permission on the server where the Agent is installed.
Allow WebDAV file Allows the Agent to utilize the WebDAV Resource on the
permissions server where the Agent is installed.
Enable FIPS 140-2 When FIPS 140-2 Compliance Mode is enabled, Agents
Compliance will only use FIPS 140-2 validated algorithms (ciphers) for
encrypting transmissions over SSH and SSL channels
including SFTP, SCP, FTPS and HTTPS protocols.
Disabled SSL/TLS Specify the SSL/TLS protocol versions and cipher suites
Protocols to disable globally. Some allowed protocols and cipher
suites may forcibly be disabled depending on your JVM
and security provider. Values must be comma-separated.
Disabled SSL/TLS Specify the SSL/TLS protocol versions and cipher suites
Cipher Suites to disable globally. Some allowed protocols and cipher
suites may forcibly be disabled depending on your JVM
and security provider. Values must be comma-separated.
Allow Implicit Trust Specify whether to allow implicit trust for certain
connections that support this configuration. If unchecked,
implicit trust will be globally disabled and all connections
will be required to validate certificates.
CRL Refresh Interval Specify in minutes how often the CRLs should be
refreshed.
CRL URLs Specify the URLs to use for CRL checking. Must be a pipe
'|' separated list.
*To check if the port number is already in use, run the IBM i command of NETSTAT
and select option 3. Then press F14 to see the numeric port numbers.
11. After reviewing and/or modifying the parameters on the INSTALLGAA command,
press enter to start the installation process.
12. Prompt (F4) the command GAAGENT/STRGAAGENT for starting the Agents
subsystem. The following screen will be displayed.
For the Server User Profile parameter, keep the default of *CURRENT if you want
to run the Agents application under your user profile. Otherwise, specify a different
user profile to run the Agents application server under.
NOTE:
For security purposes, you may want to create a new user profile and consistently
use that profile on the STRGAAGENT command. Then you would only have to grant
authority for the Agents installation IFS folders to that user profile. There are certain
user profiles that you cannot use to start the GAAGENT subsystem. These are:
'QSECOFR', ‘QSPL', 'QDOC', 'QDBSHR', 'QRJE', 'QSYS', 'QLPAUTO',
'QLPINSTALL', 'QTSTRQS' Or 'QDFTOWN'
13. Press enter on the STRGAAGENT command to start the Agents subsystem.
14. Execute the WRKACTJOB (Work with Active Jobs) command to confirm that the
Agents subsystem is running. You should find a subsystem which has the same
name as the library name that was specified on the INSTALLGAA command in step
10 (named GAAGENT by default). This subsystem should contain Agent application
jobs.
NOTE:
The Agents can automatically start when the System i is powered up (IPL). To
perform this automatic startup, place the STRGAAGENT command in the
System i startup CL program (after the start of TCPIP).
CL example:
4. Under the Java Home section, edit the value as needed by choosing option 2.
Installation – Mac OS X
GoAnywhere Agents can be installed onto Apple's Mac OS X desktops, laptops, or servers.
Requirements
Operating Systems supported Mac OS X
Disk space 160 MB for product (does not include user data)
2. Download the Agent .DMG installer from the GoAnywhere Customer Portal if you
have not already pre-configured and downloaded one through GoAnywhere MFT.
If you are using the Agent ZIP file, extract the contents of the file.
3. Open the downloaded .DMG file, double click the Agent installer, and follow the
prompts on the screen.
NOTE:
If you have not already done so, you may be prompted to install the legacy Java
SE 7 runtime. Click the More Info button and follow the instructions from Apple
to install Java. Repeat step 3 when Java is installed.
4. When prompted, specify the Agent configuration settings. If your Agent installer
application was pre-configured, all required Agent Configuration settings will be
populated using data provided when the installer was initially configured in
GoAnywhere MFT.
b. Change the working directory to the directory where the Agent was installed.
(for example, cd /Applications/Fortra/GoAnywhere_Agent/bin)
Agent Installer
Management
The GoAnywhere MFT Software Library provides Admin Users an online catalog of Agent
installer and upgrader packages that can be downloaded to the Agents installation and
used to pre-configure, install, and upgrade Agents.
To manage the available Agent installers, log in to GoAnywhere MFT as an Admin User
with the Product Administrator role. If your user account is assigned to a custom Admin
User Role, your ability to view, modify, or execute actions on this page are based on the
permissions specified for that role.
From the main menu bar, select Help and then click the Software Library link.
Initial Configuration
You must define a location on the Agents installation where Agent installers will be saved
before you can browse the online catalog. When GoAnywhere MFT is in a clustered
environment, this location needs to be a shared location available to all nodes in the
cluster.
NOTE:
When Agents is running in a cloud hosted environment, the software storage location
is disabled and users are unable to make changes.
Click the Settings button, and then specify a location where Agent installers will be stored.
Click Save. The Software Library's online catalog option will now be displayed.
Software Library
The Software Library lists Agent Installers that were downloaded from the Online Catalog
or imported from a local directory.
Page Toolbar
l View and download available Agent installers and upgraders from the GoAnywhere
Customer Portal by clicking the Browse Online Catalog button.
l Import an Agent Installer package by clicking the Import button. This option should
be used when Agents cannot connect directly to the GoAnywhere Customer Portal.
l Change the Software Library storage location by clicking the Settings button.
Software Actions
1. To download Agent installers and upgraders, log in as an Admin User with the
Product Administrator role. If your user account is assigned to a custom Admin
User Role, your ability to view, modify, or execute actions on this page are based on
the permissions specified for that role.
2. From the main menu bar, select Help and then click the Software Library link.
3. From the Software Library, click the Browse Online Catalog button. The list of
Agent Installers and upgraders for specific operating systems appears.
2. From the main menu bar, select Help and then click the Software Library link.
3. Identify an install package for the Agent's operating system, click the Actions icon,
and then select the Configure Installer icon.
4. Configure the Agent settings and then click the Generate button.
6. For instructions to install the Agent, view the GoAnywhere MFT Agent Install Guide.
General Tab
Agent Configuration
Name
The name of the Agent that will appear on the Agent Manager page when the
Agent connects. If a name is not specified, a name will be created automatically
using the Agent Registration rules on the Agent Configuration Registration page.
Registration Code
Specify an Agent Registration Code this Agent will use to register with
GoAnywhere. Registration codes are configured on the Agent Configuration
Registration page. If no registration codes are configured on the Agent Service,
then this field can be left blank.
Shutdown Port
The TCP/IP port number on which the Agent waits for shutdown commands.
Host
The host name or IP address of the Agents instance this Agent will connect to.
Port
The port number Agents connect to on the Agents instance.
Allowed Folders
By default, the Agent is provided a default read only folder on the server it is
installed on. Click the Add Folder button to add additional folder locations that can
be used by the Agent. Sub folders will inherit permissions from the defined folder
permission.
NOTE:
Folder locations can be added to an Agent after installation by adding them to
the permissions.xml file in the Agent's [Installation]\config directory. For more
information, see the GoAnywhere MFT Agent Install Guide.
Alias
The Alias for the folder location that appears in the Agent file chooser.
Path
The path to the folder location on the Agent system.
Read Only
Indicates if the Agent will have Read Only access to the folder location.
Permissions Tab
Agents can run Projects on the server where they are installed. All Agent Project
permissions will be grouped across the Agent. For example, if FTP is allowed on
the Agent, it will be allowed for all aspects of the Agent. However, you can restrict
the type of tasks and file system resources that the Agent can utilize.
Restrict Usage
When selected, the types of tasks and file system resources the Agent can utilize
are restricted to those selected.
Allow Amazon S3
Allows the Agent to utilize the Amazon S3 Buckets Resource on the server where
the Agent is installed.
Allow Azure
Allows the Agent to utilize the Azure Blob Storage Resource on the server where
the Agent is installed.
Allow Database
Allows the Agent to run Database tasks on the server where the Agent is installed.
Allow Email
Allows the Agent to run Send and Retrieve Email tasks on the server where the
Agent is installed.
Allow Excel
Allows the Agent to run Read and Write Excel tasks on the server where the Agent
is installed.
Allow FileCatalyst
Allows the Agent to run FileCatalyst tasks on the server where the Agent is
installed.
Allow FTP
Allows the Agent to run FTP tasks on the server where the Agent is installed.
Allow FTPS
Allows the Agent to run FTPS tasks on the server where the Agent is installed.
Allow GoFast
Allows the Agent to run GoFast tasks on the server where the Agent is installed.
Allow PGP
Allows the Agent to run PGP tasks on the server where the Agent is installed.
Allow SSH
Allows the Agent to run SSH tasks on the server where the Agent is installed.
Allow WebDAV
Allows the Agent to utilize the WebDAV Resource on the server where the Agent
is installed.
Allow Zip
Allows the Agent to run File Compression tasks on the server where the Agent is
installed.
NOTE:
All other standard tasks are always allowed to run on the Agent.
When FIPS 140-2 Compliance Mode is enabled, Agents will only use FIPS 140-2
validated algorithms (ciphers) for encrypting transmissions over SSH and SSL
channels including SFTP, SCP, FTPS, and HTTPS protocols.
NOTE:
This FIPS 140-2 Compliance Mode setting applies only to Agents version
1.4.0 and later.
Algorithms Tab
Specify the SSL/TLS protocol versions and cipher suites to allow globally. Some
allowed protocols and cipher suites may forcibly be disabled depending on your
JVM and security provider. A JVM can disable protocols or cipher suites based on
specific algorithms or rules (for example, key lengths). Additionally, your FIPS
provider may further disable protocols and cipher suites in FIPS mode.
NOTE:
These algorithm settings apply only to Agents version 1.4.0 and later.
Protocols
Specify the SSL/TLS protocol versions to use. The column on the left displays the
disabled protocols. The column on the right displays the allowed protocols. Click to
select an option and then use the direction buttons between the columns to move
the selection to the appropriate side.
Cipher Suites
Specify the cipher suites to use. The column on the left displays the disabled
cipher suites. The column on the right displays the allowed cipher suites. Click to
select an option and then use the direction buttons between the columns to move
the selection to the appropriate side.
Specify checks to enforce when validating server and email certificates. When not
enforced, a validation check is delegated to the JVM Security Providers. Deselecting a
validation check does not necessarily mean the check will never be used.
When the Server Certificates check box is selected, validation checks are performed on
presented server certificates when Agents connects as a client to another server.
When the Email Certificates check box is selected, validation checks are performed on
tasks to validate signing and encryption certificates related to processing emails.
NOTE:
These certificate validation settings apply only to Agents version 1.4.0 and later.
Date Validation
Select check box to apply date validity check to server certificates and email signing and
encryption certificates.
NOTE:
If a Certificate Revocation List (CRL) is expired and cannot be refreshed, the CRL
validation check will reject all certificates until the CRL is removed or an updated
CRL can be fetched.
Refresh Interval
If CRLs are enabled, specify how often to refresh all CRLs. Default Value: 5 minutes.
URLs
If CRLs are enabled, specify at least one URL in which to retrieve CRLs. To add more than
one URL to the table, select the Add URL link. Select the Delete button to delete a URL,
but there must be at least one URL entry if CRLs are enabled.
Implicit Trust
Specify whether or not to allow implicit trust for certain connections that support this
configuration. If set to "No", implicit trust will be globally disabled and all connections will
be required to validate certificates.
Pre-Upgrade Notes
This section describes important upgrade considerations for Agents.
2.3.0
SQL Server JDBC Driver Update
The SQL Server JDBC driver has been updated to version 12.8. The encrypt connection
property now defaults to true when connecting to a SQL Server database via a
GoAnywhere Resource or Project Task. If the SQL Server database certificate is not in
KMS (or the JVM cacerts truststore) then the connection will fail. This can be fixed by either
adding encrypt=false to the connection URL or by importing the SQL Server database’s
certificate into KMS.
Agents will now manage their own database parameters: driverClassName, url,
username, and password. Additional parameters such as initialSize, maxActive, maxIdle,
and maxWait are still configurable.
To perform the upgrade, an Agent must have the original default values in the existing
driverClassName, url, username, and password parameters. Its local derby database
must be in the expected location: [Installation Directory]/agentdata/database/agent.
2.1.3
Network Shares Monitors
Upgrading to Agents 2.1.3 may fail if you have active monitors that use a Network Share
resource AND whose event type is File Created or Modified or File Modified. If the
upgrader fails you will be notified that in order to upgrade you need to disable these
monitors and re-enable them once you have upgraded. This affects monitors on both
Agents and Agent Groups.
2.0.0
The upgrade to version 2.0.0 requires Java 11. You’ll need to upgrade to Agents 1.7.0 or
later in order to switch to Java 11. To upgrade to Java 11, complete the upgrade
instructions in the following sections in this order:
l Java 11 Considerations
l Configuring Agents to Run on a Different JVM
Once the Agent is running on Java 11, proceed with upgrading to version 2.0.0.
Upgrading Agents
Agents are upgraded from the Agent Manager in GoAnywhere MFT. The Agent Manager
provides tools to automatically apply upgrades to Agents and Agent Groups.
The GoAnywhere MFT Upgrade Agents page provides Admin Users the ability to upgrade
Agents to the latest software version. When an upgrade is applied, Agents ensures the
Agent is not currently processing any Jobs before the Agent is upgraded. Once the Agent
upgrade is finished, the Agent will reconnect to Agents automatically.
1. To apply an Agent Upgrade, log in to GoAnywhere MFT as an Admin User with the
Product Administrator role. If your user account is assigned to a custom Admin
User Role, your ability to view, modify, or execute actions on this page are based on
the permissions specified for that role.
2. From the main menu bar, select Help and then click the Software Library link.
3. Click the Browse Online Catalog button to find the latest Agent upgrade package,
or import one if you have downloaded an Agent upgrader from the Agents Customer
Portal.
4. From the Software Library page, identify the upgrade package, click the Actions
icon, and then select the Upgrade Agents icon.
5. The Upgrade Agents page appears. Any outdated Agents will be selected for
upgrade. Deselect any Agents that you do not wish to upgrade at this time.
6. Click the Upgrade button. The selected Agents will be upgraded once any work on
the Agent is completed.
Java 11 Considerations
Java 11 is required to use Agents. However, migrating to Java 11 requires some additional
considerations.
Updating Agent startup scripts for Java 11 on Linux and Unix systems
If your Agents are running on a Linux or Unix system, the Agent startup scripts must be
updated. Follow the steps below to update the Agent startup scripts.
3. Modify the 'agent' startup script file. Remove all occurrences of the following text: -
XX:-UseVMInterruptibleIO
6. Modify the 'agentd' startup script file. Remove all occurrences of the following text: -
XX:-UseVMInterruptibleIO
If your Agents are running on an IBM i system, the Agent startup script must be updated.
Follow the steps below to update the Agent startup script.
If your Agents are running on a Linux or Unix system running Java 11, the Agent uninstall
script must be updated before you can uninstall an Agent. Follow the steps below to
update the Agent uninstall script.
Agent Configuration
Agents are typically pre-configured through the Configure Agent Installer screen in
GoAnywhere MFT. After an Agent is installed, the configuration can be updated on the
Agent system by modifying the Agent's XML configuration file.
To configure an Agent, open the agent.xml file from the [installdirectory]/config directory
using a text or XML editor.
name The name of the Agent that will appear on the Agent Manager page
when the Agent connects. If a name is not specified, a name will be
created automatically using the Agent Registration rules on the
Agent Configuration Registration page.
host The host name or IP address of the GoAnywhere MFT instance this
Agent will connect to.
port The port number to use when connecting to the GoAnywhere MFT
instance.
shutdownPort The TCP/IP port number on which the Agent waits for a shutdown
commands. The default is 8015.
registrationCode The Agent Registration Code this Agent will use to register with
GoAnywhere MFT. If no registration codes are configured on the
Agent Service, then this field can be left blank.
maxThreads The maximum number of threads that the Agent is allowed to use.
The default value is 500.
SSL Attributes
The following attributes can be added to the agent.xml file in the SSL element to enable
and configure SSL to protect the channel between the Agent and GoAnywhere MFT.
NOTE:
The Agent must be restarted for any changes to take effect.
Listed below are the contents of a sample configuration file for an Agent.
Advanced Configuration
To configure an Agent's local address and local port ranges, open the agent.xml file
located in the [installdirectory]/config directory using a text or XML editor.
reuseAddress A socket option that tells the kernel to reuse the port
even if the port is busy in the TIME_WAIT status.
Sample Configuration
Agent Permissions
To configure an Agent's runtime configuration, folder permissions, and Project Workflow
permissions, open the permissions.xml file located in the [installdirectory]/config
directory using a text or XML editor.
Runtime Configuration
To prevent system resources from being overloaded, you can limit the number of Jobs and
Monitors that can be run on an Agent at any given time.
Folders
By default, the Agent cannot access any folders on the system where the Agent is installed.
Modify or add folder locations that can be used by the Agent.
alias The name of the folder that will appear in GoAnywhere MFT's
Project File Chooser.
readOnly Set whether the Agent can write to the designated folder or read
only. Valid values are true or false.
<folders>
<folder alias="temp" path="c:\temp" readOnly="false" />
</folders>
Task Permissions
Agents can run Projects on the server where they are installed. You can restrict the type of
Tasks that the Agent can execute.
restrictTasks If set to "true", the types of Tasks the Agent can execute are
restricted to the selected Task types that follow. Valid values
are true or false.
allowDatabaseTasks Allows the Agent to run Database tasks on the server where
the Agent is installed. Valid values are true or false.
allowEmailTasks Allows the Agent to run Email tasks on the server where the
Agent is installed. Valid values are true or false.
allowExcelTasks Allows the Agent to run Excel tasks on the server where the
Agent is installed. Valid values are true or false.
allowFTPTasks Allows the Agent to run FTP tasks on the server where the
Agent is installed. Valid values are true or false.
allowFTPSTasks Allows the Agent to run FTPS tasks on the server where the
Agent is installed. Valid values are true or false.
allowGoFastTasks Allows the Agent to run GoFast tasks on the server where
the Agent is installed. Valid values are true or false.
allowPGPTasks Allows the Agent to run PGP tasks on the server where the
Agent is installed. Valid values are true or false.
allowSSHTasks Allows the Agent to run SSH tasks on the server where the
Agent is installed. Valid values are true or false.
allowWebServiceTasks Allows the Agent to run Web Service tasks on the server
where the Agent is installed. Valid values are true or false.
File System Resource Permission allow Agents to access file system resources using file
syntax notation. You can restrict the File System Resources that the Agent has access to.
EXAMPLE:
The syntax for referencing an Amazon S3 share is: resource:s3://[ResourceName]/
[FilePath], where [ResourceName] is the name of the Amazon S3 share Resource.
Listed below are the contents of a sample permissions file for an Agent.
The following table lists the key attributes that can be updated.
Sample Configuration
<entry key="x509.crlChecking.urls"/>
</properties>
Product Administration
Starting and Stopping Agents
Windows Instructions
2. Change the working directory to the directory where the Agent is installed
(for example, cd /usr/local/Fortra/GoAnywhere_Agent/bin)
Mac OS X Instructions
2. Change the working directory to the directory where the Agent is installed
(for example, cd /Applications/Fortra/GoAnywhere Agent/bin)
2. Change the working directory to the directory where the Agent is installed
(for example, cd /Applications/Fortra/GoAnywhere Agent/bin)
Agent Logs
Agents maintain logs that record the Agent's activity. The log files record a timestamp and
description of each action performed. A new log file is created each time the current log file
reaches the maximum size defined in the log configuration. The log is stored in the Agent's
[Install Directory]\agentdata\logs directory.
If you encounter a problem with an Agent, a Fortra Support Specialist may ask you to
provide them a Debug Log to troubleshoot the issue.
3. Toward the bottom of the file, change the value for <level value="INFO"> to <level
value="DEBUG">.
4. Save the changes to the log configuration and close the editor.
Disaster Recovery
If an Agent loses connection to GoAnywhere MFT, it will continually attempt to reestablish
a connection until GoAnywhere MFT becomes available on the IP address and port the
Agent is attempting to connect to. If GoAnywhere Gateway is being used as a load
balancer for a GoAnywhere MFT cluster, Gateway will direct the Agent connection to the
next available system in the cluster. For more information on GoAnywhere Gateway,
disaster recovery, automatic failover, and clustering, see the GoAnywhere MFT Installation
Guide.
Follow your Java vendor's instructions to upgrade your external JRE. Once the JRE is
upgraded to Java 11, ensure the Java execution environment is correct.
The latest supported version of Java is bundled in the installer for Windows and Linux. If
you need to manually configure an Agent to run on a newer version of Java, follow the
steps below.
4. Modify the path within pref_jre.cfg to point to the desired Java version.
Use the following instructions to upgrade the embeded Java version to 11 on Windows
installations:
5. Create a new jre folder in the installation directory and copy the downloaded JRE
bundle into that directory.
6. Extract the contents of the JRE bundle into the current directory.
Use the following instructions to upgrade the embeded Java version to 11 on Linux
installations:
2. Log in as the user account that owns the Agents installation directory and its
contents.
3. This is typically the same user account used to start and stop Agents.
7. Create a new 'jre' folder in the installation directory and copy the downloaded JRE
bundle into that directory.
8. Extract the contents of the JRE bundle into the current directory.
l $ gunzip linux-x86-11.tar.gz
l $ tar -xvf linux-x86-11.tar
Uninstalling Agents
This section describes how to uninstall the Agents product.
Step Description
Step Description
Step Description
2 Change the working directory to the directory where the Agent was
installed
(for example, cd /usr/local/Fortra/GoAnywhere_Agent).
Step Description
2 Change the working directory to the directory where the Agent was
installed
(for example, cd /Applications/Fortra/GoAnywhere_Agent).
As a security best practice, the address provided in the passive reply will no longer be
trusted by default. To trust the addresses in a passive reply, set
org.apache.commons.net.ftp.ipAddressFromPasvResponse=true in the Agent system
properties file [installdirectory]/config/system.properties. This requires a restart of the
Agent.