Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

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

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. Run the following command in a terminal window: acc gateway mid <flags>.

    The available flags appear in the following table:

  1. 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

sndocs is an independent community mirror and is not affiliated with or endorsed by ServiceNow.

ServiceNow, the ServiceNow logo, Now, and other ServiceNow marks are trademarks and/or registered trademarks of ServiceNow, Inc., in the United States and/or other countries. Other company and product names may be trademarks of the respective companies with which they are associated.

© 2026 ServiceNow, Inc. All rights reserved.

Documentation content is redistributed under the Apache License 2.0 from the ServiceNowDocs repository.

FlagTypeDescription
-y, <--acc-yml>StringLocation 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>StringThe API key to be used by the MID Server.
-b, <--backend-url>StringOne 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, `,`.
-h, helpN/AExplains what the specified command does.