Explaining and Changing the Citrix XML Service Port

Summary

This article explains the XML Service.

The Citrix XML Service was introduced with MetaFrame 1.8 Service Pack 2 and a Feature Release 1 license needed to be installed. MetaFrame XP and later incorporates the Citrix XML Service as a standard feature.

When MetaFrame 1.8 Service Pack 2 or later is installed and the server rebooted, the Citrix XML Service binaries are placed on the system whether the Citrix XML Service was or was not installed. All that must be done to complete the Citrix XML Service installation is to register the XML Service itself by running thectxxmlss command.

Unlike MetaFrame XP or later, MetaFrame 1.8 does not allow for the sharing of port 80 with IIS.

Default IIS port number is 80. By Default Presentation server uses port 80 for the XML Service, meaning that it is sharing with IIS – or more correctly IIS is hosting the XML Service. This would allow us to have greater control over the XML Traffic in the network (i.e. the traffic can be monitored, controlled, or blocked by firewalls, if desired. In troubleshooting it is easier to identify XML traffic from the HTTP traffic).

CTXXMLSS.EXE Command Line Usage

The command-line syntax below applies to all MetaFrame environments:

Syntax:

CTXXMLSS [switches] [/R_nnnn_] [/K_nnn_] [/U] [/?]

Parameters:

/Rnnnn – Registers the service on port number nnnn /Knnn – Keep-Alive nnn seconds (default 9). /U – Unregisters the service. /? (help) – Displays the syntax for the utility and information about the utilities options.

After the Citrix XML Service is registered, a new service appears in the Services Applet and registry entries are created. Ensure this service is started.

To determine which port is being used, either look in the Citrix Management Console (MetaFrame XP and later) and/or locate the following registry key (assuming IIS port sharing is not being used):

Caution! This procedure requires you to edit the registry. Using Registry Editor incorrectly can cause serious problems that might require you to reinstall your operating system. Citrix cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. Back up the registry before you edit it.

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\CtxHttp

Value: “TcpPort” If the value is listed in hex, change to a decimal notation.

If Microsoft IIS is installed, the administrator of the MetaFrame XP installation is given the option to install the Citrix XML Service and share a port with IIS.

In fact, no separate XML Service is running. IIS serves the XML data using an ISAPI filter named Wpnbr.dll located in the \Inetpub\Scripts folder. To remove the Citrix XML Service functionality from your MetaFrame server, simply rename or delete the Wpnbr.dll file.

Lastly, once the XML Service port is changed on the MetaFrame Servers, change NFuse or Web InterFace, MetaFrame Secure Access Manager, or the Program Neighborhood Client to use the new port.

Unregistering the XML Service

• Open a command Prompt window.

• Run ctxxmlss /u (This command unregisters the Citrix XML Service and marks it for deletion).

Registering the XML Service on a port other than sharing with IIS

• Unregister the service using the previous instructions.

• Open a command Prompt window.

• Run ctxxmlss /r[Port Number] (Notice that there is no space between the switch “/r” and the port number.

• Open the service control manager and manually start the Citrix XML Service.

Note: During the unregister/register process you might see the below error message. There is no need to reboot the server. Just run the Unregister command again, go to services and attempt to start the service then Reregister the service.

Could not start the Citrix XML Service service on Local Computer.

Error 1060: The specified service does not exist as an installed service.

Click HERE to see how to configure XML with IIS 5.0,6.0 and 7.0 along with testing the service.