Use this command to view information about a group.
Purpose
Use the
getGroup command
to view a map that contains the following properties of a group:
- cn
- description
- uniqueName
These are the only properties that this command returns;
that is, you cannot modify the properties that the command returns.
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
getGroup { -uniqueName uniqueName [-clearCache clearCacheMode] [-securityDomainName domainName] }
Parameters
- -uniqueName uniqueName
- Specifies the unique name value for the group that you want to
view. This parameter maps to the uniqueName property in virtual member
manager.
- -clearCache clearCacheMode
- Specifies whether the repository adapter cache should be cleared
before retrieving the specified group information.
- Valid values are:
- clearEntity: Clears the cache for the specified
group, if the group exists in the cache.
- clearAll: Clears the cached information
for all of the entities in the adapter of the repository where the
specified group exists.
The values are not case-sensitive. There is no default value
for this parameter. If you do not specify a value, or specify a value
other than clearEntity or 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. The impact on performance is more pronounced if you use the clearAll mode,
as this invalidates the entire cache, and the subsequent operation
takes longer to complete.
- -securityDomainName domainName
- 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 retrieve the cn and description information
about the group called operators, issue this command:
$AdminTask getGroup {-uniqueName cn=operators,cn=groups,dc=yourco,dc=com}