Servers - Revision history

SarahK: /* Logging In */

2023-06-29T16:50:11Z

‎Logging In

SarahK: /* Performing a Sync */

2023-02-07T21:18:26Z

‎Performing a Sync

SarahK: /* Creating a Group */

2022-05-03T20:39:55Z

‎Creating a Group

SarahK at 20:38, 3 May 2022

2022-05-03T20:38:00Z

SarahK at 21:39, 14 April 2022

2022-04-14T21:39:16Z

SarahK: /* Assigning Products to a Group */

2022-02-22T21:15:59Z

‎Assigning Products to a Group

SarahK: /* Assigning Products to a Group */

2022-02-22T21:15:46Z

‎Assigning Products to a Group

SarahK: /* Assigning Products to a Group */

2022-02-22T21:14:09Z

‎Assigning Products to a Group

SarahK: /* Deleting a Server */

2022-02-22T21:12:30Z

‎Deleting a Server

SarahK at 21:12, 22 February 2022

2022-02-22T21:12:12Z

Show changes

@@ Line 76: / Line 76: @@
 == Logging In ==
-Some server modules support logging in to the control panel directly from WHMCS. Click the appropriate button to do this. For example, for cPanel & WHM servers, click '''Login to WHM'''.
+Some server modules support logging in to the control panel directly from WHMCS. Click the appropriate button to do this.
 == Sync Accounts ==

@@ Line 92: / Line 92: @@
 To perform a sync:
-# Click '''Sync Accounts''' for the server you wish to analyse. WHMCS will fetch an up-to-date list of account records from the server. This may require a few seconds. Upon completion, an analysis summary report will display.[[File:Server_sync_analyse.png|frame|800px]]
+# Click '''Sync Accounts''' for the server you wish to analyse. WHMCS will fetch an up-to-date list of account records from the server. This may require a few seconds. Upon completion, an analysis summary report will display.[[File:Server_sync_analyse.png|400px]]
 # Review the displayed report. The report displays two columns containing the data retrieved from the remote system (left) and the service record matches in WHMCS (right).
 #* The system highlights differences in red and highlights exact matches in green.
 #* Use the ID column in the WHMCS service record to go to the manage service screen for those records and make manual edits.
 # To update services, check '''Import/Sync''' for the desired service. The type of record determines how the system updates the service (see below).
-# Click '''Continue'''. [[File:Server_sync_review.png|frame|800px]]
+# Click '''Continue'''. <br/>[[File:Server_sync_review.png|400px]]
 # If you want to make any changes, click '''Back'''.  Otherwise, click '''Continue'''. A summary of the sync process will display.

@@ Line 60: / Line 60: @@
 #Choose whether to assign new orders to the least-full server ''(based on the percentage of accounts available within the '''Maximum No. of Account''' value)''  '''or''' fill the default server until it reaches the limit for accounts, and then move to the next server.
 #Select the servers you want to assign to this group in the box on the left.
-#Click '''Add''' to move them to the box on the right, which contains the servers for this group.<br />'''NOTE:''' If you only assign one server to a group, select the ''Add to the least full server'' fill type.
+#Click '''Add''' to move them to the box on the right, which contains the servers for this group. If you only assign one server to a group, select the ''Add to the least full server'' fill type.
 #Click '''Save Changes''' to complete the process.

@@ Line 44: / Line 44: @@
 === Deleting a Server ===
-To delete a server, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' and click the red X icon on the same row as the server you wish to delete. If the deletion succeeds, a message will appear confirming whether you want to delete it. Click OK to remove it.
+To delete a server, click the red '''X''' icon on the same row as the server you wish to delete. If the deletion succeeds, a message will appear confirming whether you want to delete it. Click OK to remove it.
 You cannot delete a server with assigned accounts. This includes terminated and cancelled accounts.
@@ Line 50: / Line 50: @@
 == Server Groups ==
-Server groups allow you to configure servers into sets in which you can assign products automatically, based on your requirements and provisioning settings. For example, you may want shared accounts on certain servers and resellers on others, with accounts being distributed evenly between all the servers you have. Server groups make this possible.
+Server groups allow you to configure servers into sets in which you can assign products automatically, based on your requirements and provisioning settings. For example, you may want shared accounts on certain servers and resellers on others, with accounts being distributed evenly between all the servers you have.
 === Creating a Group ===
@@ Line 65: / Line 65: @@
 ===Assigning Products to a Group===
-You can assign products to groups when you edit them at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' in the '''Module Settings''' tab.
+You can assign products to groups when you edit them at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services''' in the '''Module Settings''' tab.
 === Editing/Deleting a Group ===
 You will see the same interface and options when you edit a group as when you create one.
 *You can add or remove servers from a group at any time.
 *You can set the maximum number of accounts to assign to a server when editing the setup of the individual server.
 == Logging In ==
@@ Line 80: / Line 80: @@
 == Sync Accounts ==
-<div class="docs-alert-info">The Server Sync Tool replaced the '''cPanel/WHM Import''' tool in WHMCS 7.8.</div>
+<div class="docs-alert-info">The '''Server Sync Tool''' replaced the '''[[cPanel/WHM Import]]''' tool in WHMCS 7.8.</div>
-The Server Sync Tool can help you resolve the following issues:
+When you add a new server, it may already have accounts on it that you want to import to WHMCS. The '''Server Sync Tool''' can help you resolve the following issues:
 * Accounts that exist on the remote system (typically a web server) but that do not exist within WHMCS.
