Modifying agent settings

After an agent is installed, you can modify its settings.

Before you begin

You must have administrative privileges to modify agent settings

About this task

Most settings are configured during installation but you can edit them any time after installation. From the Agents List window you can manage installed agents. The table filters at the beginning of the agent table allows you to locate a specific agent or narrow the list displayed. You can filter by agent name, host name, status, time frame the agent was used, and available, configured or ignored agents.

Procedure

  1. Click Agents and the Agent List window displays.
  2. Click the name of the agent to view and modify agent properties.
  3. On the Main tab, settings that define the agent and connection are displayed. You can modify the following settings. Click Save when finished.
    Name
    The current name of the agent was given during the installation process. The agent is automatically updated if the name is changed.
    Configured
    Enable to indicate that the agent is configured.
    Throughput Metric
    The throughput metric is an arbitrary integer that indicates the ability of an agent relative to other agents to handle extra work. An agent with a metric of 10, for example, usually gets more work before an agent with a metric of 1. A weight is applied to the agent by using a formula based on throughput and the number of active jobs. The formula is Weight = Throughput / (Number of Active Jobs + 1).
    Maximum Number of Jobs
    The maximum number of concurrent jobs the agent runs. If an agent reaches the maximum number of jobs, extra requests are queued until a job finishes.
    Agents Pools
    The agent pools to which the agent is assigned.
  4. Click the Properties tab, to view, edit, remove, and add properties to the agent.
    Agent properties are used to configure builds or other process to use values that depend on the agent that is doing the work. For example, an agent property can use an agent's local settings during a build. Agent properties are resolved at run time on the agent. Secure property values are obfuscated in logs.
    • To remove a property, click the delete icon (deltete icon) under the Actions column to the right of the desired property name.
    • To edit the property, click the edit icon (oredit icon ). You can modify the property name and value in the Edit Property window. Click Save when finished.
    • Click Add Property. The New Property windows displays. Click Save when finished.
    Property Name
    Type a name for the property.
    Secure
    Click the check box to make the property secure.
    Property Value
    Type a value for the property. If you create a secure property, the typed value is obfuscated and must be retyped in the Confirm Value field
  5. To view, edit, and create an agent environment variable, click the Environment tab.
    Agent environment variables are set during agent installation and stored on the server.
    • To remove an environment variable, click the delete icon (deltete icon) under the Actions column to the right of the desired environment. Secure environments variables cannot be deleted.
    • To edit an environment variable, click the edit icon (edit icon ). You can modify the environments value in the Edit Environments Variables window.
    • Click Add Environment Variable and the Add Environment Variable windows displays.
    Variable Name
    Type a name for the variable.
    Secure
    Click the check box to make the variable secure. If you create a secure variable, the typed value is obfuscated and must be retyped in the Confirm Value field.
    Variable Value
    Type a value for the property.
  6. To view locked properties, click Locked Properties.
    The Locked Properties page lists the agent's locked properties. Locked properties cannot be edited.
  7. To view system properties, click System Properties.
    The System Properties page lists the agent's system properties. System properties cannot be edited.
  8. To set the cache location for the CodeStation repository used by the agent, click the CodeStation tab.
    Type the location of the cache in the Cache Location field. The default value is agent_installation_directory/.codestation/cache. Click Save.
  9. Click Done when finished.