Configure an Agent Client Collector with a MID Server using a single-line command

task australia Updated Sep 10, 2026 1 min read configure-acc-with-mid.md
Raw file servicenow.com

Use a single-line command to set up an Agent Client Collector with a MID Server. You can also use the single-line command to migrate agents with MID-less configuration to be used with a MID Server.

Before you begin

Role required:

  • In a Linux or macOS environment: root
  • In a Windows environment: agent_client_collector_admin

About this task

Running the single-line command includes flags, which indicate the options to be added to the acc.yml configuration file. These options dictate the configuration of the Agent Client Collector with the MID Server. If you don’t specify an option in the command, the existing option in the acc.yml file is used. If there’s no existing option, an error message indicates that the parameter is required to enable connecting to an endpoint.

Running a command validates that a connection can be made with the specified parameter (for example, the specified api-key value). However, the command doesn’t verify if the value of the parameter is valid.

Procedure

  1. In a terminal window, navigate to the Agent Client Collector installation location:

    • Linux: /usr/share/servicenow/agent-client-collector/bin/

    • macOS: /opt/servicenow/agent-client-collector/bin

    • Windows: C:\Program Files\ServiceNow\agent-client-collector\bin

  2. Run the following command: acc gateway mid <flags>.

    For example (replace with your actual values): acc gateway mid -a fbhsbnxdbshs635oo -b wss://1.2.3.4:8800.

    The available flags appear in the following table:

Flag

Type

Description

-y, <--acc-yml>

String

Location of the acc.yml being configured. Can also be used to modify and validate parameters if the file is in a different location that the default.Optional. If no value is entered, the default location of the acc.yml file is used.

-a, <--api-key>

String

The API key to be used by the MID Server.

-b, <--backend-url>

String

One or more backend connection URLs specifying a websocket endpoint to a MID Server. Multiple values are specified using commas between entries with no spaces separating the values; for example, <url1>,<url2>.

-h, help

N/A

Explains what the specified command does.

3. Restart the agent for the configuration settings to be entered into the `acc.yml` file.

Parent Topic:Configuring Agent Client Collector with a MID Server

Search documentation
Search document titles and file paths on the australia branch