Change FTP Attributes (CHGFTPA)
| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Change FTP attributes (CHGFTPA) command changes the configuration for the File Transfer Protocol (FTP) servers. The FTP attributes can be changed while the FTP servers are active. The attributes that were changed take affect the next time an FTP server connection is made. All existing connections are not changed but keep the same attributes they had when the connection was established.
Restrictions:
- You must have input/output system configuration (*IOSYSCFG) special authority to use this command.
| Top |
Parameters
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| AUTOSTART | Autostart servers | *SAME, *YES, *NO | Optional, Positional 1 |
| NBRSVR | Number of initial servers | 1-20, *SAME, *DFT | Optional |
| INACTTIMO | Inactivity timeout | 0-2147483, *SAME, *DFT | Optional |
| CCSID | Coded character set identifier | 1-65533, *SAME, *DFT | Optional |
| TBLFTPOUT | Outgoing EBCDIC/ASCII table | Single values: *SAME, *CCSID, *DFT Other values: Element list |
Optional |
| Element 1: Outgoing EBCDIC/ASCII table | Qualified object name | ||
| Qualifier 1: Outgoing EBCDIC/ASCII table | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| TBLFTPIN | Incoming ASCII/EBCDIC table | Single values: *SAME, *CCSID, *DFT Other values: Element list |
Optional |
| Element 1: Incoming ASCII/EBCDIC table | Qualified object name | ||
| Qualifier 1: Incoming ASCII/EBCDIC table | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| NAMEFMT | Initial name format | *SAME, *LIB, *PATH | Optional |
| CURDIR | Initial directory | *SAME, *CURLIB, *HOMEDIR | Optional |
| LISTFMT | Initial list format | *SAME, *DFT, *UNIX | Optional |
| CRTCCSID | New file CCSID | 1-65533, *SAME, *CALC, *USER, *SYSVAL | Optional |
| SBSD | Subsystem description | Single values: *SAME, *DFT Other values: Qualified object name |
Optional |
| Qualifier 1: Subsystem description | Name | ||
| Qualifier 2: Library | Name | ||
| ALWSSL | Allow secure sockets layer | *SAME, *YES, *NO, *ONLY | Optional |
| Top |
Autostart servers (AUTOSTART)
Specifies whether to automatically start the FTP servers when TCP/IP is started by running the Start TCP/IP (STRTCP) command, or the Start TCP/IP Server (STRTCPSVR) command with SERVER(*AUTOSTART) specified. When FTP is started by running the STRTCPSVR command, and SERVER(*AUTOSTART) is not specified, this parameter is ignored and the number of servers defined is started regardless of the value of this parameter.
- *SAME
- The autostart value that was previously set does not change; otherwise, *YES is used.
- *YES
- Start the number of servers defined in the NBRSVR parameter.
- *NO
- Do not start the number of servers defined in the NBRSVR parameter when the STRTCP command is called.
| Top |
Number of initial servers (NBRSVR)
Specifies the number of FTP servers to start initially when FTP is started by either the Start TCP/IP (STRTCP) command or the Start TCP/IP Server (STRTCPSVR) command. The initial number of servers to be started is shipped with a value of 3. The maximum number of servers that may be specified is 20.
Having more than one FTP server job running can improve the performance of initiating a session when multiple users attempt to connect to the server in a short period of time.
- *SAME
- The number of servers that was previously set does not change.
- *DFT
- The number of servers is set to the default value of 3.
- 1-20
- Specify the number of FTP servers to start.
Once the FTP servers are running, you can increase or decrease the number of servers. If you request to increase the number of servers with the CHGFTPA command, the number of current servers is increased the next time an FTP connection occurs to the server. If you request to decrease the number of servers, the request has no effect until the next time the STRTCP or STRTCPSVR command is run.
| Top |
Inactivity timeout (INACTTIMO)
Specifies the number of seconds the system allows an FTP control and data connection to remain inactive before it is ended. When an FTP connection is inactive longer than the specified length of time, it is ended.
Notes:
- The system may wait an additional 1 to 120 seconds to end the inactive connection.
- Although a client session is ended after this time, the server job remains active. The specified period relates to the time that a client session performs no interaction with the IBM i FTP server. Even though you may be issuing local FTP subcommands on a client and you do not interact with the server for the period specified, the FTP server closes the session.
This parameter is used only by the FTP server; it is not used by the FTP client.
- *SAME
- The time-out value does not change if it was previously set; otherwise, 0 seconds is used.
- *DFT
- The time-out value is set to the default of 300 seconds (5 minutes).
- 0-2147483647
- Specify an inactive time-out period in seconds. A value of 0 means that there is no time-out.
| Top |
Coded character set identifier (CCSID)
Specifies the ASCII coded-character set identifier (CCSID) that is used for single-byte character set (SBCS) ASCII file transfers when the FTP TYPE mode is set to ASCII. ASCII file transfers are also assumed when no TYPE subcommand has been issued. The CCSID value chosen is the default used by the FTP server for ASCII-to-EBCDIC and EBCDIC-to-ASCII mapping. Mapping is determined using the specified ASCII CCSID and the EBCDIC CCSID of the job.
Outgoing and incoming mapping can optionally be done with mapping tables specified for the Outgoing EBCDIC/ASCII table (TBLFTPOUT) and Incoming ASCII/EBCDIC table (TBLFTPIN) parameters. Normally the TBLFTPOUT and TBLFTPIN parameters are set to the default of *CCSID or *DFT, with both indicating that the value used in the CCSID parameter is used for mapping.
Note: IBM includes mapping support in FTP to ensure compatibility with releases prior to V3R1. Use of mapping tables for incoming TYPE A file transfers results in the loss of CCSID tagging if the target file must be created. IBM strongly recommends that you use CCSID support for normal operations.
If a mapping table is to be used for outgoing mapping, a table object can be specified in the TBLFTPOUT parameter. Then this table object is used for outgoing mapping instead of the CCSID value.
Incoming mapping can be changed to use a mapping table in the same manner by specifying a table object in the TBLFTPIN parameter. This mapping table would then override the specified CCSID value and be used for incoming mapping.
Double-byte character set (DBCS) CCSID values are not permitted for this parameter. The DBCS CCSID values can be specified using the TYPE subcommand.
- *SAME
- The CCSID value that was previously set does not change; otherwise, 00819 (ISO 8859-1 8-bit ASCII) is used.
- *DFT
- The CCSID value is 00819 (ISO 8859-1 8-bit ASCII).
- 1-65533
- Specify the CCSID value to be used. This value is validated to ensure a valid SBCS CCSID has been requested.
| Top |
Outgoing EBCDIC/ASCII table (TBLFTPOUT)
Specifies the table object that is to be used to map all outgoing server data in FTP. Outgoing server data is mapped from EBCDIC to ASCII.
If a table object is specified for the TBLFTPOUT parameter, the table object is used for outgoing mapping. Otherwise, the CCSID parameter is used to determine outgoing mapping.
Single values
- *SAME
- The TBLFTPOUT value does not change if it was previously set; otherwise, *CCSID is used.
- *CCSID
- The CCSID parameter is used to determine outgoing mapping.
- *DFT
- The CCSID parameter is used to determine outgoing mapping.
Qualifier 1: Outgoing EBCDIC/ASCII table
- name
- Specify the name of the table object to be used for mapping the outgoing FTP server data.
Qualifier 2: Library
- *LIBL
- All libraries in the user and system portions of the job's library list are searched until the first match is found.
- *CURLIB
- The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
- name
- Specify the name of the library to be searched.
| Top |
Incoming ASCII/EBCDIC table (TBLFTPIN)
Specifies the table object that is used to map all incoming server data in FTP. Incoming server data is mapped from ASCII to EBCDIC.
If a table object is specified for the TBLFTPIN parameter, the table object is used for incoming mapping. Otherwise, the CCSID parameter is used to determine incoming mapping.
Single values
- *SAME
- The TBLFTPIN value does not change if it was previously set; otherwise, *CCSID is used.
- *CCSID
- The CCSID parameter is used to determine incoming mapping.
- *DFT
- The CCSID parameter is used to determine incoming mapping.
Qualifier 1: Incoming ASCII/EBCDIC table
- name
- Specify the name of the table object to be used for mapping the incoming FTP server data.
Qualifier 2: Library
- *LIBL
- All libraries in the user and system portions of the job's library list are searched until the first match is found.
- *CURLIB
- The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
- name
- Specify the name of the library to be searched.
| Top |
Initial name format (NAMEFMT)
Specifies the initial setting of NAMEFMT (file naming format) for each new session established with the FTP server.
- *SAME
- The initial name format that was previously set does not change; otherwise, *LIB is used.
- *LIB
- The LIBRARY/FILE.MEMBER naming format is used. This is equivalent to specifying the SITE NAMEFMT 0 subcommand to the FTP server.
- *PATH
- The path naming format is used for files. This setting is equivalent to specifying the SITE NAMEFMT 1 subcommand to the FTP server.
| Top |
Initial directory (CURDIR)
Specifies the initial current working directory to be established when a user logs on to the IBM i FTP server.
- *SAME
- The initial directory that was previously set does not change; otherwise, *CURLIB is used.
- *CURLIB
- The FTP server initializes the setting of the current working directory to the current library specified in the user profile of the user logged in to the FTP server.
- *HOMEDIR
- The FTP server initializes the setting of the current working directory to the home directory specified in the user profile of the user logged in to the FTP server.
Note: CURDIR(*HOMEDIR) cannot be used with NAMEFMT(*LIB).
| Top |
Initial list format (LISTFMT)
Specifies the initial setting of LISTFMT (file listing format) for each new session established with the FTP server.
- *SAME
- The initial list format that was previously set does not change; otherwise, *DFT is used.
- *DFT
- The IBM i listing format is used. This setting is equivalent to specifying the SITE LISTFMT 0 subcommand to the IBM i FTP server.
- *UNIX
- The Unix listing format is used. This setting is equivalent to specifying the SITE LISTFMT 1 subcommand to the IBM i FTP server.
| Top |
New file CCSID (CRTCCSID)
Specifies the EBCDIC coded character set identifier (CCSID) to be used when creating new database files in libraries for ASCII file transfers.
- *SAME
- The new file CCSID value that was previously set does not change; otherwise, *CALC is used.
- *CALC
- New database files created during ASCII file transfers use the related default EBCDIC CCSID of the ASCII line CCSID.
- *USER
- New database files created during ASCII file transfers use the CCSID specified in the user profile of the user logged in to the FTP server, or if this CCSID is 65535, the default CCSID determined by the language id specified in the user profile.
- *SYSVAL
- New database files created during ASCII file transfers use the CCSID specified by the QCCSID system value.
- 1-65533
- Specify the CCSID to be used when creating new database files during ASCII file transfers. This value is validated to insure that a valid EBCDIC CCSID has been entered.
| Top |
Subsystem description (SBSD)
Specifies the subsystem description of the subsystem where FTP server jobs are to run. If the specified subsystem description does not exist, it is created.
Notes:
- A check is made to see if there is an already active subsystem with the same name as the specified subsystem. If there is an active subsystem with the same name but using a subsystem description from a different library, the CHGFTPA command will fail with message TCP3D28.
- If a subsystem description other that the IBM-supplied QSYSWRK subsystem is specified, a job queue is also created with the same name and in the same library as the specified subsystem description. This job queue is used for submitting FTP server jobs. (When the IBM-supplied QSYSWRK subsystem is specified, FTP server jobs are submitted to job queue QSYSNOMAX in library QSYS.)
Single values
- *SAME
- The subsystem description value does not change if it was previously set; otherwise, *DFT is used.
- *DFT
- FTP server jobs run in subsystem QSYSWRK in library QSYS.
Qualifier 1: Subsystem description
- name
- Specify the name of the subsystem description where FTP server jobs are to be run.
Qualifier 2: Library
- name
- Specify the name of the library to be searched.
| Top |
Allow secure sockets layer (ALWSSL)
Specifies whether the FTP server should use Secure Sockets Layer (SSL) support. SSL provides encryption of FTP datastreams (including passwords), and optionally supports certificate-based authentication of FTP clients (which allows the user to be authenticated by certificate instead of password).
- *SAME
- The allow secure sockets layer value that was previously set does not change; otherwise, *YES is used.
- *YES
- The IBM i FTP server accepts non-SSL FTP sessions. If the prerequisite products needed to allow SSL support are installed and a valid FTP server certificate is configured in the Digital Certificate Manager, SSL sessions will also be allowed.
Note:If ALWSSL(*YES) is specified and the Digital Certificate Manager is configured for required FTP client authentication, non-SSL sessions are accepted by the FTP server. However, non-anonymous FTP users must switch to SSL mode in order to log in to the IBM i FTP server.
- *NO
- The IBM i FTP server will only accept non-SSL FTP sessions.
- *ONLY
- Except for anonymous FTP users, the IBM i FTP server allows login only from SSL FTP sessions.
Note:If ALWSSL(*ONLY) is specified and either a prerequisite product required for SSL is not installed or a valid FTP server certificate is not configured in the Digital Certificate Manager, the FTP server will not start.
| Top |
Examples
None| Top |
Error messages
*ESCAPE Messages
- TCP261D
- Process did not complete successfully
- TCP264D
- Error occurred processing file.
- TCP3D28
- Active subsystem &1 not from library &2.
- TCP499A
- Error accessing configuration member.
- TCP499B
- &1 cannot be used with &2.
- TCP499D
- CRTCCSID parameter value &1 not valid.
- TCP499E
- CRTCCSID parameter value &1 not found.
- TCP4993
- CCSID parameter value &1 not valid.
- TCP4994
- CCSID parameter value &1 not found.
- TCP8050
- *IOSYSCFG authority required to use &1.
- TCP9503
- File &3 in library &2 not available.
- TCP9999
- Internal system error in program &1.
| Top |