Windows Agent

The name of the 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.

Hyphens ("-") are only allowed in agent names. They must not be used in the names of any other objects.

Allowed values: "0", "1" (default value)

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

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.

The xx characters in the file name are placeholders. They stand for the two-character abbreviation of the respective Windows version.

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".

Allowed values: ALL (default value), NONE, CONTROLS

"ALL" = The complete message file is held in the RAM.
"NONE" = Always read from the hard drive.
"CONTROLS" = All language-dependent strings that are required in order to display the dialog program are held in the RAM (not relevant for the agent).

The path and the name of the interpreter that processes the script.

Default value: powershell.exe -NonInteractive -ExecutionPolicy bypass -NoLogo -file

With the default setting, Windows jobs, starting with "Interpreter" selection are able execute PowerShell commands. The parameter " -ExecutionPolicy bypass " guarantees that the generated script (Windows job) will run regardless of security settings setup by the administrator.

When this parameter is not set, the Windows administrator must explicitly allow starting Powershell scripts on host. Otherwise Powershell jobs won't be able to start.

Also refer to the information contained on Microsoft's website regarding Powershell execution policies: https://technet.microsoft.com/library/hh847748.aspx

File ends should be specified without dot.

Default value: ps1

Allowed values: INCL, EXCL

"INCL" = Access must be allowed for every single user that is specified in [USERID]
"EXCL" = Access is denied to users that are specified in [USERID]. All other users can start jobs.

useJobObject=

The setting jobs starts in a Windows Job object. The value that are defined here serves as the default value for all AE jobs under Windows. A setting that should apply for a particular job can be specified in the Job tab.

Allowed values: "0" and "1"

"0" - The Windows Job object is not used.
"1" - The Windows Job object is used. More information about the job and its sub-jobs is available. The improved restart options are an advantage. Note that the AE job will only end when all sub-jobs have ended.

HomeDirCache=

You can use this parameter to determine whether the home directory of the login user is stored.

Specify a period of time (in minutes) after which the agent should store the name of the home directory. This will increase performance. If you use "0", this information is not stored.

Default value: 10 minutes

Note that any changes that are made in the home directory only become effective after the specified period of time.

ft_temp_file=

This parameter creates temporary files in FileTransfers.

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 originating from the RunID. The new file transfer additionally appends a file ID 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.

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

Allowed values:

"y" - 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.

"n" (default) - No check is made.

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

When this parameter is set, the Windows Agent skips NetGetDCName() and NetUserGetInfo() to determine the user home.

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

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.

[STATUS_CHECK]

time=

The internal timing cycle in which the system checks whether the job has already ended (provided that it runs in a ).

Default value: 1 second

The agent's internal job table is checked in this interval. It depends on a job's runtime whether a status check is made. The job is checked during its execution at ever increasing time interval (doubling the value "time"). These intervals never exceed the value specified for the agent with JOB_CHECKINTERVAL in the host characteristics.

For example: time=1, JOB_CHECKINTERVAL=60
The job table is checked each second
Status check after: 1s, 2s, 4s,..., 60s, 60s....

[USERID]

The specification of authorized Windows users in the format:
User name/Domain=START

Specification of unauthorized Windows users in the format:
User name/Domain=NO_START

[VARIABLES]

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

[TRACE]

The path and the file name of the trace file.

The xx characters in the file name are placeholders. They stand for the two-digit abbreviation of the particular Windows version.

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.

bindaddr=

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

Use this parameter when the connection should be established via a particular IP address (for example, 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 made in bindaddr= are then ignored.

bindlocal=

Consideration of the local host (127.0.0.1).

Use this parameter together 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 time interval in seconds in which the agent tries to establish connection to the Automation Engines. This affects the connection setup for a restart or after a lost connection.

Default value: 60 seconds

This parameter is only effective until the first successful logon to the AE system. Afterwards, you can use the parameter RECONNECT_TIME in the host characteristics.

report=

The time interval in seconds in which the agent sends the logging to the Automation Engine.

Default value: 60 seconds

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

Default value: 500 000

cp=

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

SendBufferSize=

The size of the TCP/IP input buffer for messages that should be sent (Byte).

Default value: 1048576 Byte

RecvBufferSize=

The size of the TCP/IP input buffer for messages that should be received (Byte).

Default value: 1048576 Byte

Used to set TcpKeepAlive on socket level of the operating system.

Default value: yes

[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.

[CP_LIST]

The list of communication processes.

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

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

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

Definition of whether the execution of the Windows commands of backend-type Variable objects should be shown on the desktop.

Allowed values:

"0" (default) or "1"

"0" - Commands of backend-type variables run in the background.

"1" - Commands are shown on the desktop.

This function is only available when the Windows agent has not been started via a ServiceManager (the option "Show job on desktop" of Windows jobs reacts in the same way). The commands are shown on the agent desktop.

Activating this parameter is only useful when the agent has not been started with the system user.