• Telephony > Plugin > All permission

Deprecation Announcement: On May 3, 2023, Genesys announced the deprecation of the BYOC Premises - Customer VM Solution. For more information, see Deprecation: BYOC Premises – Customer VM Solution.

After you have downloaded and unzipped the BYOC Premises – Customer VM Solution image and installation script, you are ready to set up a VM Edge.

  1. Click Admin > Telephony > Edges.
  2. Click Provision New Edge.
  3. Enter a name in the Edge Name box.
  4. Click  BYOC Premises – Customer VM Solution.
  5. Click Provision Edgeprovision_new_edge_virtual
  6. Click Download Setup Package to download the pairing token .json file. The file contains the pairing URL, Edge ID, Org ID, and other information. download_setup

Note: If you have already downloaded the Customer VM Solution image and installation script, you can ignore the Download software link.

  1. Open a Command Prompt window as an administrator.
  2. Go to the location where you downloaded the installer.
  3. Type the full file name of the installer and press Enter. The installer displays installation details and prompts you to continue.
  1. The installer checks for recommended prerequisites. 
    • If the prerequisites are met, the installer prompts you to continue. Continue with the next step.
    • If the prerequisites are not met, the installer automatically exits.

Note: If you do not have the prerequisites, and if you are installing in a development or test environment only, you can complete the installation with an override parameter.

  1. Type y and press Enter.
  1. Type the virtual machine (VM) name and press Enter.
  2. Retype the VM name and press Enter. The installer displays the available NICs with an index number for each one.
  1. Type the ifIndex number of the NIC that is dedicated for use with the VM Edge and press Enter. The installer prompts for a valid Windows Server 2012 R2 license key.
  1. Do you have a valid license key?
    • If yes, type it and press Enter.
    • If no, you can use a 30-day evaluation copy. To use this option, press Enter.

Note: If you enter an invalid license key, you see no feedback until you create the VM and try to run it. Then, the VM fails and you must delete and rebuild it.

  1. Use a file selection window to select the image file (.vhd) that you downloaded.
  2. Use a file selection window to select the pairing token file (.json) that you downloaded. The Command Prompt window indicates that the installation is ready to begin. The VM installation process takes approximately 5 minutes. 
  1. Press Enter. The Command Prompt window displays the output progress.

When the installation is complete, the Hyper-V Console displays the running VM.


  1. Log in to the VM guest console.
  2. Set the administrator password.
    Note: If there was a problem with the Windows license key or an error during the setup process, the VM guest console does not prompt you for password. In this case, delete the VM and recreate it.

  1. Log in to a VM Edge.
    When you log in, the startup automation scripts complete the pairing process. This process takes about 2 minutes. The script then logs you off and restarts the virtual machine (VM). At this point, the VM is fully provisioned and operational.

    EXTREMELY IMPORTANT: Do not log back in to the VM to monitor or perform any system configuration or management tasks. The only reason to log back in is to set a static IP address.
  2.  The NIC port that you selected is automatically renamed and marked as dedicated to the VM Edge. To see the renamed NIC port, on the host, open your Network Connections window.

After you install and configure your VM Edge, put it into service.

Note: You incur charges for a VM Edge on a monthly subscription basis. Your billing cycle for the VM Edge begins when you put it in service.

  1. Click Admin.
  2. Under Telephony, click Edges.
  3. In the Edge Name column, select the check box next to your VM Edge.
  4. Click Put In-Service.