The AFD_CONFIG file


This file contains some parameter settings that are always read when the AFD is started. The following table shows and describes what parameters can be set and which programs must be restarted to activate the new value:

Parameter Description Default Restart
AFD_TCP_PORT The TCP port number at which the process afdd will listen and wait for remote requests. If that port is currently in use by another program it will add one and see if that works so long until it finds a free port. NOTE: If this option is not set the afdd process will NOT start. 4444 afdd
AFD_TCP_LOGS The logs that may be requested from the given AFD_TCP_PORT. If this is defined, then it means for all hosts that connect to this port. With the TRUSTED_REMOTE_IP it can be resticted to specific host(s). The value given is an integer bit mask, with the following meaning:
           5 (16)    - System Log
           6 (32)    - Receive Log
           7 (64)    - Transfer Log
           8 (128)   - Transfer Debug Log
           9 (256)   - Input Log
          10 (512)   - Production Log
          11 (1024)  - Output Log
          12 (2048)  - Delete Log
          15 (16384) - Event Log
       
Just add the values in brackets to set the wanted logs.
0 afdd
TRUSTED_REMOTE_IP Trusted IP-number that may connect to AFD_TCP_PORT. To enter more then one IP-number you must have the identifier TRUSTED_REMOTE_IP on a new line for each number. Wildcards may also be used when specifying the IP-number. Optionally you can set the AFD_TCP_LOGS flag behind the IP number. If TRUSTED_REMOTE_IP is not set, all hosts may connect. None afdd
MAX_AFDD_CONNECTIONS The number of hosts that may connect to the afdd process. 5 afdd
DIR_CONFIG_NAME The file from where AFD will read it's configuration. This option may be used more then once, thus making it possible to read from multiple configuration files. $AFD_WORK_DIR/etc/DIR_CONFIG amg
MAX_NO_OF_DIR_CHECKS This is the number of times dir_check my fork itself to copy or exec some command. 20 amg
MAX_PROCESS_PER_DIR The maximum number of process that may be forked for one directory. 10 amg
AMG_DIR_RESCAN_TIME The rescan time of the local user directories in the DIR_CONFIG file. This does not effect the rescan time of remote directories, which is set with REMOTE_FILE_CHECK_INTERVAL. Don't pick a small value here if your system shows high system load when working with files or directories (eg. fault tolerant systems). This is also the interval time that the AMG checks if the DIR_CONFIG or HOST_CONFIG file have been changed. The unit is second. 5 amg
DEFAULT_DIR_WARN_TIME The time when AMG will warn in receive log that no data has been received in the specified directory. This value will be overridden by warn time value from DIR_CONFIG if set. The unit is second. 0 amg
DEFAULT_DELETE_FILES_FLAG What to do with files that have reached a certain age but cannot be transmited because either there is no rule (Unknown), they are being queued by AFD (Queued) or they are old locked files (Locked). By specifying one of the above those files will be automatically removed by AFD when DEFAULT_OLD_FILE_TIME value has been reached. To specify more then one type, just add the next with a space or comma as a separator sign and the whole string must be placed in ". Not set amg
DEFAULT_OLD_FILE_TIME When to delete Unknown, Queued or Locked files from one of AFD's input directories. The value is in hours. 24 amg
REMOVE_UNUSED_HOSTS By default AFD will never delete a host from HOST_CONFIG if the host is not found in DIR_CONFIG. With this option set, those hosts will be deleted. Not set amg
DELETE_STALE_ERROR_JOBS When a job is removed from DIR_CONFIG but FD has still files queued and these jobs produce errors (ie. they cannot be send, due to whatever reason), AFD will by default not delete these files. By setting this to YES, such jobs will be removed. NO fd
MAX_CONNECTIONS The maximum number of simultaneous connections/transfers that the AFD allows. Don't set this value to high since some environments allow only a limited number of process per user. 50 fd
REMOTE_FILE_CHECK_INTERVAL The interval in second that the FD rescans remote directories for files. Do not set this value to low. 60 fd
CREATE_SOURCE_DIR If this is set to NO, the source directories will not be created if they do not exist. When set to YES, these will be created if AFD does have the permission to do so. Currently only local directories will be created, not remote directories. YES amg
CREATE_TARGET_DIR If this is set to YES and the target directory does not exist it will be created automatically, unless the option do not create target dir is set. If it is set to NO (default) it will not create the target directory. With the option create target dir this can be overriden. NO fd
DEFAULT_AGE_LIMIT Files older then the given seconds will be deleted by default, unless the age-limit is specified under options, then this value will be taken. A value of 0 will disable this, it is however still possible to set this value with the age-limit option in DIR_CONFIG. 0 fd
EXEC_TIMEOUT When setting one of the exec options ( exec or pexec), the default is to let those process run as long as those process want to run, ie. there is no restriction in time. This default can be changed to the value specified here in seconds. If the time is up the process is killed. 0 amg/fd
DEFAULT_SMTP_SERVER The default SMTP server where mails are to be send to. This can be an IP number or a hostname. localhost fd
DEFAULT_SMTP_FROM The default what will be put into the from line, if the from option is not set under [options]. If not set it will take the user- and hostname from the current system where AFD is running. <current user>@<hostname> fd
MAX_COPIED_FILES The maximum number of files that are copied before they are send to the FD. This value is set so that the AFD starts sending files as soon as possible even when there are thousands of files waiting in the source directory to be send. Otherwise it might take to long to process all the files at once and time is lost that could be used to transmit data. 100 amg
MAX_COPIED_FILE_SIZE The maximum size in Kilobytes that are copied before they are send to the FD. 100 MB amg
ONE_DIR_COPY_TIMEOUT When AMG has collected MAX_COPIED_FILES, it will try to continue to copy from this directory until it reaches the timeout set by this option in seconds. 10 amg
FULL_SCAN_TIMEOUT The timeout for scanning all directories. If set to 0 this is diasbled. When this is set it will only take effect if during a scan there are directories which still have files to be distributed but could not because of MAX_COPIED_FILES or some other limits. If FULL_SCAN_TIMEOUT has not been reached, it will try to continue with the full directories until FULL_SCAN_TIMEOUT is reached. 0 amg
DIR_CHECK_TIMEOUT When the administrator has marked one or more directories as important (with '*'), this is the minimum time that these directories have to wait during one scan of all directories. 30 amg
CREATE_SOURCE_DIR_MODE The permission of the source directories that found in the DIR_CONFIG and created by AMG if they are not there. 775 amg
MAX_SYSTEM_LOG_FILES The number of old system logfiles that AFD keeps before they are deleted. 4
 
