Install the Agent Client Collector on a Windows machine manually

IT Operations Management > <a class="link" href="../../../product/agent-client-collector/concept/acc-landing-page.html" title="The Agent Client Collector is an agent that is installed on infrastructure components. The Agent Client Collector is built on a Sensu framework which enables you to adopt and extend monitoring checks from the community. It executes commands on the machines it is installed on and sends output data to the ServiceNow instance via the MID Server, storing events and metrics in the relevant database.">Agent Client Collector > <a class="link" href="../../../product/agent-client-collector/concept/acc-framework-landing-page.html" title="The Agent Client Collector Framework (ACC-F) application manages the agent installation on your infrastructure components, enabling sending of output data to the ServiceNow instance via the MID Server. In addition to the MID Server, you must install the Configuration Management Database for Scoped Apps (CMDB).">Agent Client Collector Framework >

Install the Agent Client Collector on a Windows machine manually when you want to test the agent on a single system.

Ensure that you’ve configured the Agent Client Collector web server. For details, see Configure the websocket server on the MID Server . Verify your server's OS and version. When using Microsoft Internet Explorer, do the following to prepare the Agent Client Collector installation file: Navigate to Server Manager > Local Server . Turn off IE Enhanced Security Configuration . Download the installation file. Change the extension of the installation file from .man to .msi

Role required: agent_client_collector_admin

Navigate to Agent Client Collector > Agent Downloads . To perform installation using the wizard: Download the .msi file that is accessible from the link on the UI. The Installation Wizard opens. Select Next until you reach the MID Web Server Connection Settings page.

Enter the relevant parameters in the dialog box fields: Table 1. MID Web Server Connection Settings fields Field name Description MID Web Server Name/IP IP address of the MID Web server. MID Web Server Port Port number of the MID Web server. Use a number between 1024-49151. MID Web Server API Key API key to access the MID Web server.

Select Next . The Create Local User Account page appears. Select the relevant option in the dialog box. Table 2. Create Local User Account dialog box Option Description Use default user (servicenow) Default user with which to run the Agent Client Collector on a Windows machine. Selecting this option creates a local user called servicenow as part of the installation.

The servicenow user password is randomly generated and is not stored in the system. A security event is created on the host machine which, if repeated, requires opening a support case. For details, see KB1649116 article in the HI Knowledge Base.

Select existing user When selecting this option, configure the following subfields: User Name : User name to log in to the Windows environment. Password : Password of the selected user. The user can be one of the following: Local user (created by the virtual machine owner; provides added resiliency). Domain user (created by IT personnel). Group Managed Service Account (gMSA): Enter the name of the group managed service account in the User Name field and leave the Password field empty. Local Service Account: Enter LOCALSERVICE in the User Name field and leave the Password field empty. Local System Account: Enter SYSTEM in the User Name field and leave the Password field empty. Due to Windows UAC restrictions, running the agent as a local SYSTEM account is necessary to perform an upgrade via msiexec .

Note: Using a Local System account creates the local group ServiceNow Users , and adds the created user to the group. The ServiceNow Users group has access to Agent Client Collector directories and has the following privileges: Performance Monitor : Comes with the base system; enables viewing all performance counters in the system. Log on as a service : Enables starting network services and services that run continuously, even when no one is logged onto the console. Debug programs : Enables debugging processes and reading process details for users outside the ServiceNow user group.

Select Create User . The system creates a Windows user with the specified credentials, and the Agent Client Collector Configuration page appears. To enable the Allow-List containing the checks enabled to run after setup, select the Enable executing command allow list check box on the resulting page.

Select Next to open the installation page. When installation completes, click Next to complete and exit the wizard.

After a successful installation, the service starts automatically and generates the following:

User: Default = servicenow (an existing user can also be configured to manage the service). The servicenow user belongs to the local user group ServiceNow Users . Service: AgentClientCollector File location: Default for installation = C:\Program Files\ServiceNow\agent-client-collector Default for service files = C:\ProgramData\ServiceNow\agent-client-collector , which holds the cache , config , and log folders.

To run Silent installation to disable installation reports, run the command line appearing in the Silent installation section of the procedure, as follows: msiexec /i /quiet /qn /norestart ACC_API_KEY= ACC_MID=wss:// : /ws/events ACC_ALLOW_LIST=False To enable the allow list of specified checks when running Silent installation, set the ACC_ALLOW_LIST parameter to True .

To configure multiple MID Servers with Silent installation, run the command line appearing in the Silent installation section of the procedure with comma-separated values, as follows: msiexec /i /quiet /qn /norestart ACC_API_KEY= ACC_MID="wss:// : /ws/events,wss:// : /ws/events" Insert the following parameter values in the command:

Table 3. Command parameters Parameter Value ACC_API_KEY The API key used to access the MID Server websocket. ACC_MID The URL of the MID Server websocket. DENY_LOCAL_LOGON When set to True , prevents any user other than the default servicenow user from logging onto the service. Default value: False

PASSWORD_NEVER_EXPIRES When set to True , the password for the default servicenow user never expires. Default value: False

START_SERVICE When set to True , the Agent Client Collector service automatically starts after installation. Default value: True

LOCALUSERNAME Account running the Agent Client Collector as a Windows service. Possible values: SYSTEM LOCALSERVICE DOMAIN\gMSA$ string (local username) Default = servicenow

When using the SYSTEM, LOCALSERVICE, or DOMAIN\gMSA$ accounts, you do not have to configure a password.

LOCALPASSWORD Password for the user specified in the LOCALUSERNAME parameter. The configured MID Server values are automatically added to the acc.yml file. The agent connects to the first available MID Server in the list.

To configure a secondary MID server, enter the following syntax in the backend-url section of the acc.yml file, per the .yml standard: - "wss:// : /ws/events" (with the quotation marks).

Upgrade the Agent Client Collector manually on a Windows system Perform a manual upgrade of your existing Agent Client Collector version on a system running a Windows OS. Uninstall the Agent Client Collector manually from a Windows machine Uninstall the Agent Client Collector from a Windows machine manually instead of using the single-line procedure. Use the manual procedure if the command script is unavailable due to the specific agent not being connected to the instance.

Parent Topic: <a class="link" href="../../../product/agent-client-collector/concept/acc-windows-install-concept.html" title="When installing the Agent Client Collector on a Windows machine, either download an installation file and use a wizard to install the agent manually, or use silent installation to automate agent installation and configuration. Manual installation enables you to test the agent on a single system, while silent installation enables you to deploy the agent at scale.">Agent Client Collector installation on a Windows machine