searchGroups command

Use this command to search for groups.

Purpose

Use the searchGroups command to find groups in virtual member manager that match particular criteria. For example, you can use the searchGroups command to find all groups with a cn that starts with IBM.

If successful, the searchGroups command returns a list of unique names of all groups that match the search criteria.

Note: If the Use global security settings option is selected for the user realm or the Global federated repositories option is selected as the realm type for the specified domain, this command is executed on the federated repository of the admin domain. However, configuration changes that are performed on the domain are applied to the security domain-specific configuration.

Syntax

searchGroups { -cn commonname -description description  [-timeLimit tlimit] 
              [-countLimit countlimit] [-clearCache clearCacheMode] [-securityDomainName domainName] }

Parameters

-cncommonname: Specifies the common name used for the group. This parameter maps to the cn property in virtual member manager.
-descriptiondescription: Specifies information about the group. This parameter maps to the description entity in a virtual member manager object.
-timeLimittlimit: Specifies the maximum amount of time in milliseconds that the search can run. The default is no time limit.
-countLimitcountlimit: Specifies the maximum number of results that you want returned from the search. By default, all groups found in the search are returned.
-clearCacheclearCacheMode: Specifies whether the repository adapter cache should be cleared before performing the search operation for groups.; The valid value is clearAll, which clears all of the cached information in the repository adapter. The value is not case-sensitive. There is no default value for this parameter. If you do not specify a value, or specify a value other than clearAll, an error message appears.; Avoid trouble: Frequent use of this parameter to clear the cache may result in performance degradation. When the cache is cleared, the subsequent operation has to get the details from the repository and update the cache with this newly retrieved data; so the subsequent operation takes longer to complete.
-securityDomainNamedomainName: Specifies the name that uniquely identifies the security domain. If you do not specify this parameter, the command uses the global federated repository.

Sample

To search for all groups that have a description specified, issue this command:

$AdminTask searchGroups {-description *}

To search for all groups that have IBM appearing in the common name of the group, issue this command:

$AdminTask searchGroups {-cn *IBM*}