# VSIClient Administration

> Check, log, update, and manually run the data collection agent.

VSIClient is the agent responsible for collecting device data and uploading it to Visual One. It runs on a data collection machine on your network, normally as a scheduled task. This page covers checking its state, reading its logs, updating it, and running collections by hand.

> **Important:** Run the command-line steps below from a command prompt opened as the **service user** configured to run the scheduled task. Device credentials are stored in that user's keyring, so commands run as anyone else will not see them.

## Checking whether VSIClient is running

**Through Task Scheduler.** Open Task Scheduler, locate the VSIClient task, and read the Status column. `Running` means the agent is active. `Ready` means it is idle between scheduled runs.

**Through PowerShell.** A returned process means it is running, and no output means it is not currently active.

```
Get-Process vsiclient
```

## Reading the logs

The collection log lives at `\vsi\vsi_collection_process.log`. To watch it live:

```
Get-Content \vsi\vsi_collection_process.log -Tail 10 -Wait
```

## Running VSIClient manually

Either start the VSIClient task from Task Scheduler, or run the agent directly from a command prompt as the service user. If the scheduled task passes optional parameters in its Action, include those too, for example `--base_path D:\vsi` or `--site XYZ`.

```
vsiclient
```

## Running a single collection on demand

A manual collection is the fastest way to test one device, and it runs independently of any VSIClient instance already active on the system, so it will not disturb the schedule. Manual runs typically take these parameters:

- `--collector <DEVICE_TYPE>`
- `--ip <IP_OR_DNS_NAME>`
- `--user <USERNAME>`
- `--password <PASSWORD>`
- `--output_path <OUTPUT_PATH>`

```
vsiclient --collector NETAPP_CLUSTER --ip netapp01.example.com --user svc-visualone --password EXAMPLE_PASSWORD --output_path C:\vsi\test
```

> **Note:** Not every device takes the same parameters. Check the device's entry in Supported Devices first, because collectors that need a serial number, an API token, or a CLI path will fail without them.

## Updating VSIClient

Stop the agent before updating it, or the install will fail while files are in use.

1. Log in to the data collection machine.
2. Open Task Scheduler, locate the VSIClient task, and click **End**.
3. Confirm it is no longer running, through Task Scheduler or `Get-Process vsiclient`.
4. Open a command prompt as the service user.
5. Run the install command below. The output should end with `Successfully installed vsiclient-*`.
6. Start the VSIClient task again in Task Scheduler.

```
pip install -i https://packages.visual1intelligence.com/simple/ -U --trusted-host packages.visual1intelligence.com vsiclient --trusted-host pypi.org --trusted-host pypi.python.org --trusted-host files.pythonhosted.org
```

## Checking a stored password

To confirm which password is stored for a device, run the following as the service user, substituting the device ID:

```
keyring get <DEVICE_ID> password
```

For example, `keyring get 1234 password`. The device ID is available as an optional column at `visual1intelligence.com/user/settings/collection-devices`, and also in `\vsi\vsi_device_config.json`.

## Related pages

[Troubleshooting](https://visualoneintelligence.com/docs/troubleshooting/) for diagnosing failures, and [Supported Devices](https://visualoneintelligence.com/docs/supported-devices-overview/) for per-device parameters.

---

Source: https://visualoneintelligence.com/docs/vsiclient-administration/