Categories

CUC (6) CUCM (26) Jabber (6) Python (2) Routing (2) Solarwinds Orion NPM (4) switching (1) Video (6) voice (2)

Tuesday, 10 February 2015

How to obtain the jabber-config.xml file

Quick post,

sometimes there is a need to change the jabber-config.xml file that Jabber clients use to populate settings parameters. To obtain it, or simply check what you currently have configured use the following link:


http://<ip address of CUCM TFTP server>:6970/jabber-config.xml

(this obviously only works on CUCM's in your cluster that run TFTP)

Now you can copy its contents, change as required and upload the new xml file (under the same name) onto EACH TFTP Server in your cluster. Also restart the TFTP service on each TFTP server in your cluster.

Pulling the .xml file down after you made changes to it, is also a good test to see if the file parses properly (no file formatting errors etc.)


Before testing your changes to your jabber-config.xml file,  remove/rename the existing local jabber-config file that is stored in:


Win 7&8  - 

 C:\Users\%user-profile name%\AppData\Roaming\Cisco\Unified Communications\Jabber\CSF\Config


Also make sure that the xml file uses UTF-8 encoding.


<?xml version="1.0" encoding="utf-8"?>
<config version="1.x">
.....content goes here
</config>


note that if you want to update the config file and deploy it onto the clients, increase the <config version="1.0">  value to 1.1 or whatever is appropriate. This way,  the Jabber client will pull up the file after having identified that a newer version is available, rather than you flushing each Jabber client and pulling the edited version 1.0 down.

when doing this in notepad, save as follows:

<filename>.xml      SAVE TYPE AS "All Files"   and use UTF-8 encoding

Once you save the file, it might be a good idea to open the file in a browser from the folder you saved it in, so you can check if it properly loads as an xml file and that it doesn't contain any parse errors.


You should see something like the screen shot below.


One, additional note on XML properties and syntax. I have wasted a lot of time in the past uploading xml file to TFTP on CUCM, and not getting the proper XML formatting as can be seen above. So what i prefer to do is do the following:

-Download the original jabber-config.xml (download it straight off your CUCM) and use that as your working file.

-Open the original in notepad+ 

-Edit the file

-Save the file (this will save it as en edited jabber-config.xml, but maintaining the original properties).

-Go ahead and rename the file into anything you want jabber-config-v2.xml for instance, or simply keep the name and load it back onto your TFTP, always change the version (<config version="x.y">, so you can actually verify that you ware looking at your edited file and not some dudd.


Once you are happy that your xml file reads properly, you can upload it into your TFTP directory on every CUCM in your cluster that runs the TFTP server.

do this by going into the OS admin pages on CUCM > Software/Upgrades > TFTP file management, as can be seen below:





Your upload directory can be " / " which will put your file in the TFTP root.

Contrary to popular believe, if you are uploading a new jabber-config.xml file over the top of an existing one, but with a higher version number (keeping the name the same); you do not require to restart the TFTP service. If you upload a whole new file with a whole new name, then Yes, you will need to restart TFTP services on all servers in your cluster that run TFTP.


If you want to experiment with your jabber-config file first, before rolling your change out enterprise wide, create a test file, like for instance "jabber-config-DFJ-v12.xml" like I did and point the Cisco Support Field in your CSF device to point to that same field, see below.



Now when you have done all this and are trying to use a very specific jabber-config file for testing purposes, it is good to be able to verify, if that file actually gets pulled down by jabber.  

I always prefer to log out of Jabber, reset the settings and close jabber altogether and start it back up, the go to :

userprofile\appdata\roaming\cisco\unifiedcomms\jabber\CSF\config\cache

and check the cachedTFTPConfigStore.xml file. the contents of the file should refelct the contents of your newly uploaded jabber-config file.
Thought i'd share it, as I keep forgetting it myself.

2 comments:

  1. Thanks, this was helpful for trying to figure out the xml file for deploying Jabber to Macs (specifying config file to use for testing/troubleshooting).

    ReplyDelete
  2. This comment has been removed by the author.

    ReplyDelete