Configuring the Agent

Owned by lsh (Unlicensed)
Last updated: Dec 02, 2021 by Emil Froeding - ENF
3 min read

Introduction

Each Configuration Management Point and Server has its own Agent Configuration.  The Agent configuration defines how the agent connects to the Management Server and defines the intervals for running the agent service.


Agent Configurations are inherited from the parent by default.

  • When creating a new Management Point it will inherit the configuration from the Agent Template,
  • When creating a new Management Server it will inherit the configuration from its parent Management Point.


To access and edit the configuration 

  • Right Click The relevant Configuration Management Point or Server and select → Configure Agent in the drop-down menu

 Client Configuration

 Click here to expand...

Element

Description

Management Server

Management Server in which the client will communicate with.

FQDNThe Fully Qualified Domain Name of the Management Server

CapaInstaller Root folder

The root folder for CapaInstaller, typically %ProgramFiles%\CapaInstaller.

User Client folder

Location for the user agent. NTFS Security will be applied for interactive users on the specified folder.

User Client log folder

Location for the logs files for the user agent. NTFS Security will be applied for interactive users on the specified folder.

Client log folder

Location for the logs files for the agent. Logs for installed packages also reside here.

Enable Front-end service for agent communication

Used to signal if the agent should use the Front-end service on the Management Server to communicate with

Note: This setting cannot be reverted when enabled.

Note: This setting cannot be set on the Point. It has to be set individually for each Management Server

Info center language

The language of CapaInstaller InfoCenter. This can follow the user’s regional settings, Windows language or defined language.

For most users, it will be convenient to use regional settings (Use input language)

Expand the drop-down list to see which languages are supported.

In case of an unsupported language, the CapaInstaller InfoCenter will default to English.


Enable Management Portal integration


If you have a Management Portal you can enable this property to provide an extra menu item in InfoCenter.

Clicking this menu item will launch a web browser and attempt to show the inserted URL. InfoCenter supports 3 variables that will be replaced with local values. Available variables are %UUID%, %COMPUTERNAME% and %MPTOKEN%.   

When inserting a URL make sure to use the proper variable at the proper location as there is no validation on this field.

Example: https://[domain]/ManagementPortal/LandingPage/index?token=%mptoken%

Use balloon messages

Balloon messages are Messenger like popup message that rises from the system tray giving both messages and questions requiring input from the user.

Removing the check will cause ordinary message boxes to be displayed.


Use graphical buttons

When checked, the InfoCenter balloon message will display images corresponding to ordinary buttons.

When not checked, ordinary buttons as OK and Cancel buttons will be displayed.

Note. This checkbox has no effect if “Use balloon messages” is unchecked.


Automatically run user agent after startup

Automatically run the user agent when the CapaInstaller InfoCenter starts.

Prevent the user from closing InfoCenter

Prevent users from closing the info center by disabling the Exit menu.

Hide system tray icon

Hides the CapaInstaller InfoCenter system tray icon. Will only be displayed when a message is displayed.

 Service Configuration

 Click here to expand...

Element

Description

Service Type

If the computers and the Management Server are within the same domain, we recommend using Local System as the Agent service account.


If the computers and the Management Server are in a different domain, in a workgroup, use a named account.


If the user is a non-domain user, the user will be created as a local user. The same user will be created on the Management Server and granted rights to the share.

It is crucial that the username and password are the same on both the agent computer and the Management Server in order to make use of pre-cached credentials.


Interval

Amount of seconds between each scheduled agent execution. The default is 14400 seconds ~ 4 hours.


Retry Interval

The interval in seconds between each retry if the agent is unable to execute.

Delay

Delay in seconds between service starts an agent executes.

Health check interval

Amount of minutes between each Health check agent execution. The default is 240 minutes ~ 4 hours.

 Dependent Services

 Click here to expand...

Element

Description

Dependent services

Services that must be started before the agent service will execute the agent.

The dependent services are not set as services that must be started before the agent service is started.

The agent service will start and wait for these services to start before executing the agent.