Agent Client Collector upgrade properties
System properties that control Agent Client Collector upgrade behavior, including the target version, rate limits, retry logic, and timeouts.
Selective upgrade properties
Set these properties before running any selective upgrade. Navigate to All > System Properties > All Properties and search for each property name.
| Property | Value | Description |
|---|---|---|
| sn_agent.auto_upgrade.enabled | true | Enables the upgrade feature. Set to true before running any upgrade, manual or scheduled. |
| sn_agent.agent_upgrade_version | Target version, for example 5.0.1 | The version agents upgrade to. If empty, the system uses the current Agent Client Collector Framework application version. Must be a valid version number. |
Optional properties
These properties have default values suitable for most environments. Adjust them only when your environment requires different rate limits or timeout thresholds.
| Property | Default | Description |
|---|---|---|
| sn_agent.auto_upgrade.max_upgrades_per_hour | 1000 | Maximum agents upgraded per job run across all MID Servers. Lower this value for a more gradual rollout pace. |
| sn_agent.auto_upgrade.max_upgrades_per_handler_per_hour | 50 | Maximum agents upgraded through a single MID Server per job run. Prevents overloading individual MID Servers. |
| sn_agent.auto_upgrade.retry_limit | 3 | Number of times the system retries a failed upgrade before permanently skipping the agent. After an agent reaches this limit, reset the failed_upgrade_attempts field on the Agent Extended Info record to allow retries. |
| sn_agent.agent_upgrade_wait_time | 30 | Minutes the system waits for an agent to complete its upgrade before marking it as failed and transitioning the agent to Warning status. |
| sn_agent.upgrade.timeout_minutes | 10 | Minutes allowed for the initial upgrade validation check on the agent (AgentVerification stage). |
| sn_agent.min_upgrade_history_per_agent | 2 | Number of upgrade history records retained per agent. Older records are automatically removed. |
Property usage note
The sn_agent.agent_upgrade_version property is specifically for overriding the upgrade target version. The sn_agent.agent_version property controls package download URLs, version display, and other system behaviors. Use sn_agent.agent_upgrade_version when you want to target a specific version for upgrades without affecting other system behavior.
Parent Topic:Agent Client Collector Framework reference