---
sourceDocument: Xanadu IT Operations Management
sourceDocumentLink: https://www.servicenow.com/docs/r/xanadu/it-operations-management

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# Agent Client Collector installation

# Agent Client Collector installation {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes to read

You can install the Agent Client Collector on any supported host machine. The Agent Client Collector connects to a MID Server using the HTTP/S protocol, and the connection remains active after being established. One MID Server may handle several agents simultaneously, while a single agent works with one MID Server at a time and switches to a different MID Server when necessary to provide failover protection.

When an agent's IP address changes, it selects a MID Server to connect to based on the agent's MID Server list.

The maximum number of agents that can be connected to a single MID Server is configurable in the sn_agent.mid.max_allowed_agents
MID Server property. The default value is 4,000.

On Windows, run the agent service as gMSA, LocalService, or Local system accounts.

On Linux and macOS, run the agent as a system account.

For ACC-V, a default 1 GiB MID Server can support 700 agents concurrently. An 8 GiB configuration for MID Server can support 8,000 agents concurrently. You can also scale out. For example, 5 MID Servers with 8 GiB of heap size can handle up to 40k agents.

If you completely reinstall the agent on a single host server, a second agent record registers on the instance. Delete the original agent on the Agent Client Collectors page (AllAgent Client CollectorAgents).

Agents whose Status = Down or Disconnected which haven't been deleted are deleted automatically after 30 days. You can modify this setting on the Autoflush form page (see [Autoflush form](https://www.servicenow.com/docs/access?context=atf-auto-flush&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US)).

Before installing the Agent Client Collector, you must do the following:

