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 elementDescriptionRequired

<target>

Specifies the target for the request 

If this element is not present, the adapter uses the default target specified in its configuration.

No

<host>

Specifies the host name or IP address of the remote computer 

To specify a dynamic target, you must use this element.

No

<user-name>

Specifies the user name for remote host authentication 

To specify a dynamic target, you must use this element.

No

<password>

Specifies the password that corresponds to the user name 

To specify a dynamic target, you must use this element.

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 

Default value: Get Groups

Yes

<object-class>

Specifies the type of object on which to perform the operation 

Default value: Group

Yes

<object-distinguished-name>

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

<parameters>

Contains the element list for the operation

Yes

<name>Specifies the name of the groupNo
<scope>

Specifies the scope of an Active Directory search

Valid values: subtree, onelevel, base 

No
<description>Specifies the description for the groupNo
<samid>Specifies the SAM-Account-Name of the groupNo

<server>

Specifies the remote server for the connection 

If the object belongs to an Active Directory service hosted on a remote server, you must use this element.

Conditional

<domain>

Specifies the remote domain for the connection 

If the object belongs to an Active Directory service hosted on a remote server, you must use this element.

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 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>
Was this page helpful? Yes No Submitting... Thank you

Comments