10139N/A<?
xml version="1.0" encoding="UTF-8" standalone="no"?>
10139N/A ! The contents of this file are subject to the terms of the 10139N/A ! Common Development and Distribution License, Version 1.0 only 10139N/A ! (the "License"). You may not use this file except in compliance 15322N/A ! You can obtain a copy of the license at 10139N/A ! See the License for the specific language governing permissions 10139N/A ! and limitations under the License. 10139N/A ! When distributing Covered Code, include this CDDL HEADER in each 16215N/A ! file and include the License file at 12773N/A ! add the following below this CDDL HEADER, with the fields enclosed 12773N/A ! by brackets "[]" replaced with your own identifying information: 12204N/A ! Portions Copyright [yyyy] [name of copyright owner] 10139N/A ! Copyright 2007-2008 Sun Microsystems, Inc. 10139N/A This function adds an entry to the Directory Server from an ldif file
10139N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
10139N/A <
function-
arg-
property name="type" value="hostname"/>
10139N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
10139N/A <
function-
arg-
property name="type" value="filepath"/>
10139N/A <
function-
arg-
def name="dsInstanceHost" type="optional">
10139N/A Directory server hostname or IP address
10139N/A <
function-
arg-
property name="type" value="hostname"/>
10139N/A <
function-
arg-
def name="dsInstancePort" type="optional">
10139N/A <
function-
arg-
property name="type" value="Port number"/>
10139N/A <
function-
arg-
def name="dsInstanceDn" type="optional">
10139N/A <
function-
arg-
property name="type" value="DN"/>
16129N/A <
function-
arg-
def name="dsInstancePswd" type="optional">
10139N/A <
function-
arg-
property name="type" value="string"/>
10139N/A <
function-
arg-
def name="entryToBeAdded" type="required">
10139N/A Entry to be added to Directory Server in ldif format
12773N/A <
function-
arg-
property name="type" value="DN"/>
12773N/A <
function-
arg-
def name="extraParams" type="optional">
12773N/A Optional extra parameters for specific test cases
10139N/A <
function-
arg-
property name="type" value="string"/>
10139N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
10139N/A Expected return code value. Default value is 0
10139N/A Wildcard 'noCheck' to not check the RC
12173N/A <
function-
arg-
property name="type" value="integer"/>
10139N/A <
function-
arg-
def name="verbose" type="optional" default="True">
10139N/A <
function-
arg-
property name="type" value="integer"/>
10139N/A <
function-
arg-
def name="knownIssue" type="optional" default="None">
10807N/A Known issue. Corresponds to an issue number.
10139N/A <
function-
arg-
property name="type" value="string" />
10139N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
10139N/A <!-- Set common ldap arguments --> 10139N/A <
call function="'_ldapCommonArgs'" />
10139N/A STAFCmdParams=' '.join(STAFCmdParamsList)
16129N/A 'name' : 'Add Entry From LDIF',
12310N/A <!-- ldapmodify Function With Script--> 12315N/A <
function name="ldapModifyWithScript">
12205N/A This function performs an ldapmodify using the script
12173N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
12052N/A <
function-
arg-
property name="type" value="hostname"/>
11903N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
11074N/A <
function-
arg-
property name="type" value="hostname"/>
10889N/A <
function-
arg-
def name="dsAdd" type="optional">
10690N/A <
function-
arg-
property name="type" value="option"/>
10686N/A <
function-
arg-
def name="dsAssertionFilter" type="optional">
10514N/A Use the LDAP assertion control with the provided filter
10391N/A <
function-
arg-
property name="type" value="filter"/>
10349N/A <
function-
arg-
def name="dsContinueOnError" type="optional">
10322N/A Continue processing even if there are errors
10273N/A <
function-
arg-
property name="type" value="option"/>
10139N/A <
function-
arg-
def name="dsReportAuthzID" type="optional">
10139N/A Use the authorization identity control
10139N/A <
function-
arg-
property name="type" value="option"/>
10139N/A <
function-
arg-
def name="dsFilename" type="optional">
10139N/A Specifies the LDIF file containing the changes to apply
10139N/A <
function-
arg-
property name="type" value="filename"/>
10139N/A <
function-
arg-
def name="dsHelp" type="optional">
10139N/A <
function-
arg-
property name="type" value="option"/>
10139N/A <
function-
arg-
def name="dsEncoding" type="optional">
10139N/A Use the specified character set for command-line input
10139N/A <
function-
arg-
property name="type" value="string"/>
10139N/A <
function-
arg-
def name="dsBindPasswordFile" type="optional">
10139N/A <
function-
arg-
property name="type" value="filename"/>
10139N/A <
function-
arg-
def name="dsControl" type="optional">
10139N/A Use a request control with the provided information
10139N/A <
function-
arg-
property name="type" value="string"/>
10139N/A <
function-
arg-
def name="dsKeyStorePath" type="optional">
<
function-
arg-
description>
Certificate keystore path
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsKeyStorePasswordFile" type="optional">
<
function-
arg-
description>
Certificate keystore PIN file
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsKeyStorePassword" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsDryRun" type="optional">
<
function-
arg-
description>
Show what would be done but do not perform any operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsSaslOption" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTrustStorePath" type="optional">
<
function-
arg-
description>
Certificate trust store path
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsTrustStorePassword" type="optional">
<
function-
arg-
description>
Certificate trust store PIN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTrustStorePasswordFile" type="optional">
<
function-
arg-
description>
Certificate trust store PIN file
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsUseStartTLS" type="optional">
<
function-
arg-
description>
Use StartTLS to secure communication with the server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsUseSASLExternal" type="optional">
<
function-
arg-
description>
Use the SASL EXTERNAL authentication mechanism
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsUseSSL" type="optional">
<
function-
arg-
description>
Use SSL for secure communication with the server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsTrustAll" type="optional">
<
function-
arg-
description>
Trust all server SSL certificates
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsVersion" type="optional">
<
function-
arg-
description>
Display Directory Server version information
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsCertNickname" type="optional">
<
function-
arg-
description>
Nickname of certificate for SSL client authentication
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsProxyAs" type="optional">
<
function-
arg-
description>
Use the proxied authorization control with the given authorization ID
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsPreReadAttributes" type="optional">
<
function-
arg-
description>
Use the LDAP ReadEntry pre-read control
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsPostReadAttributes" type="optional">
<
function-
arg-
description>
Use the LDAP ReadEntry post-read control
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsLdapVersion" type="optional">
<
function-
arg-
description>
LDAP protocol version number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsVerbose" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsInstanceHost" type="optional">
<
function-
arg-
description>
Directory Server Host Name
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="optional">
<
function-
arg-
description>
Directory Server Port Number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsInstanceDn" type="optional">
<
function-
arg-
description>
Directory Server Manager DN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsInstancePswd" type="optional">
<
function-
arg-
description>
Directory Server Manager Password
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Build the Command --> dsBinPath='%s/%s' % (dsPath,fileFolder)
if dsTrustStorePasswordFile:
if dsKeyStorePasswordFile:
for attribute in dsPreReadAttributes:
for attribute in dsPostReadAttributes:
STAFCmdParams=' '.join(STAFCmdParamsList)
'%s %s' % (STAFCmd, STAFCmdParams)
<
call function="'runCommand'">
{ 'name' : 'LDAP Modify Script',
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
<
function name="modifyEntry">
This function modifies an entry in the Directory Server
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath"/>
<
function-
arg-
def name="dsInstanceHost" type="optional">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="optional">
<
function-
arg-
description>
Directory server port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number"/>
<
function-
arg-
def name="dsInstanceDn" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="dsInstancePswd" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="entryToBeModified" type="required">
<
function-
arg-
description>
Entry to be modified in the Directory Server in ldif format
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="extraParams" type="optional">
<
function-
arg-
description>
Optional extra parameters for specific test cases
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Build the Command --> dsBinPath='%s/%s' % (dsPath,fileFolder)
<!-- Set common ldap arguments --> <
call function="'_ldapCommonArgs'"/>
STAFCmdParams=' '.join(STAFCmdParamsList)
'%s %s' % (STAFCmd, STAFCmdParams)
<
call function="'runCommand'">
'arguments' : STAFCmdParams,
'name' : 'Modify Entry from ldif file',
'expectedRC': expectedRC,
<!-- ldapsearch Function With Script--> <
function name="ldapSearchWithScript">
This function performs an ldapsearch using the script
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsDereferencePolicy" type="optional">
<
function-
arg-
description>
Specifies dereference alias policy
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTypesOnly" type="optional">
<
function-
arg-
description>
Specifies to only include attribute type names
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsAssertionFilter" type="optional">
<
function-
arg-
description>
Use the LDAP assertion control with the provided filter
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filter"/>
<
function-
arg-
def name="dsContinueOnError" type="optional">
<
function-
arg-
description>
Continue processing even if there are errors
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsPersistentSearch" type="optional">
<
function-
arg-
description>
Use the persistent search control
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsCountEntries" type="optional">
<
function-
arg-
description>
Count the number of entries returned by the server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsReportAuthzID" type="optional">
<
function-
arg-
description>
Use the authorization identity control
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsFilename" type="optional">
<
function-
arg-
description>
File containing a list of search filter strings
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsHelp" type="optional">
<
function-
arg-
description>
Display this usage information
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsEncoding" type="optional">
<
function-
arg-
description>
Use the specified character set for command-line input
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsBindPasswordFile" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsControl" type="optional">
<
function-
arg-
description>
Use a request control with the provided information
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsKeyStorePath" type="optional">
<
function-
arg-
description>
Certificate keystore path
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsKeyStorePasswordFile" type="optional">
<
function-
arg-
description>
Certificate keystore PIN file
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsKeyStorePassword" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTimeLimit" type="optional">
<
function-
arg-
description>
Maximum length of time in seconds to allow for the search
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsMatchedValuesFilter" type="optional">
<
function-
arg-
description>
Use the LDAP matched values control with the provided filter
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filter"/>
<
function-
arg-
def name="dsDryRun" type="optional">
<
function-
arg-
description>
Show what would be done but do not perform any operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsSaslOption" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTrustStorePath" type="optional">
<
function-
arg-
description>
Certificate trust store path
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsTrustStorePassword" type="optional">
<
function-
arg-
description>
Certificate trust store PIN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTrustStorePasswordFile" type="optional">
<
function-
arg-
description>
Certificate trust store PIN file
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsUseStartTLS" type="optional">
<
function-
arg-
description>
Use StartTLS to secure communication with the server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsUseSASLExternal" type="optional">
<
function-
arg-
description>
Use the SASL EXTERNAL authentication mechanism
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsUseSSL" type="optional">
<
function-
arg-
description>
Use SSL for secure communication with the server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsTrustAll" type="optional">
<
function-
arg-
description>
Trust all server SSL certificates
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsCertNickname" type="optional">
<
function-
arg-
description>
Nickname of certificate for SSL client authentication
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsProxyAs" type="optional">
<
function-
arg-
description>
Use the proxied authorization control with the given authorization ID
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsUsePasswordPolicyControl" type="optional">
<
function-
arg-
description>
Use the password policy request control
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsSimplePageSize" type="optional">
<
function-
arg-
description>
Use the simple paged results control with the given page size
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsSortOrder" type="optional">
<
function-
arg-
description>
Sort the results using the provided sort order
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsVirtualListView" type="optional">
<
function-
arg-
description>
Use the virtual list view control to retrieve the specified results page
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsGetEffectiveRightsAuthzid" type="optional">
<
function-
arg-
description>
Use geteffectiverights control with the provided authzid
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsGetEffectiveRightsAttribute" type="optional">
<
function-
arg-
description>
Specifies geteffectiverights control specific attribute list
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsVersion" type="optional">
<
function-
arg-
description>
LDAP protocol version number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsSizeLimit" type="optional">
<
function-
arg-
description>
Maximum number of entries to return from the search
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsDontWrap" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsVerbose" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsInstanceHost" type="optional">
<
function-
arg-
description>
Directory Server Host Name
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="optional">
<
function-
arg-
description>
Directory Server Port Number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsInstanceDn" type="optional">
<
function-
arg-
description>
Directory Server Manager DN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsInstancePswd" type="optional">
<
function-
arg-
description>
Directory Server Manager Password
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsScope" type="optional">
<
function-
arg-
description>
The scope of the search operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsBaseDN" type="optional">
<
function-
arg-
description>
The baseDN for the search operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="extraParams" type="optional">
<
function-
arg-
description>
Optional extra parameters for specific test cases
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsFilter" type="optional">
<
function-
arg-
description>
The filter for the search operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filter"/>
<
function-
arg-
def name="dsAttributes" type="optional">
<
function-
arg-
description>
Only return these attributes
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="outputFile" type="optional" default="'None'">
<
function-
arg-
description>
Output file containing the search result in ldif format
</
function-
arg-
description>
<
function-
arg-
property name="type" value="file"/>
<
function-
arg-
def name="outputPath" type="optional">
<
function-
arg-
description>
Path containing the outputFile
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="logStderr" type="optional" default="True">
<
function-
arg-
description>
If true, stderr for the command is redirect to stdout.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="enum">
<
function-
arg-
property-
description>
This argument can only have boolean values
</
function-
arg-
property-
description>
<
function-
arg-
property-
data type="choice" value="True"/>
<
function-
arg-
property-
data type="choice" value="False"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Build the Command --> dsBinPath='%s/%s' % (dsPath,fileFolder)
if dsGetEffectiveRightsAttribute:
for attribute in dsGetEffectiveRightsAttribute:
if dsGetEffectiveRightsAuthzid:
if dsMatchedValuesFilter:
if dsTrustStorePasswordFile:
if dsKeyStorePasswordFile:
if dsUsePasswordPolicyControl:
outputPath = '%s/..' % (dsPath)
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'" >
{ 'name' : 'LDAP Search Script',
'arguments' : STAFCmdParams,
'outputFile': '%s/%s' % (outputPath, outputFile) ,
'expectedRC': expectedRC ,
<
function name="SearchObject">
This function searches the Directory Server with optional arguments possible
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="pathname"/>
<
function-
arg-
def name="dsInstanceHost" type="optional">
<
function-
arg-
description>
Directory Server Host Name
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="optional">
<
function-
arg-
description>
Directory Server Port Number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsInstanceDn" type="optional">
<
function-
arg-
description>
Directory Server Manager DN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsInstancePswd" type="optional">
<
function-
arg-
description>
Directory Server Manager Password
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsProxyDN" type="optional">
<
function-
arg-
description>
Directory Server Proxy DN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsScope" type="optional">
<
function-
arg-
description>
The scope of the search operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsBaseDN" type="optional">
<
function-
arg-
description>
The baseDN for the search operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsFilter" type="optional">
<
function-
arg-
description>
The filter for the search operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filter"/>
<
function-
arg-
def name="extraParams" type="optional">
<
function-
arg-
description>
Optional extra parameters for specific test cases
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filter"/>
<
function-
arg-
def name="attributes" type="optional">
<
function-
arg-
description>
Optional Attributes to return
</
function-
arg-
description>
<
function-
arg-
property name="type" value="attributes"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Build the Command --> dsBinPath='%s/%s' % (dsPath,fileFolder)
<!-- Set common ldap arguments --> <
call function="'_ldapCommonArgs'"/>
STAFCmdParams=' '.join(STAFCmdParamsList)
'%s %s' % (STAFCmd, STAFCmdParams)
<
call function="'runCommand'">
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
<
function name="SearchObjectNoPwd">
This function searches the Directory Server with optional arguments possible
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="pathname"/>
<
function-
arg-
def name="dsInstanceHost" type="optional">
<
function-
arg-
description>
Directory Server Host Name
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="optional">
<
function-
arg-
description>
Directory Server Port Number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsInstanceDn" type="optional">
<
function-
arg-
description>
Directory Server Manager DN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsBaseDN" type="optional">
<
function-
arg-
description>
The baseDN for the search operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsFilter" type="optional">
<
function-
arg-
description>
The filter for the search operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filter"/>
<
function-
arg-
def name="extraParams" type="optional">
<
function-
arg-
description>
Optional extra parameters for specific test cases
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filter"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
call function="'runCommand'" >
{ 'name' : 'Search Base Object No Password',
'arguments' : '-h %s -p %s -D "%s" %s -b "%s" "%s"' % (dsInstanceHost,dsInstancePort,dsInstanceDn,extraParams,dsBaseDN,dsFilter),
'expectedRC': expectedRC,
<
function name="AnonSearchObject">
This function searches the Directory Server anonymously with optional arguments possible
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="pathname"/>
<
function-
arg-
def name="dsInstanceHost" type="optional">
<
function-
arg-
description>
Directory Server Host Name
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="optional">
<
function-
arg-
description>
Directory Server Port Number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsBaseDN" type="optional">
<
function-
arg-
description>
The baseDN for the search operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsFilter" type="optional">
<
function-
arg-
description>
The filter for the search operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filter"/>
<
function-
arg-
def name="extraParams" type="optional">
<
function-
arg-
description>
Optional extra parameters for specific test cases
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filter"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
call function="'runCommand'" >
{ 'name' : 'Anonymous Search Base Object',
'arguments' : '-h %s -p %s %s -b "%s" "%s"' % (dsInstanceHost,dsInstancePort,extraParams,dsBaseDN,dsFilter),
'expectedRC': expectedRC,
<!-- ldapdelete Function With Script--> <
function name="ldapDeleteWithScript">
This function performs an ldapdelete using the script
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsContinueOnError" type="optional">
<
function-
arg-
description>
Continue processing even if there are errors
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsFilename" type="optional">
<
function-
arg-
description>
Specifies the LDIF file containing the changes to apply
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsHelp" type="optional">
<
function-
arg-
description>
Display this usage information
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsEncoding" type="optional">
<
function-
arg-
description>
Use the specified character set for command-line input
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsBindPasswordFile" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsControl" type="optional">
<
function-
arg-
description>
Use a request control with the provided information
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsKeyStorePath" type="optional">
<
function-
arg-
description>
Certificate keystore path
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsKeyStorePasswordFile" type="optional">
<
function-
arg-
description>
Certificate keystore PIN file
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsKeyStorePassword" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsDryRun" type="optional">
<
function-
arg-
description>
Show what would be done but do not perform any operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsSaslOption" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTrustStorePath" type="optional">
<
function-
arg-
description>
Certificate trust store path
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsTrustStorePassword" type="optional">
<
function-
arg-
description>
Certificate trust store PIN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTrustStorePasswordFile" type="optional">
<
function-
arg-
description>
Certificate trust store PIN file
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsUseStartTLS" type="optional">
<
function-
arg-
description>
Use StartTLS to secure communication with the server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsUseSASLExternal" type="optional">
<
function-
arg-
description>
Use the SASL EXTERNAL authentication mechanism
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsUseSSL" type="optional">
<
function-
arg-
description>
Use SSL for secure communication with the server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsTrustAll" type="optional">
<
function-
arg-
description>
Trust all server SSL certificates
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsVersion" type="optional">
<
function-
arg-
description>
Display Directory Server version information
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsCertNickname" type="optional">
<
function-
arg-
description>
Nickname of certificate for SSL client authentication
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsLdapVersion" type="optional">
<
function-
arg-
description>
LDAP protocol version number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsVerbose" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsDeleteSubtree" type="optional">
<
function-
arg-
description>
Delete the specified entry and all entries below it
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsInstanceHost" type="optional">
<
function-
arg-
description>
Directory Server Host Name
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="optional">
<
function-
arg-
description>
Directory Server Port Number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsInstanceDn" type="optional">
<
function-
arg-
description>
Directory Server Manager DN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsInstancePswd" type="optional">
<
function-
arg-
description>
Directory Server Manager Password
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsDn" type="optional">
<
function-
arg-
description>
DNs of the entries to delete
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Build the Command --> dsBinPath='%s/%s' % (dsPath,fileFolder)
if dsTrustStorePasswordFile:
if dsKeyStorePasswordFile:
STAFCmdParams=' '.join(STAFCmdParamsList)
'%s %s' % (STAFCmd, STAFCmdParams)
<
call function="'runCommand'">
{ 'name' : 'LDAP Delete Script',
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
<
function name="DeleteEntry">
This function an entry in the Directory Server
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath"/>
<
function-
arg-
def name="dsInstanceHost" type="optional">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="optional">
<
function-
arg-
description>
Directory server port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number"/>
<
function-
arg-
def name="dsInstanceDn" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="dsInstancePswd" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsBaseDN" type="required">
<
function-
arg-
description>
Entry to be deleted in the Directory Server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="extraParams" type="optional">
<
function-
arg-
description>
Optional extra parameters for specific test cases
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Build the Command --> dsBinPath='%s/%s' % (dsPath,fileFolder)
<!-- Set common ldap arguments --> <
call function="'_ldapCommonArgs'"/>
STAFCmdParams=' '.join(STAFCmdParamsList)
'%s %s' % (STAFCmd, STAFCmdParams)
<
call function="'runCommand'">
{ 'name' : 'Delete Object',
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
<!-- ldapcompare Function With Script--> <
function name="ldapCompareWithScript">
This function performs an ldapcompare using the script
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsAssertionFilter" type="optional">
<
function-
arg-
description>
Use the LDAP assertion control with the provided filter
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filter"/>
<
function-
arg-
def name="dsContinueOnError" type="optional">
<
function-
arg-
description>
Continue processing even if there are errors
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsReportAuthzID" type="optional">
<
function-
arg-
description>
Use the authorization identity control
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsFilename" type="optional">
<
function-
arg-
description>
Specifies the LDIF file containing the changes to apply
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsHelp" type="optional">
<
function-
arg-
description>
Display this usage information
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsEncoding" type="optional">
<
function-
arg-
description>
Use the specified character set for command-line input
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsBindPasswordFile" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsControl" type="optional">
<
function-
arg-
description>
Use a request control with the provided information
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsKeyStorePath" type="optional">
<
function-
arg-
description>
Certificate keystore path
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsKeyStorePasswordFile" type="optional">
<
function-
arg-
description>
Certificate keystore PIN file
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsKeyStorePassword" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsDryRun" type="optional">
<
function-
arg-
description>
Show what would be done but do not perform any operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsSaslOption" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTrustStorePath" type="optional">
<
function-
arg-
description>
Certificate trust store path
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsTrustStorePassword" type="optional">
<
function-
arg-
description>
Certificate trust store PIN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTrustStorePasswordFile" type="optional">
<
function-
arg-
description>
Certificate trust store PIN file
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsUseStartTLS" type="optional">
<
function-
arg-
description>
Use StartTLS to secure communication with the server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsUseSASLExternal" type="optional">
<
function-
arg-
description>
Use the SASL EXTERNAL authentication mechanism
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsUseSSL" type="optional">
<
function-
arg-
description>
Use SSL for secure communication with the server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsTrustAll" type="optional">
<
function-
arg-
description>
Trust all server SSL certificates
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsVersion" type="optional">
<
function-
arg-
description>
Display Directory Server version information
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsCertNickname" type="optional">
<
function-
arg-
description>
Nickname of certificate for SSL client authentication
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsLdapVersion" type="optional">
<
function-
arg-
description>
LDAP protocol version number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsVerbose" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsInstanceHost" type="optional">
<
function-
arg-
description>
Directory Server Host Name
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="optional">
<
function-
arg-
description>
Directory Server Port Number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsInstanceDn" type="optional">
<
function-
arg-
description>
Directory Server Manager DN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsInstancePswd" type="optional">
<
function-
arg-
description>
Directory Server Manager Password
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsAttributeValue" type="optional">
<
function-
arg-
description>
Attribute:value assertion argument
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsDn" type="optional">
<
function-
arg-
description>
DNs of the entries for with to perform the compare operations
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Build the Command --> dsBinPath='%s/%s' % (dsPath,fileFolder)
if dsTrustStorePasswordFile:
if dsKeyStorePasswordFile:
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'" >
{ 'name' : 'LDAP Compare Script',
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
<
function name="compareEntry">
This function compares the attribute and value an entry to the Directory Server
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath"/>
<
function-
arg-
def name="dsInstanceHost" type="optional">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="optional">
<
function-
arg-
description>
Directory server port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number"/>
<
function-
arg-
def name="dsInstanceDn" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="dsInstancePswd" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="attrToBeCompared" type="required">
<
function-
arg-
description>
Attribute to be compared in Directory Server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="attribute"/>
<
function-
arg-
def name="entryToBeCompared" type="required">
<
function-
arg-
description>
Entry to be compared in Directory Server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="extraParams" type="optional">
<
function-
arg-
description>
Optional extra parameters for specific test cases
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Build the Command --> dsBinPath='%s/%s' % (dsPath,fileFolder)
<!-- Set common ldap arguments --> <
call function="'_ldapCommonArgs'"/>
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'" >
{ 'name' : 'Compare Object',
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
<
function name="_ldapCommonArgs">
This function resolves common ldap arguments
<!-- ldappasswordmodify Function With Script--> <
function name="ldapPasswordModifyWithScript">
This function performs an ldappasswordmodify using the script
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsHelp" type="optional">
<
function-
arg-
description>
Display this usage information
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsBindPasswordFile" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsKeyStorePath" type="optional">
<
function-
arg-
description>
Certificate keystore path
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsKeyStorePasswordFile" type="optional">
<
function-
arg-
description>
Certificate keystore PIN file
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsKeyStorePassword" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTrustStorePath" type="optional">
<
function-
arg-
description>
Certificate trust store path
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsTrustStorePassword" type="optional">
<
function-
arg-
description>
Certificate trust store PIN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsTrustStorePasswordFile" type="optional">
<
function-
arg-
description>
Certificate trust store PIN file
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsUseStartTLS" type="optional">
<
function-
arg-
description>
Use StartTLS to secure communication with the server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsUseSSL" type="optional">
<
function-
arg-
description>
Use SSL for secure communication with the server
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsTrustAll" type="optional">
<
function-
arg-
description>
Trust all server SSL certificates
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsAuthzID" type="optional">
<
function-
arg-
description>
Specifies the authorization ID for the user entry whose password should be changed
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsProvideDNForAuthzID" type="optional">
<
function-
arg-
description>
Indicates that the bind DN should be used as the authorization ID for the password modify operation
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsCurrentPassword" type="optional">
<
function-
arg-
description>
Specifies the current password for the target user
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsCurrentPasswordFile" type="optional">
<
function-
arg-
description>
Specifies the path to a file containing the current password for the target user
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsNewPassword" type="optional">
<
function-
arg-
description>
Specifies the new password for the target user
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsNewPasswordFile" type="optional">
<
function-
arg-
description>
Specifies the path to a file containing the new password for the target user
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filename"/>
<
function-
arg-
def name="dsVersion" type="optional">
<
function-
arg-
description>
Display Directory Server version information
</
function-
arg-
description>
<
function-
arg-
property name="type" value="option"/>
<
function-
arg-
def name="dsInstanceHost" type="optional">
<
function-
arg-
description>
Directory Server Host Name
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsSaslOption" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="dsInstancePort" type="optional">
<
function-
arg-
description>
Directory Server Port Number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="dsInstanceDn" type="optional">
<
function-
arg-
description>
Directory Server Manager DN
</
function-
arg-
description>
<
function-
arg-
property name="type" value="dn"/>
<
function-
arg-
def name="dsInstancePswd" type="optional">
<
function-
arg-
description>
Directory Server Manager Password
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Build the Command --> dsBinPath='%s/%s' % (dsPath,fileFolder)
if dsProvideDNForAuthzID:
if dsCurrentPasswordFile:
if dsTrustStorePasswordFile:
if dsKeyStorePasswordFile:
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'" >
{ 'name' : 'LDAP Password Modify Script',
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
<!-- Modify an attribute --> <
function name="modifyAnAttribute">
This function modifies an entry in the Directory Server
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath"/>
<
function-
arg-
def name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="required">
<
function-
arg-
description>
Directory server port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number"/>
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="DNToModify" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="attributeName" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="newAttributeValue" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="listAttributes" type="optional" default="' '">
<
function-
arg-
description>
List of attributes name and value to modify. The format is name:value
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="changetype" type="required">
<
function-
arg-
description>
Type of modification, can be delete, add, replace
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="suppressTestStatus" type="optional" default="0">
<
function-
arg-
description>
Supress the call to checkTestRC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Build the Command --> <!-- Set common ldap arguments --> <
call function="'_ldapCommonArgs'"/>
<
if expr="listAttributes != ' '">
<
iterate var="anAttributeToModify" in="listAttributes">
STAFCmdParams=' '.join(STAFCmdParamsList)
STAFCmd='modifyAnAttribute'
<
if expr="suppressTestStatus == '1'">
<
call function="'runCommand'" >
{ 'name' : 'Modify An Attribute value',
'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
'expectedRC': expectedRC,
<!-- Create a load on Directory with modifies --> <
function name="loadOfModifies">
This function creates a load of modifies against Directory. It is only for entries with uid=
user.xxx. <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath"/>
<
function-
arg-
def name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="required">
<
function-
arg-
description>
Directory server port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number"/>
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="partialDNToModify" type="required">
<
function-
arg-
description>
partial DN to modify, all but the uid=
user.xxxx </
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="attributeName" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="newAttributeValue" type="optional">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="listAttributes" type="optional" default="' '">
<
function-
arg-
description>
List of attributes name and value to modify. The format is name:value
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="changetype" type="required">
<
function-
arg-
description>
Type of modification, can be delete, add, replace
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="numEntries" type="required">
<
function-
arg-
description>
Number of entries to modify
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="clientID" type="optional">
<
function-
arg-
description>
ID for the client doing the modify
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
curr_dn="uid=user.%s,%s" % (curr_rdn_num, partialDNToModify)
'****From client, %s, Modifying %s' % (clientID,curr_dn)
<
call function="'modifyAnAttribute'">
{ 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST ,
'dsInstancePort' : DIRECTORY_INSTANCE_PORT ,
'dsInstanceDn' : DIRECTORY_INSTANCE_DN ,
'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD ,
'attributeName' : 'description' ,
'newAttributeValue' : 'New description for %s' % curr_dn ,
'changetype' : 'replace' ,
'suppressTestStatus' : '1' }
<
function name="addAnEntry">
This function modifies an entry in the Directory Server
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath"/>
<
function-
arg-
def name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstancePort" type="required">
<
function-
arg-
description>
Directory server port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number"/>
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="DNToAdd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="listAttributes" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Set common ldap arguments --> <
call function="'_ldapCommonArgs'"/>
<
iterate var="anAttributeToAdd" in="listAttributes">
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'" >
{ 'name' : 'Add New Entry',
'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
'expectedRC': expectedRC,
<!-- Modify an attribute --> <
function name="modifyDn">
This function rename the rdn
<
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath"/>
<
function-
arg-
def name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname"/>
<
function-
arg-
def name="dsInstancePort" type="required">
<
function-
arg-
description>
Directory server port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number"/>
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="DNToModify" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN"/>
<
function-
arg-
def name="newRDN" type="optional">
<
function-
arg-
description>
new rdn name : ie uid=jdoe_bis
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string"/>
<
function-
arg-
def name="deleteOldRDN" type="optional">
<
function-
arg-
description>
1 : delete old rdn, 0 do not delete old rdn, default value is 1
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="integer"/>
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<!-- Set common ldap arguments --> <
call function="'_ldapCommonArgs'" />
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'" >
'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
'expectedRC': expectedRC,