Changing ClickSofware username and password used by Xoom (technical)

In order to connect to Service Optimization, Xoom is provided with a username and password during its installation. We recommend that a dedicated user is created for Xoom which doesn’t have any other rights, including the right of remote access to the server on which Xoom is installed, and with a password that doesn’t expire. When that is not possible and there is a policy that all passwords need to expire after a certain amount of time, we provide a way to set this password for Xoom through the command line tool called XoomToolkit.

The login information is stored in the file called XoomParams.xml in the Xoom folder. The relevant part of the contents of this file looks like this:

<xoom:parameter name="SOPassword" encrypted="true" value="xfv73c3p14OzJcnQYBUXBg==" />
<xoom:parameter name="SOUsername" value="Marko" />

The username is stored as clear text that can be directly inspected and modified, while the password is encrypted for obvious reasons. This information is read when the Xoom service starts, and is afterwards routinely used by Xoom to connect to Service Optimization whenever it needs to either retrieve information or change anything in the configuration.

To change the stored password, the following needs to be run from the command line (in the Xoom folder if path hasn’t been altered to include the Xoom folder):

XoomToolkit parameter --set --encrypted SOPassword <newPassword>

Here, <newPassword> is the new password that is going to be used from this point forth to connect to Service Optimization, the parameter name is SOPassword, and the command parameters specify that the password is going to be stored in the file in an encrypted form. Once any parameter is stored in this way, there is no way to get its value out of Xoom, it is only usable internally by Xoom.

As we saw above, the username is stored in clear text and can be directly modified by editing XoomParams.xml. Alternatively, XoomToolkit can be used to modify the username as well, this time without the –encrypted flag:

XoomToolkit parameter --set SOUsername <newUsername>

Regardless of which of these two parameters were modified and how, Xoom service needs to be restarted after the modifications have been made in order for the changes to take effect.