Agent Version Control
    • Dark
      Light
    • PDF

    Agent Version Control

    • Dark
      Light
    • PDF

    Article summary

    Warning: changes will update existing Agents

    Changes to version control settings can potentially affect every device in your environment. Apply version control settings carefully.

    Windows and macOS Agents use an Agent Manager which automatically installs and updates the Agent according to your version control settings. Other OS platforms do not have an Agent Manager or built-in version control.

    By default, Windows and macOS Agents are automatically updated when a new GA version is released. To edit your version control settings, go to Configuration > Settings > Agent > Version Control. To access these settings, you must have the permission Configure Production Agent Versions.
    AccessVersionControlSessions.png

    Note

    If you chose to install the Agent directly without using the Agent Manager, then the Agent will automatically install the Agent Manager if Use Agent Version Control is enabled.

    Set the default Agent version

    The default Agent version is installed on every device unless the device meets the conditions of a version deployment rule. Read below to learn about deployment rules.

    To set the default Agent version:

    1. Select an Agent version from the dropdown under Global Default. You can select the default version for Windows and macOS independently.
      GlobalDefault.png

    2. Click Save Agent Versions.

    Agent version deployment rules

    Note

    This feature is available only if you set the Global Default Agent version to version 2.12 or higher.

    If you don't want to install the same Agent version on every device, you can create Version Deployment Rules. A version deployment rule consists of a set of conditions (device groups and tags) and a specified Agent version. If a device meets the conditions for a rule, then the specified Agent version for that rule is installed on the device.

    A device meets the conditions for a rule if it has any of the specified tags OR is in one of the specified groups. If a device does not meet the conditions for any rules, then the default Agent version is installed.

    The Agent Manager checks if a device meets a version deployment rule in the order that the rules appear in the version control settings page. This means that the order in which you add rules is important. For example, if a device meets the conditions for rules 2 and 4, then the Agent version for rule 2 is installed.

    To create a version deployment rule:

    1. Under Windows or macOS, click Add Version Deployment Rules. You can create rules for Windows and macOS independently.

    2. Select the Agent version for the rule.

    3. Click Add Tags or Add Groups to add device conditions.
      VersionDeploymentRule.png

    4. Click Save Agent Versions.

    Advanced options

    When configuring the default Agent version or a version deployment rule, you can enable Advanced Options if you need more control over the timing of Agent installation.

    By default, if you don't enable advanced options, then devices download and install the Agent very soon after you update your version control settings or a new GA Agent version is released (the Agent Manager checks for updates every 5 minutes). If you have many devices, then this could strain your network.

    Advanced options let you define an installation period by setting:

    • When to start installing Agents.
    • The number of days to spread out Agent installation.
    • The hours of the day to install Agents.

    Devices are randomly selected for Agent installation evenly throughout the installation period. If a device hasn't been updated by the end of the installation period for any reason (for example, if the device was offline), then the device is immediately updated regardless of the time of day.

    To define an installation period:

    1. Select Enable Advanced Options.
      EnableAdvancedOptions.png

    2. If you want to limit the times of day to install Agents, deselect Anytime and enter a time range. Agent installation occurs within the time range you select in each device's local time zone. A device must be powered on and connected to your tenant to install the Agent, so you should select hours when devices are likely to be online.

    3. Choose the day to start installing Agents. The way you do this is different depending on whether you have selected a specific Agent version or the latest GA version.

      • If you have selected a specific Agent version, use the date picker to select the day to start installing Agents.
      • If you have selected the latest GA version, select the number of days after the GA release to start installing Agents.
    4. Select the number of days over which to spread Agent installation. Agent installation starts on the day you selected in step 3 and finishes after the number of days you set here.

    5. Click Save Agent Versions.

    Example

    Let's say you configure the latest GA version to install between the hours of 6 pm - 6 am, 14 days after the release, spread over 10 days.
    ExampleSettings.png

    If a new GA version releases on the 1st day of the month, Agent installation starts on the 14th day of the month at 12 am midnight. Roughly 10% of devices are updated each day between the hours of 6 pm - 6 am. On the 24th day of the month (14 + 10), the final 10% of devices are updated. If a targeted device was offline and didn't get updated, but comes online on the 26th day of the month, it is updated immediately.


    Was this article helpful?