Installing Agents

Signiant Agents provide storage for jobs created in the Manager. Once you have installed an agent, you can create transfer jobs. The following describes a default installation of an Agent, including offline certificate signing. You'll also find instructions on upgrading and uninstalling Agents.

To install an Agent, you'll need to download both its installation information (INF) file and installer. If your installation is keyed, you'll also need the installation key provided by your Signiant administrator. For more information on installation keys, see Installing Managers.

Modifying the Default Agent Configuration

You can customize settings in your INF file prior to installing Agents by going to Administration > Agents > List and clicking Default Configuration. It is important that you make any modifications before downloading the Agent software, as changes you make will then be saved to the INF file.

To customize the default Agent configuration, navigate to the General > Windows Environment/Linux Environment tabs and modify the directory, administration and user settings.

  • Default Directory: The working directory for the Agent. The default is C:\Program Files\Signiant\Mobilize\transfers(Windows) or /usr/signiant/dds/transfers(Linux).
  • Administrators: The name of the administrator responsible for the Agent. The default is Administrator(Windows) or root(Linux).
  • Default User: The default user ID on the Agent. The default is ntauthority\system(Windows) or Root(Linux). To change the default user, enable Specified User and complete the Password, Confirm and Domain fields.
  • Install Directory: The directory in which the Agent software is installed. The default is C:\ProgramFiles\Signiant\Mobilize(Windows) or /usr/signiant/dds(Linux).

Downloading the Agent Installation Software

You can download the INF file (sigsetup.inf) and the installer for your platform from within the Manager.

To download the Agent installation software:

  1. In your Manager, navigate to Administration > Agents > Install.
  2. Read and accept the license agreement.
  3. Click Download inf file.
  4. Under Platform type, select your platform and click Add Agent Bundle.
  5. Click Download Agent Installer.

Installing an Agent

You can install an Agent on Windows, Linux, and macOS systems. After you download your INF file and installer, run the Agent installation program.

To install an Agent:

Windows

  1. In your Manager, run Signiant Setup.
  2. Read and accept the license agreement.
  3. Specify the location of the INF file. This file is typically found in the Downloads folder.
  4. If applicable, enter your installation key.
    Note: After you install the Agent, the software will attempt to automatically sign its security certificate by connecting to the Manager. If it is unable to connect, you'll need to request an offline certificate to complete the Agent installation.
  5. To view the output from the certificate signing request or view any installation errors, select the Setup Log File (sigsetup.log). By default, the setup log file is located at C:\tmp\sigsetup.log.
  6. Click Finish to exit.

Linux

  1. Extract the Agent archive to a temporary folder (e.g. /tmp/sigclient).

  2. At the command prompt, navigate to the folder to which you extracted the archive.

  3. Run ./sigsetup as root to start the installer. If the setup program does not find the sigsetup.inf file in the installation folder, you are prompted to specify its location.

  4. Read and accept the license agreement.

  5. If applicable, enter your installation key.

  6. Follow the prompts to complete the installation.
    Note: After you install the Agent, the software will attempt to automatically sign its security certificate by connecting to the Manager. If it is unable to connect, you'll need to request an offline certificate to complete the Agent installation.

    Note: You can view any installation errors in the Signiant Log File (sigsetup.log). By default, the log file is located at /tmp/sigsetup.log.

macOS

  1. In your Manager, run Signiant Setup.
  2. Enter your password and click OK.
  3. Read and accept the license agreement.
  4. Select the sigsetup.inf file and click Open. This file is typically found in the Downloads folder.
  5. If applicable, enter your installation key.
    Note: After you install the Agent, the software will attempt to automatically sign its security certificate by connecting to the Manager. If it is unable to connect, you'll need to request an offline certificate to complete the Agent installation.
  6. To view the output from the certificate signing request or view any installation errors, select the Signiant Log File (sigsetup.log). By default, the setup log file is located at /tmp/sigsetup.log.
  7. Once the installation is complete, click Finish to exit.

Verifying Manager-to-Agent and Agent-to-Agent Connections

To check that the Manager can connect to the Agent:

  1. In your Manager, navigate to Administration > Agents > List.
  2. Select the Agent and click Edit.

If no connection errors appear in the Edit Agent window, the Manager and Agent are able to connect.

To check that two Agents can connect:

You can use the dds_cnctst command to check if one Agent is able to connect to another. This command is available on Windows, Linux and macOS systems, in the Agent's bin folder.

Default path on each platform:

  • Windows: C:\Program Files\Signiant\Mobilize\bin
  • Linux: /usr/signiant/dds/bin
  • macOS: /usr/local/signiant/dds/bin

The dds_cnctst command, run without additional parameters, performs a connection test on TCP 49221 from that Agent to itself.
The dds_cnctst -udp command performs a connection test on UDP 49221 from that Agent to itself.

If both commands run successfully, the Agents are able to connect.

Offline Certificate Signing

If an Agent is unable to communicate with its Manager to sign its security certificate, you must do an offline certificate signing to complete the Agent software installation.

Once you revoke any existing certificate and generate a Certificate Signing Request (CSR), you can sign the certificate and import it into the Agent.

To revoke an existing certificate:

  1. In your Manager, navigate to Administration > Trusts > Local Certificates.
  2. Select the Agent and click Revoke.
  3. Make sure that Delete Selected Agents is not selected.
  4. Click Yes.

To generate a Certificate Signing Request:

Windows

  1. Access your Signiant Services through Windows Settings.
  2. Stop the Signiant Process Control Service and the Signiant UDP Relay Service.
  3. Launch the command prompt as administrator.
  4. Navigate to the Signiant install folder. Its default location is C:\Program Files\Signiant\Mobilize\.
  5. Back up the bin and security folders, in case a recovery is necessary.
  6. From the bin folder, run the following commands:
    erase *.pem
    dds_cert getnewcert -key keyless
    Note: Most Agent installations are keyless. If your installation is keyed, enter your key in place of keyless.
  7. If required, assign an alternative server name.

