Manually install Agent Client Collector on macOS

task australia Updated Sep 10, 2026 2 min read acc-install-macOS-manual.md
Raw file servicenow.com

Install Agent Client Collector manually on a machine that uses macOS when the agent is not connected to the instance or you want enhanced customization options.

Before you begin

  • Ensure that you have configured the Agent Client Collector web server.
  • Verify that your server's OS and version matches the list of supported OS versions as described in Agent Client Collector Installation.
  • (Optional): Enable golden image mode for cloning additional agents by setting the golden image marker located at /Library/Preferences/acc.rc.plist.
  • Navigate to Agent Client Collector > Deployment > Agent Downloads and download the signed .pkg relevant for your OS.
  • Store the .pkg installation package on one of your installed agents.

Role required: agent_client_collector_admin

Procedure

  1. Download the installation files to your local machine.

    Shell
    curl -L <download link from the Agent Downloads page on the instance>
  2. Validate the installation file signature.

    Text
    pkgutil --check-signature agent-client-collector-<version number>-macos-catalina_x64.pkg

    Note: Ensure that the pkg certificate chain has the ServiceNow developer ID installer certificate.

  3. Install the Agent Client Collector package.

    Shell
    sudo installer -pkg agent-client-collector-<version number>-macos-catalina_x64.pkg -target /
  4. Copy the installation files.

    1. Sample configuration file:

      sudo cp -p /Library/Application\ Support/servicenow/agent-client-collector/acc.yml.example /Library/Application\ Support/servicenow/agent-client-collector/acc.yml

    2. Sample allow list file:

      sudo cp -p /Library/Application\ Support/servicenow/agent-client-collector/check-allow-list.json.default /Library/Application\ Support/servicenow/agent-client-collector/check-allow-list.json

  5. To create new check definitions to be included in the allow list, first disable the allow list by commenting out the allow-list parameter in the acc.yml file.

    sudo -H -u _servicenow vi /Library/Application\ Support/servicenow/agent-client-collector/acc.yml

    Note: This action compromises your system's security and is recommended only as a temporary measure until you finish updating the allow list. After completing the update, uncomment the allow list parameter in the configuration file to re-activate the allow list.

    For details on adding custom checks to an allow list, see Generate an Agent Client Collector allowlist.

  6. Save the configuration file.

  7. In the configuration file, connect the agent with the MID Server.

    1. Set the MID Server connection.

      Text
      "wss://<MID Server IP>:<Web Socket Port>/ws/events"

      The web socket port was configured on the MID Server when it was set as an Agent Client Collector listener.

    2. Locate the api-key parameter and specify the API key value inside double quotation marks, as follows:

      api-key:"111111111"

      The specified API key is encrypted the first time the agent runs.

  8. To ensure that the configuration file points to a valid endpoint, run the following commands to restart the Agent Client Collector:

    Shell
    sudo launchctl unload -w /Library/LaunchDaemons/com.sn.acc.plistsudo launchctl load -w /Library/LaunchDaemons/com.sn.acc.plist

    Note: By default, exiting the installation program causes the program to restart immediately. To ensure that the program remains stopped after exiting, set the KeepAlive property in the /Library/LaunchDaemons/com.sn.acc.plist file to false.

Parent Topic:Agent Client Collector installation on a macOS system

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