MSI installation parameters

reference brazil Updated Sep 10, 2026 1 min read msi-installation-parameters.md
Raw file servicenow.com

The following table describes the MSI parameters used when preparing an agent for installation on a gold image and used with a non-persistent virtual desktop infrastructure (NPVDI) machine.

Parameter

Type

Description

NP_VDI_GOLD_IMAGE

boolean

Indicates a gold image host is enabled for the NPVDI agent.Set to true.

INSTANCE_URL

string

ServiceNow instance base URL for REST downloads.

INSTANCE_REST_API_USER

string

Basic-auth username for fetch_vdi_config REST API.This is the user created in the Prepare agent deployment on a non-persistent virtual desktop infrastructure machine procedure.

INSTANCE_REST_API_PASS

string

Basic-auth password; passed to the agent as the ACC_REG_KEY environment variable.

REGISTRATION_KEY

string

VDI light-registration key (must have light_registration=true on the instance). Passed to acc as the ACC_REG_KEY environment variable.

PAC_FILE

string

PAC file for proxy auto-configuration during downloads. Takes precedence over HTTPS_PROXY.Optional.

HTTPS_PROXY

string

Static HTTPS proxy URL for downloads (ignored if PAC_FILE is set). Applied to REST API calls only.Optional.

GOLD_IMAGE_SKIP_PROXY

boolean

Set to true to bypass PAC/proxy during configuration downloads and connect directly.Optional.

CUSTOM_PLUGIN_CERT_FOLDER

string

Directory containing custom plugin-signing certificates; copied into the agent config directory before download.Optional.

**Parent Topic:**[Agent Client Collector Framework reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/it-operations-management/agent-client-collector/agent-client-collector-reference.md)
Search documentation
Search document titles and file paths on the brazil branch