Mandato searchUsers

Utilice este mandato para buscar usuarios.

Finalidad

Utilice el mandato searchUsers para buscar usuarios en virtual member manager que coincidan con unos criterios determinados. Por ejemplo, puede utilizar el mandato searchUsers para buscar todos los usuarios con un uid que empiece por la letra 'd'.

Si es satisfactorio, el mandato searchUsers devuelve una lista de nombres exclusivos de todos los usuarios que coinciden con los criterios de búsqueda.

Nota: Si se ha seleccionado la opción Usar valores de seguridad global para la esfera de usuario o se ha seleccionado la opción Depósitos federados globales como tipo de esfera para el dominio especificado, este mandato se ejecuta en el depósito federado del dominio admin. Sin embargo, los cambios de configuración realizados en el dominio se aplican a la configuración específica del dominio de seguridad.

Sintaxis

searchUsers { {-cn nombre_común –sn apellido -principalName nombre_principal -uid uid 
               -mail mail} [-timeLimit límite_t] [-countLimit límite_recuento] [-clearCache modalidad_borrar_caché] [-securityDomainName nombre_dominio] }
Debe especificarse exactamente uno de los parámetros (cn, sn, principalName, uid o mail). Si no se especifica ninguno o más de uno, se produce una excepción.

Parámetros

-cn nombre_común
Especifica el nombre o nombre de pila del usuario. Este parámetro se correlaciona con la propiedad cn en virtual member manager.
-sn apellido
Especifica el apellido o nombre de familia del usuario. Este parámetro se correlaciona con la propiedad sn en virtual member manager.
-principalName nombre_principal
Especifica el nombre de principal del usuario que se utiliza como ID de inicio de sesión para el usuario en el sistema. Este parámetro se correlaciona con la propiedad principalName en virtual member manager.
-uid ID_usuario
Especifica el valor de ID exclusivo para el usuario que desea buscar. Este parámetro se correlaciona con la propiedad uid en virtual member manager.
–timeLimit límite_t
Especifica la cantidad de tiempo máxima en milisegundos que se puede ejecutar la búsqueda. El valor predeterminado es sin limite de tiempo.
–countLimit límite_numérico
Especifica el número máximo de resultados que desea que se devuelvan de la búsqueda. De forma predeterminada, se devuelven todos los usuarios encontrados en la búsqueda.
-clearCache modalidad_borrar_caché
Especifica si se debe borrar la memoria caché del adaptador de depósito antes de realizar la operación de búsqueda para usuarios.
El valor válido es clearAll, que borra toda la información guardada en la memoria caché del adaptador de depósito. El valor no distingue entre mayúsculas y minúsculas. No hay ningún valor predeterminado para este parámetro. Si no especifica un valor o si especifica un valor distinto a clearAll, se muestra un mensaje de error.
Cómo evitar el problema: El uso frecuente de este parámetro para borrar la memoria caché puede disminuir el rendimiento. Cuando se borra la memoria caché, la operación siguiente tendrá que obtener los detalles del depósito y actualizar la memoria caché con estos datos recién recuperados, de modo que la operación siguiente tardará más tiempo en completarse.
-securityDomainName nombre_dominio
Especifica el nombre que identifica exclusivamente el dominio de seguridad. Si no especifica este parámetro, el mandato utiliza el repositorio federado global.
Nota: Si define varias propiedades de inicio de sesión, la primera propiedad de inicio de sesión se correlaciona programáticamente con la propiedad principalName de los depósitos federados. Por ejemplo, si ha establecido uid;mail como propiedades de inicio de sesión, el atributo LDAP uid se correlaciona con la propiedad principalName de los depósitos federados.

Ejemplo

Para buscar todos los usuarios que tienen un nombre de principal, emita el mandato siguiente:
$AdminTask searchUsers {-principalName *}
Para buscar todos los usuarios que tienen un uid que empieza por la letra 'd', emita el mandato siguiente:
$AdminTask searchUsers {-uid d*}


Condiciones de uso | Comentarios