CML - How to move a CML to the new server with different IP address

This document describes how to move one of the nodes in the CML cluster to the new location (with different IP address). The steps are very similar also for the single node installation (1CML only).
It is expected that YSoft SafeQ will be stored in the same path on the new server as on the original server - moving YSoft SafeQ to the new drive/directory would require additional changes, that are not described here.

Warning

If you are planning to transfer the first CML node of the cluster (master) or the standalone CML server, verify in advance that your license can be transferred to the new server. For more information see chapter Transferring license to new system - hardware or operating system change.

Step 1 - server backup

This part describes how to backup server that shall be moved to the new location.

Perform these steps only on the server that shall be moved to new location

1

Open the Services window (e.g. Start => Run => services.msc) and stop all YSoft SafeQ services (stop whole CML server):

  • YSoft SafeQ CML

  • YSoft SafeQ CML DBS

  • YSoft SafeQ Terminal Server

  • YSoft SafeQ LDAP ReplicatorService

  • YSoft SafeQ Web Interface

 images/download/attachments/21955758/01.PNG

 

2

Using  CML Backup tool perform following actions:

 

3

Backup following folders and copy them to the new location (new server):

  • <SAFEQ_DIR>\server\temp

  • <SAFEQ_DIR>\server\spool

  • Folder containing scripts for scanning (in case that scan to script is used)

4

Be sure that all required components for server installation are copied to the new server. Required components:

  • SQDB5 backup

  • SQDB5_SQDW backup

  • Configuration backup

  • Scanning scripts

  • YSoft SafeQ 5 Installation files

Step 2 - new server installation/configuration

This part describes how to install a CML server in the new location.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg Make sure the node you want to move to the new location is stopped.

 

1

Perform following steps only on the server in the new location

1a. Perform the installation

Install YSoft SafeQ in the new location according to Basic server installation instructions.

Installation requirements:

  • Install only one CML server node (Do not connect it in to existing cluster!)

  • Use the same database type as for other nodes that are installed already

  • Untick the "Start SafeQ services after the installation is finished" option

 

1b. Restore databases

Restore databases on a newly installed server according to the CML - Database restore instructions.
images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg Do not start YSoft SafeQ services in the last step of restore procedure! Keep them stopped.

 

1c. Exchange the IP address of the new node in the database

  • Connect to the database SQDB5 using your SQL server management application (pgAdmin III for PostgreSQL or MS SQL server management studio for MS SQL server).

  • Open cluster_server table and enter the new IP address of the node to the column ip_address.

    • SQL query : update cluster_server set ip_address = '<newIP>' where ip_address = '<oldIP>'

    •   example of usage: update cluster_server set ip_address = '10.0.11.46' where ip_address = '10.0.11.20'  images/download/attachments/21955758/dbupdate.PNG

Example on the picture shows the 2nd node of cluster with IP 10.0.11.20 was changed to 10.0.11.46.

 

1d. Edit startup.conf file

Open <SAFEQ_DIR>\conf\startup.conf and edit following attributes:

  • localGUID = set this attribute according to the value from startup.conf of your original server (from the backup of configuration created at the beginning of this procedure)

  • smartq-server-id = set this attribute according to the value from column id in table cluster_server (row with IP address of new server)

  • smartq-server-dbflag = set this attribute according to the value from column db_flag in table cluster_server (row with IP address of new server)

  • smartq-server-name = set this attribute according to the value from column description in table cluster_server (row with IP address of new server)

  • check that smartq-server-ip is properly set

    images/download/attachments/21955758/confdb.png

1e. Edit TerminalServer.exe.config file

Open <SAFEQ_DIR>\terminalserver\TerminalServer.exe.config and set your new IP address in the parameter:

networkAddress = %NEW_IP_ADDRESS%

  • Check that all other attributes are set as it was in the backup of configuration created at the beginning of this procedure.

 

 1f. Restore data from original server

  • Copy spool directory from original YSoft SafeQ server to <SAFEQ_DIR>\server\spool

  • Copy temp directory from original YSoft SafeQ server to <SAFEQ_DIR>\server\temp

  • Copy folder containing scripts for scanning to the same location as it was on the original server

 

2

Perform these steps on all the CML nodes in cluster

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg The update of IP address can be also performed using the SQL query:

  • SQL query : update cluster_server set ip_address = '<newIP>' where ip_address = '<oldIP>'

  • example of usage: update cluster_server set ip_address = '10.0.11.80' where ip_address = '10.0.11.19' 


2a. Connect to the SQDB5 database

