Active Directory - Create group
Declaration
<AMACTIVEDIRECTORY ACTIVITY="create_group" AUTHTYPE="text (options)" USERNAME="text" LDAPPATH="text" GROUP="text" DISPLAYNAME="text" DESCRIPTION="text" GROUPTYPE="text (options)" GROUPSCOPE="text (options)" PASSWORD="text (encrypted)" />
Description: Creates a new Active Directory group in the specified parent container. Groups are Active Directory (or local computer) objects that can contain users, contacts, computers, and other groups that can be managed as a single unit.
Active Directory activities require a basic understanding of Active Directory and related components (e.g., Domain Controllers, Trust Relationships, Forests, LDAPs, etc.). Also, to ensure that these activities function appropriately, the target system must be part of a domain.
Practical Usage
Often used to create an Active Directory group in which to add members to. Users and computers that belong to a particular group are referred to as group members.
Group Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Parent LDAP path |
Text |
Yes |
(Empty) |
LDAPPATH= "LDAP://DC=netauto,DC=com" |
The Lightweight Directory Access Protocol (LDAP) path of the parent Active Directory container. This is usually the top most container or rootDSE path, the root of the directory data tree on a directory server. Click the Select Container button to launch a standard Windows dialog box that allows for the selection an Active Directory container. |
Name |
Text |
Yes |
(Empty) |
GROUP="Group1" |
The name of the Active Directory group to be created. |
Display name |
Text |
Yes |
(Empty) |
DISPLAYNAME="Davelopers" |
The display name of the Active Directory group to be created. |
Description |
Text |
Yes |
(Empty) |
DESCRIPTION= "Developers" |
A description of the Active Directory group to be created. |
Group type |
Text (options) |
No |
Security |
|
The type of Active Directory group to be created. Sending an e-mail message to a group sends the message to all members of the group. The available options are:
|
Group scope |
Text (options) |
No |
DomainLocal |
|
The scope of the Active Directory group to be created. Group scopes normally describe which type of users should be clubbed together in a way which is easy for their administration. The available options are:
|
Credentials Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Authentication type |
Text (options) |
No |
Default |
AUTHTYPE="Encryption" |
Specifies the types of authentication used. The available options are:
|
Username |
Text |
No |
(Empty) |
USERNAME="username" |
The username context that this activity will execute under. Leave the Username and Password parameters blank in order to use the logon user's credentials. NOTE: A Domain User has permission to access Active Directory information. However, only a Domain Administrator has permission to perform Active Directory modifications. |
Password |
Text |
No |
(Empty) |
PASSWORD="password" |
The password associated to the Username context that this activity will execute under. Leave the Username and Password parameters blank to use the logon user's credentials. |
Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.
Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)
On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: Create an Active Directory group of type "SECURITY" by the name of "administrator". The path of the new group's parent is "LDAP://servername.com".
<CREATEADGROUP LDAPPATH="LDAP://servername.com" USERNAME="administrator" PASSWORD="AM2LRnogx3fFdk=aME" GROUP="administrator" DISPLAYNAME="mycompany" DESCRIPTION="Local Security" GROUPTYPE="SECURITY" GROUPSCOPE="DOMAINLOCAL" />