Non-persistent VDI parameters, scripts, and settings

  • Release version: Australia
  • Updated May 12, 2026
  • 2 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 Non-persistent VDI parameters, scripts, and settings

    This guide provides essential instructions for ServiceNow customers setting up non-persistent VDI (Virtual Desktop Infrastructure) environments using the Agent Client Collector. It covers the installation command for mid-less mode, required logon and logoff scripts, and critical configuration settings within the acc.yml file for proper agent behavior on non-persistent VDIs.

    Show full answer Show less

    Agent Client Collector Mid-less Installation Command

    To install the Agent Client Collector on a reference device for non-persistent VDI use, run the provided msiexec command with specific parameters. This silent installation connects the agent directly to the Agent Client Collector Cloud Native Connector (CNC) gateway without needing a MID Server. Key parameters include:

    • PATHTOMSI: Location of the MSI installer downloaded from the ServiceNow instance.
    • CONNECTWITHOUTMID="true": Enables mid-less connection to CNC gateway.
    • ACCCNC: Hostname and port of the CNC gateway, obtained from your ServiceNow instance.
    • REGISTRATIONKEY: Unique key from your ServiceNow instance to register the agent.
    • INSTANCEURL: Fully qualified URL of your ServiceNow instance.
    • LOCALUSERNAME="SYSTEM": Runs the agent service as the local SYSTEM account, required for non-persistent VDIs.

    Logon and Logoff Scripts

    Four scripts are essential for managing agent behavior during VDI sessions. Obtain these scripts from ServiceNow Customer Support and place them in C:\DEXScripts\ (or update paths accordingly):

    • logonscript.ps1: Restores the agent certificate from persistent storage at session start to enable authentication without re-downloading.
    • logonscript.cmd: CMD wrapper to invoke logonscript.ps1, configured as the post-synchronization or session-start script in your VDI management tool.
    • logoffscript.ps1: Pushes residual metrics from the agent to the ServiceNow instance before session disconnect.
    • logoffscript.cmd: CMD wrapper to invoke logoffscript.ps1, configured as the power-off or session-end script.

    Non-persistent VDI Settings in acc.yml

    The acc.yml configuration file located at C:\ProgramData\ServiceNow\agent-client-collector\ must include specific settings when creating a non-persistent VDI golden image:

    • persistencetype: nonpersistent - Identifies the agent as running on a non-persistent VDI.
    • disable-asset: true - Prevents reusing the same asset record across duplicate VDIs, ensuring each instance generates its own asset record on first start.
    • agent-key-id - Must be removed before sealing the golden image so that each duplicate VDI requests a fresh key upon registration.

    These settings ensure accurate asset tracking and proper agent registration behavior in non-persistent VDI environments.

    Find the Agent Client Collector mid-less installation command syntax, logon and logoff script file names and locations, and an installation command example when setting up a non-persistent VDI golden image.

    Agent Client Collector mid-less installation command

    Run the following command on the reference device to install Agent Client Collector in mid-less mode for non-persistent VDI use. Replace each placeholder with the value provided in your ServiceNow instance under Agent Client Collector > Agent Download.

    msiexec /i <path-to-msi> /quiet /qn /norestart CONNECT_WITHOUT_MID="true" ACC_CNC="<your-acc-gateway>:443" REGISTRATION_KEY="<your-registration-key>" INSTANCE_URL="<your-instance-url>" LOCALUSERNAME="SYSTEM"

    The following table describes each parameter.

    Parameter Description
    /i <path-to-msi> Path to the Agent Client Collector MSI installer that you downloaded from the ServiceNow instance.
    /quiet /qn /norestart Installs the agent silently and prevents an automatic restart of the reference device after installation.
    CONNECT_WITHOUT_MID="true" Configures the agent to connect directly to the Agent Client Collector Cloud Native Connector (CNC) gateway without requiring a MID Server.
    ACC_CNC="<your-acc-gateway>:443" Hostname and port of your CNC gateway. Copy this value from the mid-less installation command in Agent Client Collector > Agent Download on your ServiceNow instance.
    REGISTRATION_KEY="<your-registration-key>" Registration key issued by your ServiceNow instance for this agent.
    INSTANCE_URL="<your-instance-url>" Fully qualified URL of your ServiceNow instance, for example, https://<instance>.service-now.com.
    LOCALUSERNAME="SYSTEM" Configures the agent service to run as the local SYSTEM account. This setting is required for non-persistent VDI monitoring.

    Logon and logoff scripts

    The following table lists the file names, recommended locations, and purpose of the scripts that are required for non-persistent VDI sessions. Obtain these scripts from ServiceNow Customer Support before you configure the VDI pool.

    If you place the PowerShell scripts in a location other than C:\DEXScripts\, update the corresponding .cmd wrapper to reference the new path.

    File name Type Recommended location Purpose
    logon_script.ps1 PowerShell C:\DEXScripts\ Restores the agent certificate from your persistent storage to the VDI when a session starts. Enables authentication without downloading a new certificate.
    logon_script.cmd CMD wrapper Configured in your VDI management tool as the post-synchronization or session-start script Calls logon_script.ps1. Update the path inside this file if you place the PowerShell script in a different location.
    logoff_script.ps1 PowerShell C:\DEXScripts\ Pushes residual metrics from the Agent Client Collector to the ServiceNow instance before the session disconnects.
    logoff_script.cmd CMD wrapper Configured in your VDI management tool as the power-off or session-end script Calls logoff_script.ps1. Update the path inside this file if you place the PowerShell script in a different location.

    Non-persistent VDI settings in acc.yml

    The following table lists the acc.yml settings that apply to a non-persistent VDI golden image. acc.yml is located at C:\ProgramData\ServiceNow\agent-client-collector\.

    Setting Required value Purpose
    persistence_type non_persistent Defines that the agent runs on a non-persistent VDI.
    disable-asset true Prevents the agent from re-using a single asset record across duplicate VDIs. Each duplicate VDI generates its own asset record on first start.
    agent-key-id Removed Removed from the file before sealing the golden image so duplicate VDIs request a fresh key on first registration.