FTP Server configuration

You can enable a File Transfer Protocol (FTP) server in your
FactoryTalk Optix Application
.
The runtime script
FTPServerLogic
 enables an FTP server within a
FactoryTalk Optix Application
. The script is found in the
Scripts
 category in
Template Libraries
.
IMPORTANT: You should start and stop the server only by using the exported OPC UA methods:
StartFtpServer
 and
StopFtpServer
.

Required packages

You must install stable versions of the following required NuGet packages: See NuGet packages.

Required parameters

The FTP server requires the following parameters to be configured:
FTP Server - required configuration parameters
Parameter
Description
Configuration
IPAddress
IP address assigned to the server.
The default value is set to
127.0.0.1
.
Port
Port assigned to the FTP server,
The default value is
21
.
FilesystemRoot
FTP server exposes only a fraction of the local filesystem to client
On
OptixPanel
, you can only set either:
  • %PROJECTDIR%
  • %APPLICATIONDIR%
  • %USB
    <n>
    %
     where
    <n>
     is the progressive number of a USB device.
MinimumPASVPort
Minimum port number for managing file listing and file transfer.
This value must be greater than the default
1024
.
MaximumPASVPort
Maximum port number for managing file listing or file transfer.
This value must be greater than
MinimumPASVPort
. The default value for
MaximumPASVPort
 is
1100
.
Username/Password
FTP Server login credentials
ServerCertificateFile
Server public certificate file, according to standard X509v3 and with .der extension.
It must be found in the
FTOptixApplication/ProjectFiles/PKI/Own/Certs
 directory. If specified, the private key must also be specified. If not specified, it is automatically generated at runtime in the
FTOptixApplication/ApplicationFiles/PKI/Own/Certs
 directory.
ServerPrivateKeyFile
Server private key file, with ASCII Base64 encoding and .pem extension.
It must be found in the
FTOptixApplication/ProjectFiles/PKI/Own/Certs
 directory. If specified, the certificate must also be specified. If not specified, it is automatically generated at runtime in the
FTOptixApplication/ApplicationFiles/PKI/Own/Certs
 directory.
UseFtps
Determine protocol to use, FTP or FTPS.
The FTP server is started/stopped via the
StartFtpServer/StopFtpServer
 methods.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.