UNIX Agent

The agent name is limited to 32 of the following characters: A-Z, 0-9, _, ., $, @, - and #.

The host name is used instead if this parameter remains undefined. Lowercase letters are converted to uppercase letters.

system=

The name of the AE system.
This entry must comply with the entry in the Automation Engine's INI file.

The xxx characters in the file name are placeholders. They stand for the three-digit abbreviation of the respective UNIX version. See: Terminology

The number signs serve as placeholders for a series in numerical order. When you start the agent, the log files are renamed so that the most current log file is always the one with the number 00.

The language that should be used for the logging. You can specify a primary and a secondary language.

Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a message in the secondary language.

Sets the users 'open file descriptor' limit. A value of 0 forces the agent to set the users soft limit to the existing users hard limit. A value not equal to 0 forces the agent to set the soft limit and the hard limit to that value. If the value exceeds the users existing hard limit, the agent even sets that value, if it is operated with root privileges. If the value exceeds the users existing hard limit and the agent is not operated with root privileges, the agent cannot exceed the hard limit and sets the users soft limit to the users hard limit.

Default value: 32768

Allowed values: INCL, EXCL (default value)

INCL = Access must be granted to every single user in the [USERID] section.
EXCL = No access is granted to the users who are specified in [USERID]. All other users can start jobs.

Allowed values: INCL, EXCL (default value)

INCL = Access must be granted to every single user in the [UC_USER] section.
EXCL = No access is granted to the AE users who are specified in the [UC_USER] section. All other AE users can start jobs

Default value: 30 seconds

login_check=

Password check.

Allowed values: yes and no (default value)

See: Description of the settings ANONYMOUS_FT and ANONYMOUS_JOB in the variable UC_HOSTCHAR_DEFAULT).

ReportMode=

A mask in three octal digits that you can use to assign additional rights to the job report file.

Default value: 600

The default value is the minimum value. The value 6 is used even if you specify an owner authorization level below this value.

JobFileMode=

A mask in three octal digits that you can use to assign additional rights to the job file.

Default value: 700

The default value is the minimum value. The value 7 is used even if you specify an owner authorization level below this value.

FT_Owner=

The owner of file transfer files.

Allowed values: "user" (default value) and "directory"

"user" - The user who is defined in the Login object is the file owner (User ID) of the transferred file(s). The owner of existing files that might be overwritten is kept."directory" - The transferred file(s) obtein the owner of the target folder. The same rule applies for existing files that are overwritten.

This parameter does not affect file rights or the group.

The new file transfer protocol (source and target agent are of version 9 or later) ignores this parameter. In this case, the owner is always the user who is defined in the Login object.

ReadUserAlways=

You allow or reject User IDs by using the parameter userid_type= in the [USERID] section. You can use the parameter ReadUserAlways= in order to specify whether this section should always be read before a job starts or only once when the agent starts. Reading this section only once improves the performance of your system and is therefore the default value.

Allowed values: yes and no (default value)

yes = The agent always reads the [USERID] section before a job starts.
no = The agent reads this section only once when the agent starts.

KillSignal=

The signal that is sent to the job if it is canceled through the UserInterface.

Allowed values: SIGTERM, SIGABRT and SIGKILL (default value)

SIGTERM - The job is terminated (15).
SIGABRT - The job is canceled (6)
SIGKILL - The job ends immediately (9).

ft_temp_file=

This parameter creates temporary files in file transfers.

Allowed values: yes (default value) and no

yes = The file obtains a temporary name which is composed of the letter T and an alphabetic string that originates from the RunID. The new file transfer protocol additionally appends a file ID in order to obtain a unique file name because basically, only a RunID is provided. The file is renamed after it has successfully been transferred.
no = The agent assigns the final file name when the file transfer starts.

Nagle algorithm usage for file transfers and all the agent's other sockets.

Allowed values: yes (default value) and no

no = Activates the Nagle algorithm.
yes = This procedure is not applied.

Activating the Nagle algorithm can improve the performance of file transfers, especially if you transfer many small files.

The BS2000 agent always uses the Nagle algorithm. Therefore, it does not include this INI-file parameter.

Note that this parameter should only be set in close cooperation with Automic Support!

The time limit in second for the file search

The file search aborts when the specified time limit is reached.

No time limit applies when you either define the setting "0" (default) or "-1".

This parameter is relevant for FileSystem events and the script element GET_FILESYSTEM.

The maximum level of sub-directories for FileSystem events.

You use this setting in order to determine the extent to which the directory structure is included in your search for FileSystem event files. The search directory serves as the basis for the maximum sub-directory level.

