deleteGroup command

Use this command to delete a group.

Purpose

Use the deleteGroup command to delete a group from virtual member manager. You cannot use this command to delete the descendants of the group.

If successful, the deleteGroup command returns the unique name of the deleted group.

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.
command

Syntax

deleteGroup { -uniqueName uniqueName [-securityDomainName domainName] } 

Parameters

-uniqueName uniqueName
Specifies the unique name value for the group that you want to delete. This parameter maps to the uniqueName property in virtual member manager.
-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 delete the group called 'operators', issue this command:
$AdminTask deleteGroup {-uniqueName cn=operators,cn=groups,dc=yourco,dc=com}

Icon that indicates the type of topic Reference topic



Timestamp icon Last updated: March 6, 2017 0:20
File name: deletegroupcommand.html