DM Agent Command Line

You can deploy the DM Agent to target devices via a command line executable. The PC where you run this executable must have connectivity to the MFPs on which you want to install, uninstall, or reinitialize the DM Agent.

Before you start, prepare a CSV file that contains only the IP Addresses of the target MFPs.

A firmware update is not possible via the command line. Instead, follow the instructions in Configure the DM Agent Deployment Tool to update firmware.

  1. Open a command prompt and navigate to the installation path of RICOH Streamline NX (by default the path where the tool is located is c:\Program Files\Ricoh\ RICOH Streamline NX \tools\DMAgentDeployment, but the full path may be different in your installation).

  2. Run the executable dm-agent-tool.exe [command] [options], and use the tables below to supply the [command].

    A sample full command might look as follows:

    dm-agent-tool.exe install --ds-url "https://example.com/ds" --security-key "your-security-key" --devun"admin" --devpwd"" --proxy-server "proxy.example.com:8080" --proxy-auth-type "1" --proxy-username "proxyUser" --proxy-password "proxyPass123" --csv "devices.csv"

    Command

    		 Description
    install Install the DM Agent on target devices
    uninstall Remove the DM Agent from target devices
    reinitialize Reinitialize the DM Agent on target device (but does not update firmware)

  3. The following table supplies the [options].

    4. Option

    		 Description Required? 
    --ds-url <URL> Device Server URL

    Required
    --security-key <key> Security Connection Key

    Required
    --devun <username> Device Administrator Username

    Required

    --devpwd <password>

    Device Administrator Password

    Required

    --sdkpwd <password>

    SDK/J Password

    Optional

    --proxy-server <server:port>

    Proxy server address and port

    Optional

    --proxy-auth-type <type>

    Proxy authentication type

    0: No authentication

    1: Basic authentication

    2: NTLM

    3: Kerberos

    Optional

    --proxy-username <username>

    Username for proxy authentication

    Optional

    --proxy-password <password>

    Password for proxy authenticati

    Optional

    --proxy-kdc<kdc>

    KDC for Kerberos proxy authentication

    Optional

    --proxy-realm <realm>

    Realm for Kerberos proxy authentication

    Optional

    --proxy-principal < principal >

    Service Principal Name for Kerberos proxy authentication

    Optional

    --csv <path>

    Path to CSV file with device details

    The CSV file must contain the IP Address for each target device.

    Required

After running a command, you can find the result at the following location:

C:\Users\{user}\AppData\Roaming\Ricoh\Streamline NX\DMAgentDeployment\result_output\deployToolResultFile_{date}.txt