MAX_RECEIVE_LOG_FILES The number of old receive logfiles that AFD keeps before they are deleted. 7
 
MAX_TRANSFER_LOG_FILES The number of old transfer logfiles that AFD keeps before they are deleted. 7
 
MAX_TRANS_DB_LOG_FILES The number of old transfer debug logfiles that AFD keeps before they are deleted. 3
 
MAX_MON_SYS_LOG_FILES The number of old monitor system logfiles that AFD keeps before they are deleted. 4
 
MAX_MON_LOG_FILES The number of old monitor logfiles that AFD keeps before they are deleted. 14
 
MAX_INPUT_LOG_FILES The number of old input logfiles that AFD keeps before they are deleted. 7
 
MAX_PRODUCTION_LOG_FILES The number of old production logfiles that AFD keeps before they are deleted. 7
 
MAX_OUTPUT_LOG_FILES The number of old output logfiles that AFD keeps before they are deleted. 7
 
MAX_DELETE_LOG_FILES The number of old delete logfiles that AFD keeps before they are deleted. 7
 
DEFAULT_PRINTER_CMD With this option it is possible to set the printer command for your specific environment. "lpr -P"
 
DEFAULT_PRINTER_NAME This option specifies the default printer for your system.
 
 
PING_CMD Full path of the ping command plus any options. If there are options you must put the full command in ". The hostname will be added to the end of the command.
 
afd_ctrl
TRACEROUTE_CMD Full path of the traceroute command plus any options. The hostname will be added to the end of the command.
 
afd_ctrl
VIEW_DATA_PROG Program to view data of show_olog and show_queue dialog. This may be used multiple times in AFD_CONFIG to configure different programs for different file types (patterns). The syntax is as follows:
VIEW_DATA_PROG <progname> <pattern>

   <progname> - Is the program name of the program to be
                called. If parameters need to be added,
                tey must be put in ". The filename to be
                shown, can be added with %s.
   <pattern>  - The filename pattern that applies for the
                above program name. Multiple patterns must
                be seperated with a pipe sign (|).
       
 
show_olog, show_queue
FAKE_USER <fake user name> This option allows the administrator to allow certain users to take up another identity, even if they do not exist on the system. This user will then be used to look up the permissions in the afd.users file. So if you for example give operators limited permission and do not want to create a new user, you can do the following:
             FAKE_USER     afd->operator
       
If the user afd enters the following command:
             afd_ctrl -u operator
       
the afd_ctrl dialog will come up with the permissions of operator. More fake users can be added with a comma as separater:
             FAKE_USER     afd->operator,afd->donald
       
The list may not be longer then 1023 bytes.
 
 

When one of the above values is changed the appropriate process must be restarted.


Copyright © 1999 - 2007 by H.Kiehl
Holger.Kiehl@dwd.de
Last updated: 15.07.2007
[red dot]Index [red dot]Home SourceForge.net Logo