Back to index
Summary
Modifies an existing group.groupNameStringrequiredName of the group; must be unique among local groups. clearPersonasBooleanoptionalClear personas for group, if modifying. migrateSettingsStringoptionalNew group name to which settings will be migrated. newNameStringoptionalThe new name for an existing object that is being renamed. personaArrayoptionalList of personas that this group has. removeAllUsersBooleanoptionalTrue to remove all users from this group. userNameArrayoptionalList of users in the group. |
Usage
Perl
$cmdr->modifyGroup( "test-groupName" # groupName # optionals );
ectool
ectool modifyGroup \ "test-groupName" `# groupName` \ # optionals
Examples
Perl
To add one username to the group:
$cmdr->modifyGroup("Build Users", {userName => "dduncan"});
To add two usernames to the group:
$cmdr->modifyGroup("Build Users", {userName => ["dduncan", "jack"]});
To add personas to the existing group:
$cmdr->modifyGroup("Build Users", {personas => ["persona1", "persona2"]});
ectool
To add one username to the group, use the singular userName
argument:
ectool modifyGroup "Build Users" --userName dduncan
To add two or more usernames to the group, use the plural userNames
argument:
ectool modifyGroup "Build Users" --userNames dduncan jack tthomas
To add personas to the existing group:
ectool modifyGroup "Build Users" --personas persona1 persona2