<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<!DOCTYPE stax SYSTEM "/stax.dtd">

<stax>

<function name="addEntry">

<function-prolog>

This function adds an entry to the Directory Server from an ldif file

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="filepath"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory server hostname or IP address

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory server port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Bind password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="entryToBeAdded" type="required">

<function-arg-description>

Entry to be added to Directory Server in ldif format

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="extraParams" type="optional">

<function-arg-description>

Optional extra parameters for specific test cases

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="verbose" type="optional" default="True">

<function-arg-description>

Display (or not) output.

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Local variables -->

<script>

mylocation=location

</script>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/ldapmodify%s' % (dsBinPath,fileExt)

STAFCmdParamsList.append('-a')

</script>

<!-- Set common ldap arguments -->

<call function="'_ldapCommonArgs'" />

<script>

if extraParams:

STAFCmdParamsList.append('%s' % extraParams)

if entryToBeAdded:

STAFCmdParamsList.append('-f "%s"' % entryToBeAdded)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<call function="'runCommand'">

{ 'command' : STAFCmd,

'arguments' : STAFCmdParams,

'location' : mylocation,

'name' : 'Add Entry From LDIF',

'expectedRC' : expectedRC,

'knownIssue' : knownIssue

}

</call>

<return>

STAXResult

</return>

</sequence>

</function>

<!-- ldapmodify Function With Script-->

<function name="ldapModifyWithScript">

<function-prolog>

This function performs an ldapmodify using the script

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsAdd" type="optional">

<function-arg-description>

Add the entries

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsAssertionFilter" type="optional">

<function-arg-description>

Use the LDAP assertion control with the provided filter

</function-arg-description>

<function-arg-property name="type" value="filter"/>

</function-arg-def>

<function-arg-def name="dsContinueOnError" type="optional">

<function-arg-description>

Continue processing even if there are errors

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsReportAuthzID" type="optional">

<function-arg-description>

Use the authorization identity control

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsFilename" type="optional">

<function-arg-description>

Specifies the LDIF file containing the changes to apply

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsHelp" type="optional">

<function-arg-description>

Display this usage information

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsEncoding" type="optional">

<function-arg-description>

Use the specified character set for command-line input

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsBindPasswordFile" type="optional">

<function-arg-description>

Bind password file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsControl" type="optional">

<function-arg-description>

Use a request control with the provided information

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePath" type="optional">

<function-arg-description>

Certificate keystore path

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePasswordFile" type="optional">

<function-arg-description>

Certificate keystore PIN file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePassword" type="optional">

<function-arg-description>

Certificate keystore PIN

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsDryRun" type="optional">

<function-arg-description>

Show what would be done but do not perform any operation

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsSaslOption" type="optional">

<function-arg-description>

SASL bind options

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePath" type="optional">

<function-arg-description>

Certificate trust store path

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePassword" type="optional">

<function-arg-description>

Certificate trust store PIN

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePasswordFile" type="optional">

<function-arg-description>

Certificate trust store PIN file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsUseStartTLS" type="optional">

<function-arg-description>

Use StartTLS to secure communication with the server

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsUseSASLExternal" type="optional">

<function-arg-description>

Use the SASL EXTERNAL authentication mechanism

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsUseSSL" type="optional">

<function-arg-description>

Use SSL for secure communication with the server

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsTrustAll" type="optional">

<function-arg-description>

Trust all server SSL certificates

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsVersion" type="optional">

<function-arg-description>

Display Directory Server version information

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsCertNickname" type="optional">

<function-arg-description>

Nickname of certificate for SSL client authentication

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsProxyAs" type="optional">

<function-arg-description>

Use the proxied authorization control with the given authorization ID

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsPreReadAttributes" type="optional">

<function-arg-description>

Use the LDAP ReadEntry pre-read control

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsPostReadAttributes" type="optional">

<function-arg-description>

Use the LDAP ReadEntry post-read control

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsLdapVersion" type="optional">

<function-arg-description>

LDAP protocol version number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsVerbose" type="optional">

<function-arg-description>

Use verbose mode

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory Server Host Name

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory Server Port Number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Directory Server Manager DN

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Directory Server Manager Password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/ldapmodify%s' % (dsBinPath,fileExt)

if dsAdd:

STAFCmdParamsList.append('-a')

if dsInstanceHost:

STAFCmdParamsList.append('-h %s' % dsInstanceHost)

if dsInstanceDn:

STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)

if dsInstancePswd:

STAFCmdParamsList.append('-w %s' % dsInstancePswd)

if dsAssertionFilter:

