2788N/A<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2788N/A<!DOCTYPE stax SYSTEM "/stax.dtd">
2788N/A<!--
2788N/A ! CDDL HEADER START
2788N/A !
2788N/A ! The contents of this file are subject to the terms of the
2788N/A ! Common Development and Distribution License, Version 1.0 only
2788N/A ! (the "License"). You may not use this file except in compliance
2788N/A ! with the License.
2788N/A !
2788N/A ! You can obtain a copy of the license at
2788N/A ! trunk/opends/resource/legal-notices/OpenDS.LICENSE
2788N/A ! or https://OpenDS.dev.java.net/OpenDS.LICENSE.
2788N/A ! See the License for the specific language governing permissions
2788N/A ! and limitations under the License.
2788N/A !
2788N/A ! When distributing Covered Code, include this CDDL HEADER in each
2788N/A ! file and include the License file at
2788N/A ! trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
2788N/A ! add the following below this CDDL HEADER, with the fields enclosed
2788N/A ! by brackets "[]" replaced with your own identifying information:
2788N/A ! Portions Copyright [yyyy] [name of copyright owner]
2788N/A !
2788N/A ! CDDL HEADER END
2788N/A !
5064N/A ! Copyright 2007-2010 Sun Microsystems, Inc.
6073N/A ! Portions Copyright 2012-2013 ForgeRock AS.
2788N/A ! -->
2788N/A<stax>
2788N/A <function name="addEntry">
2788N/A <function-prolog>
2788N/A This function adds an entry to the Directory Server from an ldif file
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filepath"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory server hostname or IP address
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory server port number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="Port number"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="optional">
2788N/A <function-arg-description>
2788N/A Bind DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePswd" type="optional">
2788N/A <function-arg-description>
2788N/A Bind password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="entryToBeAdded" type="required">
2788N/A <function-arg-description>
2788N/A Entry to be added to Directory Server in ldif format
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="extraParams" type="optional">
2788N/A <function-arg-description>
2788N/A Optional extra parameters for specific test cases
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2949N/A <function-arg-property name="type" value="integer"/>
2949N/A </function-arg-def>
2998N/A <function-arg-def name="verbose" type="optional" default="True">
2949N/A <function-arg-description>
2950N/A Display (or not) output.
2949N/A </function-arg-description>
2949N/A <function-arg-property name="type" value="integer"/>
2949N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A <sequence>
2788N/A <!-- Local variables -->
2788N/A <script>
2788N/A mylocation=location
2788N/A </script>
2788N/A
2788N/A <!-- Build the Command -->
2788N/A <script>
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A
2788N/A if dsPath:
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/ldapmodify%s' % (dsBinPath,fileExt)
2788N/A
2788N/A STAFCmdParamsList.append('-a')
2788N/A </script>
2788N/A
2788N/A <!-- Set common ldap arguments -->
2788N/A <call function="'_ldapCommonArgs'" />
2788N/A
2788N/A <script>
2788N/A if extraParams:
2788N/A STAFCmdParamsList.append('%s' % extraParams)
2788N/A
2788N/A if entryToBeAdded:
2788N/A STAFCmdParamsList.append('-f "%s"' % entryToBeAdded)
2788N/A
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A </script>
2788N/A <call function="'runCommand'">
2949N/A { 'command' : STAFCmd,
2949N/A 'arguments' : STAFCmdParams,
2949N/A 'location' : mylocation,
2949N/A 'name' : 'Add Entry From LDIF',
3951N/A 'expectedRC' : expectedRC,
3951N/A 'knownIssue' : knownIssue
2788N/A }
2788N/A </call>
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A </function>
2788N/A
2788N/A
2788N/A <!-- ldapmodify Function With Script-->
2788N/A <function name="ldapModifyWithScript">
2788N/A <function-prolog>
2788N/A This function performs an ldapmodify using the script
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsAdd" type="optional">
2788N/A <function-arg-description>
3847N/A Add the entries
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsAssertionFilter" type="optional">
2788N/A <function-arg-description>
2788N/A Use the LDAP assertion control with the provided filter
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filter"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsContinueOnError" type="optional">
2788N/A <function-arg-description>
2788N/A Continue processing even if there are errors
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsReportAuthzID" type="optional">
2788N/A <function-arg-description>
2788N/A Use the authorization identity control
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsFilename" type="optional">
2788N/A <function-arg-description>
2788N/A Specifies the LDIF file containing the changes to apply
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsHelp" type="optional">
2788N/A <function-arg-description>
2788N/A Display this usage information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsEncoding" type="optional">
2788N/A <function-arg-description>
2788N/A Use the specified character set for command-line input
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsBindPasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Bind password file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsControl" type="optional">
2788N/A <function-arg-description>
2788N/A Use a request control with the provided information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePath" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore path
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore PIN file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePassword" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore PIN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsDryRun" type="optional">
2788N/A <function-arg-description>
2788N/A Show what would be done but do not perform any operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsSaslOption" type="optional">
2788N/A <function-arg-description>
2788N/A SASL bind options
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePath" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store path
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePassword" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store PIN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store PIN file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseStartTLS" type="optional">
2788N/A <function-arg-description>
2788N/A Use StartTLS to secure communication with the server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseSASLExternal" type="optional">
2788N/A <function-arg-description>
2788N/A Use the SASL EXTERNAL authentication mechanism
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseSSL" type="optional">
2788N/A <function-arg-description>
2788N/A Use SSL for secure communication with the server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustAll" type="optional">
2788N/A <function-arg-description>
2788N/A Trust all server SSL certificates
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsVersion" type="optional">
2788N/A <function-arg-description>
2788N/A Display Directory Server version information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsCertNickname" type="optional">
2788N/A <function-arg-description>
2788N/A Nickname of certificate for SSL client authentication
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsProxyAs" type="optional">
2788N/A <function-arg-description>
2788N/A Use the proxied authorization control with the given authorization ID
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsPreReadAttributes" type="optional">
2788N/A <function-arg-description>
2788N/A Use the LDAP ReadEntry pre-read control
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsPostReadAttributes" type="optional">
2788N/A <function-arg-description>
2788N/A Use the LDAP ReadEntry post-read control
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsLdapVersion" type="optional">
2788N/A <function-arg-description>
2788N/A LDAP protocol version number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsVerbose" type="optional">
2788N/A <function-arg-description>
2788N/A Use verbose mode
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Host Name
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Port Number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePswd" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager Password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
3951N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A
2788N/A <sequence>
2788N/A
2788N/A <!-- Build the Command -->
2788N/A <script>
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A
2788N/A if dsPath:
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/ldapmodify%s' % (dsBinPath,fileExt)
2788N/A
2788N/A if dsAdd:
2788N/A STAFCmdParamsList.append('-a')
2788N/A
2788N/A if dsInstanceHost:
2788N/A STAFCmdParamsList.append('-h %s' % dsInstanceHost)
2788N/A
2788N/A if dsInstanceDn:
2788N/A STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)
2788N/A
2788N/A if dsInstancePswd:
2788N/A STAFCmdParamsList.append('-w %s' % dsInstancePswd)
2788N/A
2788N/A if dsAssertionFilter:
2788N/A STAFCmdParamsList.append('--assertionFilter "%s"' % dsAssertionFilter)
2788N/A
2788N/A if dsContinueOnError:
2788N/A STAFCmdParamsList.append('-c')
2788N/A
2788N/A if dsReportAuthzID:
2788N/A STAFCmdParamsList.append('-E')
2788N/A
2788N/A if dsFilename:
2788N/A STAFCmdParamsList.append('-f %s' % dsFilename)
2788N/A
2788N/A if dsHelp:
2788N/A STAFCmdParamsList.append('-H')
2788N/A
2788N/A if dsEncoding:
2788N/A STAFCmdParamsList.append('-i %s' % dsEncoding)
2788N/A
2788N/A if dsBindPasswordFile:
2788N/A STAFCmdParamsList.append('-j %s' % dsBindPasswordFile)
2788N/A
2788N/A if dsControl:
2788N/A STAFCmdParamsList.append('-J %s' % dsControl)
2788N/A
2788N/A if dsKeyStorePath:
2788N/A STAFCmdParamsList.append('-K %s' % dsKeyStorePath)
2788N/A
2788N/A if dsCertNickname:
2788N/A STAFCmdParamsList.append('-N %s' % dsCertNickname)
2788N/A
2788N/A if dsDryRun:
2788N/A STAFCmdParamsList.append('-n')
2788N/A
2788N/A if dsSaslOption:
2788N/A STAFCmdParamsList.append('-o %s' % dsSaslOption)
2788N/A
2788N/A if dsInstancePort:
2788N/A STAFCmdParamsList.append('-p %s' % dsInstancePort)
2788N/A
2788N/A if dsTrustStorePath:
2788N/A STAFCmdParamsList.append('-P %s' % dsTrustStorePath)
2788N/A
2788N/A if dsUseStartTLS:
2788N/A STAFCmdParamsList.append('-q')
2788N/A
2788N/A if dsUseSASLExternal:
2788N/A STAFCmdParamsList.append('-r')
2788N/A
2788N/A if dsTrustStorePassword:
2788N/A STAFCmdParamsList.append('--trustStorePassword %s' % dsTrustStorePassword)
2788N/A
2788N/A if dsTrustStorePasswordFile:
2788N/A STAFCmdParamsList.append('-U %s' % dsTrustStorePasswordFile)
2788N/A
2788N/A if dsKeyStorePasswordFile:
2788N/A STAFCmdParamsList.append('-u %s' % dsKeyStorePasswordFile)
2788N/A
2788N/A if dsVersion:
2788N/A STAFCmdParamsList.append('--version')
2788N/A
2788N/A if dsVerbose:
2788N/A STAFCmdParamsList.append('-v')
2788N/A
2788N/A if dsLdapVersion:
2788N/A STAFCmdParamsList.append('-V %s' % dsLdapVersion)
2788N/A
2788N/A if dsKeyStorePassword:
2788N/A STAFCmdParamsList.append('-W %s' % dsKeyStorePassword)
2788N/A
2788N/A if dsTrustAll:
2788N/A STAFCmdParamsList.append('-X')
2788N/A
2788N/A if dsProxyAs:
2788N/A STAFCmdParamsList.append('-Y "%s"' % dsProxyAs)
2788N/A
2788N/A if dsUseSSL:
2788N/A STAFCmdParamsList.append('-Z')
2788N/A
2788N/A if dsPreReadAttributes:
2788N/A for attribute in dsPreReadAttributes:
2788N/A STAFCmdParamsList.append('--preReadAttributes %s' % attribute)
2788N/A
2788N/A if dsPostReadAttributes:
2788N/A for attribute in dsPostReadAttributes:
2788N/A STAFCmdParamsList.append('--postReadAttributes %s' % attribute)
2788N/A
2788N/A
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A </script>
2788N/A
2788N/A <message>
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A </message>
2788N/A
2788N/A <call function="'runCommand'">
2788N/A { 'name' : 'LDAP Modify Script',
2788N/A 'command' : STAFCmd,
2788N/A 'arguments' : STAFCmdParams,
3194N/A 'location' : location,
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A </function>
2788N/A
2788N/A
2788N/A <function name="modifyEntry">
2788N/A <function-prolog>
2788N/A This function modifies an entry in the Directory Server
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filepath"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory server hostname or IP address
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory server port number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="Port number"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="optional">
2788N/A <function-arg-description>
2788N/A Bind DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePswd" type="optional">
2788N/A <function-arg-description>
2788N/A Bind password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="entryToBeModified" type="required">
2788N/A <function-arg-description>
2788N/A Entry to be modified in the Directory Server in ldif format
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="extraParams" type="optional">
2788N/A <function-arg-description>
2788N/A Optional extra parameters for specific test cases
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
3951N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A <sequence>
2788N/A
2788N/A <!-- Local variables -->
2788N/A <script>
2788N/A mylocation=location
2788N/A </script>
2788N/A
2788N/A <!-- Build the Command -->
2788N/A <script>
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A
2788N/A if dsPath:
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/ldapmodify%s' % (dsBinPath,fileExt)
2788N/A
2788N/A </script>
2788N/A
2788N/A <!-- Set common ldap arguments -->
2788N/A <call function="'_ldapCommonArgs'"/>
2788N/A
2788N/A <script>
2788N/A if extraParams:
2788N/A STAFCmdParamsList.append('%s' % extraParams)
2788N/A
2788N/A if entryToBeModified:
2788N/A STAFCmdParamsList.append('-f "%s"' % entryToBeModified)
2788N/A
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A </script>
2788N/A
2788N/A <message>
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A </message>
2788N/A <call function="'runCommand'">
2788N/A { 'location' : location,
2788N/A 'command' : STAFCmd,
2788N/A 'arguments' : STAFCmdParams,
3194N/A 'name' : 'Modify Entry from ldif file',
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A </function>
2788N/A
2788N/A
2788N/A <!-- ldapsearch Function With Script-->
2788N/A <function name="ldapSearchWithScript">
2788N/A <function-prolog>
2788N/A This function performs an ldapsearch using the script
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsDereferencePolicy" type="optional">
2788N/A <function-arg-description>
2788N/A Specifies dereference alias policy
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTypesOnly" type="optional">
2788N/A <function-arg-description>
2788N/A Specifies to only include attribute type names
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsAssertionFilter" type="optional">
2788N/A <function-arg-description>
2788N/A Use the LDAP assertion control with the provided filter
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filter"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsContinueOnError" type="optional">
2788N/A <function-arg-description>
2788N/A Continue processing even if there are errors
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsPersistentSearch" type="optional">
2788N/A <function-arg-description>
2788N/A Use the persistent search control
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsCountEntries" type="optional">
2788N/A <function-arg-description>
2788N/A Count the number of entries returned by the server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsReportAuthzID" type="optional">
2788N/A <function-arg-description>
2788N/A Use the authorization identity control
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsFilename" type="optional">
2788N/A <function-arg-description>
2788N/A File containing a list of search filter strings
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsHelp" type="optional">
2788N/A <function-arg-description>
2788N/A Display this usage information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsEncoding" type="optional">
2788N/A <function-arg-description>
2788N/A Use the specified character set for command-line input
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsBindPasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Bind password file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsControl" type="optional">
2788N/A <function-arg-description>
2788N/A Use a request control with the provided information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePath" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore path
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore PIN file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePassword" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore PIN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTimeLimit" type="optional">
2788N/A <function-arg-description>
2788N/A Maximum length of time in seconds to allow for the search
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsMatchedValuesFilter" type="optional">
2788N/A <function-arg-description>
2788N/A Use the LDAP matched values control with the provided filter
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filter"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsDryRun" type="optional">
2788N/A <function-arg-description>
2788N/A Show what would be done but do not perform any operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsSaslOption" type="optional">
2788N/A <function-arg-description>
2788N/A SASL bind options
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePath" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store path
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePassword" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store PIN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store PIN file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseStartTLS" type="optional">
2788N/A <function-arg-description>
2788N/A Use StartTLS to secure communication with the server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseSASLExternal" type="optional">
2788N/A <function-arg-description>
2788N/A Use the SASL EXTERNAL authentication mechanism
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseSSL" type="optional">
2788N/A <function-arg-description>
2788N/A Use SSL for secure communication with the server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustAll" type="optional">
2788N/A <function-arg-description>
2788N/A Trust all server SSL certificates
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsCertNickname" type="optional">
2788N/A <function-arg-description>
2788N/A Nickname of certificate for SSL client authentication
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsProxyAs" type="optional">
2788N/A <function-arg-description>
2788N/A Use the proxied authorization control with the given authorization ID
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUsePasswordPolicyControl" type="optional">
2788N/A <function-arg-description>
2788N/A Use the password policy request control
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsSimplePageSize" type="optional">
2788N/A <function-arg-description>
2788N/A Use the simple paged results control with the given page size
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsSortOrder" type="optional">
2788N/A <function-arg-description>
2788N/A Sort the results using the provided sort order
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsVirtualListView" type="optional">
2788N/A <function-arg-description>
2788N/A Use the virtual list view control to retrieve the specified results page
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsGetEffectiveRightsAuthzid" type="optional">
2788N/A <function-arg-description>
2788N/A Use geteffectiverights control with the provided authzid
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsGetEffectiveRightsAttribute" type="optional">
2788N/A <function-arg-description>
2788N/A Specifies geteffectiverights control specific attribute list
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsVersion" type="optional">
2788N/A <function-arg-description>
2788N/A LDAP protocol version number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsSizeLimit" type="optional">
2788N/A <function-arg-description>
2788N/A Maximum number of entries to return from the search
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsDontWrap" type="optional">
2788N/A <function-arg-description>
2788N/A Do not wrap long lines
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsVerbose" type="optional">
2788N/A <function-arg-description>
2788N/A Use verbose mode
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Host Name
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Port Number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePswd" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager Password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsScope" type="optional">
2788N/A <function-arg-description>
2788N/A The scope of the search operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsBaseDN" type="optional">
2788N/A <function-arg-description>
2788N/A The baseDN for the search operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2962N/A <function-arg-def name="extraParams" type="optional">
2962N/A <function-arg-description>
2962N/A Optional extra parameters for specific test cases
2962N/A </function-arg-description>
2962N/A <function-arg-property name="type" value="string"/>
2962N/A </function-arg-def>
2788N/A <function-arg-def name="dsFilter" type="optional">
2788N/A <function-arg-description>
2788N/A The filter for the search operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filter"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsAttributes" type="optional">
2788N/A <function-arg-description>
2788N/A Only return these attributes
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
3287N/A </function-arg-def>
3287N/A <function-arg-def name="outputFile" type="optional" default="'None'">
3287N/A <function-arg-description>
3287N/A Output file containing the search result in ldif format
3287N/A </function-arg-description>
3287N/A <function-arg-property name="type" value="file"/>
2788N/A </function-arg-def>
3315N/A <function-arg-def name="outputPath" type="optional">
2788N/A <function-arg-description>
3287N/A Path containing the outputFile
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filepath"/>
3287N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
3315N/A </function-arg-def>
3315N/A <function-arg-def name="logStderr" type="optional" default="True">
3315N/A <function-arg-description>
3315N/A If true, stderr for the command is redirect to stdout.
3315N/A </function-arg-description>
3315N/A <function-arg-property name="type" value="enum">
3315N/A <function-arg-property-description>
3315N/A This argument can only have boolean values
3315N/A </function-arg-property-description>
3315N/A <function-arg-property-data type="choice" value="True"/>
3315N/A <function-arg-property-data type="choice" value="False"/>
3315N/A </function-arg-property>
3315N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A
2788N/A <sequence>
2788N/A
2788N/A <!-- Build the Command -->
2788N/A <script>
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A
2788N/A if dsPath:
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/ldapsearch%s' % (dsBinPath,fileExt)
2788N/A
2788N/A if dsInstanceHost:
2788N/A STAFCmdParamsList.append('-h %s' % dsInstanceHost)
2788N/A
2788N/A if dsInstanceDn:
2788N/A STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)
2788N/A
2788N/A if dsInstancePswd:
2788N/A STAFCmdParamsList.append('-w %s' % dsInstancePswd)
2788N/A
2788N/A if dsScope:
2788N/A STAFCmdParamsList.append('-s %s' % dsScope)
2788N/A
2788N/A if dsDereferencePolicy:
2788N/A STAFCmdParamsList.append('-a %s' % dsDereferencePolicy)
2788N/A
2788N/A if dsTypesOnly:
2788N/A STAFCmdParamsList.append('-A')
2788N/A
2788N/A if dsAssertionFilter:
2788N/A STAFCmdParamsList.append('--assertionFilter "%s"' % dsAssertionFilter)
2788N/A
2788N/A if dsBaseDN:
2788N/A STAFCmdParamsList.append('-b "%s"' % dsBaseDN)
5429N/A else:
5429N/A STAFCmdParamsList.append('-b ""')
2788N/A
2788N/A if dsContinueOnError:
2788N/A STAFCmdParamsList.append('-c')
2788N/A
2788N/A if dsPersistentSearch:
2788N/A STAFCmdParamsList.append('-C %s' % dsPersistentSearch)
2788N/A
2788N/A if dsCountEntries:
2788N/A STAFCmdParamsList.append('--countEntries')
2788N/A
2788N/A if dsGetEffectiveRightsAttribute:
2788N/A for attribute in dsGetEffectiveRightsAttribute:
2788N/A STAFCmdParamsList.append('-e %s' % attribute)
2788N/A
2788N/A if dsReportAuthzID:
2788N/A STAFCmdParamsList.append('-E')
2788N/A
2788N/A if dsFilename:
2788N/A STAFCmdParamsList.append('-f %s' % dsFilename)
2788N/A
2788N/A if dsGetEffectiveRightsAuthzid:
2788N/A STAFCmdParamsList.append('-g %s' % dsGetEffectiveRightsAuthzid)
2788N/A
2788N/A if dsVirtualListView:
2788N/A STAFCmdParamsList.append('-G %s' % dsVirtualListView)
2788N/A
2788N/A if dsHelp:
2788N/A STAFCmdParamsList.append('-H')
2788N/A
2788N/A if dsEncoding:
2788N/A STAFCmdParamsList.append('-i %s' % dsEncoding)
2788N/A
2788N/A if dsBindPasswordFile:
2788N/A STAFCmdParamsList.append('-j %s' % dsBindPasswordFile)
2788N/A
2788N/A if dsControl:
5429N/A STAFCmdParamsList.append('-J "%s"' % dsControl)
2788N/A
2788N/A if dsKeyStorePath:
2788N/A STAFCmdParamsList.append('-K %s' % dsKeyStorePath)
2788N/A
2788N/A if dsTimeLimit:
2788N/A STAFCmdParamsList.append('-l %s' % dsTimeLimit)
2788N/A
2788N/A if dsMatchedValuesFilter:
2788N/A STAFCmdParamsList.append('--matchedValuesFilter "%s"' % dsMatchedValuesFilter)
2788N/A
2788N/A if dsDryRun:
2788N/A STAFCmdParamsList.append('-n')
2788N/A
2788N/A if dsCertNickname:
2788N/A STAFCmdParamsList.append('-N %s' % dsCertNickname)
2788N/A
2788N/A if dsSaslOption:
2788N/A STAFCmdParamsList.append('-o %s' % dsSaslOption)
2788N/A
2788N/A if dsInstancePort:
2788N/A STAFCmdParamsList.append('-p %s' % dsInstancePort)
2788N/A
2788N/A if dsTrustStorePath:
2788N/A STAFCmdParamsList.append('-P %s' % dsTrustStorePath)
2788N/A
2788N/A if dsUseStartTLS:
2788N/A STAFCmdParamsList.append('-q')
2788N/A
2788N/A if dsUseSASLExternal:
2788N/A STAFCmdParamsList.append('-r')
2788N/A
2788N/A if dsSimplePageSize:
2788N/A STAFCmdParamsList.append('--simplePageSize %s' % dsSimplePageSize)
2788N/A
2788N/A if dsSortOrder:
2788N/A STAFCmdParamsList.append('-S %s' % dsSortOrder)
2788N/A
2788N/A if dsDontWrap:
2788N/A STAFCmdParamsList.append('-T')
2788N/A
2788N/A if dsTrustStorePassword:
2788N/A STAFCmdParamsList.append('--trustStorePassword %s' % dsTrustStorePassword)
2788N/A
2788N/A if dsTrustStorePasswordFile:
2788N/A STAFCmdParamsList.append('-U %s' % dsTrustStorePasswordFile)
2788N/A
2788N/A if dsKeyStorePasswordFile:
2788N/A STAFCmdParamsList.append('-u %s' % dsKeyStorePasswordFile)
2788N/A
2788N/A if dsUsePasswordPolicyControl:
2788N/A STAFCmdParamsList.append('--usePasswordPolicyControl')
2788N/A
2788N/A if dsVersion:
2788N/A STAFCmdParamsList.append('-V %s' % dsVersion)
2788N/A
2788N/A if dsVerbose:
2788N/A STAFCmdParamsList.append('-v')
2788N/A
2788N/A if dsKeyStorePassword:
2788N/A STAFCmdParamsList.append('-W %s' % dsKeyStorePassword)
2788N/A
2788N/A if dsTrustAll:
2788N/A STAFCmdParamsList.append('-X')
2788N/A
2788N/A if dsProxyAs:
2788N/A STAFCmdParamsList.append('-Y "%s"' % dsProxyAs)
2788N/A
2788N/A if dsUseSSL:
2788N/A STAFCmdParamsList.append('-Z')
2788N/A
2788N/A if dsSizeLimit:
2788N/A STAFCmdParamsList.append('-z %s' % dsSizeLimit)
2962N/A
2962N/A if extraParams:
2962N/A STAFCmdParamsList.append('%s' % extraParams)
2788N/A
2788N/A if dsFilter:
2788N/A STAFCmdParamsList.append('"%s"' % dsFilter)
2788N/A
2788N/A if dsAttributes:
2788N/A STAFCmdParamsList.append('%s' % dsAttributes)
2788N/A
3287N/A if not outputPath:
3287N/A outputPath = '%s/..' % (dsPath)
3287N/A
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A </script>
2788N/A
4153N/A <if expr="outputFile != 'None'">
4153N/A <call function="'runCommand'" >
4153N/A { 'name' : 'LDAP Search Script',
4153N/A 'command' : STAFCmd,
4153N/A 'arguments' : STAFCmdParams,
4153N/A 'location' : location,
4153N/A 'outputFile': '%s/%s' % (outputPath, outputFile) ,
4153N/A 'expectedRC': expectedRC ,
4153N/A 'logStderr' : logStderr,
4153N/A 'knownIssue': knownIssue
4153N/A }
4153N/A </call>
4153N/A <else>
4153N/A <call function="'runCommand'" >
4153N/A { 'name' : 'LDAP Search Script',
4153N/A 'command' : STAFCmd,
4153N/A 'arguments' : STAFCmdParams,
4153N/A 'location' : location,
4153N/A 'expectedRC': expectedRC ,
4153N/A 'logStderr' : logStderr,
4153N/A 'knownIssue': knownIssue
4153N/A }
4153N/A </call>
4153N/A </else>
4153N/A </if>
4153N/A
2788N/A <return>
3287N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A </function>
2788N/A
2788N/A
2788N/A <function name="SearchObject">
2788N/A <function-prolog>
2788N/A This function searches the Directory Server with optional arguments possible
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="pathname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Host Name
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Port Number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePswd" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager Password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsProxyDN" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Proxy DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsScope" type="optional">
2788N/A <function-arg-description>
2788N/A The scope of the search operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsBaseDN" type="optional">
2788N/A <function-arg-description>
2788N/A The baseDN for the search operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsFilter" type="optional">
2788N/A <function-arg-description>
2788N/A The filter for the search operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filter"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="extraParams" type="optional">
2788N/A <function-arg-description>
2788N/A Optional extra parameters for specific test cases
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filter"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="attributes" type="optional">
2788N/A <function-arg-description>
2788N/A Optional Attributes to return
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="attributes"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
3194N/A Expected return code value. Default value is 0.
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
3951N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A <sequence>
2788N/A
2788N/A <!-- Local variables -->
2788N/A <script>
2788N/A mylocation=location
2788N/A </script>
2788N/A
2788N/A <!-- Build the Command -->
2788N/A <script>
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A
2788N/A if dsPath:
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/ldapsearch%s' % (dsBinPath,fileExt)
2788N/A
2788N/A </script>
2788N/A
2788N/A <!-- Set common ldap arguments -->
2788N/A <call function="'_ldapCommonArgs'"/>
2788N/A
2788N/A <script>
2788N/A if dsProxyDN:
2788N/A STAFCmdParamsList.append('-Y "%s"' % dsProxyDN)
2788N/A
2788N/A if dsScope:
2788N/A STAFCmdParamsList.append('-s %s' % dsScope)
2788N/A
2788N/A if extraParams:
2788N/A STAFCmdParamsList.append('%s' % extraParams)
2788N/A
2788N/A if dsBaseDN:
2788N/A STAFCmdParamsList.append('-b "%s"' % dsBaseDN)
2788N/A
2788N/A if dsFilter:
2788N/A STAFCmdParamsList.append('"%s"' % dsFilter)
2788N/A
2788N/A if attributes:
2788N/A STAFCmdParamsList.append('%s' % attributes)
2788N/A
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A </script>
2788N/A
2788N/A <message>
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A </message>
2788N/A
2788N/A <call function="'runCommand'">
2788N/A { 'command' : STAFCmd,
2788N/A 'arguments' : STAFCmdParams,
2788N/A 'location' : location,
3194N/A 'name' : 'ldapsearch',
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A
2788N/A </function>
2788N/A
2788N/A
2788N/A <function name="SearchObjectNoPwd">
2788N/A <function-prolog>
2788N/A This function searches the Directory Server with optional arguments possible
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="pathname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Host Name
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Port Number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsBaseDN" type="optional">
2788N/A <function-arg-description>
2788N/A The baseDN for the search operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsFilter" type="optional">
2788N/A <function-arg-description>
2788N/A The filter for the search operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filter"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="extraParams" type="optional">
2788N/A <function-arg-description>
2788N/A Optional extra parameters for specific test cases
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filter"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
3194N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A <sequence>
2788N/A <call function="'runCommand'" >
2788N/A { 'name' : 'Search Base Object No Password',
2788N/A 'command' : '%s/ldapsearch%s' % (dsBinPath,fileExt),
2788N/A 'arguments' : '-h %s -p %s -D "%s" %s -b "%s" "%s"' % (dsInstanceHost,dsInstancePort,dsInstanceDn,extraParams,dsBaseDN,dsFilter),
3194N/A 'location' : location,
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A </function>
2788N/A
5789N/A<!-- TO BE DEPRECATED -->
2788N/A <function name="AnonSearchObject">
2788N/A <function-prolog>
2788N/A This function searches the Directory Server anonymously with optional arguments possible
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="pathname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Host Name
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Port Number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsBaseDN" type="optional">
2788N/A <function-arg-description>
2788N/A The baseDN for the search operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsFilter" type="optional">
2788N/A <function-arg-description>
2788N/A The filter for the search operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filter"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="extraParams" type="optional">
2788N/A <function-arg-description>
2788N/A Optional extra parameters for specific test cases
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filter"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
3951N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A <sequence>
5789N/A <script>
5789N/A if dsPath:
5789N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
5789N/A STAFCmd='%s/ldapsearch%s' % (dsBinPath,fileExt)
5789N/A </script>
2788N/A <call function="'runCommand'" >
2788N/A { 'name' : 'Anonymous Search Base Object',
2788N/A 'location' : location,
5789N/A 'command' : STAFCmd,
3194N/A 'arguments' : '-h %s -p %s %s -b "%s" "%s"' % (dsInstanceHost,dsInstancePort,extraParams,dsBaseDN,dsFilter),
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A </function>
2788N/A
2788N/A
2788N/A <!-- ldapdelete Function With Script-->
2788N/A <function name="ldapDeleteWithScript">
2788N/A <function-prolog>
2788N/A This function performs an ldapdelete using the script
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsContinueOnError" type="optional">
2788N/A <function-arg-description>
2788N/A Continue processing even if there are errors
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsFilename" type="optional">
2788N/A <function-arg-description>
2788N/A Specifies the LDIF file containing the changes to apply
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsHelp" type="optional">
2788N/A <function-arg-description>
2788N/A Display this usage information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsEncoding" type="optional">
2788N/A <function-arg-description>
2788N/A Use the specified character set for command-line input
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsBindPasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Bind password file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsControl" type="optional">
2788N/A <function-arg-description>
2788N/A Use a request control with the provided information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePath" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore path
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore PIN file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePassword" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore PIN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsDryRun" type="optional">
2788N/A <function-arg-description>
2788N/A Show what would be done but do not perform any operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsSaslOption" type="optional">
2788N/A <function-arg-description>
2788N/A SASL bind options
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePath" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store path
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePassword" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store PIN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store PIN file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseStartTLS" type="optional">
2788N/A <function-arg-description>
2788N/A Use StartTLS to secure communication with the server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseSASLExternal" type="optional">
2788N/A <function-arg-description>
2788N/A Use the SASL EXTERNAL authentication mechanism
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseSSL" type="optional">
2788N/A <function-arg-description>
2788N/A Use SSL for secure communication with the server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustAll" type="optional">
2788N/A <function-arg-description>
2788N/A Trust all server SSL certificates
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsVersion" type="optional">
2788N/A <function-arg-description>
2788N/A Display Directory Server version information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsCertNickname" type="optional">
2788N/A <function-arg-description>
2788N/A Nickname of certificate for SSL client authentication
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsLdapVersion" type="optional">
2788N/A <function-arg-description>
2788N/A LDAP protocol version number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsVerbose" type="optional">
2788N/A <function-arg-description>
2788N/A Use verbose mode
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsDeleteSubtree" type="optional">
2788N/A <function-arg-description>
2788N/A Delete the specified entry and all entries below it
2788N/A </function-arg-description>
4865N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Host Name
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Port Number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePswd" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager Password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsDn" type="optional">
2788N/A <function-arg-description>
2788N/A DNs of the entries to delete
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A
2788N/A <sequence>
2788N/A
2788N/A <!-- Build the Command -->
2788N/A <script>
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A
2788N/A if dsPath:
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/ldapdelete%s' % (dsBinPath,fileExt)
2788N/A
2788N/A if dsInstanceHost:
2788N/A STAFCmdParamsList.append('-h %s' % dsInstanceHost)
2788N/A
2788N/A if dsInstanceDn:
2788N/A STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)
2788N/A
2788N/A if dsInstancePswd:
2788N/A STAFCmdParamsList.append('-w %s' % dsInstancePswd)
2788N/A
2788N/A if dsContinueOnError:
2788N/A STAFCmdParamsList.append('-c')
2788N/A
2788N/A if dsFilename:
2788N/A STAFCmdParamsList.append('-f %s' % dsFilename)
2788N/A
2788N/A if dsHelp:
2788N/A STAFCmdParamsList.append('-H')
2788N/A
2788N/A if dsEncoding:
2788N/A STAFCmdParamsList.append('-i %s' % dsEncoding)
2788N/A
2788N/A if dsBindPasswordFile:
2788N/A STAFCmdParamsList.append('-j %s' % dsBindPasswordFile)
2788N/A
2788N/A if dsControl:
2788N/A STAFCmdParamsList.append('-J %s' % dsControl)
2788N/A
2788N/A if dsKeyStorePath:
2788N/A STAFCmdParamsList.append('-K %s' % dsKeyStorePath)
2788N/A
2788N/A if dsCertNickname:
2788N/A STAFCmdParamsList.append('-N %s' % dsCertNickname)
2788N/A
2788N/A if dsDryRun:
2788N/A STAFCmdParamsList.append('-n')
2788N/A
2788N/A if dsSaslOption:
2788N/A STAFCmdParamsList.append('-o %s' % dsSaslOption)
2788N/A
2788N/A if dsInstancePort:
2788N/A STAFCmdParamsList.append('-p %s' % dsInstancePort)
2788N/A
2788N/A if dsTrustStorePath:
2788N/A STAFCmdParamsList.append('-P %s' % dsTrustStorePath)
2788N/A
2788N/A if dsUseStartTLS:
2788N/A STAFCmdParamsList.append('-q')
2788N/A
2788N/A if dsUseSASLExternal:
2788N/A STAFCmdParamsList.append('-r')
2788N/A
2788N/A if dsTrustStorePassword:
2788N/A STAFCmdParamsList.append('--trustStorePassword %s' % dsTrustStorePassword)
2788N/A
2788N/A if dsTrustStorePasswordFile:
2788N/A STAFCmdParamsList.append('-U %s' % dsTrustStorePasswordFile)
2788N/A
2788N/A if dsKeyStorePasswordFile:
2788N/A STAFCmdParamsList.append('-u %s' % dsKeyStorePasswordFile)
2788N/A
2788N/A if dsVersion:
2788N/A STAFCmdParamsList.append('--version')
2788N/A
2788N/A if dsVerbose:
2788N/A STAFCmdParamsList.append('-v')
2788N/A
2788N/A if dsLdapVersion:
2788N/A STAFCmdParamsList.append('-V %s' % dsLdapVersion)
2788N/A
2788N/A if dsKeyStorePassword:
2788N/A STAFCmdParamsList.append('-W %s' % dsKeyStorePassword)
2788N/A
2788N/A if dsTrustAll:
2788N/A STAFCmdParamsList.append('-X')
2788N/A
2788N/A if dsDeleteSubtree:
2788N/A STAFCmdParamsList.append('-x')
2788N/A
2788N/A if dsUseSSL:
2788N/A STAFCmdParamsList.append('-Z')
2788N/A
2788N/A if dsDn:
2788N/A for dn in dsDn:
2788N/A STAFCmdParamsList.append('"%s"' % dn)
2788N/A
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A </script>
2788N/A
2788N/A <message>
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A </message>
2788N/A
2788N/A <call function="'runCommand'">
2788N/A { 'name' : 'LDAP Delete Script',
2788N/A 'command' : STAFCmd,
2788N/A 'arguments' : STAFCmdParams,
3194N/A 'location' : location,
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A </function>
2788N/A
2788N/A
2788N/A <function name="DeleteEntry">
2788N/A <function-prolog>
2788N/A This function an entry in the Directory Server
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filepath"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory server hostname or IP address
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory server port number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="Port number"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="optional">
2788N/A <function-arg-description>
2788N/A Bind DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePswd" type="optional">
2788N/A <function-arg-description>
2788N/A Bind password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsBaseDN" type="required">
2788N/A <function-arg-description>
2788N/A Entry to be deleted in the Directory Server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="extraParams" type="optional">
2788N/A <function-arg-description>
2788N/A Optional extra parameters for specific test cases
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A
2788N/A <sequence>
2788N/A
2788N/A <!-- Local variables -->
2788N/A <script>
2788N/A mylocation=location
2788N/A </script>
2788N/A
2788N/A <!-- Build the Command -->
2788N/A <script>
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A
2788N/A if dsPath:
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/ldapdelete%s' % (dsBinPath,fileExt)
2788N/A
2788N/A </script>
2788N/A
2788N/A <!-- Set common ldap arguments -->
2788N/A <call function="'_ldapCommonArgs'"/>
2788N/A
2788N/A <script>
2788N/A if extraParams:
2788N/A STAFCmdParamsList.append('%s' % extraParams)
2788N/A
2788N/A if dsBaseDN:
2788N/A STAFCmdParamsList.append('"%s"' % dsBaseDN)
2788N/A
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A </script>
2788N/A
2788N/A <message>
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A </message>
2788N/A
2788N/A <call function="'runCommand'">
2788N/A { 'name' : 'Delete Object',
2788N/A 'command' : STAFCmd,
2788N/A 'arguments' : STAFCmdParams,
3194N/A 'location' : location,
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A
2788N/A </function>
2788N/A
2788N/A
2788N/A <!-- ldapcompare Function With Script-->
2788N/A <function name="ldapCompareWithScript">
2788N/A <function-prolog>
2788N/A This function performs an ldapcompare using the script
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsAssertionFilter" type="optional">
2788N/A <function-arg-description>
2788N/A Use the LDAP assertion control with the provided filter
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filter"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsContinueOnError" type="optional">
2788N/A <function-arg-description>
2788N/A Continue processing even if there are errors
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
3137N/A <function-arg-def name="dsReportAuthzID" type="optional">
3137N/A <function-arg-description>
3137N/A Use the authorization identity control
3137N/A </function-arg-description>
3137N/A <function-arg-property name="type" value="option"/>
3137N/A </function-arg-def>
2788N/A <function-arg-def name="dsFilename" type="optional">
2788N/A <function-arg-description>
2788N/A Specifies the LDIF file containing the changes to apply
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsHelp" type="optional">
2788N/A <function-arg-description>
2788N/A Display this usage information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsEncoding" type="optional">
2788N/A <function-arg-description>
2788N/A Use the specified character set for command-line input
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsBindPasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Bind password file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsControl" type="optional">
2788N/A <function-arg-description>
2788N/A Use a request control with the provided information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePath" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore path
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore PIN file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePassword" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore PIN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsDryRun" type="optional">
2788N/A <function-arg-description>
2788N/A Show what would be done but do not perform any operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsSaslOption" type="optional">
2788N/A <function-arg-description>
2788N/A SASL bind options
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePath" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store path
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePassword" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store PIN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store PIN file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseStartTLS" type="optional">
2788N/A <function-arg-description>
2788N/A Use StartTLS to secure communication with the server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseSASLExternal" type="optional">
2788N/A <function-arg-description>
2788N/A Use the SASL EXTERNAL authentication mechanism
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseSSL" type="optional">
2788N/A <function-arg-description>
2788N/A Use SSL for secure communication with the server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustAll" type="optional">
2788N/A <function-arg-description>
2788N/A Trust all server SSL certificates
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsVersion" type="optional">
2788N/A <function-arg-description>
2788N/A Display Directory Server version information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsCertNickname" type="optional">
2788N/A <function-arg-description>
2788N/A Nickname of certificate for SSL client authentication
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsLdapVersion" type="optional">
2788N/A <function-arg-description>
2788N/A LDAP protocol version number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsVerbose" type="optional">
2788N/A <function-arg-description>
2788N/A Use verbose mode
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Host Name
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Port Number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePswd" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager Password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsAttributeValue" type="optional">
2788N/A <function-arg-description>
2788N/A Attribute:value assertion argument
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsDn" type="optional">
2788N/A <function-arg-description>
2788N/A DNs of the entries for with to perform the compare operations
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
6073N/A <function-arg-def name="useCmpRC" type="optional">
6073N/A <function-arg-description>
6073N/A Use an exit code that indicates whether comparison is successful.
6073N/A Results are an exit code of 6 (COMPARE_TRUE) or
6073N/A an exit code of 5 (COMPARE_FALSE).
6073N/A </function-arg-description>
6073N/A <function-arg-property name="type" value="option"/>
6073N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A
2788N/A <sequence>
2788N/A
2788N/A <!-- Build the Command -->
2788N/A <script>
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A
2788N/A if dsPath:
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/ldapcompare%s' % (dsBinPath,fileExt)
2788N/A
2788N/A if dsInstanceHost:
2788N/A STAFCmdParamsList.append('-h %s' % dsInstanceHost)
2788N/A
2788N/A if dsInstanceDn:
2788N/A STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)
2788N/A
2788N/A if dsInstancePswd:
2788N/A STAFCmdParamsList.append('-w %s' % dsInstancePswd)
2788N/A
2788N/A if dsAssertionFilter:
2788N/A STAFCmdParamsList.append('--assertionFilter "%s"' % dsAssertionFilter)
2788N/A
2788N/A if dsContinueOnError:
2788N/A STAFCmdParamsList.append('-c')
3137N/A
3137N/A if dsReportAuthzID:
3137N/A STAFCmdParamsList.append('-E')
3137N/A
2788N/A if dsFilename:
2788N/A STAFCmdParamsList.append('-f %s' % dsFilename)
2788N/A
2788N/A if dsHelp:
2788N/A STAFCmdParamsList.append('-H')
2788N/A
2788N/A if dsEncoding:
2788N/A STAFCmdParamsList.append('-i %s' % dsEncoding)
2788N/A
2788N/A if dsBindPasswordFile:
2788N/A STAFCmdParamsList.append('-j %s' % dsBindPasswordFile)
2788N/A
2788N/A if dsControl:
2788N/A STAFCmdParamsList.append('-J %s' % dsControl)
2788N/A
2788N/A if dsKeyStorePath:
2788N/A STAFCmdParamsList.append('-K %s' % dsKeyStorePath)
2788N/A
2788N/A if dsCertNickname:
2788N/A STAFCmdParamsList.append('-N %s' % dsCertNickname)
2788N/A
2788N/A if dsDryRun:
2788N/A STAFCmdParamsList.append('-n')
2788N/A
2788N/A if dsSaslOption:
2788N/A STAFCmdParamsList.append('-o %s' % dsSaslOption)
2788N/A
2788N/A if dsInstancePort:
2788N/A STAFCmdParamsList.append('-p %s' % dsInstancePort)
2788N/A
2788N/A if dsTrustStorePath:
2788N/A STAFCmdParamsList.append('-P %s' % dsTrustStorePath)
2788N/A
2788N/A if dsUseStartTLS:
2788N/A STAFCmdParamsList.append('-q')
2788N/A
2788N/A if dsUseSASLExternal:
2788N/A STAFCmdParamsList.append('-r')
2788N/A
2788N/A if dsTrustStorePassword:
2788N/A STAFCmdParamsList.append('--trustStorePassword %s' % dsTrustStorePassword)
2788N/A
2788N/A if dsTrustStorePasswordFile:
2788N/A STAFCmdParamsList.append('-U %s' % dsTrustStorePasswordFile)
2788N/A
2788N/A if dsKeyStorePasswordFile:
2788N/A STAFCmdParamsList.append('-u %s' % dsKeyStorePasswordFile)
2788N/A
2788N/A if dsVersion:
2788N/A STAFCmdParamsList.append('--version')
2788N/A
2788N/A if dsVerbose:
2788N/A STAFCmdParamsList.append('-v')
2788N/A
2788N/A if dsLdapVersion:
2788N/A STAFCmdParamsList.append('-V %s' % dsLdapVersion)
2788N/A
2788N/A if dsKeyStorePassword:
2788N/A STAFCmdParamsList.append('-W %s' % dsKeyStorePassword)
2788N/A
2788N/A if dsTrustAll:
2788N/A STAFCmdParamsList.append('-X')
2788N/A
2788N/A if dsUseSSL:
2788N/A STAFCmdParamsList.append('-Z')
6073N/A
6073N/A if useCmpRC:
6073N/A STAFCmdParamsList.append('--useCompareResultCode')
2788N/A
2788N/A if dsDn:
2788N/A for dn in dsDn:
2788N/A STAFCmdParamsList.append('"%s"' % dn)
2788N/A
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A </script>
2788N/A
2788N/A <call function="'runCommand'" >
2788N/A { 'name' : 'LDAP Compare Script',
2788N/A 'command' : STAFCmd,
2788N/A 'arguments' : STAFCmdParams,
3194N/A 'location' : location,
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A </function>
2788N/A
2788N/A
2788N/A <function name="compareEntry">
2788N/A <function-prolog>
2788N/A This function compares the attribute and value an entry to the Directory Server
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filepath"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory server hostname or IP address
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory server port number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="Port number"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="optional">
2788N/A <function-arg-description>
2788N/A Bind DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePswd" type="optional">
2788N/A <function-arg-description>
2788N/A Bind password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="attrToBeCompared" type="required">
2788N/A <function-arg-description>
2788N/A Attribute to be compared in Directory Server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="attribute"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="entryToBeCompared" type="required">
2788N/A <function-arg-description>
2788N/A Entry to be compared in Directory Server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="extraParams" type="optional">
2788N/A <function-arg-description>
2788N/A Optional extra parameters for specific test cases
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A <sequence>
2788N/A
2788N/A <!-- Local variables -->
2788N/A <script>
2788N/A mylocation=location
2788N/A </script>
2788N/A
2788N/A <!-- Build the Command -->
2788N/A <script>
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A
2788N/A if dsPath:
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/ldapcompare%s' % (dsBinPath,fileExt)
2788N/A
2788N/A </script>
2788N/A
2788N/A <!-- Set common ldap arguments -->
2788N/A <call function="'_ldapCommonArgs'"/>
2788N/A <script>
2788N/A if extraParams:
2788N/A STAFCmdParamsList.append('%s' % extraParams)
2788N/A
2788N/A if attrToBeCompared:
2788N/A STAFCmdParamsList.append('"%s"' % attrToBeCompared)
2788N/A
2788N/A if entryToBeCompared:
2788N/A STAFCmdParamsList.append('"%s"' % entryToBeCompared)
2788N/A
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A </script>
2788N/A
2788N/A <call function="'runCommand'" >
2788N/A { 'name' : 'Compare Object',
2788N/A 'command' : STAFCmd,
2788N/A 'arguments' : STAFCmdParams,
3194N/A 'location' : location,
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A </function>
2788N/A
2788N/A
2788N/A <function name="_ldapCommonArgs">
2788N/A <function-prolog>
2788N/A This function resolves common ldap arguments
2788N/A </function-prolog>
2788N/A <function-no-args/>
2788N/A
2788N/A <script>
2788N/A if dsInstanceHost:
2788N/A STAFCmdParamsList.append('-h %s' % dsInstanceHost)
2788N/A
2788N/A if dsInstancePort:
2788N/A STAFCmdParamsList.append('-p %s' % dsInstancePort)
2788N/A
2788N/A if dsInstanceDn:
2788N/A STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)
2788N/A
2788N/A if dsInstancePswd:
2788N/A STAFCmdParamsList.append('-w "%s"' % dsInstancePswd)
2788N/A </script>
2788N/A
2788N/A </function>
2788N/A
2788N/A
2788N/A <!-- ldappasswordmodify Function With Script-->
2788N/A <function name="ldapPasswordModifyWithScript">
2788N/A <function-prolog>
2788N/A This function performs an ldappasswordmodify using the script
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsHelp" type="optional">
2788N/A <function-arg-description>
2788N/A Display this usage information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsBindPasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Bind password file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePath" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore path
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore PIN file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsKeyStorePassword" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate keystore PIN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePath" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store path
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePassword" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store PIN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustStorePasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Certificate trust store PIN file
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseStartTLS" type="optional">
2788N/A <function-arg-description>
2788N/A Use StartTLS to secure communication with the server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsUseSSL" type="optional">
2788N/A <function-arg-description>
2788N/A Use SSL for secure communication with the server
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsTrustAll" type="optional">
2788N/A <function-arg-description>
2788N/A Trust all server SSL certificates
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsAuthzID" type="optional">
2788N/A <function-arg-description>
2788N/A Specifies the authorization ID for the user entry whose password should be changed
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsProvideDNForAuthzID" type="optional">
2788N/A <function-arg-description>
2788N/A Indicates that the bind DN should be used as the authorization ID for the password modify operation
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsCurrentPassword" type="optional">
2788N/A <function-arg-description>
2788N/A Specifies the current password for the target user
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsCurrentPasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Specifies the path to a file containing the current password for the target user
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsNewPassword" type="optional">
2788N/A <function-arg-description>
2788N/A Specifies the new password for the target user
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsNewPasswordFile" type="optional">
2788N/A <function-arg-description>
2788N/A Specifies the path to a file containing the new password for the target user
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filename"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsVersion" type="optional">
2788N/A <function-arg-description>
2788N/A Display Directory Server version information
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="option"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Host Name
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
3137N/A <function-arg-def name="dsSaslOption" type="optional">
3137N/A <function-arg-description>
3137N/A SASL bind options
3137N/A </function-arg-description>
3137N/A <function-arg-property name="type" value="string"/>
3137N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Port Number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="dn"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePswd" type="optional">
2788N/A <function-arg-description>
2788N/A Directory Server Manager Password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="integer"/>
2788N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A
2788N/A <sequence>
2788N/A
2788N/A <!-- Build the Command -->
2788N/A <script>
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A
2788N/A if dsPath:
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/ldappasswordmodify%s' % (dsBinPath,fileExt)
2788N/A
2788N/A if dsAuthzID:
2788N/A STAFCmdParamsList.append('-a "%s"' % dsAuthzID)
2788N/A
2788N/A if dsProvideDNForAuthzID:
2788N/A STAFCmdParamsList.append('-A')
2788N/A
2788N/A if dsInstanceHost:
2788N/A STAFCmdParamsList.append('-h %s' % dsInstanceHost)
2788N/A
2788N/A if dsInstanceDn:
2788N/A STAFCmdParamsList.append('-D "%s"' % dsInstanceDn)
2788N/A
2788N/A if dsInstancePswd:
2788N/A STAFCmdParamsList.append('-w %s' % dsInstancePswd)
2788N/A
2788N/A if dsCurrentPassword:
2788N/A STAFCmdParamsList.append('-c %s' % dsCurrentPassword)
2788N/A
2788N/A if dsCurrentPasswordFile:
2788N/A STAFCmdParamsList.append('-C %s' % dsCurrentPasswordFile)
2788N/A
2788N/A if dsHelp:
2788N/A STAFCmdParamsList.append('-H')
2788N/A
2788N/A if dsBindPasswordFile:
2788N/A STAFCmdParamsList.append('-j %s' % dsBindPasswordFile)
2788N/A
2788N/A if dsKeyStorePath:
2788N/A STAFCmdParamsList.append('-K %s' % dsKeyStorePath)
2788N/A
2788N/A if dsNewPassword:
2788N/A STAFCmdParamsList.append('-n %s' % dsNewPassword)
2788N/A
2788N/A if dsNewPasswordFile:
2788N/A STAFCmdParamsList.append('-N %s' % dsNewPasswordFile)
2788N/A
2788N/A if dsSaslOption:
2788N/A STAFCmdParamsList.append('-o %s' % dsSaslOption)
2788N/A
2788N/A if dsInstancePort:
2788N/A STAFCmdParamsList.append('-p %s' % dsInstancePort)
2788N/A
2788N/A if dsTrustStorePath:
2788N/A STAFCmdParamsList.append('-P %s' % dsTrustStorePath)
2788N/A
2788N/A if dsUseStartTLS:
2788N/A STAFCmdParamsList.append('-q')
2788N/A
2788N/A if dsTrustStorePassword:
2788N/A STAFCmdParamsList.append('--trustStorePassword %s' % dsTrustStorePassword)
2788N/A
2788N/A if dsTrustStorePasswordFile:
2788N/A STAFCmdParamsList.append('-U %s' % dsTrustStorePasswordFile)
2788N/A
2788N/A if dsKeyStorePasswordFile:
2788N/A STAFCmdParamsList.append('-u %s' % dsKeyStorePasswordFile)
2788N/A
2788N/A if dsVersion:
2788N/A STAFCmdParamsList.append('-V')
2788N/A
2788N/A if dsKeyStorePassword:
2788N/A STAFCmdParamsList.append('-W %s' % dsKeyStorePassword)
2788N/A
2788N/A if dsTrustAll:
2788N/A STAFCmdParamsList.append('-X')
2788N/A
2788N/A if dsUseSSL:
2788N/A STAFCmdParamsList.append('-Z')
2788N/A
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A </script>
2788N/A
2788N/A <call function="'runCommand'" >
2788N/A { 'name' : 'LDAP Password Modify Script',
2788N/A 'command' : STAFCmd,
2788N/A 'arguments' : STAFCmdParams,
3194N/A 'location' : location,
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A </function>
2788N/A
2788N/A
2788N/A <!-- Modify an attribute -->
2788N/A <function name="modifyAnAttribute">
2788N/A <function-prolog>
2788N/A This function modifies an entry in the Directory Server
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filepath"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Directory server hostname or IP address
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="dsInstancePort" type="required">
2788N/A <function-arg-description>
2788N/A Directory server port number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="Port number"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="dsInstanceDn" type="required">
2788N/A <function-arg-description>
2788N/A Bind DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="dsInstancePswd" type="required">
2788N/A <function-arg-description>
2788N/A Bind password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="DNToModify" type="required">
2788N/A <function-arg-description>
2788N/A DN to modify
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="attributeName" type="optional">
2788N/A <function-arg-description>
2788N/A Attribute to modify
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="newAttributeValue" type="optional">
2788N/A <function-arg-description>
2788N/A New Attribute Value
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="listAttributes" type="optional" default="' '">
2788N/A <function-arg-description>
2788N/A List of attributes name and value to modify. The format is name:value
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="changetype" type="required">
2788N/A <function-arg-description>
2788N/A Type of modification, can be delete, add, replace
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="suppressTestStatus" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Supress the call to checkTestRC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
3951N/A
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A
2788N/A </function-map-args>
2788N/A <sequence>
2788N/A
2788N/A <!-- Local variables -->
2788N/A <script>
2788N/A mylocation=location
2788N/A
2788N/A
2788N/A <!-- Build the Command -->
2788N/A
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A STAFCmd=''
2788N/A </script>
2788N/A
2788N/A <!-- Set common ldap arguments -->
2788N/A <call function="'_ldapCommonArgs'"/>
2788N/A
2788N/A <if expr="listAttributes != ' '">
2788N/A <iterate var="anAttributeToModify" in="listAttributes">
2788N/A <script>
2788N/A if anAttributeToModify:
2788N/A anAttributeToModify=anAttributeToModify.replace('"','QUOT')
2788N/A STAFCmdParamsList.append('-l "%s"' % anAttributeToModify)
2788N/A </script>
2788N/A </iterate>
2788N/A </if>
2788N/A <script>
2788N/A if newAttributeValue:
2788N/A newAttributeValue=newAttributeValue.replace('"','QUOT')
2788N/A </script>
2788N/A <script>
2788N/A
2788N/A if DNToModify:
2788N/A STAFCmdParamsList.append('-d "%s"' % DNToModify)
2788N/A
2788N/A if attributeName:
2788N/A STAFCmdParamsList.append('-a "%s"' % attributeName)
2788N/A
2788N/A if newAttributeValue:
2788N/A STAFCmdParamsList.append('-v "%s"' % newAttributeValue)
2788N/A
2788N/A if changetype:
2788N/A STAFCmdParamsList.append('-t "%s"' % changetype)
2788N/A
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A
2788N/A STAFCmd='modifyAnAttribute'
2788N/A </script>
3194N/A
3194N/A <if expr="suppressTestStatus == '1'">
3194N/A <script>
3194N/A expectedRC = 'noCheck'
3194N/A </script>
3194N/A </if>
3194N/A
2788N/A <call function="'runCommand'" >
2788N/A { 'name' : 'Modify An Attribute value',
2854N/A 'command' : '%s/bin/java' % JAVA_HOME,
2788N/A 'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
2788N/A 'location' : location,
4710N/A 'envCmd' : ['CLASSPATH=%s/../%s/ldapjndi' % (dsPath,remote.reljavadir)],
4710N/A 'path' : '%s/../%s/ldapjndi' % (dsPath,remote.reljavadir),
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A
2788N/A <return>
3194N/A [RC,STAXResult]
2788N/A </return>
2788N/A </sequence>
2788N/A
2788N/A </function>
2788N/A
2788N/A <!-- Create a load on Directory with modifies -->
2788N/A <function name="loadOfModifies">
2788N/A <function-prolog>
2788N/A This function creates a load of modifies against Directory. It is only for entries with uid=user.xxx.
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A
4153N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filepath"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Directory server hostname or IP address
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="dsInstancePort" type="required">
2788N/A <function-arg-description>
2788N/A Directory server port number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="Port number"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="dsInstanceDn" type="required">
2788N/A <function-arg-description>
2788N/A Bind DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="dsInstancePswd" type="required">
2788N/A <function-arg-description>
2788N/A Bind password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="partialDNToModify" type="required">
2788N/A <function-arg-description>
2788N/A partial DN to modify, all but the uid=user.xxxx
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="attributeName" type="optional">
2788N/A <function-arg-description>
2788N/A Attribute to modify
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="newAttributeValue" type="optional">
2788N/A <function-arg-description>
2788N/A New Attribute Value
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="listAttributes" type="optional" default="' '">
2788N/A <function-arg-description>
2788N/A List of attributes name and value to modify. The format is name:value
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="changetype" type="required">
2788N/A <function-arg-description>
2788N/A Type of modification, can be delete, add, replace
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="numEntries" type="required">
2788N/A <function-arg-description>
2788N/A Number of entries to modify
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="clientID" type="optional">
2788N/A <function-arg-description>
2788N/A ID for the client doing the modify
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
2788N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A
2788N/A </function-map-args>
2788N/A <sequence>
2788N/A
2788N/A <script>
2788N/A import random
2788N/A curr_rdn_num=random.randint(0,99)
2788N/A curr_dn="uid=user.%s,%s" % (curr_rdn_num, partialDNToModify)
2788N/A </script>
2788N/A
2788N/A <message>
2788N/A '****From client, %s, Modifying %s' % (clientID,curr_dn)
2788N/A </message>
2788N/A
2788N/A <call function="'modifyAnAttribute'">
2788N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST ,
2788N/A 'dsInstancePort' : DIRECTORY_INSTANCE_PORT ,
2788N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN ,
2788N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD ,
2808N/A 'dsPath' : dsPath ,
2788N/A 'DNToModify' : curr_dn ,
2788N/A 'attributeName' : 'description' ,
2788N/A 'newAttributeValue' : 'New description for %s' % curr_dn ,
2788N/A 'changetype' : 'replace' ,
2788N/A 'suppressTestStatus' : '1' }
2788N/A </call>
2788N/A
2788N/A <return>
2788N/A [STAXCode,STAXReason]
2788N/A </return>
2788N/A
2788N/A </sequence>
2788N/A
2788N/A </function>
2788N/A
2788N/A
2788N/A <!-- Add a New entry-->
2788N/A <function name="addAnEntry">
2788N/A <function-prolog>
2788N/A This function modifies an entry in the Directory Server
2788N/A </function-prolog>
2788N/A <function-map-args>
2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Location of target host
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
2788N/A <function-arg-description>
2788N/A Pathname to installation root
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="filepath"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A <function-arg-description>
2788N/A Directory server hostname or IP address
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="hostname" />
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePort" type="required">
2788N/A <function-arg-description>
2788N/A Directory server port number
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="Port number"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstanceDn" type="required">
2788N/A <function-arg-description>
2788N/A Bind DN
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="dsInstancePswd" type="required">
2788N/A <function-arg-description>
2788N/A Bind password
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="DNToAdd" type="required">
2788N/A <function-arg-description>
2788N/A DN to add
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="DN"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="listAttributes" type="required">
2788N/A <function-arg-description>
2788N/A Attributes to add
2788N/A </function-arg-description>
2788N/A <function-arg-property name="type" value="string"/>
2788N/A </function-arg-def>
2788N/A <function-arg-def name="expectedRC" type="optional" default="0">
2788N/A <function-arg-description>
3194N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </function-arg-description>
2788N/A </function-arg-def>
3951N/A <function-arg-def name="knownIssue" type="optional" default="None">
3951N/A <function-arg-description>
3951N/A Known issue. Corresponds to an issue number.
3951N/A </function-arg-description>
3951N/A </function-arg-def>
2788N/A </function-map-args>
2788N/A <sequence>
2788N/A <!-- Local variables -->
2788N/A <script>
2788N/A mylocation=location
2788N/A
2788N/A # build the command
2788N/A STAFCmdParamsList=[]
2788N/A STAFCmdParams=''
2788N/A STAFCmd=''
2788N/A </script>
2788N/A <!-- Set common ldap arguments -->
2788N/A <call function="'_ldapCommonArgs'"/>
2788N/A
2788N/A <iterate var="anAttributeToAdd" in="listAttributes">
2788N/A <script>
5374N/A anAttributeToAdd=anAttributeToAdd.replace('"','QUOT')
2788N/A STAFCmdParamsList.append('-v "%s"' % anAttributeToAdd)
2788N/A </script>
2788N/A </iterate>
2788N/A <script>
2788N/A if DNToAdd:
2788N/A STAFCmdParamsList.append('-d "%s"' % DNToAdd)
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A STAFCmd='addAnEntry'
2788N/A </script>
2788N/A <call function="'runCommand'" >
2788N/A { 'name' : 'Add New Entry',
2854N/A 'command' : '%s/bin/java' % JAVA_HOME,
2788N/A 'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
2788N/A 'location' : location,
4710N/A 'envCmd' : ['CLASSPATH=%s/../%s/ldapjndi' % (dsPath,remote.reljavadir)],
4710N/A 'path' : '%s/../%s/ldapjndi' % (dsPath,remote.reljavadir),
3951N/A 'expectedRC': expectedRC,
3951N/A 'knownIssue': knownIssue
2788N/A }
2788N/A </call>
2788N/A <return>
3194N/A STAXResult
2788N/A </return>
2788N/A </sequence>
2788N/A </function>
2788N/A
4724N/A
4724N/A <!-- Rename an entry -->
4724N/A <function name="modifyDn">
4724N/A <function-prolog>
4724N/A This function renames an entry, either by a modRDN or by a modDN
4724N/A </function-prolog>
4724N/A <function-map-args>
4724N/A <function-arg-def name="location"
4724N/A type="optional"
4724N/A default="STAF_REMOTE_HOSTNAME">
4724N/A <function-arg-description>
4724N/A Location of target host
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="hostname"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsPath"
4724N/A type="optional"
4724N/A default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
4724N/A <function-arg-description>
4724N/A Pathname to installation root
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="filepath"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsInstanceHost"
4724N/A type="optional"
4724N/A default="STAF_REMOTE_HOSTNAME">
4724N/A <function-arg-description>
4724N/A Directory server hostname or IP address
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="hostname"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsInstancePort" type="required">
4724N/A <function-arg-description>
4724N/A Directory server port number
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="Port number"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsInstanceDn" type="required">
4724N/A <function-arg-description>
4724N/A Bind DN
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="DN"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsInstancePswd" type="required">
4724N/A <function-arg-description>
4724N/A Bind password
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="string"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="DNToModify" type="required">
4724N/A <function-arg-description>
4724N/A DN to modify
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="DN"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="newRDN"
4724N/A type="optional"
4724N/A default="None">
4724N/A <function-arg-description>
4724N/A New rdn name : ie uid=jdoe_bis. If not passed, the newRDN will be the
4724N/A same old rdn
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="string"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="deleteOldRDN"
4724N/A type="optional"
4724N/A default="None">
4724N/A <function-arg-description>
4724N/A 1 : delete old rdn, 0 do not delete old rdn, default value is 1
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="integer"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="newSuperior"
4724N/A type="optional"
4724N/A default="None">
4724N/A <function-arg-description>
4724N/A New parent entry for the entry
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="DN"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="expectedRC" type="optional" default="0">
4724N/A <function-arg-description>
4724N/A Expected return code value. Default value is 0
4724N/A Wildcard 'noCheck' to not check the RC
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="integer"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="knownIssue" type="optional" default="None">
4724N/A <function-arg-description>
4724N/A Known issue. Corresponds to an issue number.
4724N/A </function-arg-description>
4724N/A </function-arg-def>
4724N/A </function-map-args>
4724N/A <sequence>
4724N/A
4724N/A <!-- Local variables -->
4724N/A <script>
4724N/A mylocation=location
4724N/A #Build the Command
4724N/A STAFCmdParamsList=[]
4724N/A STAFCmdParams=''
4724N/A STAFCmd=''
4724N/A </script>
4724N/A
4724N/A <!-- Set common ldap arguments -->
4724N/A <call function="'_ldapCommonArgs'" />
4724N/A <script>
4724N/A if DNToModify:
4724N/A STAFCmdParamsList.append('-d "%s"' % DNToModify)
4724N/A
4724N/A if newRDN:
4724N/A STAFCmdParamsList.append('-e "%s"' % newRDN)
4724N/A
4724N/A if deleteOldRDN == 0:
4724N/A STAFCmdParamsList.append('-f "false"')
4724N/A elif deleteOldRDN == 1:
4724N/A STAFCmdParamsList.append('-f "true"')
4724N/A
4724N/A if newSuperior:
4724N/A STAFCmdParamsList.append('-g "%s"' % newSuperior)
4724N/A
4724N/A STAFCmdParams=' '.join(STAFCmdParamsList)
4724N/A
4724N/A STAFCmd='modifyDn'
4724N/A </script>
4724N/A <call function="'runCommand'" >
4724N/A { 'name' : 'Modify DN',
4724N/A 'command' : '%s/bin/java' % JAVA_HOME,
4724N/A 'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
4724N/A 'location' : location,
4724N/A 'envCmd' : ['CLASSPATH=%s/../%s/ldapjndi' % (dsPath,remote.reljavadir)],
4724N/A 'path' : '%s/../%s/ldapjndi' % (dsPath,remote.reljavadir),
4724N/A 'expectedRC': expectedRC,
4724N/A 'knownIssue': knownIssue
4724N/A }
4724N/A </call>
4724N/A <return>
4724N/A STAXResult
4724N/A </return>
4724N/A </sequence>
4724N/A </function>
4724N/A
4724N/A
4724N/A
5047N/A <!-- Do an ldapsearch using SASL authentication -->
4035N/A <function name="saslSearch">
4035N/A <function-prolog>
4035N/A This function searches the Directory Server using SASL authentication
4035N/A </function-prolog>
4035N/A <function-map-args>
4035N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
4035N/A <function-arg-description>
4035N/A Location of target host
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="hostname"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
4035N/A <function-arg-description>
4035N/A Pathname to installation root
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="filepath"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
4035N/A <function-arg-description>
4035N/A Directory server hostname or IP address
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="hostname"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="dsInstancePort" type="required">
4035N/A <function-arg-description>
4035N/A Directory server port number
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="Port number"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="dsScope" type="optional">
4035N/A <function-arg-description>
4035N/A Search scope
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="string"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="dsBaseDN" type="required">
4035N/A <function-arg-description>
4035N/A Search base dn
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="DN"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="dsFilter" type="required">
4035N/A <function-arg-description>
4035N/A Search filter
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="string"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="mechanism" type="required">
4035N/A <function-arg-description>
4035N/A SASL mechanism
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="string"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="authenticationId" type="required">
4035N/A <function-arg-description>
4035N/A Authentication ID
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="DN"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="password" type="required">
4035N/A <function-arg-description>
4035N/A Authentication password
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="string"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="authorizationId" type="optional">
4035N/A <function-arg-description>
4035N/A Authorization ID
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="DN"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="realm" type="optional">
4035N/A <function-arg-description>
4035N/A Attribute to modify
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="string"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="protection" type="optional">
4035N/A <function-arg-description>
4035N/A Quality of protection (auth / auth-int / auth-conf)
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="string"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="strength" type="optional">
4035N/A <function-arg-description>
4035N/A Cipher strength (low / medium / high)
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="string"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="maxbuffersize" type="optional">
4035N/A <function-arg-description>
4035N/A Maximum receive buffer size.
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="string"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="suppressTestStatus" type="optional" default="0">
4035N/A <function-arg-description>
4035N/A Supress the call to checkTestRC
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="string"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="expectedRC" type="optional" default="0">
4035N/A <function-arg-description>
4035N/A Expected return code value. Default value is 0
4035N/A Wildcard 'noCheck' to not check the RC
4035N/A </function-arg-description>
4035N/A <function-arg-property name="type" value="string"/>
4035N/A </function-arg-def>
4035N/A
4035N/A <function-arg-def name="knownIssue" type="optional" default="None">
4035N/A <function-arg-description>
4035N/A Known issue. Corresponds to an issue number.
4035N/A </function-arg-description>
4035N/A </function-arg-def>
4035N/A
4035N/A </function-map-args>
4035N/A <sequence>
4035N/A
4035N/A <!-- Local variables -->
4035N/A <script>
4035N/A mylocation=location
4035N/A
4035N/A
4035N/A <!-- Build the Command -->
4035N/A
4035N/A STAFCmdParamsList=[]
4035N/A STAFCmdParams=''
4035N/A STAFCmd=''
4035N/A </script>
4035N/A
4035N/A <!-- Set common ldap arguments -->
4035N/A <call function="'_ldapCommonArgs'"/>
4035N/A
4035N/A <script>
4035N/A if dsScope:
4035N/A STAFCmdParamsList.append('-s "%s"' % dsScope)
4035N/A
4035N/A if dsBaseDN:
4035N/A STAFCmdParamsList.append('-b "%s"' % dsBaseDN)
4035N/A
4035N/A if dsFilter:
4035N/A STAFCmdParamsList.append('-f "%s"' % dsFilter)
4035N/A
4035N/A if mechanism:
4035N/A STAFCmdParamsList.append('--mech "%s"' % mechanism)
4035N/A
4035N/A if authenticationId:
4035N/A STAFCmdParamsList.append('--authid "%s"' % authenticationId)
4035N/A
4035N/A if password:
4035N/A STAFCmdParamsList.append('-w "%s"' % password)
4035N/A
4035N/A if authorizationId:
4035N/A STAFCmdParamsList.append('--authorizationId "%s"' % authorizationId)
4035N/A
4035N/A if realm:
4035N/A STAFCmdParamsList.append('--realm "%s"' % realm)
4035N/A
4035N/A if protection:
4035N/A STAFCmdParamsList.append('--qop "%s"' % protection)
4035N/A
4035N/A if strength:
4035N/A STAFCmdParamsList.append('--strength "%s"' % strength)
4035N/A
4035N/A if maxbuffersize:
4087N/A STAFCmdParamsList.append('--maxbufsize "%s"' % maxbuffersize)
4035N/A
4035N/A
4035N/A STAFCmdParams=' '.join(STAFCmdParamsList)
4035N/A
4035N/A STAFCmd='saslSearchClient'
4035N/A </script>
4035N/A
4035N/A <if expr="suppressTestStatus == '1'">
4035N/A <script>
4035N/A expectedRC = 'noCheck'
4035N/A </script>
4035N/A </if>
4035N/A
4035N/A <call function="'runCommand'" >
4035N/A { 'name' : 'Modify An Attribute value',
4035N/A 'command' : '%s/bin/java' % JAVA_HOME,
4035N/A 'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
4035N/A 'location' : location,
4710N/A 'envCmd' : ['CLASSPATH=%s/../%s/ldapjndi' % (dsPath,remote.reljavadir)],
4710N/A 'path' : '%s/../%s/ldapjndi' % (dsPath,remote.reljavadir),
4035N/A 'expectedRC': expectedRC,
4035N/A 'knownIssue': knownIssue
4035N/A }
4035N/A </call>
4035N/A
4035N/A <return>
4056N/A STAXResult
4035N/A </return>
4035N/A </sequence>
4035N/A
4035N/A </function>
4724N/A
4724N/A
4724N/A
4724N/A <function name="SearchExternalChangelog">
4724N/A <function-prolog>
4724N/A This function searches the external changelog
4724N/A </function-prolog>
4724N/A <function-map-args>
4724N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
4724N/A <function-arg-description>
4724N/A Location of target host
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="hostname"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
4724N/A <function-arg-description>
4724N/A Pathname to installation root
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="pathname"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsInstanceHost" type="optional">
4724N/A <function-arg-description>
4724N/A Directory Server Host Name
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="hostname"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsInstancePort" type="optional">
4724N/A <function-arg-description>
4724N/A Directory Server Port Number
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="integer"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsInstanceDn" type="optional">
4724N/A <function-arg-description>
4724N/A Directory Server Manager DN
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="dn"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsInstancePswd" type="optional">
4724N/A <function-arg-description>
4724N/A Directory Server Manager Password
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="string"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsScope" type="optional">
4724N/A <function-arg-description>
4724N/A The scope of the search operation
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="dn"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsBaseDN" type="optional">
4724N/A <function-arg-description>
4724N/A The baseDN for the search operation
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="dn"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="dsFilter" type="required">
4724N/A <function-arg-description>
4724N/A The filter for the search operation
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="filter"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="extraParams" type="optional">
4724N/A <function-arg-description>
4724N/A Optional extra parameters for specific test cases
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="string"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="attributes" type="optional">
4724N/A <function-arg-description>
4724N/A Optional Attributes to return
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="attributes"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="changelogCookie"
4724N/A type="optional"
4724N/A default="None">
4724N/A <function-arg-description>
4724N/A Changelog cookie of the last change retrieved.
4724N/A (OpenDS external changelog => non draft-compatible mode)
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="string"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="changeNumberFilter"
4724N/A type="optional"
4724N/A default="None">
4724N/A <function-arg-description>
4724N/A Changenumber corresponding to the last change retrieved.
4724N/A (Changelog draft-compatible mode)
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="filter"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="expectedRC" type="optional" default="0">
4724N/A <function-arg-description>
4724N/A Expected return code value. Default value is 0.
4724N/A Wildcard 'noCheck' to not check the RC
4724N/A </function-arg-description>
4724N/A <function-arg-property name="type" value="integer"/>
4724N/A </function-arg-def>
4724N/A <function-arg-def name="knownIssue" type="optional" default="None">
4724N/A <function-arg-description>
4724N/A Known issue. Corresponds to an issue number.
4724N/A </function-arg-description>
4724N/A </function-arg-def>
4724N/A </function-map-args>
4724N/A <sequence>
4724N/A
4724N/A <!-- Local variables -->
4724N/A <script>
4724N/A mylocation=location
4724N/A </script>
4724N/A
4724N/A <!-- Build the Command -->
4724N/A <script>
4724N/A STAFCmdParamsList=[]
4724N/A STAFCmdParams=''
4724N/A
4724N/A if dsPath:
4724N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
4724N/A STAFCmd='%s/ldapsearch%s' % (dsBinPath,fileExt)
4724N/A
4724N/A </script>
4724N/A
4724N/A <!-- Set common ldap arguments -->
4724N/A <call function="'_ldapCommonArgs'"/>
4724N/A
4724N/A <script>
4724N/A if changelogCookie:
4724N/A control = '1.3.6.1.4.1.26027.1.5.4:false:%s' % changelogCookie
4724N/A STAFCmdParamsList.append('--control "%s"' % control)
4724N/A
4724N/A if dsScope:
4724N/A STAFCmdParamsList.append('-s %s' % dsScope)
4724N/A
4724N/A if extraParams:
4724N/A STAFCmdParamsList.append('%s' % extraParams)
4724N/A
4724N/A if dsBaseDN:
4724N/A STAFCmdParamsList.append('-b "%s"' % dsBaseDN)
4724N/A
4724N/A if dsFilter:
4724N/A if changeNumberFilter:
4724N/A searchFilter = '&amp;%s%s' % (changeNumberFilter, dsFilter)
4724N/A else:
4724N/A searchFilter = dsFilter
4724N/A STAFCmdParamsList.append('"%s"' % searchFilter)
4724N/A else:
4724N/A if changeNumberFilter:
4724N/A STAFCmdParamsList.append('"%s"' % changeNumberFilter)
4724N/A
4724N/A if attributes:
4724N/A STAFCmdParamsList.append('%s' % attributes)
4724N/A else:
5442N/A STAFCmdParamsList.append('"*" +')
4724N/A
4724N/A STAFCmdParams=' '.join(STAFCmdParamsList)
4724N/A </script>
4724N/A
4724N/A <message>
4724N/A '%s %s' % (STAFCmd, STAFCmdParams)
4724N/A </message>
4724N/A
5159N/A <!-- Give the changes time to propagate in the ECL -->
5159N/A <script>
5159N/A myCounter = 1
5159N/A taskRC = 1
5159N/A noOfLoops = 10
5159N/A </script>
5159N/A <loop from="1" to="noOfLoops" while="taskRC != 0">
5159N/A <sequence>
5159N/A
5159N/A <message>
5159N/A 'LOOP number %s - %s %s' % (myCounter, STAFCmd, STAFCmdParams)
5159N/A </message>
5159N/A
5159N/A <call function="'runCommand'">
5159N/A { 'command' : STAFCmd,
5159N/A 'arguments' : STAFCmdParams,
5159N/A 'location' : location,
5159N/A 'name' : 'ldapsearch',
5159N/A 'expectedRC': expectedRC,
5159N/A 'knownIssue': knownIssue
5159N/A }
5159N/A </call>
5159N/A <script>
5159N/A STAFCmdRC = RC
5159N/A STAFCmdResult = STAXResult
5159N/A myCounter = myCounter + 1
5159N/A </script>
5159N/A
5159N/A <if expr='STAFCmdResult[0][1] != None and len(STAFCmdResult[0][1].strip()) > 0'>
5159N/A <sequence>
5159N/A <script>taskRC = 0</script>
5159N/A <return>STAFCmdResult</return>
5159N/A </sequence>
5159N/A </if>
5159N/A </sequence>
5159N/A </loop>
5159N/A
4724N/A <return>
4724N/A STAXResult
4724N/A </return>
4724N/A </sequence>
4724N/A
4724N/A </function>
4035N/A
5047N/A
5047N/A
5047N/A <!-- Read ECL and replay changes on stand-alone server -->
5047N/A <function name="eclReadAndPlay">
5047N/A <function-prolog>
5047N/A This function reads the ECL in a replicated server and replays the changes
5047N/A on a stand-alone server
5047N/A </function-prolog>
5047N/A <function-map-args>
5047N/A <function-arg-def name="location"
5047N/A type="optional"
5047N/A default="STAF_REMOTE_HOSTNAME">
5047N/A <function-arg-description>
5047N/A Location of target host
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="hostname"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="dsPath"
5047N/A type="optional"
5047N/A default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
5047N/A <function-arg-description>
5047N/A Pathname to installation root
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="filepath"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="standaloneHost"
5047N/A type="optional"
5047N/A default="STAF_REMOTE_HOSTNAME">
5047N/A <function-arg-description>
5047N/A Stand-alone directory server hostname or IP address
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="hostname"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="standalonePort" type="required">
5047N/A <function-arg-description>
5047N/A Stand-alone directory server port number
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="Port number"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="replicaHost1" type="required">
5047N/A <function-arg-description>
5047N/A Replicated Directory server hostname or IP address
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="hostname"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="replicaPort1" type="required">
5047N/A <function-arg-description>
5047N/A Replicated Directory server port number
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="Port number"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="replicaHost2" type="required">
5047N/A <function-arg-description>
5047N/A Replicated Directory server hostname or IP address
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="hostname"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="replicaPort2" type="required">
5047N/A <function-arg-description>
5047N/A Replicated Directory server port number
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="Port number"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="bindDn" type="required">
5047N/A <function-arg-description>
5047N/A Bind DN
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="DN"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="bindPswd" type="required">
5047N/A <function-arg-description>
5047N/A Bind password
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="string"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="eclMode" type="required">
5047N/A <function-arg-description>
5047N/A ECL search mode: "draft" or "opends"
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="string"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="queueSize"
5047N/A type="optional"
5047N/A default="1000">
5047N/A <function-arg-description>
5047N/A Size of the queue where the read updates are stored for the writer to
5047N/A replay on the stand-alone server
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="integer"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="displayMissingChanges"
5047N/A type="optional"
5047N/A default="False">
5047N/A <function-arg-description>
5047N/A Whether information on missing changes should be displayed or not
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="boolean"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="outputFilename" type="required">
5047N/A <function-arg-description>
5047N/A Standard output file name
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="filepath"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="expectedRC" type="optional" default="0">
5047N/A <function-arg-description>
5047N/A Expected return code value. Default value is 0
5047N/A Wildcard 'noCheck' to not check the RC
5047N/A </function-arg-description>
5047N/A <function-arg-property name="type" value="integer"/>
5047N/A </function-arg-def>
5047N/A <function-arg-def name="knownIssue" type="optional" default="None">
5047N/A <function-arg-description>
5047N/A Known issue. Corresponds to an issue number.
5047N/A </function-arg-description>
5047N/A </function-arg-def>
5047N/A </function-map-args>
5047N/A <sequence>
5047N/A
5047N/A <!-- Local variables -->
5047N/A <script>
5047N/A mylocation=location
5047N/A #Build the Command
5047N/A STAFCmdParamsList=[]
5047N/A STAFCmdParams=''
5047N/A STAFCmd='EclReadAndPlay'
5047N/A </script>
5047N/A
5047N/A <!-- Set common ldap arguments -->
5047N/A <script>
5047N/A STAFCmdParamsList.append('-m %s' % eclMode)
5047N/A STAFCmdParamsList.append('-q %s' % queueSize)
5047N/A STAFCmdParamsList.append('-D "%s"' % bindDn)
5047N/A STAFCmdParamsList.append('-w "%s"' % bindPswd)
5047N/A STAFCmdParamsList.append('-s %s:%s' % (standaloneHost, standalonePort))
5047N/A STAFCmdParamsList.append('-p %s:%s' % (replicaHost1, replicaPort1))
5047N/A STAFCmdParamsList.append('-p %s:%s' % (replicaHost2, replicaPort2))
5047N/A STAFCmdParamsList.append('-o %s' % outputFilename)
5047N/A
5047N/A if (displayMissingChanges == True):
5047N/A displayMC = 'true'
5047N/A else:
5047N/A displayMC = 'false'
5047N/A STAFCmdParamsList.append('-x %s' % displayMC)
5047N/A
5047N/A STAFCmdParams=' '.join(STAFCmdParamsList)
5047N/A
5047N/A STAFCmd='EclReadAndPlay'
5047N/A </script>
5047N/A <call function="'runCommand'" >
5047N/A { 'name' : 'Read ECL and replay',
5047N/A 'command' : '%s/bin/java' % JAVA_HOME,
5047N/A 'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
5047N/A 'location' : location,
5047N/A 'envCmd' : ['CLASSPATH=%s/../%s/ldapjdk:%s/../%s/ldapjdk/ldapjdk.jar' \
5047N/A % (dsPath,remote.reljavadir,dsPath,remote.reljavadir)],
5047N/A 'path' : '%s/../%s/ldapjdk' % (dsPath,remote.reljavadir),
5047N/A 'expectedRC': expectedRC,
5047N/A 'knownIssue': knownIssue
5047N/A }
5047N/A </call>
5047N/A <return>
5047N/A STAXResult
5047N/A </return>
5047N/A </sequence>
5047N/A </function>
2788N/A</stax>