Perform high-volume Agent Client Collector upgrade

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 2 minutes de lecture

    • Perform high-volume upgrade of your Agent Client Collector agents when you want to upgrade all of your agents at one time.

    Avant de commencer

    Configure the Agent Client Collector web server. For details, see Configure the websocket server on the MID Server.

    Ensure that the MID Server, MID Web Server, and the MID Server websocket server are running.

    Select the version to which you want to upgrade your agent.
    1. Navigate to All > System Properties > All Properties.
    2. Select New.
    3. Assign the following values:
      • Name = sn_agent.agent_upgrade_version
      • Type = string
      • Value = The version number to be upgraded to, in the format <major_version.minor_version.patch_version>. For example: 4.3.2
    4. Select Submit.
    If you do not select a version, the agent automatically upgrades to the current Agent Client Collector Framework scoped app version.
    Roles required: agent_client_collector_admin
    • In a Windows environment: Local SYSTEM account
    • In a Linux environment: sudo rpm/dpkg
    • In a macOS environment: sudo pkg

    Pourquoi et quand exécuter cette tâche

    High-volume upgrade is supported only in a Windows or Linux environment.

    High-volume upgrade does not support Agent Client Collector to MID Server communication via mTLS.

    When performing high-volume upgrade, all agents that aren't using the most up-to-date version are upgraded. No upgrade is performed on agents already using the upgraded version.

    No upgrade is performed on agents that are outside the application scope. For more information, see Application scope.

    An agent is excluded from high-volume upgrade when you reach the failed upgrade limit for an agent. The failed upgrade limit is specified in the sn_agent.auto_upgrade.retry_limit system property. The default value for this property is 3.
    • This property applies to both high-volume and selective upgrades that have failed.
    • When an agent reaches the failed upgrade limit, an Agent Client Collector administrator can still run selective upgrade on the agent.
    • You can manually reset the failed upgrade limit by selecting the Reset failed upgrade attempts option on the agent page (select All > Agent Client Collector > Agents and select an agent).
    • After a successful upgrade, the upgraded agent is considered to have zero failed upgrades (for future upgrades).

    Procédure

    1. Verify that the version number you want to upgrade to is available.
      1. Navigate to All > System Properties > All Properties.
      2. Locate the sn_agent.agent_version property.
        Verify that the version number displayed is a valid agent version, representing the version that the agent will be upgraded to. If the version number is not valid, the version updates to the sn_agent.agent_version number.
    2. Enable the property on the System Properties table (All > System Properties > All Properties) to activate the upgrade.
      1. Locate the sn_agent.auto_upgrade.enabled property.
      2. Set the property value to true.
        Upgrading starts within one minute of enabling the property.

    Résultats

    • For agents connected to a MID Server: The scheduled job upgrades 50 agents on each MID Server per hour. The maximum number of agents that can be upgraded at a time for all MID Servers is 1,000.
    • For MID-less agents: The scheduled job upgrades up to 1,000 agents per hour by default.
    • For both MID Server and MID-less agents: To modify the number of agents being upgraded at a time, update the value of the sn_agent.auto_upgrade.max_upgrades_per_handler_per_hour property (All > System Properties > All Properties). The default value is 1,000.
      Remarque :
      Modifying this value can negatively impact system performance.

    To modify the frequency of the upgrade, update the value of the Repeat Interval in the Upgrade Agents Incrementally scheduled job (All > System Definition > Scheduled Jobs).