Get Groups operation
The Get Groups operation retrieves one or more Active Directory groups.
The following table describes the elements for the <items> XML element and adapter request for the Get Groups operation.
Elements for the <items> XML for the Get Groups operation
Input element | Description | Required |
---|---|---|
| Specifies the target for the request | No |
| Specifies the host name or IP address of the remote computer | No |
| Specifies the user name for remote host authentication | No |
| Specifies the password that corresponds to the user name | No |
| Indicates the beginning of the | Yes |
| Indicates the beginning of a | Yes |
| Specifies the operation to execute | Yes |
| Specifies the type of object on which to perform the operation | Yes |
| Specifies the distinguished name of the organizational unit or the domain name whose groups to be searched For example, to search groups in an OU, use the following distinguished name: OU=MyOU,DC=punbnadv21,DC=local To search groups in a domain, use the following distinguished name: DC=punbnadv21,DC=local | Yes |
| Contains the element list for the operation | Yes |
<name> | Specifies the name of the group | No |
<scope> | Specifies the scope of an Active Directory search Valid values: subtree, onelevel, base | No |
<description> | Specifies the description for the group | No |
<samid> | Specifies the SAM-Account-Name of the group | No |
| Specifies the remote server for the connection | Conditional |
| Specifies the remote domain for the connection | Conditional |
| Specifies the logon user name for the remote server | Conditional |
| Specifies the password associated with the user name | Conditional |
The following figure shows a sample adapter request for the Get Groups operation.
Adapter request for the Get Groups operation
<request-data>
<active-directory-request>
<commands>
<command>
<active-directory-command>Get Groups</active-directory-command>
<object-class>Group</object-class>
<object-distinguished-name>OU=OUTest,DC=punbnadv21,DC=local</object-distinguished-name>
<parameters>
<scope>subtree</scope>
<desc>OU</desc>
</parameters>
</command>
</commands>
</active-directory-request>
</request-data>
The following figure shows a sample adapter response for the Get Groups operation:
Sample adapter response for the Get Groups operation
<active-directory-response>
<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>dsquery group "OU=OUTest,DC=punbnadv21,DC=local" -scope "subtree"</command>
<line-count>7</line-count>
<execution-milliseconds>43672</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">"CN=TestGroup1,OU=OUTest2,OU=OUTest,DC=punbnadv21,DC=local"</line>
<line index="5">"CN=TestGroup2,OU=OUTest2,OU=OUTest,DC=punbnadv21,DC=local"</line>
<line index="6">"CN=OUGroup1,OU=OUTest,DC=punbnadv21,DC=local"</line>
<line index="7">Remote application exited with code: 0 </line>
</output>
</command-output>
</commands-output>
</target-output>
</active-directory-response>
Comments