getGroup

Back to index

Summary

Retrieves a group by its name.
groupName
Stringrequired
Name of the group; must be unique among local groups.
providerName
Stringoptional
The name of the provider from which to get the group.
traverseHierarchy
Booleanoptional
Set to 0 or true to include nested groups in the result if this is an LDAP group and recursive traversal of group hierarchy is enabled for the directory provider.

Usage

Perl

$cmdr->getGroup( "test-groupName" # groupName # optionals );

ectool

ectool getGroup \ "test-groupName" `# groupName` \ # optionals

Examples

Perl

$cmdr->getGroup("QA group", {providerName => "LDAP", traverseHierarchy => true});

ectool

ectool getGroup "QA group" --providerName "LDAP" --traverseHierarchy true