This is a how-to explaining the settings associated with the Windows Spiceworks Agent (MSI). With this information, you should be able to deploy the agent in a number of scenarios, including SCCM, PDQ Deploy, PSExec, batch files, etc.

See the references at the bottom for deploying the agent via GPO. Yes, it involves using Orca, an MSI editor, but it’s not terribly hard…!

NOTE: This documentation was written some years ago, so the location from where you would download the MSI might change by the time you read this.

Pre-requisites:

The Windows client must have Dot Net 3.5 SP1 installed prior to deploying the agent.

Step 1: The Spiceworks Agent is an MSI, so you get to enjoy the benefits the Windows Installer offers.

Since the SW Agent is an MSI, the installer itself has a number of parameters available to you.

To find out what those are, run ‘msiexec.exe /?’ and take a look at the command-switches available. Alternatively, review the following Microsoft website: Command-Line Options - Win32 apps | Microsoft Learn

However, remember that the agent requires various parameters specific to itself in order to install properly. If you try and use, say, the “passive” switch with msiexec, the agent will fail since it requires some options like the Spiceworks server address, port, authentication key, etc. to install properly.

Step 2: Where the heck IS the Spiceworks Agent MSI?

*THE LOCATION OF THE MSI MAY CHANGE OVER TIME, so be aware

To find the MSI, open up your Spiceworks instance, hover over either the ‘Inventory,’ ‘Help Desk,’ or ‘Purchasing’ menu items > ‘Settings’ (this tends to change from version to version) - or look for ‘Remote Settings.’

Below ‘Additional,’ click the ‘Remote Sites & Agents’ link.

Look for the section called “Manage Your Devices With Remote Agents,” the link for the MSI should be below, entitled “Download the remote agent for this installation.”

Save this MSI somewhere handy for your computers/users to install.

Step 3: Deploying the MSI

Here we go:

This install scenario would assume the following:

  • You have a Spiceworks installation on the site: https://spiceworks.yourdomain.com on port 443
  • You’ve configured the authentication key on your central Spiceworks install as “supersecretspiceysauce.”
  • You want a tray icon to show up for the user with a caption of “Company Helpdesk” with a clickable URL of https://spiceworks.yourdomain.com/portal
  • You want the agent to install as silently as possible, and don’t want the computer restarting after install
  • You want to log the MSI progress to a logfile in c:\ called ‘spicey_install.log.’

These are the parameters you need to configure:

SPICEWORKS_SERVER=“spiceworks.yourdomain.com
SPICEWORKS_AUTH_KEY=“supersecretspiceysauce”
SPICEWORKS_PORT=443
SPICEWORKS_SITE_LABEL=“Remote”
TRAY_CLICK_LABEL=“Company Helpdesk”
TRAY_CLICK_URL=“https://spiceworks.yourdomain.com/portal
ADDLOCAL=FeatureService,FeatureTray

So, how does this work while installing via MSI?

Run the install like this (should be all on one line):

msiexec.exe /i “Spiceworks Agent.msi” SPICEWORKS_SERVER=“spiceworks.yourdomain.com” SPICEWORKS_AUTH_KEY=“supersecretspiceysauce” SPICEWORKS_PORT=443 SPICEWORKS_SITE_LABEL=“Remote” TRAY_CLICK_LABEL=“Company Helpdesk” TRAY_CLICK_URL=“https://spiceworks.yourdomain.com/portal” ADDLOCAL=FeatureService,FeatureTray /q /norestart /log c:\spicey_install.log

Step 4: SPICEWORKS_SERVER

This is the ip address or hostname of your Spiceworks server.

In order for the agent to work, it needs to be able to communicate with the server address.

Enclose your address in quotes. Note that you do NOT put http or https here, just the hostname or IP address.

Example:

SPICEWORKS_SERVER=“spiceworks.yourdomain.com

Step 5: SPICEWORKS_AUTH_KEY

This is the authentication key you configured in your Spiceworks remote agent settings.

Enclose your authentication key in quotes - note that this will be the ENCRYPTED authorization key from a system running the agent already.

See Step 3. from this How-to to discover what you need to use here: http://community.spiceworks.com/how_to/show/5805-creating-a-spiceworks-agent-transform-file-using-insted

Example:

SPICEWORKS_AUTH_KEY=“Vy9nQljJVaT8xrzTg+EJten2xU8=”

Step 6: SPICEWORKS_PORT

This is port where your Spiceworks installation resides. I would recommend using port 443 here, unless you’ve configured it for something else (this is not typical).

Do NOT enclose your port in quotes - this is a direct integer.

Example:

SPICEWORKS_PORT=443

Step 7: SPICEWORKS_SITE_LABEL

This is more or less an arbitrary name to help define some defining detail to the Spiceworks server…i.e. so an administrator can know a bit more information about a remote agent connection at a glance (done from the ‘remote sites’ page from within the main app).

Enclose your Spiceworks Site label in quotes.

Example:

SPICEWORKS_SITE_LABEL=“SYS4203 - (Rob’s Laptop)”

OR:

SPICEWORKS_SITE_LABEL=“%computername%”

(Thanks, Alan M.!)

Step 8: ADDLOCAL

This refers to the features that are available within the agent itself during install.

At the time of this writing, there are two features:

FeatureService, which installs the main service
FeatureTray, which installs the tray icon and applet the user can interact with.

For example - if you want to install the main application, but not the systray icon, use this:

FeatureService

