Command-line Use & Parameters of SVM Agent

Command-line Use & Parameters of SVM Agent

Summary

This article provides a compiled list of all command-line options available to the SVM Agent and their corresponding configuration parameters. It also teaches you the basics of performing manual installs and work with the Agent in command-line. 

While the settings command-line parameters of the Agent are convenient for direct Agent command-line interaction and enforcement, the settings could also be used in advanced Agent deployment packages

Synopsis

Find the installation commands to install the Agent listed first, and the table with parameters after it. 

Work with the Agent in command-line 

 This approach to installing an Agent can be used for a variety of reasons.

You need to install an Agent at a particular network segment to test if Proxy is blocking your connections. Find more information on the logic and the exact required installation settings in this KB.

You need to run a quick scan with debugging enabled to detect what metadata does your Agent pickup. Find more on how to work with logging in this KB article, or see that KB if Agents were already installed. 

  • You need to setup Agents on your client machine to begin learning SVM2018 and you want to do it without going through WSUS or SCCM deployments.
  • For all other reasons, you may wish to deploy an Agent.

Once logged in to your SVM2018 account, go to Scanning/Scanning via Local Agents/Download Local Agent. Find and click on the version of the Agent for Windows (for installation of MAC or RHEL Agents, find the corresponding articles). This will automatically download the most current version.

Install options:

Open the Command Prompt as Administrator before proceeding.
Browse to the Agent's directory where you saved the csia.exe binary.

Install the SVM Agent as the current user, prompts for a password, settings saved to HKCU:

o             csia.exe -i <config options>

Install the SVM Agent to run as the LocalSystem. Saves the Agent settings to HKLM:

o             csia.exe -i -L <config options

Install the SVM Agent to run as another user. Prompts for password and saves settings to HKEY_<user>:

o             csia.exe -i -R <user> <config options>

Install the Agent in command-line, but do not write settings to the registry (also works with -R and -L):

o             csia.exe -i -N

Once the agent is installed it will automatically scan after ten minutes.
You can also initiate an on-demand immediate scan by executing < csia.exe -c >.
It will take about 15 minutes and you should see the results under Completed Scans

Additional Information

The commands provided next will help you get used to the command-line quickly. 
To see the Agent config options or to get command-line help:

  • csia.exe –h

Run a quick scan with your own selected CMD options. Ignores registry settings and server settings:

o             csia.exe -c <config options>

Run Agent in service mode as the current user, reading options from the CMD, registry, and server. Command-line options taking precedence, then server options, then registry options.

o             csia.exe -fg <config options>

Run Agent in service mode as a different user with -L and -R. It will read options in the same way as a service would do, except for <config options> on the command-line override which, unlike a service, has no command line:

o             csia.exe -fg -L <config options>

o             csia.exe -fg -R <user> <config options>

Order of precedence:

Settings in the command-line take precedence but, but not when the Agent is running as a service.

Settings from the server take precedence over settings read from the registry.

This way of installing the Agent can be used for a variety of reasons, including testing and debugging. 

Command-Line Agent Options Table

The command-line option column represents what would be used at the command line when running the agent file on the system from a command prompt. The config parameter column would be how the parameter would be expressed in the respective configuration areas for agents of each operating system listed. Each listed operating system is listed with their configuration areas and each OS column is populated to display whether or not the configuration option is available to that corresponding agent.

Command-Line Option Config Parameter Windows (registry) Linux (csia.conf) Mac (plist)
-A/--network-appliance Network Appliance o - -
-c/--cli   o o o
-d/--debug <path> LogFile o o o
--getfileinfo <path>   o o o
-h/--help   o o o
-n/--checkin-interval <interval> CheckInInterval o o o
-o/--outdir <path>   o o o
-oc/--output-csv <file>   o o o
-ox/--output-xml <file>   o o o
-si/--scantime_interval <minutes>   o o o
--skipwait SkipWait o o o
-v/--verbose Logging o o o
-V/--version   o o o
-g/--group <group> GroupName o o o
-D/--direct-connection ProxyConfigState o o o
--forcehttps ForceHttps o o o
--ignore-ca IgnoreUnknownCA o o o
--ignore-cn IgnoreInvalidCN o o o
--ignore-crl IgnoreCRL o o o
--pac-url <url> PACFileURL o - -
--requesttimeout <minutes> RequestTimeout o o o
-U/--proxy-user <user: pass> ProxyUser/ProxyPass o o o
--use-network-winhttp NetworkImplementation o - -
--use-network-wininet NetworkImplementation o - -
-x/--proxy <proxy: port> ProxyURL o o o
--check-wmi CheckWMI o - -
-t/--type InspectionType o o o
-w/--no-os-update/--no-win-update WindowsUpdate o o o
--wua-proxy <0,1 or host[port]> WuaProxySetting o - -
--userid <userid> CSIAUser o o o
--token <token> CSIAToken o o o
--host <hostname> CSIAHost o o o
--port <port> CSIAPort o o o
--delete-all-settings   o - -
--dry-run/--dryrun   o o o
-i/--install   o o o
-L/--localsystem   o - -
--manual   o - -
-N/--no-registry-write   o - -
-p/--copy <dest>   o - -
-r/--remove   o o o
-R/--runas <user[pass]>   o - -
-S/--only-save-settings   o - -
--service-failure-actions <actions>   o - -
--service-failure-command <command line>   o - -
--service-failure-flag   o - -
--service-failure-reboot <message>   o - -
--service-failure-reset <period>   o - -


Descriptions of the command line options can be found in the Cloud Helpnet Guide or the On-Prem Guide if that's your solution of choice. 

Was this article helpful? Yes No
No ratings
Version history
Last update:
‎Sep 14, 2019 11:17 AM
Updated by:
Contributors