By limiting the directory level, you can improve the performance of FileSystem events especially when their folder structure is deeply nested and includes numerous files.

Allowed values:
"0" (default) = There is no limitation.
"1" = The files are only searched in the search directory. Sub-directories are not included in this search.
"2" = With this setting being used, the search for files includes the search directory and one directory level below.
"3" = The search includes the directory plus two sub-directory levels.
etc.

This parameter is relevant for FileSystem events and the script element GET_FILESYSTEM.

The name and the path of the file that includes the authentication package (company-key file).

This parameter must be specified if you use the authentication methods "Server" or "Server and Agent". Any attempt to log in fails if the company-key file cannot be found.

When the agent starts, it reads the company-key file and stores its information in the file that is specified in the parameter KeyStore=. The first file is deleted afterward.

The name and the path of the file that includes the information of the authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending *.kstr) or the path of the agent's INI file. If you define a file name, the ending *.kstr is not automatically appended.

The KeyStore file is created when the agent starts for the first time. You must not delete, rename or move it subsequently. Regardless of the authentication method that you use, any attempt to log in will fail if the agent cannot find this file when it starts. In this case, you must open the menu item "Renew transfer key" in the affected agent's System Overview.

[USERID]

The definition of the authorized UNIX users in the format:
User name=START

Definition of the non-authorized UNIX users in the format:
User name=NO_START

Default value: root=NO_START

The definition of the non-authorized AE users in the format:
User ID=NO_START

The User ID (OH_IDNR) of each user is registered in the AE databaseA database is an organized collection of data including relevant data structures. in the OH table.

This parameter checks the available hard disk space before a file transfer is processed.

Allowed values:
"yes" - The system checks whether there is sufficient hard disk space for the files that should be transferred. The files will only be transferred when there is enough space. Otherwise, the file transfer will abort with an error message.
"no" (default) - No check is made.

Checking the available space of network drives may occasionally lead to an incorrect result.

By using the parameter FT_Linkfiles you control, if the agent should transfer linked files of the source or ignore them.

Allowed values:
"yes" - Links will be dereferenced and files the links are pointing to, will be transferred.
"no" (default) - Links will be ignored.

Executing a Wildcard-FileTransfer with "no" as value, may result in the transfer being set to ENDED_EMPTY, in case there are only links in the source directory.

[VARIABLES]

This section contains the agent variables that include agent settings and information.

The xxx characters in the file name are placeholders. They stand for the three-digit abbreviation of the respective UNIX version. See:Terminology

The number signs serve as placeholders for a series in numerical order. When you start a trace, the trace files will be renamed so that the most current trace file is always the one with the number 00.

Allowed values: 0 (default value) to 9

Trace flags must only be used in close cooperation with Automic Support.

[HOSTS]

Assignment of an agent's name to its address (DNS name or TCP/IP address) if it cannot directly be accessed through the address that is stored in the server. Specify several assignments line by line, there is no upper limit for the number of assignments.

In file transfers, the sending agent obtains the destination agent's internal address from the Automation Engine. The sending agent replaces this internal address by the external address that is defined here.

This setting is only required if you run file transfers with agents that cannot directly establish a TCP/IP connection between each other by using the address that they have received from the Server. This can happen if the agents that are involved in the file transfer are located on different networks or if a firewall is used.

[TCP/IP]

Other agents and the Job Messenger use this port number in order to establish a connection.

bindaddr=

The IP address or host name for the connection to the agent.

You can use this parameter if a specific IP address should be used for the connection (if the computer has more than one network interface card).

Alternately, you can also specify the IP address or host name in port=

(Format: port=IP address:port or DNS name:port). Specifications that are made in bindaddr= are ignored in this case.

bindlocal=

The consideration of the local host (127.0.0.1).

This parameter must be used in combination with bindaddr=.

Allowed values: 0 (default value), 1

0 = No listen socket is created.
1 = An additional listen socket is created on the local host.

connect=

The ime interval in seconds in which the agent tries to establish a connection to the Automation Engine. This setting affects the connection establishment for a restart of when the connection has been lost.

The former parameter name agent= is still valid for compatibility reasons.

Default value: 60 seconds

maxrepcnt=

The maximum number of report blocks that should be transferred to the Automation Engine at the same time.

Default value: 8 blocks

Maximum length of messages (in bytes) that the agent accepts.

Default value: 500 000

cp=

The address of the communication process in the AE system to which the agent should connect.

Allowed formats:
DNS Name:Port number
TCP/IP Address:Port number

