Saltar al contenido principal
Versión: Siguiente

LDAP SEARCH ALL

LDAP SEARCH ALL ( dnRootEntry ; arrResult ; filtro {; alcance {; atributos {; atributosenArray}}} )

ParámetroTipoDescripción
dnRootEntryText→Distinguished Name del elemento raíz donde iniciar la búsqueda
arrResultObject array←Resultado de la búsqueda
filtroText→Filtro de búsqueda LDAP
alcanceText→Alcance de la búsqueda: "base" (por defecto), "one", o "sub"
atributosText array→Atributos a recuperar
atributosenArrayBoolean array→True = forzar el retorno de los atributos como array; false = forzar el retorno de los atributos como variables simples

Este comando no es hilo seguro, no puede ser utilizado en código apropiativo.

Descripción​

El comando LDAP SEARCH ALL busca todas las ocurrencias que coinciden con los criterios definidos en el servidor LDAP objetivo. Este comando debe ser ejecutado dentro de una conexión a un servidor LDAP abierta con LDAP LOGIN; de lo contrario se devuelve un error 1003.

Tenga en cuenta que los servidores LDAP generalmente imponen un número máximo de entradas que se pueden recibir de una búsqueda. Por ejemplo, el directorio de Microsoft Active limita este número a 1.000 entradas por defecto.

En dnRootEntry, pase el Distinguished Name del elemento raíz del servidor LDAP; la búsqueda se iniciará a partir de este elemento.

En tabResult, pase un array objeto que se llenará con todas las entradas coincidentes; en este array, cada elemento es un objeto que contiene los pares atributo/valor devueltos por una entrada coincidente. Puede utilizar el parámetro atributos para definir los parámetros a devolver.

En filtro, pase el filtro de búsqueda LDAP a aplicar. La cadena filtro debe ser compatible con rfc2225. Puede pasar una cadena vacía "" para no filtrar la búsqueda; el "*" se soporta para buscar subcadenas.

En alcance, pase una de las siguientes constantes del tema "LDAP":

ConstanteTipoValorComentario
LDAP root onlyTexto"base"Buscar sólo en el elemento raíz definido por dnRootEntry (por defecto si se omite)
LDAP root and nextTexto"one"Buscar en el elemento la raíz definido por dnRootEntry y en las entradas posteriores directamente en un nivel
LDAP all levelsTexto"sub"Buscar en el elemento raíz definido por dnRootEntry y en todas las entradas posteriores

En atributos, pase un array texto que contiene la lista de todos los atributos LDAP a recuperar a partir de las entradas encontradas. Por defecto, si se omite este parámetro, todos los atributos se recuperan.

Nota: tenga en cuenta que los nombres de atributos LDAP distinguen entre mayúsculas y minúsculas. Para más información sobre los atributos LDAP, puede consultar esta página que lista todos los atributos disponibles para MS Active directory.

Por defecto, el comando devuelve atributos como un array si se encuentran varios resultados, o como una variable si se encuentra un solo resultado. Los parámetros opcionales atributosEnArray permiten "forzar" el formato de los atributos devueltos en un array o como una variable para cada atributo definido:

  • Cuando pase true en un elemento, el elemento correspondiente del parámetro atributos será devuelto en un array. Si se encuentra un solo valor, el comando devuelve un array con un solo elemento.
  • Cuando pase false en un elemento, el elemento correspondiente del parámetro atributos será devuelto en una variable simple. Si se encuentran varias entradas, el comando devuelve sólo el primer elemento.

Ejemplo 1​

Queremos obtener el número de teléfono de todos los usuarios con nombre "smith" en el directorio de la empresa:

 ARRAY TEXT($_tabAttributes;0)
 ARRAY BOOLEAN($_tabAttributes_asArray;0)
 APPEND TO ARRAY($_tabAttributes;"cn")
 APPEND TO ARRAY($_tabAttributes_asArray;False)
 APPEND TO ARRAY($_tabAttributes;"telephoneNumber")
 APPEND TO ARRAY($_tabAttributes_asArray;False)
 ARRAY OBJECT($_entry;0)
 
 LDAP LOGIN($url;$myLogin;$pwd)
 $filter:="cn=*smith*"
 LDAP SEARCH ALL($dnSearchRootEntry;$_entry;$filter;LDAP all levels;$_tabAttributes)
 LDAP LOGOUT
 
 
  //$_entry contendrá por ejemplo
  // $_entry{1} = {"cn":"John Smith","telephoneNumber":"01 40 87 00 00"}
  // $_entry{2} = {"cn":"Adele Smith","telephoneNumber":"01 40 87 00 01"}
  // $_entry{3} = {"cn":"Adrian Smith","telephoneNumber":"01 23 45 67 89"}
  // ...

Ejemplo 2​

Estos ejemplos ilustran el uso del parámetro atributosEnArray:

 ARRAY OBJECT($_entry;0)
 ARRAY TEXT($_tabAttributes;0)
 ARRAY BOOLEAN($_tabAttributes_asArray;0)
 APPEND TO ARRAY($_tabAttributes;"cn")
 APPEND TO ARRAY($_tabAttributes_asArray;False)
 APPEND TO ARRAY($_tabAttributes;"memberOf")
 APPEND TO ARRAY($_tabAttributes_asArray;True)
 
 LDAP LOGIN($url;$login;$pwd;LDAP password plain text)
 LDAP SEARCH ALL($dnSearchRootEntry;$_entry;$filter;LDAP all levels;$_tabAttributes;$_tabAttributes_asArray)
 LDAP LOGOUT
 
 ARRAY TEXT($_arrMemberOf;0)
 OB GET ARRAY($_entry{1};"memberOf";$_arrMemberOf)
  // en $_arrMemberOf tenemos un array que contiene todos los grupos de la entrada
 ARRAY TEXT($_tabAttributes;0)
 ARRAY BOOLEAN($_tabAttributes_asArray;0)
 APPEND TO ARRAY($_tabAttributes;"cn")
 APPEND TO ARRAY($_tabAttributes_asArray;False)
 APPEND TO ARRAY($_tabAttributes;"memberOf")
 APPEND TO ARRAY($_tabAttributes_asArray;False)
 
 LDAP LOGIN($url;$login;$pwd;LDAP password plain text)
 LDAP SEARCH ALL($dnSearchRootEntry;$_entry;$filter;LDAP all levels;$_tabAttributes;$_tabAttributes_asArray)
 LDAP LOGOUT
 
 $memberOf:=OB Get($_entry{1};"memberOf")
  // en $memberOf tenemos una variable que contiene el primer grupo de la entrada

Ver también​

LDAP
LDAP Search