topic Re: CUC 7.1(3b) - 'set cuc ldapfilter .....' in Unified Communications Infrastructure

CUC 7.1(3b) - 'set cuc ldapfilter .....'

david.kelsen — Tue, 19 Mar 2019 07:51:40 GMT

Hi,

We're looking to filter our LDAP directory in CUC 7.1(3b) to only pull in accounts where the 'ipPhone' field contains something (or is not null).

We've been able to successfully implement this in CUCM, so that our Corporate Directory only lists AD accounts with the ipPhone field populated.

According to guides we've found online the command from CLI is, 'set cuc ldapfilter {insert filter}'

The syntax we're trying to use is:

set cuc ldapfilter '(&(objectclass=user)(!(objectclass=Computer))(!(UserAccountControl:1.2.840.113556.1.4.803:=2))(ipPhone=*))'

The problem is that the CUC CLI removes the ampersand (&) from the beginning of the string, so we end up with the following if we paste in the above filter:

set cuc ldapfilter '((objectclass=user)(!(objectclass=Computer))(!(UserAccountControl:1.2.840.113556.1.4.803:=2))(ipPhone=*))'

Has anyone successfully implemented LDAP filtering in CUC, if so can you please post a sample syntax?

Or, does anyone know how to type/enter an ampersand (&) in CUC CLI?

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

William Bell — Tue, 27 Apr 2010 23:57:45 GMT

I believe that your syntax is incorrect.

From this guide: http://www.ciscosystems.com/en/US/docs/voice_ip_comm/cucm/cli_ref/7_1_3/cli_ref_713.html#wp39913

The 'set cuc ldapfilter' is a wizard based command. For example:

admin:set cuc ldapfilter

Please select the LDAP server type for which you wish to set the filter:
1 Microsoft Active Directory
2 Netscape or Sun ONE LDAP Server
3 OpenLDAP
4 Microsoft Active Directory Application Mode

Selection: 1

Current filter:
(&(objectclass=user)(!(objectclass=Computer))(!(UserAccountControl:1.2.840.113556.1.4.803:=2)))

New Filter:
(&(objectclass=user)(!(objectclass=Computer))(!(UserAccountControl:1.2.840.113556.1.4.803:=2))(ipPhone=*))

Filter updated successfully.

admin:

The items in blue and bold represent data you would input.

I just tested this on my 7.1(3b) lab system and the ampersand is not lost. So, try entering "set cuc ldapfilter" by itself and hit enter. Follow the wizard and see if you are still having problems.

HTH.

Regards,
Bill

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

david.kelsen — Wed, 28 Apr 2010 00:21:28 GMT

Awesome!

I just applied the filter successfully following your guide.

It wasn't clear in the Cisco Guides I'd read that the command 'set cuc ldapfilter' was a wizard.

Thanks so much for your help William.

Cheers,

Dave.

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

satish rawat — Wed, 16 Jun 2010 14:06:44 GMT

Hi Dave,

I noticed you sucessfully created custom filter in CUCM & wanted to check if you can provide more details to me. I am running CUCM 5.1.3.

i followed the steps mentioned at below forum but i am stuck becuase i am getting file not found error.

http://uccert.wikidot.com/forum/t-134148

any idea what i am missing, i verified xml filename but it may be something on my sql command. Below is content of my sql commands under xml file. can you check what i am missing

please let me know if you can provide some easy seteps to do this.

thanks

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

Aaron Harrison — Wed, 16 Jun 2010 14:11:37 GMT

The app isn't finding your LDAPFilter.xml file (as the error states).

In the -input parameter, specify the full path:

-input=c:\ccmupgrade\LDAPFilter.xml

Regards

Aaron

Please rate helpful posts...

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

satish rawat — Wed, 16 Jun 2010 14:21:19 GMT

Hi Aaron,

Thanks for the quick response !

i tried using the file path but ends up in same error.

see the output from my command prompt

C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>java -cp .\classes;.\lib\saaj-api.jar;.\lib\saaj-impl.jar;.\lib\ma
il.jar;.\lib\activation.jar;.\lib\jaxm-api.jar;.\lib\jaxm-runtime.jar;.\lib\xerc
esImpl.jar;.\lib\xml-apis.jar AxlSqlToolkit -username=ccmapplication -password=c
isco -host=10.236.18.17 -input=test.xml
select * from ldapfilter where tkldapserver=1
*****************************************************************************
Sending message...
---------------------
http://schemas.xmlsoap.org/soap/envelope/">
OAP-ENV:Header/>se
lect * from ldapfilter where tkldapserver=1dy>
---------------------
Positive response received.
---------------------
http://schemas.xmlsoap.org/soap/envelope/" SO
AP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
r/>http://www.cisco.com/A
XL/API/1.0" xmlns:xsi="http://www.cisco.com/AXL/API/1.0" sequence="1276697871719
">c8b4c680-ead1-43c0-a264-27da8142c5391<
/tkldapserver>(&(objectclass=user)(!(objectclass=Computer))(!(UserAc
countControl:1.2.840.113556.1.4.803:=2)))LQueryResponse>
---------------------