* Ensure that one or more MID Servers are properly registered and validated with your instance, to be available for an agent connection request. For details, see [Configuring MID Servers](https://www.servicenow.com/docs/access?context=c_MIDServerConfiguration&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US). In a staging environment, you need only one MID Server. However, in a production environment, configure at least two MID Servers to support zero-touch configuration and ensure that a MID Server is always available if one fails.
* Ensure that there's a validated connection from the designated server where you're installing the agent to the MID Server.
* Ensure that the MID Server port on which the Agent Client Collector listener runs is accessible.
* Ensure that the following plugins are installed on your instance.For ACC-V:

  * Agent Client Collector for Visibility
  * Agent Client Collector Framework
  * Discovery \[com.snc.discovery\] plugin

  {#acc-installation__ul_yr1_5vx_bpb}

  For ACC-M:
  * Agent Client Collector Framework
  * Agent Client Collector Monitoring
  * Event Management and Service Mapping Core
  * Metric Intelligence - com.snc.sa.metric plugin

  {#acc-installation__ul_vvc_4jt_ylb}

  For ACC-L:
  * Agent Client Collector Log Analytics
  * Health Log Analytics

  {#acc-installation__ul_xjd_hsf_hsb}

  For DEX: ITOM Cloud Services

  You can verify that these plugins are installed on the System DefinitionsPlugins page.
* All plugins that come with the base system are signed with the ServiceNow certificate. Optionally, you can use custom plugins and sign them using your own certificate, as described in [Enable OpenSSL secure signing for plugins](https://www.servicenow.com/docs/AtsI6Gj7g1M~jQ4qVvbgyw "Create a self-signed certificate for an Agent Client Collector plugin. The following procedure gives an example of how to create an x509 certificate using OpenSSL. For other certificate types, consult OpenSSL documentation.").

* Ensure that your system has the minimum requirements for agent installation.{#acc-installation__table_xfj_pz4_hbc__entry__2}

  | Agent Client Collector component | Requirements |
  |-|-|
  | Agent Client Collector Framework | * 1 GB RAM * 300 MB free disk space * 1 CPU core {#acc-installation__ul_zwz_5z4_hbc} |
  | Agent Client Collector Monitoring | * 1 GB RAM * 1 GB free disk space * 1 CPU core {#acc-installation__ul_lvm_jyc_3bc} |
  | Agent Client Collector for Visibility | * 1 GB RAM * 1 GB free disk space * 1 CPU core {#acc-installation__ul_lq2_yz4_hbc} |
  [Table 1. Minimum installation requirements]

  {#acc-installation__table_xfj_pz4_hbc}
* Ensure that you are installing Agent Client Collector on one of the supported operating system distributions:{#acc-installation__table_ids_3rw_ywb__entry__2}

  | Operating System | Distribution |
  |-|-|
  | Linux | * Red Hat Enterprise Linux - RHEL and Oracle Linux - OL 7, 8, 9 * CentOS 7, CentOS Stream 8 and 9 * SLES 12, 15 * Debian 9, 10, 11 * Ubuntu 18.04, 20.04, 22.04, 24.04 LTS * Amazon Linux 2 AMIs * Amazon 2023 {#acc-installation__ul_s1q_krw_ywb} |
  | Windows (ACC-M and ACC-L are supported only on servers, not endpoints) | * Windows Server 2012, 2012r2, 2016, 2019, 2022 * Windows 10 Enterprise Edition * Windows 11 Professional and Enterprise * Windows 11 Surface on ARM64 {#acc-installation__ul_lmy_jrw_ywb} |
  | macOS (on both x86_64 and arm64 (Apple Silicon) architectures. ACC-M and ACC-L are supported only on servers, not endpoints) | * Catalina * Big Sur * Monterey * Ventura {#acc-installation__ul_hng_jrw_ywb} |
  [Table 2. Supported Operating System Distributions]

  {#acc-installation__table_ids_3rw_ywb}{#acc-installation__os-supported}
{#acc-installation__os-supported}

{#acc-installation__ul_s25_4th_xkb}  
Important:  
All supported operating systems only work with the x86-64 CPU architecture type. ACC-F v3.1.1 also adds native support for ARM64 on Apple Silicon architectures. For the latest information, see the [Agent Client Collection on non- x86-64 computers and embedded boards \[KB1172387\]](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB1172387) article in the Now Support Knowledge Base.

When using ACC-L: The Agent Client Collector comes with the default servicenow user. Ensure that this user has read access to enable Agent Client Collector to view all the configured log paths. For example, the Agent Client Collector servicenow user that comes installed with the base system does not have permissions to view the paths to /var/log/ in Linux and C:\\Windows\\System32 in Windows. For information about configuring permissions for the servicenow user, see the [ACC-L Permission Denied issues
\[KB1117271\]](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB1117271) article in the Now Support Knowledge Base.

When determining the number of machines and servers needed to support your agents (such as the number of machines requiring proxy agents), you must consider the agents' performance KPIs. For
details on agent performance KPIs, see [Agent Client Collector performance and footprint for URL monitoring](https://www.servicenow.com/docs/YdqodZqfHoogla2exgQ~2Q "The following tables display the agent performance KPIs and its footprint on the host during URL monitoring data collection execution on different operation systems.").

For details on using Agent Client Collector in an air-gapped
environment, see the [Agent Client Collector Framework Air Gapped
Configuration Item Management Solution \[KB1585753\]](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB1585753) article in the Now Support Knowledge Base.

Agent Client Collector supports domain separation. The domain of the agent and the CIs it creates is determined by the domain of the MID Server that the agent is connected to. The user's domain must be the lowest domain level (known as a leaf domain) to enable creating a Websocket endpoint extension for the MID Server.
**Related concepts**   

* [Agent Client Collector installation on a Linux OS system](https://www.servicenow.com/docs/eSF0HFu0zPSDWAj8jYiuYg "Install Agent Client Collector on a system that uses a Linux OS, either using a single-line command script, or following the installation procedure to embed in your own package distribution mechanism. The installation procedure provides consistency when using package distribution solutions.")  
**Related tasks**   

* [Install the Agent Client Collector on a Windows machine manually](https://www.servicenow.com/docs/xyMLIlDbdNb9hLq0YlzI6w "Install the Agent Client Collector on a Windows machine manually when you want to test the agent on a single system.")

*[\>]: and then