Skip to content

Installing ISAM Agent on Linux

Server Selection

The ISAM Agent can be installed on Linux or Windows. For best performance and throughput, the ideal and recommended solution is to install it on the same system that will host the replicated data files.

Preparing to Install

The agent runs as a systemd service. Default values are used for the user account name, user group and profile name to be used, but can be customized. For more information, refer to Preparing to Install on Linux.

Installation

Installing ISAM Agent on a Linux system involves downloading and running an RPM installer. The installation can be downloaded from the Synergex Resource Center.

The name of the installation file will be as shown below, where n.n.n.n is the version number of the product you've downloaded:

ISAM Agent installer
sip-isam-agent-n.n.n-n.el9.x86_64.rpm

The installation is started using the package manager and requires root privileges, like this:

Install ISAM Agent
sudo dnf install sip-isam-agent-n.n.n-n.el9.x86_64.rpm

The product will be installed into the directory /usr/lib/synergex/sip/isam-agent.

Configuration

By default, the ISAM Agent runs on TCP/IP port 2126 and needs two essential configuration values to operate:

  • The URL (including port) of the Configuration Server, if in use.
  • The name of the profile to load.

The default values are

  • Configuration Server URL: https://localhost:5120
  • Profile name: 'default'

If you need to change these values, please refer to the information below.

Changing the Service Port Number

Changing the Configuration Server URL

When the agent starts, it attempts to determine the URL of a Configuration Server in the following ways:

  • Checks for a command-line parameter --config-server followed by the URL and port of the config server.
  • Checks for an environment variable SIP_CONFIG_SERVER that specifies the URL and port of the config server.
  • Checks /usr/lib/synergex/sip/isam-agent/appsettings.json for a ConfigurationServerUrl property that specifies the URL and port of the config server.

Changing the Profile Name

When the agent starts, it attempts to determine the profile name in the following ways:

  • Checks for a command-line parameter --config-profile followed by the name of the profile to use.
  • Checks for an environment variable SIP_CONFIG_PROFILE that specifies the name of the profile to use.
  • Checks /usr/lib/synergex/sip/isam-agent/appsettings.json for a ProfileName property that specifies the name of the profile to use.

Service Management

The ISAM Agent runs as a standard Linux systemd service and can be controlled using the systemctl utility. Some examples of common systemctl commands are as follows:

Show service status:
sudo systemctl status sip-isam-agent
Restart service:
sudo systemctl restart sip-isam-agent
Stop service:
sudo systemctl stop sip-isam-agent
Disable service:
sudo systemctl disable sip-isam-agent
Enable service:
sudo systemctl enable sip-isam-agent

Upgrades

To upgrade the ISAM Agent to a new version:

  • Review the release notes for the new version so you're aware of any prerequisite tasks or tasks that must be completed after the upgrade.
  • Download the installer for the new version and copy it to the target system.
  • Make sure you still have the installer for the version you are currently running, in case you need to revert to that version for any reason.
  • Perform any prerequisite tasks as defined in the release notes.
  • When you're ready to perform the upgrade, stop the service and verify that it stopped.
  • Execute the installer for the new version. You don't need to remove the old version; the installer for the new version will perform an in-place upgrade.
  • Perform any post-upgrade tasks as defined in the release notes.
  • Restart the service and verify that it started.
Upgrade ISAM agent
sudo systemctl stop sip-isam-agent
sudo systemctl status sip-isam-agent
sudo dnf install sip-isam-agent-n.n.n-n.el10.x86_64.rpm
sudo systemctl start sip-isam-agent
sudo systemctl status sip-isam-agent

Removal

To remove the ISAM Agent from a Linux system:

  • Stop the service.
  • Verify that the service stopped.
  • Remove the product using the package manager.
Uninstall ISAM Agent
sudo systemctl stop sip-isam-agent
sudo systemctl status sip-isam-agent
sudo dnf remove sip-isam-agent