STAFCmdParamsList.append('--assertionFilter "%s"' % dsAssertionFilter)

if dsContinueOnError:

STAFCmdParamsList.append('-c')

if dsReportAuthzID:

STAFCmdParamsList.append('-E')

if dsFilename:

STAFCmdParamsList.append('-f %s' % dsFilename)

if dsHelp:

STAFCmdParamsList.append('-H')

if dsEncoding:

STAFCmdParamsList.append('-i %s' % dsEncoding)

if dsBindPasswordFile:

STAFCmdParamsList.append('-j %s' % dsBindPasswordFile)

if dsControl:

STAFCmdParamsList.append('-J %s' % dsControl)

if dsKeyStorePath:

STAFCmdParamsList.append('-K %s' % dsKeyStorePath)

if dsCertNickname:

STAFCmdParamsList.append('-N %s' % dsCertNickname)

if dsDryRun:

STAFCmdParamsList.append('-n')

if dsSaslOption:

STAFCmdParamsList.append('-o %s' % dsSaslOption)

if dsInstancePort:

STAFCmdParamsList.append('-p %s' % dsInstancePort)

if dsTrustStorePath:

STAFCmdParamsList.append('-P %s' % dsTrustStorePath)

if dsUseStartTLS:

STAFCmdParamsList.append('-q')

if dsUseSASLExternal:

STAFCmdParamsList.append('-r')

if dsTrustStorePassword:

STAFCmdParamsList.append('--trustStorePassword %s' % dsTrustStorePassword)

if dsTrustStorePasswordFile:

STAFCmdParamsList.append('-U %s' % dsTrustStorePasswordFile)

if dsKeyStorePasswordFile:

STAFCmdParamsList.append('-u %s' % dsKeyStorePasswordFile)

if dsVersion:

STAFCmdParamsList.append('--version')

if dsVerbose:

STAFCmdParamsList.append('-v')

if dsLdapVersion:

STAFCmdParamsList.append('-V %s' % dsLdapVersion)

if dsKeyStorePassword:

STAFCmdParamsList.append('-W %s' % dsKeyStorePassword)

if dsTrustAll:

STAFCmdParamsList.append('-X')

if dsProxyAs:

STAFCmdParamsList.append('-Y "%s"' % dsProxyAs)

if dsUseSSL:

STAFCmdParamsList.append('-Z')

if dsPreReadAttributes:

for attribute in dsPreReadAttributes:

STAFCmdParamsList.append('--preReadAttributes %s' % attribute)

if dsPostReadAttributes:

for attribute in dsPostReadAttributes:

STAFCmdParamsList.append('--postReadAttributes %s' % attribute)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<call function="'runCommand'">