This sends keep-alive packets in order to keep the agent connections.

Allowed values: "N" and "Y" (default value)
"Y" - Keep-alive packets are sent.

This parameter is only checked when the agent runs under Linux.

The time interval in seconds in which packages for keeping the connections are sent.

The default value that depends on the system environment is used if you do not specify this parameter or use the value 0.

SendBufferSize=

Size of the TCP/IP input buffer for messages that should be sent (MB, KB or bytes).

Bytes are used by default. Alternately, you can also append the letter "K" or kilobytes or "M" for megabytes to the number. You can use uppercase or lowercase letters for this purpose.

Examples (the following definitions are identical):
Specification in bytes: 1048576
Specification in Kbytes: 1024K or 1024k
Specification in Mbytes : 1M or 1m

Default value: 1 Mbyte

RecvBufferSize=

Size of the TCP/IP input buffer for messages that should be received (MB, KB or bytes).

Bytes are used by default. Alternately, you can also append the letter "K" or kilobytes or "M" for megabytes to the number. You can use uppercase or lowercase letters for this purpose.

Default value: 1 Mbyte

[MISC]

FileBufferSize=

Size of the input buffer for files that are transferred with a FileTransfer object (MB, KB or bytes).

Bytes are used by default. Alternately, you can also append the letter "K" or kilobytes or "M" for megabytes to the number. You can use uppercase or lowercase letters for this purpose.

Examples (the following definitions are identical):
Specification in bytes: 1048576
Specification in Kbytes: 1024K or 1024k
Specification in Mbytes : 1M or 1m

Default value: 0 (The OS setting is used).

authentification=

Authentication method for the login data in the Login objects of the jobs and file transfers.

Allowed values: local (default) and PAM

local = OS calls
PAM = Pluggable Authentication Modules (see also: parameter Libname=)

PAM authentication is only supported for agents that run on AIX, Linux and Sun Solaris.

TraceFileSize=

The maximum size of a trace file. The agent creates a new file if this value has been reached.

Bytes are used by default. Alternately, you can also append the letter "K" or kilobytes or "M" for megabytes to the number. You can use uppercase or lowercase letters for this purpose.

This adds a line breack (LF) at the end of text files that have been sent using a file transfer.

Allowed values: "yes" and "no" (default value)

"yes" - The agent always adds an LF to the end of text files in file transfers in which it is the receiving agent.e It is irrelevant whether the files already end with an LF.
"no" - The files are transferred without any changes.

Collection of process information.

Allowed values: yes (default) and no

yes = The agent retrieves the process information of all AE processes and sends it to the Automation Engine for the periodic job check. By doing so, the consumed CPU time is refreshed in the UserInterface. Note that this can negatively affect CPU and performance if many active processes are involved.
no = No process information is collected. The consumed CPU time is retrieved when the job has ended and then sent to the Automation Engine.

This parameter is not available for AIX.

Logging output in the terminal that is used to start the agent.

Allowed values: yes and no (default)

yes = The agent's logging data is output in the console. An additional log file is written.
no = Logging data is only written to the log file.

Authorization check before the source file is deleted.

Allowed value: yes (default value) and no

yes - The user's authorization to delete the source file is verified.
no - The authorization is not verified and the file is deleted. The UNIX user under which the agent runs is used (usually this is root).

[PAM]

Libname=

Path and filename of the PAM library.

Specify the library name if the PAM authentication methodshould be used (see also parameter authentication=)

By default, the file libpam.so is searched in the agent's directory.

This parameter is only relevant for AIX, Linux and Sun Solaris agents.

If turned on and PAM authentication is used, a PAM user session is opened for each job also applying the session credentials by PAM (e.g. limits defined in /etc/security/limits.conf). This setting applies to jobs, but not FileTransfers or file events.

Allowed value: yes and no (default value)

[STARTCMD]

Allowed values: fork (default value), batch

fork = The job starts with fork function.
batch = The job starts with a batch command.

Other_Shell=

Shell options for starting jobs under any Shell.
You can use this line if jobs should be started with a batch command.

The specification of a specific Shell path.

The environment variable PATH is used if you do not specify this parameter. If this variable is not available, the system uses the "/bin" directory.

[CP_LIST]

List of communication processes.

This list is created when the agent starts and it is extended when new communication processes are activated. You will find more detailed information about establishing a connection in the chapter Multi-Server Operation.

The communication process that is defined in the parameter cp= ( [TCP/IP] section) is not included in the cp list.

Format:
Port number=DNS name
or
Port number=TCP/IP address