@@ Line 94: / Line 92: @@
 To perform a sync:
-# Click '''Sync Accounts''' for the server you wish to analyse.
+# Click '''Sync Accounts''' for the server you wish to analyse. WHMCS will fetch an up-to-date list of account records from the server. This may require a few seconds. Upon completion, an analysis summary report will display.[[File:Server_sync_analyse.png|frame|800px]]
 # Review the displayed report. The report displays two columns containing the data retrieved from the remote system (left) and the service record matches in WHMCS (right).
 #* The system highlights differences in red and highlights exact matches in green.
 #* Use the ID column in the WHMCS service record to go to the manage service screen for those records and make manual edits.
-# To update services, check '''Import/Sync''' for the desired service. The type of record determines how the system updates the service. For more information, see below.
+# To update services, check '''Import/Sync''' for the desired service. The type of record determines how the system updates the service (see below).
 # Click '''Continue'''. [[File:Server_sync_review.png|frame|800px]]
 # If you want to make any changes, click '''Back'''.  Otherwise, click '''Continue'''. A summary of the sync process will display.
-To view more information about the updated records and other changes, check the activity log at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > System > Activity Log'''.
+To view more information about the updated records and other changes, check the activity log at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs'''.
 ==== Sync Report ====
 <div class="docs-alert-warning">
-Auto-imported services will be created under an existing client with a matching email address, or a newly created client where no existing match exists. Since most web server control panels do not track end customer details, we can usually import only an email address and other details must be populated manually. In cases where even an email address is not available, a placeholder email address of {domain}@example.com will be used for the client in WHMCS.</div>
+Auto-imported services will be created under an existing client with a matching email address, or a newly created client where no existing match exists. Since most web server control panels do not track end customer details, we can usually import only an email address and other details must be populated manually. In cases where even an email address is not available, a placeholder email address of <tt>{domain}@example.com</tt> will be used for the client in WHMCS.
 ===== Partial Match =====
@@ Line 115: / Line 112: @@
 Service record exists in WHMCS but there are some discrepancies in data.
-Checking the Import/Sync checkbox for a service like this will result in the service being modified to match the information returned from the remote system.  This can include updating any of the following: domain, primary IP, username, product, status and/or creation date.
+Checking '''Import/Sync''' for a service like this will result in the service being modified to match the information returned from the remote system.  This can include updating any of the following: domain, primary IP, username, product, status and/or creation date.
 ===== Missing within WHMCS =====
@@ Line 121: / Line 118: @@
 This occurs when an account exists on the remote system, but no matching service record can be found within WHMCS.
-Select the Import/Sync option for a record like this will result in a new service record being created. WHMCS will attempt to use an existing product if a match is found, otherwise it will create a new product also.
+Selecting '''Import/Sync''' for a record like this will result in a new service record being created. WHMCS will attempt to use an existing product if a match is found, otherwise it will create a new product also.
 ===== Missing on Remote System =====
@@ Line 127: / Line 124: @@
 This occurs when a service record exists within WHMCS but not on the remote system. You can resolve this using one of the following methods:
-* To terminate the service in WHMCS, check the Import/Sync option. The system will set the service to Terminated within WHMCS.
+* To terminate the service in WHMCS, check '''Import/Sync'''. The system will set the service to '''Terminated''' within WHMCS.
-* To create the service on the server, don't check '''Import/Sync'''. Instead, go to the Service, ensure the details are set correctly and click the Create button to provision it again.
+* To create the service on the server, don't check '''Import/Sync'''. Instead, go to the service, ensure the details are set correctly, and click '''Create''' to provision it again.
 == Status Monitoring ==
@@ Line 134: / Line 131: @@
 <html><a href="http://www.youtube.com/watch?v=0w7YcalU078&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature.</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>
-Status monitoring allows you to view the load and uptime for each of your Linux-based servers from within the WHMCS Client or Admin Areas.
+Status monitoring allows you to view the load and uptime for each of your Linux-based servers from within the WHMCS Client Area or Admin Area.
-To enable this, you must upload the <tt>status</tt> folder in the WHMCS ZIP file download to each of your servers. Then, enter the URL to that folder in the server setup '''Server Status URL''' field. You can also leave the field blank, which disables monitoring for that server.
+To enable this, you must upload the <tt>status</tt> folder in the WHMCS ZIP file download to each of your servers. Then, enter the URL to that folder in the '''Server Status URL''' field. You can also leave the field blank, which disables monitoring for that server.
 WHMCS disables '''PHP Info''' output by default for security reasons. To enable it, edit the <tt>index.php</tt> file and uncomment (remove the <tt>#</tt> character from) the line <tt>#phpinfo();</tt>.
@@ Line 170: / Line 167: @@
 Disabling a server removes it from the daily usage statistics update (which could fail if a disconnected server was active) and moves it to the bottom of all server menus.
-To change the status of a server, navigate to Setup > Servers and click the status icon to toggle to the other status. For example, click the green checkmark icon on an active server to deactivate it.
+To change the status of a server, click the status icon to toggle to the other status. For example, click the green checkmark icon on an active server to deactivate it.

@@ Line 1: / Line 1: @@
 In WHMCS, server modules allow you to quickly enable and configure automation on many popular server control panels. You can add each of your servers in order to assign sales to them and perform other important tasks.
-You can add and modify servers at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
+You can access this feature at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
 <html><a href="https://www.youtube.com/watch?v=NeB5GekyC4Q" class="docs-video-tutorial"><em>Watch the video tutorial for this feature.</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>