MachPanel Knowledgebase

PFSense Deployment & Integration Prerequisites (Hyper-V Environment)

zohaib.shaikh — Wed, 01 Apr 2026 15:39:06 GMT

Summary

It describes how to integrate and deploy pfSense CE in MachPanel Hyper-V environment.

Applies To

Applies to MachPanel build v 8.2.50 and above

Overview

This document outlines the prerequisites and key configuration requirements for deploying pfSense CE in a Hyper-V environment and integrating it with MachPanel. Adhering to these guidelines ensures consistency, scalability, and seamless operation, especially in high-availability (HA) setups.

1. pfSense Deployment on Hyper-V

Deploy pfSense CE as a virtual machine on Hyper-V hosts by following the official Netgate documentation:  https://docs.netgate.com/pfsense/en/latest/recipes/virtualize-hyper-v.html
Ensure that the VM is provisioned with appropriate resources (CPU, RAM, and storage) based on expected workload and tenant usage.

2. Network Interface Configuration

Configure network interfaces in pfSense as per deployment requirements.
Maintain consistent interface naming and ordering across all pfSense instances (Primary and HA peers).

Important:  Consistent interface naming and ordering are critical for proper synchronization between pfSense nodes in high-availability configurations.
Reference Topology.

Below are two pfSense Servers shown side by side as example:

3. Virtual Switch & Interface Alignment

Ensure that the Hyper-V virtual switch name matches the corresponding pfSense interface name used for tenant communication.
Recommended naming convention: "TENANTS" (ensure correct spelling and consistency across all systems)

Important:  The naming must be identical across:

Hyper-V Virtual Switches - required for pfSense deployment.
pfSense Interfaces  - required for proper mapping and automation via MachPanel.

4. Trunk Configuration

Configure the "TENANTS" virtual switch on Hyper-V as a trunk port.
This allows multiple VLANs to pass through, and enables tenant-level network segmentation.

**Sample Commands to configure Trunk - executed on hyper-v host

Steps for PFSense1 Server:
Command 1:
Get-VMNetworkAdapter -VMName PFSense1 | Select Name, SwitchName, MacAddress
==> Copy MacAddress (Lets say: 00155D1E0775)
Command 2:
Get-VMNetworkAdapter -VMName "pfsense1" |
Where-Object {$_.MacAddress -eq "00155D1E0775"} |
Set-VMNetworkAdapterVlan -Trunk -NativeVlanId 1 -AllowedVlanIdList "1-4094"

**Repeat steps for PFSense2 Server:
Command 1:
Get-VMNetworkAdapter -VMName PFSense2 | Select Name, SwitchName, MacAddress
==> Copy MacAddress (Lets say: 00155D1E0779)
Command 2:
Get-VMNetworkAdapter -VMName "pfsense2" |
Where-Object {$_.MacAddress -eq "00155D1E0779"} |
Set-VMNetworkAdapterVlan -Trunk -NativeVlanId 1 -AllowedVlanIdList "1-4094"

5. REST API Configuration and MachPanel Integration

Install the pfSense REST API package.
Generate and securely store the API key, which will be required for MachPanel integration. Reference:  https://github.com/pfrest/pfSense-pkg-RESTAPI
Once pfSense servers are set up, configure them in MachPanel as Master and Slave one by one:

Configure Admin Access on HTTP for demo setup:

Configure REST API Settings:

Configure REST API Keys:

Configure MachPanel and Integrate pfSense Server in MachPanel:

Configure Interfaces in MachPanel:

Add Master and Slave pfSense Servers in MachPanel:

6. High Availability Considerations

For HA deployments:
Apply identical configurations across all pfSense nodes.
Ensure:

Interface naming consistency
Matching virtual switch configurations
Proper synchronization settings

Failure to maintain consistency may result in sync failures or unpredictable behavior.

High Availability configuration required on Primary/Master PFSense Server:

VMIntegrationService Fails On Host Having Language Other Than English

rehan_waseem — Thu, 22 Aug 2024 09:04:41 GMT

Summary

This article give information about fixing the issue faced when Hyper-V host Server have language other than English, then the VMIntegrationService "Guest Service Interface" fails on it.

Applies to

Applies to MachPanel v7 and above

Details

When Hyper-V host have language other than English, then following command gets failed, as it looks for "Guest Service Interface" and it was not found because of the different language of Hyper-V host

While searching the whole service of the VM it shows this service with different name as shown below

Resolution

To fix this issue below should be done.

Have to set correct name on Hyper-V Host machines in registry. The integration service name can be mentioned in registry path: SOFTWARE\MachSol\MachPanel, new string key: VMIntegrationServiceName, value: "Guest Service Interface". Update the value "Guest Service Interface" in desired Host Machine Language.

MachPanel KeyCloak SSO Authentication

zohaib.shaikh — Thu, 16 Mar 2023 07:26:33 GMT

Summary

This article provides you information about how to configure MachPanel KeyCloak SSO Authentication in MachPanel.

Applies to

Applies to MachPanel v7.2.11 and above.

KeyCloak Single-Sign On Overview

KeyCloak is an Open Source Identity and Access Management. It is used to Add authentication to applications and secure services with minimum effort.

Users authenticate with KeyCloak rather than individual applications. This means that your applications don't have to deal with login forms, authenticating users, and storing users. Once logged-in to KeyCloak, users don't have to login again to access a different application.This also applied to logout. KeyCloak provides single-sign out, which means users only have to logout once to be logged-out of all applications that use KeyCloak.

Integrating KeyCloak SSO with MachPanel

Step 1:

Download KeyCloak

Unzip the Package.
Open CMD and navigate to BIN folder inside the directory containing the unzipped package.
Execute: kc.bat start-dev

Browse https://<IP.of.KeyCloak.Machine>:8080 (Replace "<IP.of.KeyCloak.Machine>" with the IP of KeyCloak Server.
Create Admin user for Master Realm. Like:
- Username: Admin
- Password: Admin
Login via Admin User.

