Device Discovery with the USB Agent Tool

The USB Agent allows SLNX to discover USB-connected devices. The Agent periodically polls connected devices and sends the data to the Delegation Server, which then synchronizes the data with the Core server.

Once the agent is installed on the USB-connected PC, these device will be discovered and appear in the Devices list after a polling interval. The default polling interval is 60 minutes (1 hour) and the devices are identified with a unique icon, shown below.

The following information may be retrieved from a USB-connected device, dependent upon model and vendor: 

  • Generic Items: Manufacturer, Model, Serial Number, Installed Memory, Comment

  • Status Items: System Status, Printer Status

  • Device Counters: Total, Printer Black, Printer Color Full

The Agent does not support SNMP Trap.

You can find the installer in the USBAgent subfolder of the installation package and you can perform either a manual or silent install. Instructions for both methods are provided below.

After installing the USB Agent on target devices, proceed to Create a Polling Task.

Limitations

  • Device Status Lifecycle will not be calculated for USB devices

  • USB devices cannot be selected as Monitored Devices for Notification Policies.

  • USB devices will not be selectable for configuration tasks because no device management is being done for the USB device

Install the USB Agent Manually

  1. Launch USBAgentSetup.exe.

  2. Accept the license agreement to proceed.

  3. In the Security Connection Keys screen, enter the PC Client security key generated during the Core Server installation.

  4. Change the default destination folder if necessary.

  5. In the Delegation Server screen, enter the IP address and port to connect to the Delegation Server. Enable SSL/TLS if using SSL to communicate with the server. In the HTTP port field, enter 9090 when NOT using SSL, or enter 52443 if enabling SSL.

  6. On the Proxy screen, enable HTTP Proxy if using a proxy to connect to the Delegation Server.

  7. Click Install to finish the installation.

The default location for logs is C:\Windows\Temp\Ricoh\USBAgent\logs and the database file is located in C:\ProgramData\RICOH\USBAGENT.

Install the USB Agent Silently

The silent installer allows for unattended installation of the USB Agent. To install silently, the following syntax is used:

USBAgentSetup.exe /s /v"/qn PROPERTIES”

Argument Meaning
/s

Tells the USBAgentSetup.exe to run silently
/v

Tells the USBAgentSetup.exe to pass all parameters within this argument to the internal MSI.
/qn

Instructs the install to run in silent mode with no UI.

Additional options that can be used to set the interface level:

/q[n|b|r|f]

  • n - No UI
  • b - Basic UI
  • r - Reduced UI
  • f - Full UI (default)

When using /qn from a command-line, the command prompt must first be elevated to Administrator privileges. In other cases where there is a UI, the installer can prompt for elevation.
PROPERTIES

See the properties section below.

These are the public properties that are set to configure the system. Each property name is all uppercase, and the value is set via an '='. (i.e. PROPERTY=value).

When property values have spaces, the values must be quoted with the quotes escaped via a \ character (e.g. PROPERTY=\"value with spaces\")

Example: DS_PORT=8080 ENABLE_SSL=0

Properties

The following properties can be set using VARIABLE=VALUE formatting. If there are spaces in a value, they must be surrounded with quotes. These quotes must be escaped with a \. Any \ characters must also be escaped with a \ (i.e. \\).

Example:

USBAgentSetup.exe /s /v"/qn INSTALLDIR=\”C:\Program Files\Ricoh\Streamline NX\USB Agent\” DS_ADDRESS= slnxds.ricoh.com DS_PORT=9090 ENABLE_SSL=0 ENABLE_SSL_TRUST_CERT=1 PLATY_SECURITY_CONNECTION_KEY=”myconnectionkey” HTTP_PROXY_ENABLED=0"

Property Name Meaning Notes /Example
INSTALLDIR Sets the location of the installation

Default Value:

%PROGRAMFILES%\Ricoh
\Streamline NX\USB Agent

Example:

INSTALLDIR=\"D:\\
RICOH\\USBAgent\”
DS_ADDRESS The DNS or IP address where the DS server exists for the USB Agent to communicate

Example:

DS_ADDRESS=
slnxds.ricoh.com
DS_PORT The port on which the communication with the DS server will be done

Example: 

DS_PORT=443
ENABLE_SSL Specifies if the communication to DS should be done over SSL

Available Values:

0 = disabled

1 = enabled

Default Value: 1

Example: 

ENABLE_SSL=0
ENABLE_SSL_TRUST_CERT Specifies if the USB Agent will trust all certificates or do certificate validation

Available Values:

0 = Certificate Validation will be done

1 = All certificates will be trusted

Default Value: 0

Example: 

ENABLE_SSL_ TRUST_CERT = 1
PLATY_SECURITY_CONNECTION_KEY Specifies the PC Client security connection key to establish trust to the DS server

Example:

PLATY_SECURITY_CONNECTION_
KEY="myconnectionkey"

HTTP_PROXY_ENABLED

If enabled, an HTTP proxy will be used to communicate to the DS server.

If enabled, the HTTP_PROXY_USER, HTTP_PROXY_USER and HTTP_PROXY_PASSWORD must be set

Available Values:

0 = disabled

1 = enabled

Example:

HTTP_PROXY_ENABLED=1

HTTP_PROXY_URL

Specifies the URL to the proxy server.

Example:

HTTP_PROXY_URL=
"http://proxy.ricoh.com:8888"

HTTP_PROXY_USER

Specifies the user for authentication against the proxy server

Example:

TTP_PROXY_USER=proxyuser

HTTP_PROXY_PASSWORD

Specifies the password for authentication against the proxy server. This value is encrypted and stored in the registry.

Example:

HTTP_PROXY_PASSWORD=proxypassword