C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>java -cp .\classes;.\lib\saaj-api.jar;.\lib\saaj-impl.jar;.\lib\ma
il.jar;.\lib\activation.jar;.\lib\jaxm-api.jar;.\lib\jaxm-runtime.jar;.\lib\xerc
esImpl.jar;.\lib\xml-apis.jar AxlSqlToolkit -username=ccmapplication -password=c
isco -host=10.236.18.17 -input=c:\ccmupgrade\LDAPFilter.xml
java.io.FileNotFoundException: c:\ccmupgrade\LDAPFilter.xml (The system cannot f
ind the file specified)
        at java.io.FileInputStream.open(Native Method)
        at java.io.FileInputStream.(Unknown Source)
        at java.io.FileInputStream.(Unknown Source)
        at AxlSqlToolkit.execute(AxlSqlToolkit.java:188)
        at AxlSqlToolkit.main(AxlSqlToolkit.java:244)

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

Aaron Harrison — Wed, 16 Jun 2010 14:50:39 GMT

Where is your LDAPFilter file? Is it in c:\ccmupgrade?

The file you attached to the post earlier is named "LDAP Filter.xml" (with a space in the middle). If your file on disk has the space, rename it to remove the space.

Regards

Aaron

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

satish rawat — Wed, 16 Jun 2010 15:42:44 GMT

Yes the file is in C:\ccmUpgrade

see i have tried diffrent combinations and it still errrors, i think this has something to do with contents of xml file.

notice when i used a diffrent filename( test.xml) it didnt error though the path mentiond doesnt have C:\ccmUpgrade

C:\ccmUpgrade>
C:\ccmUpgrade>
C:\ccmUpgrade>java -cp .\classes;.\lib\saaj-api.jar;.\lib\saaj-impl.jar;.\lib\ma
il.jar;.\lib\activation.jar;.\lib\jaxm-api.jar;.\lib\jaxm-runtime.jar;.\lib\xerc
esImpl.jar;.\lib\xml-apis.jar AxlSqlToolkit -username=ccmapplication -password=c
isco -host=10.236.18.17 -input=LDAPFilter1.xml
java.io.FileNotFoundException: LDAPFilter1.xml (The system cannot find the file
specified)
        at java.io.FileInputStream.open(Native Method)
        at java.io.FileInputStream.(Unknown Source)
        at java.io.FileInputStream.(Unknown Source)
        at AxlSqlToolkit.execute(AxlSqlToolkit.java:188)
        at AxlSqlToolkit.main(AxlSqlToolkit.java:244)

C:\ccmUpgrade>

in order to rule out that it is issue with file pathname or file name i used a diffrent filename ( just for testing ) and didnt error.

C:\ccmUpgrade>java -cp .\classes;.\lib\saaj-api.jar;.\lib\saaj-impl.jar;.\lib\ma
il.jar;.\lib\activation.jar;.\lib\jaxm-api.jar;.\lib\jaxm-runtime.jar;.\lib\xerc
esImpl.jar;.\lib\xml-apis.jar AxlSqlToolkit -username=ccmapplication -password=c
isco -host=10.236.18.17 -input=test.xml
select * from ldapfilter where tkldapserver=1
*****************************************************************************
Sending message...
---------------------
http://schemas.xmlsoap.org/soap/envelope/">
OAP-ENV:Header/>se
lect * from ldapfilter where tkldapserver=1dy>
---------------------
Positive response received.
---------------------
http://schemas.xmlsoap.org/soap/envelope/" SO
AP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
r/>http://www.cisco.com/A
XL/API/1.0" xmlns:xsi="http://www.cisco.com/AXL/API/1.0" sequence="1276702654499
">c8b4c680-ead1-43c0-a264-27da8142c5391<
/tkldapserver>(&(objectclass=user)(!(objectclass=Computer))(!(UserAc
countControl:1.2.840.113556.1.4.803:=2)))LQueryResponse>
---------------------

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

satish rawat — Wed, 16 Jun 2010 15:46:47 GMT

if i rename to LDAFiter.xml to test.xml i get below error:

C:\ccmUpgrade>
C:\ccmUpgrade>java -cp .\classes;.\lib\saaj-api.jar;.\lib\saaj-impl.jar;.\lib\ma
il.jar;.\lib\activation.jar;.\lib\jaxm-api.jar;.\lib\jaxm-runtime.jar;.\lib\xerc
esImpl.jar;.\lib\xml-apis.jar AxlSqlToolkit -username=ccmapplication -password=c
isco -host=10.236.18.17 -input=test.xml
[Fatal Error] :13:48: The entity name must immediately follow the '&' in the ent
ity reference.
org.xml.sax.SAXParseException: The entity name must immediately follow the '&' i
n the entity reference.
        at org.apache.xerces.parsers.DOMParser.parse(Unknown Source)
        at AxlSqlToolkit.execute(AxlSqlToolkit.java:188)
        at AxlSqlToolkit.main(AxlSqlToolkit.java:244)

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

