Agent Client Collector Spoke

  • Release version: Zurich
  • Updated July 31, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Agent Client Collector Spoke

    The Agent Client Collector spoke automates command execution on agents or configuration items (CIs) through the ServiceNow platform using the Agent Client Collector framework. Installed on target systems, the framework communicates output data back to ServiceNow via the MID Server, enabling streamlined remote management and monitoring.

    Show full answer Show less

    Key Features

    • Command Execution: Run commands on agents to retrieve system details, running processes, logged-on users, network statistics, and running services.
    • Agent Management: Actions to get agent status, restart agents, and install the Agent Client Collector framework on Linux and Windows hosts.
    • Security Monitoring: Pre-built subflows like SNH CyberAttack Detection to detect Windows server threats and notify administrators.
    • Compliance Automation: Subflows to manage compliance for remote workers with automated alerting on violations.
    • Integration with ServiceNow Flow Designer: Sample subflows provided can be customized in new application scopes to automate routine tasks.

    Requirements and Compatibility

    • Requires an Integration Hub subscription and MID Server configured with PowerShell capabilities.
    • Built for Agent Client Collector framework version 2.2.0; may support later versions.
    • Dependent plugins must be installed, including IntegrationHub Runtime, REST Action Step, Complex Object, Dynamic Inputs, ITOM Visibility License, and the Agent Client Collector framework itself.
    • For command execution on Linux, set ACCALLOWLIST=0; for Windows, set ACCALLOWLIST=False.
    • To install agents using spoke actions, define allowed IP addresses or ranges under Agent Client Collector Spoke > CIDR Ranges.

    Practical Application for ServiceNow Customers

    This spoke enables ServiceNow customers to automate remote system management and monitoring efficiently within their existing workflows. By leveraging the predefined actions and subflows, customers can improve operational responsiveness, ensure compliance, monitor security threats, and maintain system health with minimal manual intervention. Proper setup of the MID Server and adherence to dependency and configuration requirements are essential for effective use.

    Automate the process of executing commands on agents or configuration items (CI) using the ServiceNow Agent Client Collector spoke. Agent Client Collector framework allows you to execute commands on the systems where it is installed and sends output data to the ServiceNow® instance through the MID Server.

    Request apps on the Store

    Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    Integration Hub subscription

    This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.

    Spoke version

    Agent Client Collector spoke v1.2.0 is the latest version.

    Supported versions

    This spoke was built for Agent Client Collector framework v2.2.0, but may be compatible with later versions.

    Spoke dependencies

    If you’re having trouble installing the app, ensure that these dependent plugins are installed:
    • ServiceNow IntegrationHub Runtime (com.glide.hub.integration.runtime)
    • ServiceNow IntegrationHub Action Step - REST (com.glide.hub.action_step.rest)
    • Complex Object (com.glide.cobject)
    • ServiceNow Flow Designer - Dynamic Inputs (com.glide.hub.dynamic_inputs)
    • ITOM Visibility License (com.snc.itom.vis.license)
    • Agent Client Collector Framework v2.2.0 (sn_agent)
      Note:
      To enable Agent Client Collector to execute commands, ensure that ACC_ALLOW_LIST=0 for Linux environments or ACC_ALLOW_LIST=False for Windows environments.
    Note:
    Some of these plugins are licensable features and require appropriate licenses, if used outside the spoke implementation.

    Spoke subflows

    The Agent Client Collector spoke provides sample subflows to demonstrate automating Agent Client Collector framework tasks. To customize a sample subflow, copy it to a new application scope. Available sample subflows include:

    Subflow Description
    Managing Compliance for Remote Workers Manages compliance for remote workers and sends an email to the system administrator when one or more specified compliance conditions are violated.
    Restart Agent Verifies the status of an agent and restarts the agent if the status is down.
    SNH CyberAttack Detection Applies SigHealth CyberAttack Detection for Windows server and send an email to the system administrator when a threat is detected.
    Install Agent on Linux Installs Agent Client Collector on a Linux hosts.
    Install Agent on Windows Installs Agent Client Collector framework on multiple windows hosts.

    Spoke actions

    The Agent Client Collector spoke provides actions to automate Agent Client Collector tasks when events occurs in your ServiceNow instance. Available actions include:

    Action Description
    Get Agent Status Get the status of an agent.
    Get Logged on Users Retrieves the list of all logged-in users and the related metadata for the specified host system.
    Get Network Statistics Retrieves the list of all network interfaces and the related metadata for the specified host system.
    Get Running Processes Retrieves the list of all running processes and the related metadata for the specified host system.
    Get Running Services Retrieves the list of all running services in Windows OS and the related data for the specified host system.
    Get System Details Retrieves the hardware and software details of the specified agent.
    Restart Agent Restarts an agent.
    Run Command on Agent Runs a command on a given agent host.
    Note:
    Use caution while executing commands.
    Run Osquery on Agent Runs the specified Osquery on the specified agent host.
    Install Agent on Linux Installs Agent Client Collector framework on a Linux host.
    Install Agent on Windows Installs Agent Client Collector framework on windows host.
    Note:
    To use the Install Agent on Linux and Install Agent on Windows spoke actions, navigate to Agent Client Collector Spoke > CIDR Ranges, create a record to specify the required IP address or range of IP addresses.

    For information about setting up the spoke, see Set up the Agent Client Collector spoke.

    MID Server requirements

    To use these actions, your instance must have a MID Server set up and configured to use PowerShell. For more information about running actions on the MID Server, see Integration steps. For more information about the MID Server, see MID Server.

    To set up the MID Server for this spoke, see Set up MID Server for a spoke.