To install the main application WITH the systray icon, use this:

FeatureService,FeatureTray

Example:

ADDLOCAL=FeatureService,FeatureTray

Step 9: TRAY_CLICK_LABEL

b5c2468bd141b94c4b17244de4354c5333c7a1a90b29fab61b68ed0cd2e49230_systray.jpg

This is the text that appears at the top of the context-menu when a user right-clicks the tray icon. When a user clicks this text, a web browser will attempt to connect to the URL specified in the ‘TRAY_CLICK_URL’ parameter.

Enclose your label in quotes:

Example:

TRAY_CLICK_LABEL=“IT Helper”

Step 10: TRAY_CLICK_URL

This is the clickable URL that you want your users to be able to click when they right-click the tray icon.

Enclose the url within quotes.

Example:

TRAY_CLICK_URL=“https://spiceworks.yourdomain.com/portal

Step 11: NOTE: Registry settings

Now that you’ve installed the agent, where are all these settings stored?

(64-bit Windows) HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Spiceworks\Agent

(32-bit Windows) HKEY_LOCAL_MACHINE\SOFTWARE\Spiceworks\Agent (not verified)

Step 12: Want to deploy this via Active Directory GPO?

Go to the following how-to: http://community.spiceworks.com/how_to/show/5805

This explains how to download and use InstEd to make a Transform file.

As you can see, you can deploy the agent with all the granularity offered when installing it through the normal method of the GUI installation.

Using the msiexec process, you can also remove the application easily.

Special thanks to TTime for some of the info here.

See the reference: “Deploy Spiceworks Agent using GPO” for details on using the Active Directory GPO method for installation using Orca, a freely available MSI editor.

74 Spice ups

Awesome how-to as always Rob! Thank you for writing it up.

You know I LOVE a feature when I write up a how-to :wink:

…on a Saturday…

Thanks for this.

I just started installing spiceworks agent 6.0. I have installed it 3 laptops so far. My questions is about the spiceworks_site_label. Is this field equivalent to the Remote Site field that is configured for remote sites? I have a remote SW server that reports back to the central SW server with the remote site name (Dallas in this example) so that I know where the remote devices were scanned. This also allows me to use the “Others like this” drop down to group these devices.

When I use the “Others like this” drop down on the devices that have been created via the SW agent, I always only get one device, the device I was viewing, even though all 3 laptops were installed with the same site label. The SPICEWORKS_SITE_LABEL info appears in the same slot as the Remote Site info appears for other devices. It appears that each SPICEWORKS_SITE_LABEL is added as unique, even if the text was exactly the same. This negates the value of “Other like this” grouping.

Thoughts?

Yes, it is supposed to be the site name. That’s interesting. I would take this up with support@spiceworks.com and have them fix it.

Try as I may, if I use ADDLOCAL=FeatureService,FeatureTray, it will install the agent, but the tray icon never shows up unless I launch it manually from inside the start menu folder. What am I missing?

http://community.spiceworks.com/topic/245933-remote-agent-tray-icon-missing?page=1#entry-1509801
"Brandon (Spiceworks) Jul 23, 2012 at 02:58 PM

The Agent tray does not start automatically when restarting Windows. We will try to get this into a future version but for now you will have to add the tray to the startup group. Also, if an older version of the agent is installed you may see the tray appear/disappear as the agent typically gets auto-updated to the current version right away, which will cause the tray to be closed out."

See http://community.spiceworks.com/how_to/show/6787 for tray agent

There is something strange about the menu choices for the tray app depending on how you install it. See “Spiceworks 6.1 Agent Tray App Menu differences” http://community.spiceworks.com/topic/262481-spiceworks-6-1-agent-tray-app-menu-differences and “SW6 Tray Icon has 2 different menus depending on how it’s installed” http://community.spiceworks.com/topic/262269-sw6-tray-icon-has-2-different-menus-depending-on-how-it-s-installed … can anyone shed any light on this?

Sweet!

thx for share

These aren’t working well for me with the 6.2 version of the agent. Is this still accurate?

hi all
is there a way to include in the msi the group i want to add my use to ?
Thanks

This past year has been the first full deployment of the agent, and this how to has answered many questions I had about the inner workings. Thanks Rob for the share, I’m filing this away.

Most software I deploy using GP has two parts for the deployment. An MSI that is pushed out using the tools for that and a ADM file that has the necessary settings that can be configured without messing about with transforms or any of that. Why do it this way, it seems harder for the users?

If you want to make an ADM file for the agent, I say go for it! Link it here if you do :wink:

Thanks Rob.
I was able to deploy the msi through your walkthrough. It should also be noted that the SPICEWORKS_SITE_LABEL can use the %computername% variable to pull the computers name. Ex- SPICEWORKS_SITE_LABEL=“%computername%”

This page is being used as “Official Documentation” for this process.
It is important to note that with the current (and older) version of Spiceworks, the Agent MSI package DOES NOT RUN THE ENCRYPTION ROUTINE ON THE AUTH KEY given on the command line in a silent full install. I have not done full testing to determine all cases where the encryption is not run, however in the Textbook Example (Tray and all installed) via PSExec this is the case.

In order for a push of the agent to work via PSExec (and possibly other cases), the post-encrypted Auth Key must be used, and must be extracted from the registry of a successfully installed agent that uses the same Auth Key. Alternately, a second run of a Repair MSI install must be completed to get Windows Installer to encrypt the Auth Key properly.