{ 'name' : 'LDAP Modify Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'location' : location,

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

<return>

STAXResult

</return>

</sequence>

</function>

<function name="modifyEntry">

<function-prolog>

This function modifies an entry in the Directory Server

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="filepath"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory server hostname or IP address

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory server port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Bind password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="entryToBeModified" type="required">

<function-arg-description>

Entry to be modified in the Directory Server in ldif format

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="extraParams" type="optional">

<function-arg-description>

Optional extra parameters for specific test cases

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Local variables -->

<script>

mylocation=location

</script>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/ldapmodify%s' % (dsBinPath,fileExt)

</script>

<!-- Set common ldap arguments -->

<call function="'_ldapCommonArgs'"/>

<script>

if extraParams:

STAFCmdParamsList.append('%s' % extraParams)

if entryToBeModified:

STAFCmdParamsList.append('-f "%s"' % entryToBeModified)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<call function="'runCommand'">

{ 'location' : location,

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'name' : 'Modify Entry from ldif file',

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

<return>

STAXResult

</return>

</sequence>

</function>

<!-- ldapsearch Function With Script-->

<function name="ldapSearchWithScript">

<function-prolog>

This function performs an ldapsearch using the script

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsDereferencePolicy" type="optional">

<function-arg-description>

Specifies dereference alias policy

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsTypesOnly" type="optional">

<function-arg-description>

Specifies to only include attribute type names

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsAssertionFilter" type="optional">

<function-arg-description>

Use the LDAP assertion control with the provided filter

</function-arg-description>

<function-arg-property name="type" value="filter"/>

</function-arg-def>

<function-arg-def name="dsContinueOnError" type="optional">

<function-arg-description>

Continue processing even if there are errors

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsPersistentSearch" type="optional">

<function-arg-description>

Use the persistent search control

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsCountEntries" type="optional">

<function-arg-description>

Count the number of entries returned by the server

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsReportAuthzID" type="optional">

<function-arg-description>

Use the authorization identity control

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsFilename" type="optional">

<function-arg-description>

File containing a list of search filter strings

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsHelp" type="optional">

<function-arg-description>

Display this usage information

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsEncoding" type="optional">

<function-arg-description>

Use the specified character set for command-line input

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsBindPasswordFile" type="optional">

<function-arg-description>

Bind password file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsControl" type="optional">

<function-arg-description>

Use a request control with the provided information

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePath" type="optional">

<function-arg-description>

Certificate keystore path

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePasswordFile" type="optional">

<function-arg-description>

Certificate keystore PIN file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePassword" type="optional">

<function-arg-description>

Certificate keystore PIN

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsTimeLimit" type="optional">

<function-arg-description>

Maximum length of time in seconds to allow for the search

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsMatchedValuesFilter" type="optional">

<function-arg-description>

Use the LDAP matched values control with the provided filter

</function-arg-description>

<function-arg-property name="type" value="filter"/>

</function-arg-def>

<function-arg-def name="dsDryRun" type="optional">

<function-arg-description>

Show what would be done but do not perform any operation

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsSaslOption" type="optional">

<function-arg-description>

SASL bind options

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePath" type="optional">

<function-arg-description>

Certificate trust store path

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePassword" type="optional">

<function-arg-description>

Certificate trust store PIN

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePasswordFile" type="optional">

<function-arg-description>

Certificate trust store PIN file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsUseStartTLS" type="optional">

<function-arg-description>

Use StartTLS to secure communication with the server

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsUseSASLExternal" type="optional">

<function-arg-description>

Use the SASL EXTERNAL authentication mechanism

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsUseSSL" type="optional">

<function-arg-description>

Use SSL for secure communication with the server

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsTrustAll" type="optional">

<function-arg-description>

Trust all server SSL certificates

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsCertNickname" type="optional">

<function-arg-description>

Nickname of certificate for SSL client authentication

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsProxyAs" type="optional">

<function-arg-description>

Use the proxied authorization control with the given authorization ID

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsUsePasswordPolicyControl" type="optional">

<function-arg-description>

Use the password policy request control

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsSimplePageSize" type="optional">

<function-arg-description>

Use the simple paged results control with the given page size

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsSortOrder" type="optional">

<function-arg-description>

Sort the results using the provided sort order

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsVirtualListView" type="optional">

<function-arg-description>

Use the virtual list view control to retrieve the specified results page

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsGetEffectiveRightsAuthzid" type="optional">

<function-arg-description>

Use geteffectiverights control with the provided authzid

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsGetEffectiveRightsAttribute" type="optional">

<function-arg-description>

Specifies geteffectiverights control specific attribute list

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsVersion" type="optional">

<function-arg-description>

LDAP protocol version number

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsSizeLimit" type="optional">

<function-arg-description>

Maximum number of entries to return from the search

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsDontWrap" type="optional">

<function-arg-description>

Do not wrap long lines

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsVerbose" type="optional">

<function-arg-description>

Use verbose mode

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory Server Host Name

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory Server Port Number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Directory Server Manager DN

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Directory Server Manager Password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsScope" type="optional">

<function-arg-description>

The scope of the search operation

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsBaseDN" type="optional">

<function-arg-description>

The baseDN for the search operation

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="extraParams" type="optional">

<function-arg-description>

Optional extra parameters for specific test cases

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsFilter" type="optional">

<function-arg-description>

The filter for the search operation

</function-arg-description>

<function-arg-property name="type" value="filter"/>

</function-arg-def>

<function-arg-def name="dsAttributes" type="optional">

<function-arg-description>

Only return these attributes

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="outputFile" type="optional" default="'None'">

<function-arg-description>

Output file containing the search result in ldif format

</function-arg-description>

<function-arg-property name="type" value="file"/>

</function-arg-def>

<function-arg-def name="outputPath" type="optional">

<function-arg-description>

Path containing the outputFile

</function-arg-description>

<function-arg-property name="type" value="filepath"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="logStderr" type="optional" default="True">

<function-arg-description>

If true, stderr for the command is redirect to stdout.

</function-arg-description>

<function-arg-property name="type" value="enum">

<function-arg-property-description>

This argument can only have boolean values

</function-arg-property-description>

<function-arg-property-data type="choice" value="True"/>

<function-arg-property-data type="choice" value="False"/>

</function-arg-property>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/ldapsearch%s' % (dsBinPath,fileExt)

if dsInstanceHost:

STAFCmdParamsList.append('-h %s' % dsInstanceHost)

if dsInstanceDn:

STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)

if dsInstancePswd:

STAFCmdParamsList.append('-w %s' % dsInstancePswd)

if dsScope:

STAFCmdParamsList.append('-s %s' % dsScope)

if dsDereferencePolicy:

STAFCmdParamsList.append('-a %s' % dsDereferencePolicy)

if dsTypesOnly:

STAFCmdParamsList.append('-A')

if dsAssertionFilter:

STAFCmdParamsList.append('--assertionFilter "%s"' % dsAssertionFilter)

if dsBaseDN:

STAFCmdParamsList.append('-b "%s"' % dsBaseDN)

else:

STAFCmdParamsList.append('-b ""')

if dsContinueOnError:

STAFCmdParamsList.append('-c')

if dsPersistentSearch:

STAFCmdParamsList.append('-C %s' % dsPersistentSearch)

if dsCountEntries:

STAFCmdParamsList.append('--countEntries')

if dsGetEffectiveRightsAttribute:

for attribute in dsGetEffectiveRightsAttribute:

STAFCmdParamsList.append('-e %s' % attribute)

if dsReportAuthzID:

STAFCmdParamsList.append('-E')

if dsFilename:

STAFCmdParamsList.append('-f %s' % dsFilename)

if dsGetEffectiveRightsAuthzid:

STAFCmdParamsList.append('-g %s' % dsGetEffectiveRightsAuthzid)

if dsVirtualListView:

STAFCmdParamsList.append('-G %s' % dsVirtualListView)

if dsHelp:

STAFCmdParamsList.append('-H')

if dsEncoding:

STAFCmdParamsList.append('-i %s' % dsEncoding)

if dsBindPasswordFile:

STAFCmdParamsList.append('-j %s' % dsBindPasswordFile)

if dsControl:

STAFCmdParamsList.append('-J "%s"' % dsControl)

if dsKeyStorePath:

STAFCmdParamsList.append('-K %s' % dsKeyStorePath)

if dsTimeLimit:

STAFCmdParamsList.append('-l %s' % dsTimeLimit)

if dsMatchedValuesFilter:

STAFCmdParamsList.append('--matchedValuesFilter "%s"' % dsMatchedValuesFilter)

if dsDryRun:

STAFCmdParamsList.append('-n')

if dsCertNickname:

STAFCmdParamsList.append('-N %s' % dsCertNickname)

if dsSaslOption:

STAFCmdParamsList.append('-o %s' % dsSaslOption)

if dsInstancePort:

STAFCmdParamsList.append('-p %s' % dsInstancePort)

if dsTrustStorePath:

STAFCmdParamsList.append('-P %s' % dsTrustStorePath)

if dsUseStartTLS:

STAFCmdParamsList.append('-q')

if dsUseSASLExternal:

STAFCmdParamsList.append('-r')

if dsSimplePageSize:

STAFCmdParamsList.append('--simplePageSize %s' % dsSimplePageSize)

if dsSortOrder:

STAFCmdParamsList.append('-S %s' % dsSortOrder)

if dsDontWrap:

STAFCmdParamsList.append('-T')

if dsTrustStorePassword:

STAFCmdParamsList.append('--trustStorePassword %s' % dsTrustStorePassword)

if dsTrustStorePasswordFile:

STAFCmdParamsList.append('-U %s' % dsTrustStorePasswordFile)

if dsKeyStorePasswordFile:

STAFCmdParamsList.append('-u %s' % dsKeyStorePasswordFile)

if dsUsePasswordPolicyControl:

STAFCmdParamsList.append('--usePasswordPolicyControl')

if dsVersion:

STAFCmdParamsList.append('-V %s' % dsVersion)

if dsVerbose:

STAFCmdParamsList.append('-v')

if dsKeyStorePassword:

STAFCmdParamsList.append('-W %s' % dsKeyStorePassword)

if dsTrustAll:

STAFCmdParamsList.append('-X')

if dsProxyAs:

STAFCmdParamsList.append('-Y "%s"' % dsProxyAs)

if dsUseSSL:

STAFCmdParamsList.append('-Z')

if dsSizeLimit:

STAFCmdParamsList.append('-z %s' % dsSizeLimit)

if extraParams:

STAFCmdParamsList.append('%s' % extraParams)

if dsFilter:

STAFCmdParamsList.append('"%s"' % dsFilter)

if dsAttributes:

STAFCmdParamsList.append('%s' % dsAttributes)

if not outputPath:

outputPath = '%s/..' % (dsPath)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<if expr="outputFile != 'None'">

<call function="'runCommand'" >

{ 'name' : 'LDAP Search Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'location' : location,

'outputFile': '%s/%s' % (outputPath, outputFile) ,

'expectedRC': expectedRC ,

'logStderr' : logStderr,

'knownIssue': knownIssue

}

</call>

<else>

<call function="'runCommand'" >

{ 'name' : 'LDAP Search Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'location' : location,

'expectedRC': expectedRC ,

'logStderr' : logStderr,

'knownIssue': knownIssue

}

</call>

</else>

</if>

<return>

STAXResult

</return>

</sequence>

</function>

<function name="SearchObject">

<function-prolog>

This function searches the Directory Server with optional arguments possible

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="pathname"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory Server Host Name

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory Server Port Number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Directory Server Manager DN

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Directory Server Manager Password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsProxyDN" type="optional">

<function-arg-description>

Directory Server Proxy DN

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsScope" type="optional">

<function-arg-description>

The scope of the search operation

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsBaseDN" type="optional">

<function-arg-description>

The baseDN for the search operation

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsFilter" type="optional">

<function-arg-description>

The filter for the search operation

</function-arg-description>

<function-arg-property name="type" value="filter"/>

</function-arg-def>

<function-arg-def name="extraParams" type="optional">

<function-arg-description>

Optional extra parameters for specific test cases

</function-arg-description>

<function-arg-property name="type" value="filter"/>

</function-arg-def>

<function-arg-def name="attributes" type="optional">

<function-arg-description>

Optional Attributes to return

</function-arg-description>

<function-arg-property name="type" value="attributes"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0.

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Local variables -->

<script>

mylocation=location

</script>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/ldapsearch%s' % (dsBinPath,fileExt)

</script>

<!-- Set common ldap arguments -->

<call function="'_ldapCommonArgs'"/>

<script>

if dsProxyDN:

STAFCmdParamsList.append('-Y "%s"' % dsProxyDN)

if dsScope:

STAFCmdParamsList.append('-s %s' % dsScope)

if extraParams:

STAFCmdParamsList.append('%s' % extraParams)

if dsBaseDN:

STAFCmdParamsList.append('-b "%s"' % dsBaseDN)

if dsFilter:

STAFCmdParamsList.append('"%s"' % dsFilter)

if attributes:

STAFCmdParamsList.append('%s' % attributes)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<call function="'runCommand'">

{ 'command' : STAFCmd,

'arguments' : STAFCmdParams,

'location' : location,

'name' : 'ldapsearch',

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

<return>

STAXResult

</return>

</sequence>

</function>

<function name="SearchObjectNoPwd">

<function-prolog>

This function searches the Directory Server with optional arguments possible

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="pathname"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory Server Host Name

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory Server Port Number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Directory Server Manager DN

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsBaseDN" type="optional">

<function-arg-description>

The baseDN for the search operation

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsFilter" type="optional">

<function-arg-description>

The filter for the search operation

</function-arg-description>

<function-arg-property name="type" value="filter"/>

</function-arg-def>

<function-arg-def name="extraParams" type="optional">

<function-arg-description>

Optional extra parameters for specific test cases

</function-arg-description>

<function-arg-property name="type" value="filter"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0

Wildcard 'noCheck' to not check the RC

</function-arg-description>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<call function="'runCommand'" >

{ 'name' : 'Search Base Object No Password',

'command' : '%s/ldapsearch%s' % (dsBinPath,fileExt),

'arguments' : '-h %s -p %s -D "%s" %s -b "%s" "%s"' % (dsInstanceHost,dsInstancePort,dsInstanceDn,extraParams,dsBaseDN,dsFilter),

'location' : location,

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

<return>

STAXResult

</return>

</sequence>

</function>

<!-- TO BE DEPRECATED -->

<function name="AnonSearchObject">

<function-prolog>

This function searches the Directory Server anonymously with optional arguments possible

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="pathname"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory Server Host Name

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory Server Port Number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsBaseDN" type="optional">

<function-arg-description>

The baseDN for the search operation

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsFilter" type="optional">

<function-arg-description>

The filter for the search operation

</function-arg-description>

<function-arg-property name="type" value="filter"/>

</function-arg-def>

<function-arg-def name="extraParams" type="optional">

<function-arg-description>

Optional extra parameters for specific test cases

</function-arg-description>

<function-arg-property name="type" value="filter"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<script>

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/ldapsearch%s' % (dsBinPath,fileExt)

</script>

<call function="'runCommand'" >

{ 'name' : 'Anonymous Search Base Object',

'location' : location,

'command' : STAFCmd,

'arguments' : '-h %s -p %s %s -b "%s" "%s"' % (dsInstanceHost,dsInstancePort,extraParams,dsBaseDN,dsFilter),

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

<return>

STAXResult

</return>

</sequence>

</function>

<!-- ldapdelete Function With Script-->

<function name="ldapDeleteWithScript">

<function-prolog>

This function performs an ldapdelete using the script

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsContinueOnError" type="optional">

<function-arg-description>

Continue processing even if there are errors

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsFilename" type="optional">

<function-arg-description>

Specifies the LDIF file containing the changes to apply

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsHelp" type="optional">

<function-arg-description>

Display this usage information

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsEncoding" type="optional">

<function-arg-description>

Use the specified character set for command-line input

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsBindPasswordFile" type="optional">

<function-arg-description>

Bind password file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsControl" type="optional">

<function-arg-description>

Use a request control with the provided information

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePath" type="optional">

<function-arg-description>

Certificate keystore path

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePasswordFile" type="optional">

<function-arg-description>

Certificate keystore PIN file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePassword" type="optional">

<function-arg-description>

Certificate keystore PIN

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsDryRun" type="optional">

<function-arg-description>

Show what would be done but do not perform any operation

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsSaslOption" type="optional">

<function-arg-description>

SASL bind options

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePath" type="optional">

<function-arg-description>

Certificate trust store path

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePassword" type="optional">

<function-arg-description>

Certificate trust store PIN

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePasswordFile" type="optional">

<function-arg-description>

Certificate trust store PIN file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsUseStartTLS" type="optional">

<function-arg-description>

Use StartTLS to secure communication with the server

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsUseSASLExternal" type="optional">

<function-arg-description>

Use the SASL EXTERNAL authentication mechanism

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsUseSSL" type="optional">

<function-arg-description>

Use SSL for secure communication with the server

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsTrustAll" type="optional">

<function-arg-description>

Trust all server SSL certificates

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsVersion" type="optional">

<function-arg-description>

Display Directory Server version information

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsCertNickname" type="optional">

<function-arg-description>

Nickname of certificate for SSL client authentication

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsLdapVersion" type="optional">

<function-arg-description>

LDAP protocol version number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsVerbose" type="optional">

<function-arg-description>

Use verbose mode

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsDeleteSubtree" type="optional">

<function-arg-description>

Delete the specified entry and all entries below it

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory Server Host Name

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory Server Port Number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Directory Server Manager DN

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Directory Server Manager Password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsDn" type="optional">

<function-arg-description>

DNs of the entries to delete

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/ldapdelete%s' % (dsBinPath,fileExt)

if dsInstanceHost:

STAFCmdParamsList.append('-h %s' % dsInstanceHost)

if dsInstanceDn:

STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)

if dsInstancePswd:

STAFCmdParamsList.append('-w %s' % dsInstancePswd)

if dsContinueOnError:

STAFCmdParamsList.append('-c')

if dsFilename:

STAFCmdParamsList.append('-f %s' % dsFilename)

if dsHelp:

STAFCmdParamsList.append('-H')

if dsEncoding:

STAFCmdParamsList.append('-i %s' % dsEncoding)

if dsBindPasswordFile:

STAFCmdParamsList.append('-j %s' % dsBindPasswordFile)

if dsControl:

STAFCmdParamsList.append('-J %s' % dsControl)

if dsKeyStorePath:

STAFCmdParamsList.append('-K %s' % dsKeyStorePath)

if dsCertNickname:

STAFCmdParamsList.append('-N %s' % dsCertNickname)

if dsDryRun:

STAFCmdParamsList.append('-n')

if dsSaslOption:

STAFCmdParamsList.append('-o %s' % dsSaslOption)

if dsInstancePort:

STAFCmdParamsList.append('-p %s' % dsInstancePort)

if dsTrustStorePath:

STAFCmdParamsList.append('-P %s' % dsTrustStorePath)

if dsUseStartTLS:

STAFCmdParamsList.append('-q')

if dsUseSASLExternal:

STAFCmdParamsList.append('-r')

if dsTrustStorePassword:

STAFCmdParamsList.append('--trustStorePassword %s' % dsTrustStorePassword)

if dsTrustStorePasswordFile:

STAFCmdParamsList.append('-U %s' % dsTrustStorePasswordFile)

if dsKeyStorePasswordFile:

STAFCmdParamsList.append('-u %s' % dsKeyStorePasswordFile)

if dsVersion:

STAFCmdParamsList.append('--version')

if dsVerbose:

STAFCmdParamsList.append('-v')

if dsLdapVersion:

STAFCmdParamsList.append('-V %s' % dsLdapVersion)

if dsKeyStorePassword:

STAFCmdParamsList.append('-W %s' % dsKeyStorePassword)

if dsTrustAll:

STAFCmdParamsList.append('-X')

if dsDeleteSubtree:

STAFCmdParamsList.append('-x')

if dsUseSSL:

STAFCmdParamsList.append('-Z')

if dsDn:

for dn in dsDn:

STAFCmdParamsList.append('"%s"' % dn)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<call function="'runCommand'">

{ 'name' : 'LDAP Delete Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'location' : location,

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

<return>

STAXResult

</return>

</sequence>

</function>

<function name="DeleteEntry">

<function-prolog>

This function an entry in the Directory Server

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="filepath"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory server hostname or IP address

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory server port number

</function-arg-description>

<function-arg-property name="type" value="Port number"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Bind DN

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Bind password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsBaseDN" type="required">

<function-arg-description>

Entry to be deleted in the Directory Server

</function-arg-description>

<function-arg-property name="type" value="DN"/>

</function-arg-def>

<function-arg-def name="extraParams" type="optional">

<function-arg-description>

Optional extra parameters for specific test cases

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Local variables -->

<script>

mylocation=location

</script>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/ldapdelete%s' % (dsBinPath,fileExt)

</script>

<!-- Set common ldap arguments -->

<call function="'_ldapCommonArgs'"/>

<script>

if extraParams:

STAFCmdParamsList.append('%s' % extraParams)

if dsBaseDN:

STAFCmdParamsList.append('"%s"' % dsBaseDN)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<message>

'%s %s' % (STAFCmd, STAFCmdParams)

</message>

<call function="'runCommand'">

{ 'name' : 'Delete Object',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'location' : location,

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

<return>

STAXResult

</return>

</sequence>

</function>

<!-- ldapcompare Function With Script-->

<function name="ldapCompareWithScript">

<function-prolog>

This function performs an ldapcompare using the script

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>

Pathname to installation root

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsAssertionFilter" type="optional">

<function-arg-description>

Use the LDAP assertion control with the provided filter

</function-arg-description>

<function-arg-property name="type" value="filter"/>

</function-arg-def>

<function-arg-def name="dsContinueOnError" type="optional">

<function-arg-description>

Continue processing even if there are errors

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsReportAuthzID" type="optional">

<function-arg-description>

Use the authorization identity control

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsFilename" type="optional">

<function-arg-description>

Specifies the LDIF file containing the changes to apply

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsHelp" type="optional">

<function-arg-description>

Display this usage information

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsEncoding" type="optional">

<function-arg-description>

Use the specified character set for command-line input

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsBindPasswordFile" type="optional">

<function-arg-description>

Bind password file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsControl" type="optional">

<function-arg-description>

Use a request control with the provided information

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePath" type="optional">

<function-arg-description>

Certificate keystore path

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePasswordFile" type="optional">

<function-arg-description>

Certificate keystore PIN file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsKeyStorePassword" type="optional">

<function-arg-description>

Certificate keystore PIN

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsDryRun" type="optional">

<function-arg-description>

Show what would be done but do not perform any operation

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsSaslOption" type="optional">

<function-arg-description>

SASL bind options

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePath" type="optional">

<function-arg-description>

Certificate trust store path

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePassword" type="optional">

<function-arg-description>

Certificate trust store PIN

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsTrustStorePasswordFile" type="optional">

<function-arg-description>

Certificate trust store PIN file

</function-arg-description>

<function-arg-property name="type" value="filename"/>

</function-arg-def>

<function-arg-def name="dsUseStartTLS" type="optional">

<function-arg-description>

Use StartTLS to secure communication with the server

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsUseSASLExternal" type="optional">

<function-arg-description>

Use the SASL EXTERNAL authentication mechanism

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsUseSSL" type="optional">

<function-arg-description>

Use SSL for secure communication with the server

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsTrustAll" type="optional">

<function-arg-description>

Trust all server SSL certificates

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsVersion" type="optional">

<function-arg-description>

Display Directory Server version information

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsCertNickname" type="optional">

<function-arg-description>

Nickname of certificate for SSL client authentication

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsLdapVersion" type="optional">

<function-arg-description>

LDAP protocol version number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsVerbose" type="optional">

<function-arg-description>

Use verbose mode

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="dsInstanceHost" type="optional">

<function-arg-description>

Directory Server Host Name

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsInstancePort" type="optional">

<function-arg-description>

Directory Server Port Number

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="dsInstanceDn" type="optional">

<function-arg-description>

Directory Server Manager DN

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="dsInstancePswd" type="optional">

<function-arg-description>

Directory Server Manager Password

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsAttributeValue" type="optional">

<function-arg-description>

Attribute:value assertion argument

</function-arg-description>

<function-arg-property name="type" value="string"/>

</function-arg-def>

<function-arg-def name="dsDn" type="optional">

<function-arg-description>

DNs of the entries for with to perform the compare operations

</function-arg-description>

<function-arg-property name="type" value="dn"/>

</function-arg-def>

<function-arg-def name="useCmpRC" type="optional" default="'True'">

<function-arg-description>

Use an exit code that indicates whether comparison is successful.

Results are an exit code of 6 (COMPARE_TRUE) or

an exit code of 5 (COMPARE_FALSE).

</function-arg-description>

<function-arg-property name="type" value="option"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="6">

<function-arg-description>

Expected return code value. Default value is 6 (COMPARE_TRUE).

Wildcard 'noCheck' to not check the RC

</function-arg-description>

<function-arg-property name="type" value="integer"/>

</function-arg-def>

<function-arg-def name="knownIssue" type="optional" default="None">

<function-arg-description>

Known issue. Corresponds to an issue number.

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

dsBinPath='%s/%s' % (dsPath,fileFolder)

STAFCmd='%s/ldapcompare%s' % (dsBinPath,fileExt)

if dsInstanceHost:

STAFCmdParamsList.append('-h %s' % dsInstanceHost)

if dsInstanceDn:

STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)

if dsInstancePswd:

STAFCmdParamsList.append('-w %s' % dsInstancePswd)

if dsAssertionFilter:

STAFCmdParamsList.append('--assertionFilter "%s"' % dsAssertionFilter)

if dsContinueOnError:

STAFCmdParamsList.append('-c')

if dsReportAuthzID:

STAFCmdParamsList.append('-E')

if dsFilename:

STAFCmdParamsList.append('-f %s' % dsFilename)

if dsHelp:

STAFCmdParamsList.append('-H')

if dsEncoding:

STAFCmdParamsList.append('-i %s' % dsEncoding)

if dsBindPasswordFile:

STAFCmdParamsList.append('-j %s' % dsBindPasswordFile)

if dsControl:

STAFCmdParamsList.append('-J %s' % dsControl)

if dsKeyStorePath:

STAFCmdParamsList.append('-K %s' % dsKeyStorePath)

if dsCertNickname:

STAFCmdParamsList.append('-N %s' % dsCertNickname)

if dsDryRun:

STAFCmdParamsList.append('-n')

if dsSaslOption:

STAFCmdParamsList.append('-o %s' % dsSaslOption)

if dsInstancePort:

STAFCmdParamsList.append('-p %s' % dsInstancePort)

if dsTrustStorePath:

STAFCmdParamsList.append('-P %s' % dsTrustStorePath)

if dsUseStartTLS:

STAFCmdParamsList.append('-q')

if dsUseSASLExternal:

STAFCmdParamsList.append('-r')

if dsTrustStorePassword:

STAFCmdParamsList.append('--trustStorePassword %s' % dsTrustStorePassword)

if dsTrustStorePasswordFile:

STAFCmdParamsList.append('-U %s' % dsTrustStorePasswordFile)

if dsKeyStorePasswordFile:

STAFCmdParamsList.append('-u %s' % dsKeyStorePasswordFile)

if dsVersion:

STAFCmdParamsList.append('--version')

if dsVerbose:

STAFCmdParamsList.append('-v')

if dsLdapVersion:

STAFCmdParamsList.append('-V %s' % dsLdapVersion)

if dsKeyStorePassword:

STAFCmdParamsList.append('-W %s' % dsKeyStorePassword)

if dsTrustAll:

STAFCmdParamsList.append('-X')

if dsUseSSL:

STAFCmdParamsList.append('-Z')

if useCmpRC == 'True':

STAFCmdParamsList.append('--useCompareResultCode')

if dsDn:

for dn in dsDn:

STAFCmdParamsList.append('"%s"' % dn)

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<call function="'runCommand'" >

{ 'name' : 'LDAP Compare Script',

'command' : STAFCmd,

'arguments' : STAFCmdParams,

'location' : location,

'expectedRC': expectedRC,

'knownIssue': knownIssue

}

</call>

<return>

STAXResult

</return>

</sequence>

</function>

<function name="compareEntry">

<function-prolog>

This function compares the attribute and value an entry to the Directory Server

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

<function-arg-description>