The last command produces a CSR file named <agent_hostname>_req.pem (e.g. myserver.example.com_req.pem).

Linux/macOS

  1. Launch the command prompt as root.
  2. Navigate to the bin folder.

    • Linux default location: /usr/signiant/dds/bin
    • macOS default location: /usr/local/signiant/dds/bin
  3. Stop Signiant Services using the following command: siginit stop
  4. In the Signiant install folder, back up the bin and security folders, in case a recovery is necessary.
  5. From the bin folder, run the following commands:
    rm -f *.pem
    ./dds_cert getnewcert -key keyless
    Note: Most Agent installations are keyless. If your installation is keyed, enter the key in place of keyless.
  6. If required, assign an alternative server name.

The last command produces a CSR file named <agent_hostname>_req.pem (e.g. myserver.example.com_req.pem).

To sign the certificate:

  1. Open the CSR file in a text editor.
  2. Copy the contents of the file.
  3. In your Manager, navigate to Administration > Agents > Install.
  4. Click Sign Certificate.
  5. Enter your installation key or select This Agent's organization is "keyless".
  6. Select your platform.
  7. Paste the contents of the CSR file into the large text field in the Sign Certificate window.
  8. Click Submit Request.
    Note: The signed certificate then becomes available. It is named <hostname>_cert.pem
    (e.g. myserver.example.com_cert.pem)
  9. Save this file to a temporary folder (e.g. C:\temp or /tmp).

To import the signed certificate into the Agent:

Windows or macOS: Run Signiant Setup, choosing the Import Certificate option when prompted. Tip: If Signiant Setup is unavailable, you can run the dds_cert update -newcert <signed_cert_file> command to import the signed certificate.

Linux: Run ./dds_cert update -newcert <signed_cert_file>.

To restart Signiant Services:

Windows: From Windows Settings, start the Signiant Process Control Service and the Signiant UDP Relay Service.
Linux/macOS: Run siginit start (e.g./usr/signiant/dds/init/siginit start sigagent).

Note: You can test that the certificate is valid by verifying the connection between the Manager and the Agent.

Updating Agents

The Update option appears when an on-premises Agent application version is lower than the Manager version. To update an Agent or multiple Agents to the latest version, select the Agent or Agents and click Update. If multiple Agents are selected and one Agent cannot be updated, Update will become unavailable and a reason will be displayed.

Note: The Update option is not available for external Agents.

If the update fails, the Version column displays Failed and includes a link to the Job Details page.

Upgrading Agents

You can upgrade Agents either individually or as a group. A single Agent can be upgraded using the Agent installation software. Several Agents can be upgraded at once using the Manager.

To upgrade a single Agent on a Windows, Linux, or macOS platform, re-run Signiant Setup, selecting the Upgrade option when prompted.

Updating Agent Bundles

To update your Agent bundle:

  1. In the Manager, select Administration > Agents > Install. The Version column displays the Agent bundle version you have installed.
  2. In Platform type, select the platform-specific Agent bundle you want to update and click Update Agent Bundle.

The download and installation progress is displayed in the Version column. When the Agent bundle is downloaded and installed, the Version column is updated with the bundle version.

Agent Bundle Pending Install Process

When Install pending is displayed in the Version column, the Agent bundle file has been download but not installed. To complete the installation process:

  1. In the Manager, go to Administration > Manager > Application and click Install.
  2. Click Browse or Choose File, browse to the download folder for your browser and find the Agent ZIP file for your selected platform, select this file and click OK.
  3. To verify that the installation completed correctly, return to Administration > Agent > Install and ensure the Version column is up-to-date with the current Agent bundle version.

Running a Bulk Agent Upgrade

You can upgrade a selection of Agents, once or on a recurring schedule, by adding an upgrade job in your Manager.

To run a bulk Agent upgrade:

  1. In your Manager, navigate to Administration > Agents > Upgrade.
  2. Click Add, or click Edit to change an existing upgrade job.
  3. On the Basic tab, specify the following information:

    • Job Name: Enter a unique name for the job.
    • Job Options: Select the Agents to upgrade.
    • Transport Options: Specify if WAN Accelerator is used.
    • Notification and Logging: Enter one or more email addresses to which any Job Failure Reports should be sent. Select the Log Detail Level (Error, Warn, Info, or Debug). Error provides the smallest amount of detail, while Debug provides the most detail.
    • Job Schedule (optional): Select the frequency of the upgrade job.
      Tip: You can enter additional Job Schedule parameters on the Advanced tab.

Uninstalling an Agent

To uninstall an Agent:

Windows

  1. Run Signiant Setup.
    Note: You can run Signiant Setup by downloading the Agent Installer in your Manager.
  2. Select the Uninstall option and confirm that you want to uninstall the software.
  3. When the uninstallation is complete, click Finish to exit.

Linux

  1. At the command prompt, navigate to the folder to which you downloaded the Agent installer and INF file. By default, these are located in /usr/signiant/dds.
  2. Enter ./bin/siguninstall.
  3. In the Signiant Uninstall program, select the package you want to uninstall (in this case, the Agent) and confirm the uninstallation.
  4. Once the uninstallation is complete, press any key to exit.

macOS

  1. Run Signiant Setup.
    Note: You can run Signiant Setup by downloading the Agent Installer in your Manager.
  2. Enter your password and click OK.
  3. In the Welcome to Signiant Setup window, select Uninstall Signiant Agent.
  4. Verify that Signiant Agent appears in Packages to Uninstall.
  5. When the uninstallation is complete, click OK to exit.