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

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# Install ACC on a Windows machine manually

# Install the Agent Client Collector on a Windows machine manually {#ariaid-title1}

* Release version: Yokohama
* 
* Updated August 17, 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 minutes to read

Install the Agent Client Collector on a Windows machine manually when you want to test the agent on a single system.

## Before you begin

1. Ensure that you've configured the Agent Client Collector web server. For details, see [Configure the websocket server on the MID Server](https://www.servicenow.com/docs/Nhz4taSWhPBGMQb4g~EIQg "Configure the websocket server on MID Servers to enable connections from agents to the MID Server. You can configure only one websocket server per MID Server.").
2. Verify your server's OS and version.
3. When using Microsoft Internet Explorer, do the following to prepare the Agent Client Collector installation file:
   1. Navigate to Server ManagerLocal Server.
   2. Turn off IE Enhanced Security Configuration.
   3. Download the installation file.
   4. Change the extension of the installation file from .man to .msi
   {#acc-install-windows__ol_o3l_jxy_j4b}
4. Ensure that .NET Framework 4.6.2 or later is installed on the target machine.  
   Note:  
   If the .NET Framework is not running effectively, use the legacy VBSript installer by running the following command on the target machine: `msiexec /i <msi_file_path> /quiet /qn /norestart USE_VBS_CA=1 ACC_API_KEY=<key_value> ACC_MID=wss://<mid_ip>:<websocket_port>/ws/events
   ACC_ALLOW_LIST=False`
5. Enable golden image mode for cloning additional agents by setting the msi property GOLDEN_IMAGE=true.
{#acc-install-windows__ol_nc5_dwy_ylb}

Role required: agent_client_collector_admin

## Procedure

1. Navigate to Agent Client CollectorAgent Downloads.
2. To perform installation using the wizard:
   1. Download the .msi file that is accessible from the link on the UI.  
      The Installation Wizard opens.
   2. Select Next until you reach the MID Web Server Connection Settings page.  

      <br />

   3. Enter the relevant parameters in the dialog box fields:  
      {#acc-install-windows__table_b4p_fxy_ylb__entry__2}

      | Field name | Description |
      |-|-|
      | MID Web Server Name/IP | IP address of the MID Web server. |
      | MID Web Server Port | Port number of the MID Web server. Use a number between 1024-49151. |
      | MID Web Server API Key | API key to access the MID Web server. |
      [Table 1. MID Web Server Connection Settings fields]

      {#acc-install-windows__table_b4p_fxy_ylb}
   4. Select Next.  
      The Create Local User Account page appears.  

      <br />

   5. Select the relevant option in the dialog box.  
      {#acc-install-windows__table_hdl_d1z_hkb__entry__2}

      | Option | Description |
      |-|-|
      | Use default user (servicenow) | Default user with which to run the Agent Client Collector on a Windows machine. Selecting this option creates a local user called servicenow as part of the installation. The servicenow user password is randomly generated and is not stored in the system. A security event is created on the host machine which, if repeated, requires opening a support case. For details, see [KB1649116](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB1649116) article in the HI Knowledge Base. |
      | Select existing user | When selecting this option, configure the following subfields: * User Name: User name to log in to the Windows environment. * Password: Password of the selected user. {#acc-install-windows__ul_l5p_szx_4lb} The user can be one of the following: * Local user (created by the virtual machine owner; provides added resiliency). * Domain user (created by IT personnel). * Group Managed Service Account (gMSA): Enter the name of the group managed service account in the User Name field and leave the Password field empty. * Local Service Account: Enter LOCALSERVICE in the User Name field and leave the Password field empty. * Local System Account: Enter SYSTEM in the User Name field and leave the Password field empty. Due to Windows UAC restrictions, running the agent as a local SYSTEM account is necessary to perform an upgrade via msiexec. {#acc-install-windows__ul_rbh_hyt_jyb} |
      [Table 2. Create Local User Account dialog box]

      {#acc-install-windows__table_hdl_d1z_hkb}  
      Note:  
      Using a Local System account creates the local group ServiceNow Users, and adds the created user to the group. The ServiceNow Users group has access to Agent Client Collector directories and has the following privileges:
      * Performance Monitor: Comes with the base system; enables viewing all performance counters in the system.
      * Log on as a service: Enables starting network services and services that run continuously, even when no one is logged onto the console.
      * Debug programs: Enables debugging processes and reading process details for users outside the ServiceNow user group.
      {#acc-install-windows__ul_sn4_yyl_flb}
   6. Select Create User.  
      The system creates a Windows user with the specified credentials, and the Agent Client Collector Configuration page appears.
   7. To enable the Allow-List containing the checks enabled to run after setup, select the Enable executing command allow list check box on the resulting page.  

      <br />

   8. Select Next to open the installation page.  
      When installation completes, click Next to complete
      and exit the wizard.

      After a successful installation, the service starts automatically and
      generates the following:
      * User: Default = servicenow (an existing user can also be configured to manage the service). The servicenow user belongs to the local user group ServiceNow Users.
      * Service: AgentClientCollector
      * File location:
        * Default for installation = C:\\Program Files\\ServiceNow\\agent-client-collector
        * Default for service files = C:\\ProgramData\\ServiceNow\\agent-client-collector, which holds the cache, config, and log folders.
        {#acc-install-windows__ul_vtn_v1z_1mb}
      {#acc-install-windows__ul_x52_4pr_1mb}
   {#acc-install-windows__substeps_lvc_rbz_ylb}
3. To run Silent installation to disable installation reports, run the command line appearing in the Silent installation section of the procedure, as follows:  
   `msiexec /i <msi_file_path> /quiet /qn /norestart ACC_API_KEY=<key_value> ACC_MID=wss://<mid_ip>:<websocket_port>/ws/events ACC_ALLOW_LIST=False`

   To enable the allow list of specified checks when running Silent installation, set the ACC_ALLOW_LIST parameter to True.
4. To configure multiple MID Servers with Silent installation, run the command line appearing in the Silent installation section of the procedure with comma-separated values, as follows:  
   `msiexec /i <msi_file_path> /quiet /qn /norestart
   ACC_API_KEY=<key_value>
   ACC_MID="wss://<mid1_ip>:<websocket1_port>/ws/events,wss://<mid2_ip>:<websocket2_port>/ws/events"`

   Insert the following parameter values in the command:
   {#acc-install-windows__table_al4_f4s_wlb__entry__2}

   | Parameter | Value |
   |-|-|
   | ACC_API_KEY | The API key used to access the MID Server websocket. |
   | ACC_MID | The URL of the MID Server websocket. |
   | DENY_LOCAL_LOGON | When set to True, prevents any user other than the default servicenow user from logging onto the service. Default value: False |
   | HTTPS_PROXY | A fully qualified URL to a proxy server. For example: https://proxy.url.net |
   | PAC_FILE | A readable filepath on the system. For example: /path/to/servicenow/readable/file |
   | PASSWORD_NEVER_EXPIRES | When set to True, the password for the default servicenow user never expires. Default value: False |
   | START_SERVICE | When set to True, the Agent Client Collector service automatically starts after installation. Default value: True |
   | LOCALUSERNAME | Account running the Agent Client Collector as a Windows service. Possible values: * SYSTEM * LOCALSERVICE * DOMAIN\\gMSA$ * string (local username) {#acc-install-windows__ul_j2k_ywt_hxb} Default = `servicenow` When using the SYSTEM, LOCALSERVICE, or DOMAIN\\gMSA$ accounts, you do not have to configure a password. |
   | LOCALPASSWORD | Password for the user specified in the LOCALUSERNAME parameter. |
   [Table 3. Command parameters]

   {#acc-install-windows__table_al4_f4s_wlb}

   The configured MID Server values are automatically
   added to the acc.yml file. The agent connects to the first
   available MID Server in the list.

   To configure a
   secondary MID server, enter the following syntax in the
   backend-url section of the acc.yml
   file, per the .yml standard: - "wss://\<MID IP\>:\<Web socket port\>/ws/events" (with the quotation
   marks).
* **[Upgrade the Agent Client Collector manually on a Linux system](https://www.servicenow.com/docs/w4KvxwOxLHtFEdQTGbEl1Q)**   
  Perform a manual upgrade of your existing Agent Client Collector version on a system running a Linux OS if the single-line command script is not connected to the instance or you want to use enhanced customization options.
* **[Uninstall the Agent Client Collector manually from a Windows machine](https://www.servicenow.com/docs/8EYUwPj2SiCUilfaP5WTnw)**   
  Uninstall the Agent Client Collector from a Windows machine manually instead of using the single-line procedure. Use the manual procedure if the command script is unavailable due to the specific agent not being connected to the instance.

*[\>]: and then