{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":20999,"path":"integrate-applications/integration-hub/acc-spoke.md","title":"Agent Client Collector Spoke","bundle":null,"doc_type":null,"release":"australia","body":"\n# Agent Client Collector Spoke\n\nAutomate 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.\n\n## Request apps on the Store\n\nVisit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) 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](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).\n\n## Integration Hub subscription\n\nThis spoke requires an Integration Hub subscription. For more information, see [Legal schedules - IntegrationHub overview](https://www.servicenow.com/content/dam/servicenow-assets/public/en-us/doc-type/legal/snc-addendum-integrationhub.pdf).\n\n## Spoke version\n\nAgent Client Collector spoke v1.2.0 is the latest version. For version history of the spoke, see [Agent Client Collector Spoke release notes](https://www.servicenow.com/docs/r/store-release-notes/store-integrationhub-rn-agent-client-collector.html).\n\n## Supported versions\n\nThis spoke was built for Agent Client Collector framework v2.2.0, but may be compatible with later versions.\n\n## Spoke dependencies\n\nIf you’re having trouble installing the app, ensure that these dependent plugins are installed:\n\n- ServiceNow IntegrationHub Runtime \\(com.glide.hub.integration.runtime\\)\n- ServiceNow IntegrationHub Action Step - REST \\(com.glide.hub.action\\_step.rest\\)\n- Complex Object \\(com.glide.cobject\\)\n- ServiceNow Flow Designer - Dynamic Inputs \\(com.glide.hub.dynamic\\_inputs\\)\n- ITOM Visibility License \\(com.snc.itom.vis.license\\)\n- Agent Client Collector Framework v2.2.0 \\(sn\\_agent\\)\n\n **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.\n\n\n**Note:** Some of these plugins are licensable features and require appropriate licenses, if used outside the spoke implementation.\n\n## Spoke subflows\n\nThe 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:\n\n|Subflow|Description|\n|-------|-----------|\n|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.|\n|Restart Agent|Verifies the status of an agent and restarts the agent if the status is down.|\n|SNH CyberAttack Detection|Applies SigHealth CyberAttack Detection for Windows server and send an email to the system administrator when a threat is detected.|\n|Install Agent on Linux|Installs Agent Client Collector on a Linux hosts.|\n|Install Agent on Windows|Installs Agent Client Collector framework on multiple windows hosts.|\n\n## Spoke actions\n\nThe Agent Client Collector spoke provides actions to automate Agent Client Collector tasks when events occurs in your ServiceNow instance. Available actions include:\n\n\n
\n\nAction\n\n\n\nDescription\n\n
\n\nGet Agent Status\n\n\n\nGet the status of an agent.\n\n
\n\nGet Logged on Users\n\n\n\nRetrieves the list of all logged-in users and the related metadata for the specified host system.\n\n
\n\nGet Network Statistics\n\n\n\nRetrieves the list of all network interfaces and the related metadata for the specified host system.\n\n
\n\nGet Running Processes\n\n\n\nRetrieves the list of all running processes and the related metadata for the specified host system.\n\n
\n\nGet Running Services\n\n\n\nRetrieves the list of all running services in Windows OS and the related data for the specified host system.\n\n
\n\nGet System Details\n\n\n\nRetrieves the hardware and software details of the specified agent.\n\n
\n\nRestart Agent\n\n\n\nRestarts an agent.\n\n
\n\nRun Command on Agent\n\n\n\nRuns a command on a given agent host. **Note:** Use caution while executing commands.\n\n
\n\nRun Osquery on Agent\n\n\n\nRuns the specified Osquery on the specified agent host.\n\n
\n\nInstall Agent on Linux\n\n\n\nInstalls Agent Client Collector framework on a Linux host.\n\n
\n\nInstall Agent on Windows\n\n\n\nInstalls Agent Client Collector framework on windows host.\n\n
**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.\n\nFor information about setting up the spoke, see [Set up the Agent Client Collector spoke](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/setup-acc.md).\n\n## MID Server requirements\n\nTo 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/integration-steps.md). For more information about the MID Server, see [MID Server](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/mid-server-landing.md).\n\nTo set up the MID Server for this spoke, see [Set up MID Server for a spoke](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/config-adv-mid-settings-for-oauth-on-mid.md).\n\n"}}