Product Documentation

Virtual Machines

Jun 05, 2015
Updated: 2013-02-15

The Virtual Machine web service is installed on the Microsoft SCVMM server in your environment. You can install the Virtual Machine web service using either the graphical interface of the Services Manager installer or through the command line. After the installation process finishes, you can enable the service and continue configuration through the control panel.

To install the Virtual Machines web service using the graphical interface

The installation process includes preliminary configuration to create the web service account and IIS application pool, and define the service port.

This task assumes the Services Manager installer is running and the Select Deployment Task page is displayed.

  1. On the Select Deployment Task page, select Add Services & Locations.
  2. On the Add Services & Locations page, select Install Services.
  3. Accept the License Agreement and then click Next.
  4. On the Select Web Services page, select Virtual Machine Web Service and then click Next.
  5. On the Ready to Install page, review your selection and then click Install.
  6. After the installation finishes, click Finish.
  7. On the Installed Services page, click Configure next to the Virtual Machine web service list item.
  8. On the Summary page, review the configuration information. If you want to change anything, return to the appropriate configuration page. When the summary contains the settings you want, click Next. The Configuration Tool configures the Virtual Machine web service and displays progress.
  9. Click Finish and then click Exit to close the Configuration Tool.

To install the Virtual Machines web service through the command line

  1. On the SCVMM server, log on as an administrator.
  2. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
  3. At the command prompt, enter CortexSetupConsole.exe /Install:VirtualMachine. The Setup Tool installs the web service and returns the command prompt.
  4. At the command prompt, enter install-locationServicesVirtualMachineWSConfigurationVMConfigConsole.exe and specify the following properties:
    Property Description
    /UserName:vm_svc_acct Impersonation account for the Virtual Machine service. This parameter is optional if you are using /GenerateCredentials.
    /Password:password The application pool password. This parameter is optional if you are using /GenerateCredentials.
    /ServicePort:port Inbound port to be used and added to the CortexServices web site. Default = 8095
    /AutoCreateUser:True | False Optional. Create the service account in Active Directory.
    /GenerateCredentials:True | False Optional. Generate password for the service account.
    /SkipUserRoleCreation:True | False Default = False
    /UserRoleName:name The SCVMM user role under which the service operates. Default = CSM_SelfServiceUser. This parameter is optional if you have set /SkipUserRoleCreation to True.
    /VMHostGroups:host-groups A comma-delimited list of host groups to add to the SCVMM scope. This parameter is optional if you have set /SkipUserRoleCreation to True.
    /VMMServer:address:port Default = localhost

    Install-location denotes the web service installation directory on the local computer. The default directory is C:Program Files (x86)CitrixCortex.

    The Configuration Tool performs initial configuration of the web service and returns the command prompt.

Sample command string

The following command performs initial configuration of the web service:
install-locationServicesCitrixWSConfigurationVMConfigConsole.exe /UserName:vm_svc_acct /Password:password /ServicePort:8095 

When the installation process is finished, log on to the control panel and configure the web service. For instructions, see Configure the Virtual Machine service.