Aaron Harrison — Wed, 16 Jun 2010 15:47:42 GMT

In my last post I suggested you rename the file, not use a space in the parameter.

If you put a space in the parameter it probably won't work, as it will see the space as the end of the filename. Your other test filenames don't have spaces...

FileNotFoundException means just that; it doesn't matter what the contents of the file are because the app can't find the file.

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

Aaron Harrison — Wed, 16 Jun 2010 15:52:44 GMT

OK - now you are getting somewhere.

The file is now found, however in XML '&' is a special character. It needs to be escaped by replacing the & in your LDAP query string with &

So an example would be:

Regards

Aaron

Please rate helpful posts and mark answered questions that you've got a satisfactory response from to help identify useful content in the forums...
https://supportforums.cisco.com/docs/DOC-6212

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

satish rawat — Wed, 16 Jun 2010 16:09:15 GMT

thanks aaron,

now when i replaced & with & i am getting another error:

sorry i have not background to sql or vb , any idea where should this delimiter be inserted.

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

Aaron Harrison — Wed, 16 Jun 2010 16:23:18 GMT

Looks like you have replaced & with & rather than &

You need the ; as well.

Regards

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

satish rawat — Wed, 16 Jun 2010 16:55:42 GMT

Thanks Aaron for your valuable help. the script fiinally works.

Now when i look at sample.response file for results it says fatal error ( syntex error).

any idea what is wrong with my query

attaching the response file

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

Aaron Harrison — Wed, 16 Jun 2010 17:05:07 GMT

You have :

update ldapfilter set filter = ='(....

two = =

it should start:

update ldapfilter set filter = '(....

Regards

Aaron

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

satish rawat — Wed, 16 Jun 2010 17:22:35 GMT

Hi Aaron,

Thanks for all your help. I figured out the issue and rectificed my SQl query

see the output from CUCM CLI:

admin:run sql select * from ldapfilter where tkldapserver=1
pkid tkldapserver filter
==================================== ============ ================================================================================================================================================================================================================================================
c8b4c680-ead1-43c0-a264-27da8142c539 1 (&(objectclass=user)(!(objectclass=Computer))(!(UserAccountControl:1.2.840.113556.1.4.803:=2))(|(telephonenumber=2*)(telephonenumber=3*)( telephonenumber=4*)(telephonenumber=5*)(telephonenumber=6*)(telephonenumber=7*)( telephonenumber=8*)))
admin:

what would be my next step is my CUCM ready to import users per this filter. what else do i need to setup in CUCM.

there seems to be not a document available to describer the steps on cisco.com

anyway

thanks for your help !!

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

Aaron Harrison — Wed, 16 Jun 2010 18:40:27 GMT

It's not documented on Cisco.com as it's not supported. Version 8 allows you to do this via the GUI, which is supported.

Take a look at this post and the article that Bill wrote : https://supportforums.cisco.com/message/3047630?tstart=0

Basically if all is well you need to restart the DirSync service for the change to take effect, and then do a resync.

Regards

Aaron

Please rate helpful posts and mark answered questions that you've got a satisfactory response from to help identify useful content in the forums...
https://supportforums.cisco.com/docs/DOC-6212

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

satish rawat — Thu, 17 Jun 2010 15:10:09 GMT

Hi Aaron,

Thanks for your help yesterdday.

I have one more questions maybe you can help.

I needed to create a LDAP query so that i can search users with telephone no starting with 5 and any four digits. my current query states 5* and this will match 5 and any no of digits. Do you have any idea how to do this. here is my sql query for your refrence

filter ='(&(objectclass=user)(!(objectclass=Computer))(!(UserAccountControl:1.2.840.113556.1.4.803:=2))(|(telephonenumber=2*)(telephonenumber=3*)(telephonenumber=)( telephonenumber=4*)(telephonenumber=5*)(telephonenumber=6*)(telephonenumber=7*)( telephonenumber=8*)))' where tkldapserver=1"/>

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

Aaron Harrison — Thu, 17 Jun 2010 21:08:15 GMT

Try using nested greater than/less thans... I seem to recall doing this at some point but not really in a position to test:

Regards

Aaron

Re: CUC 7.1(3b) - 'set cuc ldapfilter .....'

satish rawat — Thu, 17 Jun 2010 22:31:14 GMT

Thanks Aaron,

Can you check if below query is good to match dial range XXXX.

This runs fine from command prompt as well as CLI but I don’t see any user imported in CUCM while when I used expression ))(|(telephonenumber=2))) it worked cannot match my entire dial range.

)))' where tkldapserver=1"/>

Thannks