High Availability

Overview

High availability is the capability of an IT system to operate at a specified performance level, even when hardware, software, or network components fail. It is typically achieved through redundancy, automated failover, and resilient design so that users experience little to no disruption during outages or maintenance activities.

How high availability works in SharePoint Manager Plus

In SharePoint Manager Plus, high availability is achieved through a failover setup where a secondary SharePoint Manager Plus instance will be installed on another machine. When users connect through a virtual IP or hostname, requests are automatically routed to the primary SharePoint Manager Plus server. If the primary server becomes unavailable, the secondary server seamlessly takes over, maintaining uninterrupted access with minimal downtime.

An image showing the high availability architecture in SharePoint Manager Plus

Prerequisites

  1. Configure an external Microsoft SQL Server database before enabling high availability.
  2. The external database hostname must not be set to “localhost” when enabling high availability.
  3. A minimum of two servers is required to configure high availability: one acting as the primary server and the other as the secondary server which uses the database configured on the primary server.
  4. Ensure all servers run the same build. We recommend that you upgrade to the latest version.
  5. Ensure all servers can communicate without firewall or antivirus restrictions.
  6. Use the same product port number across all secondary servers as configured on the primary server.
  7. Ensure that port 7800 (high availability communication) and the default product ports 8085 (HTTP) and 8086 (HTTPS) are open and reachable on all configured servers.
  8. Confirm HTTP and HTTPS before enabling high availability, as this setting cannot be changed later. All servers must use the same protocol as the primary server.
  9. The user running the product must have admin privileges to bind or unbind the virtual IP for same-subnet mode.

Configuring high availability

  1. Log in to SharePoint Manager Plus and navigate to Admin > Configuration > High Availability.
    Navigating to the High Availability feature in SharePoint Manager Plus
  2. Select Click to Configure to open the High Availability page.
    Configuring high availability in SharePoint Manager Plus
  3. In the Secondary Server(s) section,
    • Enter the hostname or IP address of the SharePoint Manager Plus instance that you would like to configure as a secondary node in the Secondary Server URL field.
    • Enter the Secondary server Admin Username and Secondary server Admin Password.
    • If additional secondary servers are needed, click + Add a secondary server.
  4. In the Access Mode section,
    • If the primary and secondary servers are in the same subnet:
      • Enter the Virtual IP and Virtual Hostname.
      • Leave the Primary and Secondary Servers are on Different Subnets box unchecked.
      • Note The virtual IP automatically binds to the active server in the high availability setup. You can map this IP to a virtual hostname in DNS.
    • If the primary and secondary server(s) are in different subnets:
      • Check the Primary and Secondary Servers are on Different Subnets box.
      • Create a virtual host and provide the hostname in the Virtual Hostname field.
  5. Click Configure.
Note Scheduled tasks will run on the primary server by default. If the primary server fails, the secondary server that was added first to the high availability configuration becomes the active node and takes over the task execution. You can identify which server is currently active on the High Availability page.

Modifying the high availability configuration

Note Changes to the high availability configuration can be made only on the primary server.
  • Steps to modify the high availability configuration:
    • In the Deployment section, hover over an entry and click the edit icon-edit icon.
    • Modify the Virtual IP and Virtual Hostname, and check or uncheck the Primary and Secondary Servers are on Different Subnets box based on whether your servers operate in the same or different subnets.
    • Modifying the access URL in a high availability configuration in SharePoint Manager Plus
    • Click Update.
    Note
    • If the primary server and secondary servers are in different subnets, a virtual IP cannot be used.
    • When changing the configuration from different subnets to the same subnet, ensure that the primary and secondary servers are within the same subnet.
  • Steps to edit secondary server(s):
    • In the Secondary Server(s) section, hover over an entry and click the edit icon-edit icon.
    • Modify the Display Name, Secondary Server URL, Secondary server Admin Username, and Secondary server Admin Password.
    • Editing a secondary server in a high availability configuration in SharePoint Manager Plus
    • Click Update.
  • Steps to add a secondary server:
    • In the Secondary Server(s) section, click + Add a secondary server.
    • Enter the secondary server's hostname or IP address in the Secondary Server URL field.
    • Enter the Secondary server Admin Username and Secondary server Admin password.
    • Adding a secondary server in a high availability configuration in SharePoint Manager Plus
    • Click Add. Once the configuration is successful, the added secondary server will restart and join the high availability setup.
  • Steps to remove a secondary server:
    • To remove a secondary server, hover over the secondary server entry and click the remove icon-close icon.
    • Removing a secondary server in a high availability configuration in SharePoint Manager Plus
    • On the pop-up that appears, confirm your action to remove the secondary server.
  • Step to remove the high availability configuration:
    • Click Remove Configuration under the Secondary Server(s) section to delete the entire high availability setup. After the removal is complete, the primary server will restart, and the secondary servers will become inaccessible.
    Note When removing the configuration, if a secondary server is down, it has to be manually decommissioned to avoid security risks.

Promoting the secondary server to the primary server

When a primary server is down and cannot be recovered, you can promote any available secondary server to the primary role, allowing you to modify the high availability configuration from that server.

  1. Log in to SharePoint Manager Plus from the secondary server.
  2. A pop-up will appear as shown in the image below. Click Promote Now.
    An image showing that the primary server is down in a high availability configuration in SharePoint Manager Plus
  3. You will be redirected to the High Availability page. Here, all available secondary servers will be listed with the Promote as primary option.
    Promoting a secondary server to the primary role in a high availability configuration in SharePoint Manager Plus
  4. Click Promote as primary on the desired secondary server entry to promote it to the primary role.