Will Hallam
ServiceNow Employee
ServiceNow Employee

Introduction

Agent Client Collector, ServiceNow's all-purpose host agent, is meant to connect to one ServiceNow instance at a time.  This article covers the steps involved with taking a running agent and pointing it at a different ServiceNow instance.

Configure Target MID Server

Agent Client Collector communicates with the ServiceNow platform via a MID (Management, Instrumentation, Discovery) server, so prior to attaching any agents you must have at least one MID on your instance with a websocket endpoint configured.  Accomplish this by clicking the "Setup ACC Listener" related link on the MID server record page.

snip1.JPG

NOTE: If you are running multiple MIDs on the same server, you must select a different port for each MID websocket endpoint.

Collect Data

In order to migrate a running agent from one ServiceNow instance to another, you must have the following information from the new instance:

1 - MID server web socket URL, obtained via Agent Client Collector->Deployment->Websocket Endpoint

snip2.JPG

2 - MID server web socket API key, obtained via Agent Client Collector->Deployment->MID Web Server API Key

snip3.JPG

 

Once you have those two pieces of information, you are ready to repoint the agent.

Modify Agent Configuration

Aligning an Agent Client Collector with a different ServiceNow instance consists of modifying it's config file, "acc.yml", then restarting the agent.

 

Start by making a backup copy of the existing acc.yml file.  By default it is installed under /etc/servicenow/agent-client-collector on Linux and c:/ProgramData/ServiceNow/agent-client-collector/config.

 

Now remove or move aside the mid selection files, "mid.list.json", and "mid.selection.metadata.json".

 

Next, modify the acc.yml file as follows:

1 - Modify the key/value pair which starts with "backend-url:" such that the value is the MID web socket URL you retrieved above.

2 - Modify the key/value pair which starts with "api-key:" such that the value is the MID web socket API key you retrieved above.

snip4.JPG

Restart ACC

After updating the agent configuration, restart the agent service using the applicable method for the server OS.

Version history
Last update:
‎12-13-2023 08:39 AM
Updated by:
Contributors