Add Members to Group operation
The Add Members to Group operation adds one or more users, groups, service accounts, or computers as new members of an Active Directory group.
The following table describes the elements for the <items> XML element and adapter request for the Add Members to Group operation.
Elements for the <items> XML for the Add Members to Group operation
Input element | Description | Required |
|---|---|---|
<target> | Specifies the target for the request | No |
<host> | Specifies the host name or IP address of the remote computer | No |
<user-name> | Specifies the user name for remote host authentication | No |
<password> | Specifies the password that corresponds to the user name | No |
<commands> | Indicates the beginning of the <commands> element, which contains the individual <command> elements | Yes |
<command> | Indicates the beginning of a <command> element, which contains the elements that specify the operation to execute and its parameters | Yes |
<active-directory-command> | Specifies the operation to execute | Yes |
<object-class> | Specifies the type of object on which to perform the operation | Yes |
<object-distinguished-name> | Specifies the distinguished name of the group to which the members are to be added. For example, CN=MyGroup,OU=MyOU,DC=punbnadv21,DC=local | Yes |
<parameters> | Contains the element list for the operation | No |
<add-member> | Specifies the set of user, group, and computer objects in a comma-separated list to add to a group | Yes |
<server> | Specifies the remote server for the connection | Conditional |
<domain> | Specifies the remote domain for the connection | Conditional |
<user-name> | Specifies the logon user name for the remote server | Conditional |
<password> | Specifies the password associated with the user name | Conditional |
The following figure shows a sample adapter request for the Add Members to Group operation.
Adapter request for the Add Members to Group operation
<active-directory-request>
<commands>
<command>
<active-directory-command>Add Members to Group</active-directory-command>
<object-class>Group</object-class>
<object-distinguished-name>CN=TestGroup1,OU=OUTest2,OU=OUTest,DC=punbnadv21,Dc=local</object-distinguished-name>
<parameters>
<add-member>CN=Testuser1,CN=Users,DC=punbnadv21,Dc=local</add-member>
<add-member>CN=Testuser2,CN=Users,DC=punbnadv21,Dc=local</add-member>
</parameters>
</command>
</commands>
</active-directory-request>
</request-data>
The following figure shows a sample adapter response for the Add Members to Group operation:
Sample adapter response for the Add Members to Group operation
<metadata>
<status>success</status>
</metadata>
<target-output host="vw-pun-bna-dv21.bmc.com">
<metadata>
<os-id>Windows Server 2008</os-id>
<os-version>6.3.9600</os-version>
<status>success</status>
</metadata>
<commands-output>
<command-output>
<metadata>
<command>dsmod group "CN=TestGroup1,OU=OUTest2,OU=OUTest,DC=punbnadv21,Dc=local" -addmbr "CN=Testuser2,CN=Users,DC=punbnadv21,Dc=local" "CN=Testuser1,CN=Users,DC=punbnadv21,Dc=local"</command>
<line-count>5</line-count>
<execution-milliseconds>49141</execution-milliseconds>
<exit-code>0</exit-code>
<status>success</status>
</metadata>
<output>
<line index="1">Copyright 2010 BMC Software Ltd, Version: 1.5 </line>
<line index="2">Connecting to remote service...</line>
<line index="3">Connected to remote host.</line>
<line index="4">dsmod succeeded:CN=TestGroup1,OU=OUTest2,OU=OUTest,DC=punbnadv21,Dc=local</line>
<line index="5">Remote application exited with code: 0 </line>
</output>
</command-output>
</commands-output>
</target-output>
</active-directory-response>