Step 2: (If you already have Realm available then Skip this step and move to Next Step)

Always create New Realm. Do not use Master Realm

After creation go to Realm Settings and set "Require SSL" to "None".

Step 3: Configure "User Federation" (If you already have Federation Configured then Skip this step and move to Next Step)

Navigate to "User Federation" and click on "Add new Provider" button:

Configure as follows:

Set "Console display name" and select "Vendor" as "Active Directory" from drop down:

Set "Connection URL" as LDAP://<AD Server IP>:

Set "Bind Type" as "Simple".

Set "Bind DN" by copying "Distinguished Name" of your "Administrator" account.

Set "Password" of the Administrator account.

Configure LDAP Settings for searching and updating users from AD to Realm as follows:

"Users DN" = Distinguished Name of OU from where the users have to be searched / updated.

"Username LDAP Attribute" = Attribute that needs to be used for login authentication. Set "userPrincipalName" here.

Set other parameters as follows:

Set "Synchronization Settings", "Kerberos Integration" and "Advanced settings" as shown below and finally hit "Save" button:

Step 4: Create and Configure Client:

Navigate to "Clients" under Newly configured Realm and click on "Create Client" button:

Configure as follows (replace https://supportpanel.machsol.com with https://<yourpanel.yourdomain.com> where applies):

Step 5 (Configure MachPanel to work with KeyCloak):

Configure following in MachPanel, Navigate to Home > System Configuration > Authentication being logged in as Provider in MachPanel:

Scroll down to enable "KeyCloak SSO" and enter the required details:

Make sure the "Issuer Endpoint" URL is accessible from MachPanel Control Panel server.

Its up to you to enable or disable the "Auto-Redirect to KeyCloak Login" and "Signout from KayCloak on panel Signout" options.

You can get "Issuer Endpoint" from following interface in "KayCloak":

You can get "Client Id" from following interface in KeyCloak:

Lastly, you can get "Client Secret" by clicking on "Client ID" and then going to "Credentials" tab:

After setting all the values in MachPanel, hit save and your panel will start redirecting to KeyCloak Login Page for authentication.

After that when you try to login to your panel you will be redirected to KeyCoak Sign showing the Machpanel SSO Realm Name in title:

Step 6: Lastly you must associate AD Accounts with Staff and/or Customer Accounts and Contacts:

Before Login, ensure that you associate your Provider/Provider Staff, Reseller/Reseller Staff, Customer and Customer Contacts with appropriate AD Accounts in MachPanel.

You can do that by following the details on KB link below:

https://kb.machsol.com/Knowledgebase/55606/Authenticate-Active-Directory-user-Staff-Customer-and-Contact

If you login to KeyCloak via a user that exists in AD and is able to authenticate, but its not associated with any staff/customer/contact in MachPanel, then you will get an error as follows:

Clicking on the link will log you out of KeyCloak and allow you to login again using a correct user.

If there is ever any issue and you want to update configuration of MachPanel but cannot login due to issue with KeyCloak configuration, you can login to MachPanel directly 'bypassing SSO' by using "http://localhost:786" directly on the control panel server (the default URL for MachPanel).

Ingram Micro integration for O365

mudesira.munir — Wed, 10 Aug 2022 13:53:14 GMT

Summary

This article provides step by step information to configure "Ingram Micro integration for O365" in MachPanel.

Applies To

This applies to v7.0.40 & above

Ingram Micro (CSP Indirect Reseller) Integration

Ingram Micro is a third party distributor which partners with IT infrastructure and services providers to optimize their businesses. There are two steps to integrate Ingram Micro in "Automation Module for Microsoft CSP".

STEP-01: Add CSP Distributor:

Navigate to path: Home > Service Director > Microsoft CSP > CSP Distributors, click "Add CSP Distributor".

Fill these details and Click "Save".

Distribution Provider: Select Ingram Micro
Name: Type Name of "CSP Indirect Reseller" profile which helps you remember it.
Description: Provide description.
API End Point: You get the following details from your provider including API End Point.
Subscription Key: How to get Cloud Marketplace API Subscription Key
User name: Provide User name.
Password: Provide password.
Marketplace Code: xx (A two letter Market code like US, UK, NL etc.)
Status: Editable, can be Enabled or Disabled
Send cancel approval notices to email: Provide email address.

Added CSP Indirect distributors will be listed like this

In above listing "Options" can be use to edit or remove a record.

STEP-02: Add CSP Profile for Ingram Micro:

Now navigate to Home > Service Director > Microsoft CSP > Microsoft CSP Profiles.

Under Microsoft CSP Profiles tab, Click "Add CSP Profile" to add a new profile.

Choose "CSP Indirect Reseller", fill the following details, Select the Distributor just added.

Profile Name: Provide friendly name
Distributor: Select newly added CSP Indirect Reseller as distributor.
Sell to location: Your region
Azure Environment: Select environment.

Tenant Management Azure App Configuration for Tenant Management

Azure App Id: Provide azure appid.
Azure App Certificate Thumbprint: Provide thumbprint of azure app certificate.
Azure App Client Secret Value: Provide azure app secret value.
Enable Direct Routing for Teams: If enabled, following details need to be specified as well
- Base FQDN of Provider SBC:
- Dedicated Trunk or Derived Trunk

Once Indirect Reseller profile is added, it will be shown in CSP profile listing (Separate Section: CSP Indirect Reseller)

Here you see "Options" as well to manage (i.e., to Edit, Test, and Remove). Further flow is same i.e., Commercial SaaS Products is there to add/sync NCE Products and add/update NCE product prices just like a Direct Partner CSP profile.

CSP Indirect Reseller Profile can also be selected in "Microsoft 365 Partner Profile" while creating Microsoft CSP Products/Plan.

Remote user Mailbox Feature for 0365 Hybrid Integration

Khurram.hameed — Mon, 09 Aug 2021 09:27:03 GMT

Summary

This article provides a summary on How to add/Manage O365 (Remote) Mailbox.

Prerequisites

Please follow the steps given below in sequence

On premises Exchange Hybrid is configured
Customer has exchange and office 365 subscription active in MachPanel on same (local AD) organization.

Step to create

Navigate to manage exchange subscription (i.e. Home > Service Director > Exchange Hosting > Exchange Accounts > Manage Service)
Go to Tab: Mailboxes, click to add mailbox, drop down list now contains another option O365 mailbox
Further flow is just like adding/managing a new mailbox

ENOM Domain Registrar and SSL Vendors Integration

rehan_waseem — Fri, 19 Jun 2020 20:05:15 GMT

Summary

This article describers how to Integrate Domain Registrars (Enom).

Applies To

This article applies to MachPanel all build versions

Integrate Domain Registrars:

Control Panel Supports automated domain registration, renewal, and transfers with supported domain providers. To view the list of available hosting panel providers, navigate to: Home » System Configuration » Providers » Domain Registrars

Currently following domain providers are supported:

DirectI(Logic Boxes)
DK Hostmaster Registry
Enom
Offline Domain Registrar
OpenSRS
Registry.be
RRPproxy
RRPproxy EPP
SIDN EPP
Stargate
TransIP

*Note: You can also check the Connectivity of Integrated Domain Registrar

Click on the Configure link and follow the instructions below: In this KB we are using ENOM as an example.

Provider: Friendly name for this provider. No need to change this field.
Enable eNom: Select NO only if you want to disable the registrar. This will result in removal of TLDs assigned to this registrar from order forms and prevents system from renewing these TLDs.
Enable Test Mode: Select YES if you want to perform test domain registrations.
Allow Transfer: Will you allow domain transfer? Select Yes.
Allow Change Contact Info: Will you allow user to change domain contact info? Select Yes.
Parked Domain Name Servers: Select the name servers assigned by default to domain registrations.
Allow Register Name Server: Will you allow to register child name servers? If selected Yes, customer can register child name servers using customer control panel.
Admin Contact: Check Use Customer Profile Data if you want to use customer's profile for admin contact of newly registered domains, otherwise enter the information in the fields given.
Technical Contact: Check Use Customer Profile Data if you want to use customer's profile for admin contact of newly registered domains, otherwise enter the information in the fields given.
Billing Contact: Check Use Customer Profile Data if you want to use customer's profile for admin contact of newly registered domains, otherwise enter the information in the fields given.

Important: eNom TEST and LIVE servers are restricted by IP. You must contact eNom support, provider them your IP and request to allow it for TEST/LIVE API calls.

To do this:

Log into your eNom reseller account, click on left menu option Help then, eNom Support Center link.
Click the request help feature from Support Center tool.
Send your login name and the IP address you want added to the live environment.
You will receive a confirmation email with the case assigned.
eNom will reply back via the assigned case when it's completed.

Selling/Provisioning of Domain Name Products:

You can sell Domain Names either via Offline Order Form (MachPanel) or via E- commerce (Online Store)

Sell Domain Name via Offline Order Form (MachPanel)

Select Order Type, select TLD you created with the Enom registrar, provide VAT number and click Shopping cart as shown below:

Click Next.

Provide payment information for domain name product. Click Save when done.

You will land on Service Queue page where you can finally RUN the product. Or it will provision automatically.

Click Control to manual Configure settings for example NS etc.

Under Home >> Customer Manage >> Customers. Click on Customer Number and select Subscription tab. You will see the Domain Name product there.

Sell Domain Name via E- commerce (Online Store)

Once the order form is set up, you will see Launch Store link. Click on the link to launch the newly configured store.

Integrate SSL Vendors

To view the list of available hosting panel providers, navigate to: Home » System Configuration » Providers » SSL Vendors

Following domain providers are supported:

Digicert:

Click on Configure to configure the Digicert Provider.

Provider Customer Name, Customer Account # and API Key

After that Click Digicert Cert Central and provide API Key and Parent Division Id which you can get from your Digicert Central Portal. For API URL you can give this https://www.digicert.com/services/v2/ and check 'Enabled'

Selling/Provisioning of SSL Accounts

You can navigate to Customer Manager > Customers and then click Customer Id

Go to Subscription menu and click 'Subscribe Service'

After Billing Currency and then select DigiCert SSL

Then from the list choose you required Certificate and click Purchase Now

It will load the Add Organization pop-up and on the below you can Click 'Purchase Now'

RDS (Remote Desktop Services) Integration, Subscription and Management

mudesira.munir — Wed, 11 Dec 2019 11:43:30 GMT

Summary

This article provides information about how to Integrate, Subscribe and Manage Remote Desk Services (RDS) in MachPanel Control server.

Applies To

MachPanel version 7 and above

Prerequisites

Active Directory Domain is Integrated https://kb.machsol.com/Knowledgebase/50263/-Add-Active-Directory-Domain-in-MachPanel

Procedure

Enable RDS module: Log-in as Provider (or its Staff with abilities to Enable Built in Modules) Navigate to Home > System Configuration > Built-in Modules (../RCC/System/ConfigureModules.aspx)

Log-off and Log-in again to see changes.
Enable RDS provider(s) (should be enabled by default):
Navigate to Home > System Configuration > Providers > RDS Providers then Check "Enabled" and Click Save:

Add Server Group

Navigate to Home > Service Director > RDS Hosting > Server Groups click to Add Server Group

Server Group Name: A name of one's own choice
Provider: Select from enabled RDS Provider (s)
Active Directory Domain: Select from Active Directory Domains

Add Server to Server Group:

Navigate to: Home > Service Director > RDS Hosting > Server Groups > Servers

Once you click "Servers" button, you get following screen to fill in "Server FQDN", "Server IP" and "Roles" in RDS Server settings:

Server FQDN: This is the Fully Qualified Domain Name for RDS Server.
Server IP: This is the IP address (as per IP Binding in MachPanel Remote Configuration Studio) of RDS Server.
Roles: This is the designated Server Role (deployed on remote RDS server). You can select "RD Connection Broker", "RD TS Gateway" or "Both" from drop-down:

Once added, Server will be shown in listing like this:

Click Test Service to ensure that connection is successful.

Add Microsoft RDS Service Plan

Navigate to Home > Service Plans > RDS Hosting, Click "Add New Product" from "Reseller Product Listing" or "Customer Product Listing" to add new plan for Reseller or Customer accordingly.
Flow is same as that of other modules (https://kb.machsol.com/Knowledgebase/52399/Creating-Service-Plan-Package-in-MachPanel) with the exception that cost and price of each resource can be set individually.

Basic Info

Resources

Payment Cycle and Payment Group Selection

Price Group: Cost and Price against each collection

Associate Add-on (only billing only add-on is available)

Click Finish button to complete package creation.

Subscribe customer to RDS Hosting Service:

Follow the steps as highlighted on KB link below but choose "RDS Hosting" from Service selection:
https://kb.machsol.com/Knowledgebase/50275/Sell-a-service-to-customer-in-MachPanel

After order is completed, Job is added to Service queue, after getting processed subscription will list in RDS Accounts

Manage RDS Hosting:

Navigate to Home > Service Director > RDS Hosting > Accounts

Clicking "Manage" link will take you to General Information tab:

You can put the subscription On-Hold, mark it Cancelled and /or Generate Renewal Invoice. Subscribed Add-on(s) and Billing details can be viewed in next two adjacent tabs.
You can view or add Policies from Polices Tab:

Click "Add Policy" button to add new policy:

You can view or add User Settings by clicking on User Settings Tab:

Lastly, You can Add New File Share and Sync All File Share Used Storage by clicking File Share.

You can navigate to detailed management of RDS Organization by going to RDS Organizations Tab and clicking on "Manage" button. Afterwards you get to see detailed management options as below:
Organization show read only Organization related information.

Security Group

User in an RDS organization are listed where these can be searched based on any of the given search filters

Add user

Add users in bulk using .csv

Update users in bulk Using .csv

Operations on User can be performed by clicking against any user in RDS users' listing

Like click on change password shows pop-up to change password

Edit user Interface looks like

Status and progress on actions performed can be tracked in Group Actions (Adjacent Tab)

Avalara Integration/Configuration

mudesira.munir — Mon, 04 Mar 2019 05:59:28 GMT

Summary

This article provides a summary on how to integrate/configure Avalara in MachPanel.

Applies To

This article applies to MachPanel build v6.0.38.

Avalara Integration/Configuration

The Avalara Integration fetches either the default company\client configuration present in Avalara, or the other manually configured Tax Jurisdictions from Avalara to calculate taxes for customers created in MachPanel for their invoices and stores tax calculations.

Settings that need to be configured in Avalara account:

Company Settings (These settings are done in Avalara AvaTax account by company itself.)

Default company supported. (If we don’t mention any company it will by default go to default company for both buyer/seller.)

Tax jurisdictions need to be configured.

Settings that need to be configured for Avalara in MachPanel:

Navigate to following path: Home > System Configuration > Billing Configuration > Taxation > Tax Zones

Configure Tax Zones

Use Built-In Taxation.

Use Avalara for Taxation: If Avalara for Taxation is selected, it will show Avalara form.

Avalara API inputs:

Account ID

License Key

URL = https://rest.avatax.com

Select Locale

Save Options for related Company (Provider or the reseller being configured). For a new reseller created, by default MachPanel Taxation will be ON.

Transactions handling:

When creating new Customer/Reseller following new fields will be shown under "Personal Info" section by checking Is Taxable:

CompanyTaxId/Vat Number (Required)

Tax exemption Id (Optional)

Handled in:

a. PCC
b. RCC
c. CCC
d. STORE
e. API

i. Added new API call “UpdateCustomerTaxId(TaxOrVATId,
ExemptionId)
ii. Existing API for create customer or reseller is not edited

CompanyTaxId/Vat Number and Tax Exemption Id view/edit added in:

i. PCC
ii. RCC
iii. CCC

In Offline order in PCC/CCC, Store, API handled tax using Avalara if enabled.

Tax will be calculated using Avalara SaleOrder, display tax amount (no percentage etc. to display, just display total tax amount with currency like USD 10.00).

Two-factor authentication (2FA)

zohaib.shaikh — Sun, 23 Apr 2017 04:25:20 GMT

Summary

This article provides summary on how you can configure Two Factor authentication (2FA) in MachPanel.

Applies To

This article applies to MachPanel Build v6 and above.

Two Factor Authentication (2FA):

Two Factor Authentication, also known as 2FA, two step verification or TFA (as an acronym), is an extra layer of security that is known as "multi factor authentication" that requires not only a password and username but also something that only, and only, that user has on them, i.e. a piece of information only they know.

To Configure 2FA settings in MachPanel, navigate to the following path: Home » System Configuration » Authentication. Select Two Factor Authentication Settings tab.
Check Enabled All sorts of options are possible to entertain different scenarios about enabling/disabling 2FA on different levels (Staff/Resellers/Customers) using the checkboxes highlighted below:
1. Enabled: Enabled will enable the option globally without affecting any users. It is up to the user to enable/disable the option for himself/herself.
2. Enable by default for new (i) Customers (ii) Resellers (iii) Staff Users: This means that after saving configuration having this checkbox enabled, the respective new Customer/Reseller/Staff will have the option to use 2FA enabled by default.
3. Update Existing Users: This option will update existing users based on the previous settings.
  1. If only "a" is Checked and "b" is Unchecked, the option will be disabled for existing Customers/Resellers/Staff.
  2. If "a" and "b" both are Checked, it means that option will be enabled for existing Customers/Resellers/Staff.

For 2FA Settings Authenticate Using following:

Send PIN through Email
Send PIN through SMS
Authenticator App

Send PIN through Email:

Select PIN expires in Minutes. Save Settings

You can configure Email address at following path: Home > System Configuration > Emails Configuration > Email Templates

Send PIN through SMS

For this option you have to navigate to System Configuration > SMS Setting

Provide Twilio API Settings.

Account SID: Here provide the twilio Account SID.
Auth Token: Provide twilio account authentication token
Number: Provide your number.
Twilio API URL: Provide the Twilio API URL.

SMS Templates

Navigate to System Configuration > SMS Setting >SMS Template Add "Templates" for the PIN SMS to be sent. See snapshot below:

Authenticator App

Mobile Authenticator App can be used to enable App Authentication in MachPanel.

How Login Works for Authenticator app?

1^st time login
1. After password is verified
2. User is shown a QR code
3. User will scan QR code using any app, suggested apps are (Google Authenticator, Microsoft Authenticator, Authy 2-Factor Authentication)
4. When QR code is scanned, user will get 6-digit auth code in application.
  1. Warning: Code changes in 30 seconds.
  2. 6-digit TOTP Code in application
  3. In case user account is duplicated, then latest one will be valid.
5. User will input code, if code is accepted user is logged in.
Returning user login
1. Same as 1^st time login but no need to scan QR code.
2. User just needs to enter code from his mobile app.
Reset Authenticator App.
1. Needed in case user lost his device, or reinstalled app and does not have code available.
2. Click on Re-Authenticate your mobile authenticator app link.
3. Enter registered email address and hit Submit to get secret key on your registered email address:
4. Check your email for secret key and enter the received secret key on Step 2 and hit "Re-Authenticate your mobile authenticator app" button:
v. Finally you will be taken to login screen, where you can enter your login/password and then you will be asked to register a new authenticator app.

Duo Authentication

Log in to the Duo Admin Panel at https://admin-b3a41f98.duosecurity.com/ using your credentials.
Navigate to the "Applications" section in the menu.

Click on "Protect an application" to begin configuring a new application for protection.
Search and Choose "Web SDK".

Update desired settings / parameters like Name etc. OR leave unchanged. Lets set the name as "MachPanel-Web SDK Application".
Copy the details to notepad (or copy directly to MachPanel). You need "Client ID", "Client Secret" and "API hostname".
Hit "Save" at bottom of screen.

Enter the copied details into the appropriate fields within MachPanel for integration.
Click on "Save Settings".

Based on the settings, you or your customers (resellers/customers) will get option to enable and configure the Duo Security App for 2FA.

Click on "Save" and if its a new account, you will need to scan the QR code to add application on your device.

If existing account, you will be presented with option to accept the "Duo Push" notification on your device.

Finally you will be logged in to the panel after successful verification/approval.

Exchange Severs configuration and Global Settings in MachPanel.

rehan_waseem — Mon, 21 Apr 2014 03:15:31 GMT

Summary

This article provides a summary for integration of Exchange server, creating\selling of Exchange service plan, and service management (adding mailboxes, contacts, DL's, public folders etc.) in MachPanel.

Applies To

This article applies to MachPanel Build v7

Prerequisite

MachPanel Control Server Installation
http://kb.machsol.com/Knowledgebase/Article/50261
MachPanel Remote Server Installation
http://kb.machsol.com/Knowledgebase/Article/5026

Customization of MachPanel:

Customization of MachPanel includes Personalization, Localization, Layout Settings, Menu Setting, Theme changes & Email Templates etc.

Company profile settings are used in all the documents where company information is displayed. For example, Invoice document, Payment document, customer control center etc.

Please review the following KB article for further details:

http://kb.machsol.com/Knowledgebase/Article/50300

Management of Exchange Server Group in MachPanel

Integrate Exchange in MachPanel:

To integrate Exchange in MachPanel, navigate to the following path:Home » Service Director » Exchange Hosting » Server Groups and Add a Server Group. See the snapshot below:

To integrate Exchange in MachPanel please review the following KB article for further details:

http://kb.machsol.com/Knowledgebase/Article/50264

Email Clients

To integrate Email Client please follow below KB article:

https://kb.machsol.com/Knowledgebase/53475/How-to-integrate-Email-Client-charge-for-the-license

General Settings

You can set below setting on Server Group level for your Exchange Subscriptions

For checkbox setting Quota to 0 on Disable.
- This feature will work as needed for any mailbox disabled/enabled after the update is deployed.
- For existing mailboxes already disabled, you have to enable and then disable mailbox Or you can use set quota to 0 using PS: Set-Mailbox "UPN" -MaxSendSize "0" -MaxReceiveSize "0" (Have to replace UPN with UPN of mailbox.)
- Also, following query can be used to generate the PS commands: Select 'Set-Mailbox "' + UPN + '" -MaxSendSize "0" -MaxReceiveSize "0"' from HB_tblExchangeMailboxes where Disabled='1' and UserLDAPUrl!=''
- Above query will generate PS commands for the mailbox which are already disabled before the update. So you can copy those commands and execute them on Exchange Powershell.

Create Send Connector for Relay Accepted Domain
- You can create Send Connector for Internal/External relay domain using below KB article:

https://kb.machsol.com/Knowledgebase/55687/How-to-add-SMTP-Mail-Domain

OWA Mailbox Policies
- When a new server group is added, OWA policy is automatically added with default values in Database and within few minutes the policy get created on backend Exchange too. (When policy is created or modified, edit/remove buttons become disable)
- You can also create OWA mailbox policy as provider under the Server Group Setting
- You can give the policy name, choose your Server Group and then select Customers or select All

Then you can check/uncheck Communication Management resources

Similarly check/uncheck resources for Information Management, Security, User Experience, Time Management, File Access and Offline Access

At the end check/uncheck OWA features

Once Save it will apply to all of the mailboxes of the customer selected while creation of this OWA Policy and can be seen under Exchange Account Management interface as shown below:

You can also create Policy under the Account management and apply to its selected mailboxes

Billing system Configuration & Management:

Billing preferences are set of configurations that are supposed to be setup according to the underlying business scenarios because these settings totally depend on your business nature and customer relationship. Please review the following KB article for further details:

http://kb.machsol.com/Knowledgebase/Article/52404

Creating & Selling Exchange Service Plan:

Before Subscribing or Selling Exchange Service to a customer, create a Service Plan \ Package.

To create a new package \ service plan, navigate to the following path: Home >> Service Plan >> Exchange Hosting.

Click on Customer Product Listing tab, add new product. See the snapshot below:

Please view more details on Creating Service Plan \Package in MachPanel; http://kb.machsol.com/Knowledgebase/Article/52399

Please review the following KB article for Upgrading an existing Service Plan, resources, creating and selling Add-on; http://kb.machsol.com/Knowledgebase/Article/50348

Provisioning of a Service Plan:

Please review the following KB article for selling and provisioning of Exchange service further details:

http://kb.machsol.com/Knowledgebase/Article/50275

Service Management of Exchange:

You can manage hosting services for Exchange by clicking on the Service Management link from the following path: Home >> Service Director >> Exchange Hosting >> Exchange Accounts. See the snapshot below:

Please review the following KB article for further details:

http://kb.machsol.com/Knowledgebase/Article/52407

Integrate VPS (Hyper-V) server in MachPanel

mudesira.munir — Wed, 23 May 2012 03:19:38 GMT

Summary

This article provides information on how to integrate MachPanel Automation Module for Microsoft Hyper-V.

Applies To

Applies to MachPanel v6 and onward.

Pre-Requisites:

MachPanel Control Server has been installed, if not then follow below KB article:
http://kb.machsol.com/Knowledgebase/Article/50261
MachPanel Remote Server has been installed on the Hyper-V host, if not then follow below KB article:
http://kb.machsol.com/Knowledgebase/Article/50262
Active Directory information has been added in MachPanel, if not then follow below KB article:
http://kb.machsol.com/Knowledgebase/Article/50263

MachPanel Control Server and MachPanel Remote Server communicate with each other over Port 7860. MachPanel Control Server passes on the information to remote server where actual provisioning takes place. Also make sure that MachPanel Control Server and MachPanel Remote Server are on the same build and that MachPanel Provisioning Service is running on both servers.

References

To prepare sealed images please refer to the following knowledge base article.

http://kb.machsol.com/Downloads/Download/50314

Latest versions of Hyper-V

To Enable/Disable VPS provider, navigate to the path: Home >> System Configuration >> Providers >> VPS Hosting.

In order to add a new server group, navigate to the path: Home >> Service Director >> VPS Hosting.

Adding Server Group and Member Server to VPS Hosting

To add a Server Group to the VPS Hosting Extension, select Server Groups and then click on Add Server Group button as shown below:

In Step-1 provide Server Group Name and select provider then click on Next button as shown below:

Storage Configuration: Select Cluster or StandAlone. (Default: Standalone)
Gaurded Fabric: Select Key protector added in Setup.

Note: The Cluster option is For Hyper-V 2012 or later only with Active Directory selection. (If no active directory is selected then Storage configuration is Stand Alone and it will disable Cluster radio button. If Provider is Hyper-V Server 2008 then Storage Configuration is Stand Alone and Cluster will be disabled. You need to configure Active Directory Domain before adding server group for cluster by Navigating to this: Home > Service Director > Active Directory > Active Directory Domains

Enable Virtual Networking Using VXLANs: Please review Following KB for more details: https://kb.machsol.com/Knowledgebase/Article/55559

Virtual Hard Disks / VHD Locations: New option to specify multiple locations for Virtual Hard Disks. Provide VHD path, Max size in GB's and select customer.
Max Size: Provide Disc size in GB.
Customer: Select Customers and click Add.

In Step-2 provide Reference Id, IP, Username and Password and then click on Finish button as shown below:

Description of each item is as follows:

Reference Id: It is an identifier for the provider, so as to know which Hyper-V server it is.
IP: It is the IP of server where Hyper-V is installed as well as MachPanel Remote Server.
No. of VM’s allowed on this server: Provide total number of Allowed VM.
RAM that can be allocated to VMs: Provide the size of a RAM.
Virtual Processors: Provide total number of Virtual processors allowed.

After integrating you need to Test Service by clinking on Test Service link as shown in the snapshot below:

You can also health check for each VPS server.

In order to provision Hyper-V you need to Add IP's or Virtual Switches in Virtual Networks. Please review the KB article at the link given below:

Adding Virtual Networks: https://kb.machsol.com/Knowledgebase/55699/How-to-Add-Virtual-Networks-in-Hyper-servers

Note 1: If VPS Hosting Module is not enabled, navigate to the System Configuration >> Built-in Modules, check VPS module enabled box and then click on Update configuration button. Also check to see if you have acquired appropriate licenses for VPS Hosting Module.
Note 2: It has been noticed that if UAC is enabled on a remote server, the Service Account does not get appropriate rights in local security policy so we have to make amends and fix that. For any service account below permission on Remote Servers where MachPanel Remote agent is installed are mandatory to have:

Allow log on locally:

Log on as a service:

Storefront Integration With Provider’s Website using Variables

zohaib.shaikh — Thu, 13 Oct 2011 01:34:53 GMT

MachPanel has the option to enable a panel login link for the client to take your clients from their billing account directly to their panel account. The system works through sending HTML parameters (aka. variables) to the purchase routine to initiate a sale, whether they are sent by HTML submission form or a direct purchase link. Integration involves accessing these variables directly. Certain steps can be skipped based upon your requirements. This can be accomplished by creating direct links to the cart by copying them and following Storefront variables will be required for successful integration

Variable Name

Description

OFID

This variable relates to order form id

PGID

This variable relates to Payment group id

PType

This variable corresponds to the package type Possible values are:

1=Shared Hosting
2=Misc. Product
13=Software Product
14=CRM Hosting Product
5=Dedicated Server Hosting
15=AddOn Product
16=Microsoft Exchange
8=SSL Products
10=Domain Name Products
17=Microsoft SharePoint
18=Microsoft Office Communication Server
19=VPS Hosting

Type

This variable relates to the type of domain order. In case of transfer order Type is “Transfer”

Domain

Domain name variable to register or transfer with Top Level Domain (TLD) e.g. hostbreak.com (Meant for single domain order only)

PackId

Variable describing the Package Id to be purchased. (Package ids are separated by commas ",")

Cycle

Relates to the Billing cycle or duration. (Comma "," separated package ids correspond to selected packages)

Possible values are:

1=Weekly,

2= 2 Weeks,

3=3 Weeks,

4=Monthly,

5=2 Months,

6=Quarterly,

7=Bi-Annual,

8=Annual,

9=2 Years,

10=3 Years,

11=4 Years,

12=5 Years,

13=6 Years,

14=7 Years,

15=8 Years,

16=9 Years,

17=10 Years,

18=Once

Integrating Web Hosting Services with MachPanel

mudesira.munir — Fri, 24 Jun 2011 05:25:00 GMT

Summary

This articles describes in detail about the integrating MachPanel Automation Module for WebHosting in MachPanel.

Applies To

MachPanel all versions

Pre-Requisites

MachPanel Control Server has been installed, if not then follow below KB article:
http://kb.machsol.com/Knowledgebase/Article/50261

MachPanel Remote Server has been installed, if not then follow below KB article:
http://kb.machsol.com/Knowledgebase/Article/50262

All the required back end servers have been installed e.g IIS, DNS, FTP, Mail Servers etc.

Hosting Panels & Hostmatic Components

Following hosting panel are supported:

Below is the list of services and their providers which MachPanel Automation Module for WebHosting supports:

Web Services
- IIS 6 Server
- IIS 7 Server
- IIS 8 Server
- IIS 10 Server

FTP Services
- Microsoft FTP 6 Server
- Microsoft FTP 7/7.5 Server (Windows 2008 or Windows 2012)
- Microsoft FTP 10 Server (Windows 2016)
- Gene6 FTP Server
- Filezilla FTP Server
Mail Services
- Mail Enable Server
- Merak Mail Server 9.2.1
- Smarter Mail Server 6.x
- Smarter Mail Server 8.x
- SmarterMail 11.x/12.x/13.x
DNS Services
- Microsoft DNS Server
- Simple DNS Plus Server
- Power DNS
Database Services
- SQL Server 2000
- SQL Server 2005
- SQL Server 2008
- SQL Server 2012
- SQL Server 2014
- SQL Server 2016
- MYSQL 5.1 Server
Web Stats
- SmarterStats 4
Protected Folders
- IIS Password

Integrating Plesk in MachPanel

Navigate to Home > Service Director > Web Hosting > Server group and then click Add Server Group.
In Step-1 provide server group name, select provider as "Plesk" and click Next.

In Step-2 provide server information as below and click Finish:
- Plesk Server Name
- Plesk Base URL
- Plesk Login
- Plesk Password
- Plesk Shared IP Address
- Maximum website load
- Current website load

Integrating MachPanel Automation Module for WebHosting in MachPanel

Navigate to Home > Service Director > Web Hosting > Server group and then click Add Server Group.

Enter Server Group name, select Hostmatic Control Server from the Provider drop down list. Then move to next step.

4) Enter the Web Hosting Server Reference ID, IP, local administrator credentials and click Finish.

At this point you have successfully added the Hostmatic Control Server in MachPanel. Now you need to add services in the recently added server. So click on the recently added Hostmatic Control Server group.
You will see the list of Web Hosting Server being added in this Server Group. To add Web Hosting Services in the Hostmatic Server, click Services in the options menu against the desired server. then click on Add Service button.

From the Service drop down menu, select the Service you want to add.

After selecting the service, you will be taken to their respective pages. Fill the required information for the services and save. Add multiple services as per your requirements. Please review following KB article for more details:

http://kb.machsol.com/Knowledgebase/Article/53474

Below is a snapshot of Web, DNS services added in the above Hostmatic Server.

Hit Test Service for each service and if you get below snapshot then integration of that service is successful.

Configure MachPanel With Pre-Installed SharePoint

fawad.khan — Thu, 16 Apr 2009 12:30:20 GMT

Summary
This article provides guidelines for integrating MachPanel with SharePoint, when SharePoint is already / previously installed.

Applies To
MachPanel all versions

Solution
An important thing to note is that SharePoint integration with MachPanel is successful only when MachPanel accesses SharePoint with same user through which SharePoint was installed.
In case you have already installed SharePoint then you must know which user was logged in during installation, then set this user as Domain Administrator Login by following the steps below. As an example we will use user name Administrator2.

Step1: Setting Up Domain Administrator Login
Domain administrator login: This will be the user responsible for connecting with Active Directory.
In your MachPanel Control Center, Navigate to Home » Service Director » Active Directory Domains

Step2: Domain Administrator Login Permissions
Since the same Domain User (administrator2) which is being used for MachPanel and SharePoint integration will also be used for Standalone Exchange so it must be member of certain groups for Standalone Exchange. To do this, please do the following:

1. Click Start, point to Settings, click Control Panel, double-click Administrative Tools, and then double-click Active Directory Users and Computers.
2. In the console tree, click Users.
3. In the details pane, right-click the user (administrator2 that was set in MachPanel) and then click Properties.
4. Click on the Member of tab to check that this user (administrator2) has following permissions:

Domain Admins (Set Primary)
Domain Users
Enterprise Admins
Exchange Servers
Exchange Organization Administrators
Group Policy Creator Owners
Schema Admins

This will ensure that both your SharePoint and Exchange integrations work through a single user.

MachPanel v.7 Storefront Integration With Provider Website

zohaib.shaikh — Tue, 04 Nov 2008 02:16:43 GMT

Download Information

This is a detailed step-by-step guide explaining the MachPanel Storefront integration with your (Provider’s) website. This integration will allow your clients to have one control panel login once they have ordered products. Furthermore, this guide also illustrates how to customize the look and feel of the order form according to Provider’s taste and need.

Applies To

MachPanel v.7

Download

GUIDE: MachPanel Storefront integration with Provider's website.

PayPal Integration

Zeeshan Masood — Tue, 04 Nov 2008 01:22:39 GMT

Summary
This document describes how to configure PayPal with MachPanel

Applies To
MachPanel all versions

Solution

Step 1: Browse PayPal site
IMPORTANT: You’ll need to create an API username for PayPal, which is different from your PayPal username. Give the API username, password, and signature in the settings below. Follow these steps:

1. Log in to your PayPal Business account.
2. Click My Account.
3. Click Profile.
4. Under Account Information, click API Access.
5. Click Request API Credentials.
6. Click API Signature.
7. Click the Agree checkbox.
8. Click Submit.

Step 2: Configure PayPal as your payment gateway
To configure PayPal as your payment gateway, follow this:

1. Navigate to Home » System Configuration » Providers » Payment Gateways
2. Click on the Configure link and follow the instructions below:

• Provider: Shows the name of provider you are configuring (Not editable).
• Enabled: Select NO only if you want to disable the payment gateway. This will prevent system from charging bills through this gateway.
• Enable Test Mode: Select YES if you want to perform test transaction. No credit card is charged in this case, so be careful.
• API User Name: Enter your PayPal API username.
• API Password: PayPal API password.
• API Signature: Enter your PayPal signature.
• API URL: Defaults to https://www.paypal.com/cgi-bin/webscr?. Leave it same.

Note: Please be careful, as the test mode and real mode API URLs and credentials (username and password) are different. So beware of the mode (test or real) and the credentials that you use.

MachPanel Storefront Integration With Provider Website

fawad.khan — Tue, 04 Nov 2008 00:48:04 GMT

Summary
MachPanel integration with your (Provider’s) website allows your clients to have one control panel login once they have ordered products. They would buy say a domain and hosting package via MachPanel, set up payment and then be given a login to their control panel where it's all managed. Most of all, Provider does not has to worry about the look and feel part because MachPanel supports complete customization (themes, CSS) in this respect. It can easily customize the look and feel of the order form according to Provider’s taste and need.

Applies To
MachPanel all versions

Solution
Consult complete guide Storefront Integration With Provider’s website with examples at:
http://kb.machsol.com/Downloads/7

MachPanel Knowledgebase

PFSense Deployment & Integration Prerequisites (Hyper-V Environment)

Summary

Applies To

Overview

1. pfSense Deployment on Hyper-V

2. Network Interface Configuration

3. Virtual Switch & Interface Alignment

4. Trunk Configuration

5. REST API Configuration and MachPanel Integration

6. High Availability Considerations

VMIntegrationService Fails On Host Having Language Other Than English

Summary

Applies to

Details

Resolution

MachPanel KeyCloak SSO Authentication

Summary

Applies to

KeyCloak Single-Sign On Overview

Integrating KeyCloak SSO with MachPanel

Step 1:

Step 2: (If you already have Realm available then Skip this step and move to Next Step)

Step 3: Configure "User Federation" (If you already have Federation Configured then Skip this step and move to Next Step)

Step 4: Create and Configure Client:

Step 5 (Configure MachPanel to work with KeyCloak):

Step 6: Lastly you must associate AD Accounts with Staff and/or Customer Accounts and Contacts:

Before Login, ensure that you associate your Provider/Provider Staff, Reseller/Reseller Staff, Customer and Customer Contacts with appropriate AD Accounts in MachPanel.

Ingram Micro integration for O365

Summary

Applies To

Ingram Micro (CSP Indirect Reseller) Integration

Remote user Mailbox Feature for 0365 Hybrid Integration

Prerequisites

Step to create

ENOM Domain Registrar and SSL Vendors Integration

Summary

Applies To

Integrate Domain Registrars:

Selling/Provisioning of Domain Name Products:

Integrate SSL Vendors

Selling/Provisioning of SSL Accounts

RDS (Remote Desktop Services) Integration, Subscription and Management

Summary

Applies To

Prerequisites

Procedure

Add Server Group

Add Server to Server Group:

Add Microsoft RDS Service Plan

Subscribe customer to RDS Hosting Service:

Manage RDS Hosting:

Avalara Integration/Configuration

Summary

Applies To

Avalara Integration/Configuration

Settings that need to be configured in Avalara account:

Settings that need to be configured for Avalara in MachPanel:

Two-factor authentication (2FA)

Summary

Applies To

Two Factor Authentication (2FA):

Send PIN through Email:

Send PIN through SMS

SMS Templates

Authenticator App

Duo Authentication​

Exchange Severs configuration and Global Settings in MachPanel.

Summary

Applies To

Prerequisite

Customization of MachPanel:

Management of Exchange Server Group in MachPanel

Integrate VPS (Hyper-V) server in MachPanel

Summary

Applies To

Pre-Requisites:

References

Latest versions of Hyper-V

Adding Server Group and Member Server to VPS Hosting

Duo Authentication