The connection shall be made using the management application equal to the type of SQL server that was selected during the installation of YSoft SafeQ (pgAdmin III for PostgreSQL or MS SQL server management studio for MS SQL server). We are describing mainly the procedure for pgAdmin III application, steps for MS SQL server management studio are very similar.

  • Launch the application by going to Start menu => All Programs => PostgreSQL 9.2 (or by going to Start menu => Y Soft Corporation in case of embedded postgreSQL installation).

  • Double-click SafeQ PostgreSQL server connection (in the tree under Servers).

  • Enter the password you have selected in CML installation (for postgres user).

images/download/attachments/21955757/04.PNG

2b. Edit table cluster_server

  • In pgAdmin III go to SQDB5 => Schemas => public => Tables => right-click table cluster_server => View Data => View All Rows

    images/download/attachments/21955757/050.png

 

2c. Edit ip_address field and enter a new IP address for the server where the address has changed

In our example the IP address of 2nd node was changed from 10.0.11.20 to 10.0.11.46.

  • Go to File -> Save once the IP address has been replacedimages/download/attachments/21955758/019.PNG

 

2d. Verify the new IP address in table smartq_servers

  • Verify that the new IP address has been automatically changed also in the table smartq_servers in column ip. If the change has not been done automatically, update IP address also in this table.


2e. Repeat above mentioned action on all nodes of YSoft SafeQ CML cluster (Except the one which has been moved)!

 

3

Perform this step on all YSoft SafeQ CML nodes in cluster (except the one which has been moved):

Open the Services window (e.g. Start => Run => services.msc) and restart all YSoft SafeQ services:

  • YSoft SafeQ CML

  • YSoft SafeQ CML DBS

  • YSoft SafeQ Terminal Server

  • YSoft SafeQ LDAP Replicator Service

  • YSoft SafeQ Web Interface

 

4

Perform these steps on server which has been moved:


4a. Configure permissions for services

  • Open the Services window (e.g. Start => Run => services.msc) and set YSoft SafeQ services to run under the same account as on the old system.

4b. Start the services

Open the Services window (e.g. Start => Run => services.msc) and start all YSoft SafeQ services:

  • YSoft SafeQ CML

  • YSoft SafeQ CML DBS

  • YSoft SafeQ Terminal Server

  • YSoft SafeQ LDAP Replicator Service

  • YSoft SafeQ Web Interface

5

Verify that synchronization in the cluster is functional:

  • Log in to the web interface (YSoft SafeQ Web interface => System => System information)

    • Verify that new IP address is visible in Cluster server info table

    • Verify that all servers are showing status ONLINE (the node you are connected to may show status LOCAL)

    • Verify that synchronization between the nodes in the cluster is functional. See table DBsync database & system pools (non-local servers only). Values in column Database pool priority must not be growing constantly. They shall be changing and they shall be often around 0.

6

Optional step

Now you can delete server with original IP address.WARNING: Do not start YSoft SafeQ services on "original" server

 

Step 3 - configuring ORS to connect to the new IP address of CML

This section describes how you shall reconfigure the ORS server for the connection to the new IP address of the CML server.

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/warning.svg This procedure must be followed every time the IP address of the CML is changed. The procedure must be performed on every ORS server.

 

1

Open the Services window (e.g. Start => Run => services.msc) and stop all ORS services:

  • YSoft SafeQ Terminal Server

  • YSoft SafeQ ORS

  • YSoft SafeQ ORS Web Service

2

Edit file <SAFEQ_ORS_DIR>\conf\modules\ors.conf and set your new IP address of the CML server in parameter:

  • serverIP%NODE_ID%= %NEW_CML_IP_ADDRESS%

images/download/attachments/21955758/ors.JPG

3

Delete ORS cache

Delete folder <SAFEQORS_DIR>\server\cache


4

Open the Services window (e.g. Start => Run => services.msc) and start all YSoft SafeQ ORS services:

  • YSoft SafeQ Terminal Server

  • YSoft SafeQ ORS

  • YSoft SafeQ ORS Web Service

Other required reconfiguration

This section describes what additional steps must be performed for a proper functionality of the YSoft SafeQ once the IP address of one CML node has been changed.

 

1

Reconfigure all print drivers (or YSoft SafeQ clients) to connect to the new IP address

All print drivers that were connected to the CML with old IP address must be re-connected to the new IP address.

 

2

Reconfigure HW terminals:
If you are using hardware terminals, make sure that they are pointing to the new IP address.

 

3

Reinstall all embedded Terminals:

Reinstall all embedded terminals that shall be connecting to the server with the new IP address.

 

4

Reconfigure CRS server (IP address of CML has to be changed):

If you are using a CRS server, the new IP address of the CML server has to be updated also on the CRS side. The modification has to be done in the following places:

4a. database yBoxDB

  • table smartq_servers, column ip

4b. database yBoxDBCDC   

  • table smartq_servers, column ip

4d. database yBoxDBREP

  • no changes are required