2788N/A<?
xml version="1.0" encoding="UTF-8" standalone="no"?>
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 ! You can obtain a copy of the license at 2788N/A ! See the License for the specific language governing permissions 2788N/A ! and limitations under the License. 2788N/A ! When distributing Covered Code, include this CDDL HEADER in each 2788N/A ! file and include the License file at 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] 3215N/A ! Copyright 2007-2008 Sun Microsystems, Inc. 2788N/A This function adds an entry to the Directory Server from an ldif file
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsInstanceHost" type="optional">
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 name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN"/>
2788N/A <
function-
arg-
def name="dsInstancePswd" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="entryToBeAdded" type="required">
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 name="extraParams" type="optional">
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 name="expectedRC" type="optional" default="0">
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"/>
2998N/A <
function-
arg-
def name="verbose" type="optional" default="True">
2949N/A </
function-
arg-
description>
2949N/A <
function-
arg-
property name="type" value="integer"/>
3951N/A <
function-
arg-
def name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A <!-- Set common ldap arguments --> 2788N/A <
call function="'_ldapCommonArgs'" />
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A <
call function="'runCommand'">
2949N/A 'arguments' : STAFCmdParams,
2949N/A 'name' : 'Add Entry From LDIF',
2788N/A <!-- ldapmodify Function With Script--> 2788N/A <
function name="ldapModifyWithScript">
2788N/A This function performs an ldapmodify using the script
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsAdd" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="option"/>
2788N/A <
function-
arg-
def name="dsAssertionFilter" type="optional">
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 name="dsContinueOnError" type="optional">
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 name="dsReportAuthzID" type="optional">
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 name="dsFilename" type="optional">
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 name="dsHelp" type="optional">
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 name="dsEncoding" type="optional">
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 name="dsBindPasswordFile" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="filename"/>
2788N/A <
function-
arg-
def name="dsControl" type="optional">
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 name="dsKeyStorePath" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="filename"/>
2788N/A <
function-
arg-
def name="dsKeyStorePasswordFile" type="optional">
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 name="dsKeyStorePassword" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsDryRun" type="optional">
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 name="dsSaslOption" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsTrustStorePath" type="optional">
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 name="dsTrustStorePassword" type="optional">
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 name="dsTrustStorePasswordFile" type="optional">
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 name="dsUseStartTLS" type="optional">
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 name="dsUseSASLExternal" type="optional">
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 name="dsUseSSL" type="optional">
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 name="dsTrustAll" type="optional">
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 name="dsVersion" type="optional">
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 name="dsCertNickname" type="optional">
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 name="dsProxyAs" type="optional">
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 name="dsPreReadAttributes" type="optional">
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 name="dsPostReadAttributes" type="optional">
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 name="dsLdapVersion" type="optional">
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 name="dsVerbose" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="option"/>
2788N/A <
function-
arg-
def name="dsInstanceHost" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
2788N/A <
function-
arg-
def name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
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 name="dsInstancePswd" type="optional">
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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A if dsTrustStorePasswordFile:
2788N/A for attribute in dsPreReadAttributes:
2788N/A for attribute in dsPostReadAttributes:
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'LDAP Modify Script',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <
function name="modifyEntry">
2788N/A This function modifies an entry in the Directory Server
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsInstanceHost" type="optional">
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 name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN"/>
2788N/A <
function-
arg-
def name="dsInstancePswd" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="entryToBeModified" type="required">
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 name="extraParams" type="optional">
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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A <!-- Set common ldap arguments --> 2788N/A <
call function="'_ldapCommonArgs'"/>
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A <
call function="'runCommand'">
2788N/A 'arguments' : STAFCmdParams,
3194N/A 'name' : 'Modify Entry from ldif file',
2788N/A <!-- ldapsearch Function With Script--> 2788N/A <
function name="ldapSearchWithScript">
2788N/A This function performs an ldapsearch using the script
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsDereferencePolicy" type="optional">
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 name="dsTypesOnly" type="optional">
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 name="dsAssertionFilter" type="optional">
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 name="dsContinueOnError" type="optional">
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 name="dsPersistentSearch" type="optional">
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 name="dsCountEntries" type="optional">
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 name="dsReportAuthzID" type="optional">
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 name="dsFilename" type="optional">
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 name="dsHelp" type="optional">
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 name="dsEncoding" type="optional">
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 name="dsBindPasswordFile" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="filename"/>
2788N/A <
function-
arg-
def name="dsControl" type="optional">
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 name="dsKeyStorePath" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="filename"/>
2788N/A <
function-
arg-
def name="dsKeyStorePasswordFile" type="optional">
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 name="dsKeyStorePassword" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsTimeLimit" type="optional">
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 name="dsMatchedValuesFilter" type="optional">
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 name="dsDryRun" type="optional">
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 name="dsSaslOption" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsTrustStorePath" type="optional">
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 name="dsTrustStorePassword" type="optional">
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 name="dsTrustStorePasswordFile" type="optional">
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 name="dsUseStartTLS" type="optional">
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 name="dsUseSASLExternal" type="optional">
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 name="dsUseSSL" type="optional">
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 name="dsTrustAll" type="optional">
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 name="dsCertNickname" type="optional">
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 name="dsProxyAs" type="optional">
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 name="dsUsePasswordPolicyControl" type="optional">
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 name="dsSimplePageSize" type="optional">
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 name="dsSortOrder" type="optional">
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 name="dsVirtualListView" type="optional">
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 name="dsGetEffectiveRightsAuthzid" type="optional">
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 name="dsGetEffectiveRightsAttribute" type="optional">
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 name="dsVersion" type="optional">
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 name="dsSizeLimit" type="optional">
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 name="dsDontWrap" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="option"/>
2788N/A <
function-
arg-
def name="dsVerbose" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="option"/>
2788N/A <
function-
arg-
def name="dsInstanceHost" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
2788N/A <
function-
arg-
def name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
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 name="dsInstancePswd" type="optional">
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 name="dsScope" type="optional">
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 name="dsBaseDN" type="optional">
2788N/A The baseDN for the search operation
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="dn"/>
2962N/A <
function-
arg-
def name="extraParams" type="optional">
2962N/A Optional extra parameters for specific test cases
2962N/A </
function-
arg-
description>
2962N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsFilter" type="optional">
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 name="dsAttributes" type="optional">
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 name="outputFile" type="optional" default="'None'">
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"/>
3315N/A <
function-
arg-
def name="outputPath" type="optional">
3287N/A Path containing the outputFile
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="filepath"/>
2788N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
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 name="logStderr" type="optional" default="True">
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"/>
3951N/A <
function-
arg-
def name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A if dsGetEffectiveRightsAttribute:
2788N/A for attribute in dsGetEffectiveRightsAttribute:
2788N/A if dsGetEffectiveRightsAuthzid:
2788N/A if dsTrustStorePasswordFile:
2788N/A if dsUsePasswordPolicyControl:
3287N/A outputPath = '%s/..' % (dsPath)
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
4153N/A <
if expr="outputFile != 'None'">
4153N/A <
call function="'runCommand'" >
4153N/A { 'name' : 'LDAP Search Script',
4153N/A 'arguments' : STAFCmdParams,
4153N/A 'outputFile': '%s/%s' % (outputPath, outputFile) ,
4153N/A <
call function="'runCommand'" >
4153N/A { 'name' : 'LDAP Search Script',
4153N/A 'arguments' : STAFCmdParams,
2788N/A <
function name="SearchObject">
2788N/A This function searches the Directory Server with optional arguments possible
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsInstanceHost" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
2788N/A <
function-
arg-
def name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
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 name="dsInstancePswd" type="optional">
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 name="dsProxyDN" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="dn"/>
2788N/A <
function-
arg-
def name="dsScope" type="optional">
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 name="dsBaseDN" type="optional">
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 name="dsFilter" type="optional">
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 name="extraParams" type="optional">
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 name="attributes" type="optional">
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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A <!-- Set common ldap arguments --> 2788N/A <
call function="'_ldapCommonArgs'"/>
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A <
call function="'runCommand'">
2788N/A 'arguments' : STAFCmdParams,
2788N/A <
function name="SearchObjectNoPwd">
2788N/A This function searches the Directory Server with optional arguments possible
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsInstanceHost" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
2788N/A <
function-
arg-
def name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
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 name="dsBaseDN" type="optional">
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 name="dsFilter" type="optional">
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 name="extraParams" type="optional">
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 name="expectedRC" type="optional" default="0">
3194N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </
function-
arg-
description>
3951N/A <
function-
arg-
def name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
call function="'runCommand'" >
2788N/A { 'name' : 'Search Base Object No Password',
2788N/A 'arguments' : '-h %s -p %s -D "%s" %s -b "%s" "%s"' % (dsInstanceHost,dsInstancePort,dsInstanceDn,extraParams,dsBaseDN,dsFilter),
2788N/A <
function name="AnonSearchObject">
2788N/A This function searches the Directory Server anonymously with optional arguments possible
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsInstanceHost" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
2788N/A <
function-
arg-
def name="dsInstancePort" type="optional">
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 name="dsBaseDN" type="optional">
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 name="dsFilter" type="optional">
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 name="extraParams" type="optional">
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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
call function="'runCommand'" >
2788N/A { 'name' : 'Anonymous Search Base Object',
3194N/A 'arguments' : '-h %s -p %s %s -b "%s" "%s"' % (dsInstanceHost,dsInstancePort,extraParams,dsBaseDN,dsFilter),
2788N/A <!-- ldapdelete Function With Script--> 2788N/A <
function name="ldapDeleteWithScript">
2788N/A This function performs an ldapdelete using the script
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsContinueOnError" type="optional">
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 name="dsFilename" type="optional">
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 name="dsHelp" type="optional">
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 name="dsEncoding" type="optional">
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 name="dsBindPasswordFile" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="filename"/>
2788N/A <
function-
arg-
def name="dsControl" type="optional">
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 name="dsKeyStorePath" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="filename"/>
2788N/A <
function-
arg-
def name="dsKeyStorePasswordFile" type="optional">
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 name="dsKeyStorePassword" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsDryRun" type="optional">
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 name="dsSaslOption" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsTrustStorePath" type="optional">
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 name="dsTrustStorePassword" type="optional">
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 name="dsTrustStorePasswordFile" type="optional">
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 name="dsUseStartTLS" type="optional">
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 name="dsUseSASLExternal" type="optional">
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 name="dsUseSSL" type="optional">
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 name="dsTrustAll" type="optional">
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 name="dsVersion" type="optional">
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 name="dsCertNickname" type="optional">
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 name="dsLdapVersion" type="optional">
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 name="dsVerbose" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="option"/>
2788N/A <
function-
arg-
def name="dsDeleteSubtree" type="optional">
2788N/A Delete the specified entry and all entries below it
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="option"/>
2788N/A <
function-
arg-
def name="dsInstanceHost" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
2788N/A <
function-
arg-
def name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
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 name="dsInstancePswd" type="optional">
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 name="dsDn" type="optional">
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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A if dsTrustStorePasswordFile:
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'LDAP Delete Script',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <
function name="DeleteEntry">
2788N/A This function an entry in the Directory Server
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsInstanceHost" type="optional">
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 name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN"/>
2788N/A <
function-
arg-
def name="dsInstancePswd" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsBaseDN" type="required">
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 name="extraParams" type="optional">
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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A <!-- Set common ldap arguments --> 2788N/A <
call function="'_ldapCommonArgs'"/>
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'Delete Object',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <!-- ldapcompare Function With Script--> 2788N/A <
function name="ldapCompareWithScript">
2788N/A This function performs an ldapcompare using the script
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsAssertionFilter" type="optional">
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 name="dsContinueOnError" type="optional">
2788N/A Continue processing even if there are errors
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="option"/>
3137N/A <
function-
arg-
def name="dsReportAuthzID" type="optional">
3137N/A Use the authorization identity control
3137N/A </
function-
arg-
description>
3137N/A <
function-
arg-
property name="type" value="option"/>
2788N/A <
function-
arg-
def name="dsFilename" type="optional">
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 name="dsHelp" type="optional">
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 name="dsEncoding" type="optional">
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 name="dsBindPasswordFile" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="filename"/>
2788N/A <
function-
arg-
def name="dsControl" type="optional">
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 name="dsKeyStorePath" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="filename"/>
2788N/A <
function-
arg-
def name="dsKeyStorePasswordFile" type="optional">
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 name="dsKeyStorePassword" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsDryRun" type="optional">
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 name="dsSaslOption" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsTrustStorePath" type="optional">
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 name="dsTrustStorePassword" type="optional">
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 name="dsTrustStorePasswordFile" type="optional">
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 name="dsUseStartTLS" type="optional">
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 name="dsUseSASLExternal" type="optional">
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 name="dsUseSSL" type="optional">
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 name="dsTrustAll" type="optional">
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 name="dsVersion" type="optional">
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 name="dsCertNickname" type="optional">
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 name="dsLdapVersion" type="optional">
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 name="dsVerbose" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="option"/>
2788N/A <
function-
arg-
def name="dsInstanceHost" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
2788N/A <
function-
arg-
def name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
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 name="dsInstancePswd" type="optional">
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 name="dsAttributeValue" type="optional">
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 name="dsDn" type="optional">
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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A if dsTrustStorePasswordFile:
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A <
call function="'runCommand'" >
2788N/A { 'name' : 'LDAP Compare Script',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <
function name="compareEntry">
2788N/A This function compares the attribute and value an entry to the Directory Server
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsInstanceHost" type="optional">
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 name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN"/>
2788N/A <
function-
arg-
def name="dsInstancePswd" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="attrToBeCompared" type="required">
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 name="entryToBeCompared" type="required">
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 name="extraParams" type="optional">
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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A <!-- Set common ldap arguments --> 2788N/A <
call function="'_ldapCommonArgs'"/>
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A <
call function="'runCommand'" >
2788N/A { 'name' : 'Compare Object',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <
function name="_ldapCommonArgs">
2788N/A This function resolves common ldap arguments
2788N/A <!-- ldappasswordmodify Function With Script--> 2788N/A <
function name="ldapPasswordModifyWithScript">
2788N/A This function performs an ldappasswordmodify using the script
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsHelp" type="optional">
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 name="dsBindPasswordFile" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="filename"/>
2788N/A <
function-
arg-
def name="dsKeyStorePath" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="filename"/>
2788N/A <
function-
arg-
def name="dsKeyStorePasswordFile" type="optional">
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 name="dsKeyStorePassword" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsTrustStorePath" type="optional">
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 name="dsTrustStorePassword" type="optional">
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 name="dsTrustStorePasswordFile" type="optional">
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 name="dsUseStartTLS" type="optional">
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 name="dsUseSSL" type="optional">
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 name="dsTrustAll" type="optional">
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 name="dsAuthzID" type="optional">
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 name="dsProvideDNForAuthzID" type="optional">
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 name="dsCurrentPassword" type="optional">
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 name="dsCurrentPasswordFile" type="optional">
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 name="dsNewPassword" type="optional">
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 name="dsNewPasswordFile" type="optional">
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 name="dsVersion" type="optional">
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 name="dsInstanceHost" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
3137N/A <
function-
arg-
def name="dsSaslOption" type="optional">
3137N/A </
function-
arg-
description>
3137N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
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 name="dsInstancePswd" type="optional">
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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A if dsTrustStorePasswordFile:
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A <
call function="'runCommand'" >
2788N/A { 'name' : 'LDAP Password Modify Script',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <!-- Modify an attribute --> 2788N/A <
function name="modifyAnAttribute">
2788N/A This function modifies an entry in the Directory Server
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
2788N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
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 name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
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 name="dsInstancePort" type="required">
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 name="dsInstanceDn" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN"/>
2788N/A <
function-
arg-
def name="dsInstancePswd" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="DNToModify" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN"/>
2788N/A <
function-
arg-
def name="attributeName" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="newAttributeValue" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="listAttributes" type="optional" default="' '">
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 name="changetype" type="required">
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 name="suppressTestStatus" type="optional" default="0">
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 name="expectedRC" type="optional" default="0">
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"/>
3951N/A <
function-
arg-
def name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A <!-- Set common ldap arguments --> 2788N/A <
call function="'_ldapCommonArgs'"/>
2788N/A <
if expr="listAttributes != ' '">
2788N/A <
iterate var="anAttributeToModify" in="listAttributes">
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A STAFCmd='modifyAnAttribute'
3194N/A <
if expr="suppressTestStatus == '1'">
2788N/A <
call function="'runCommand'" >
2788N/A { 'name' : 'Modify An Attribute value',
2788N/A 'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
2788N/A <!-- Create a load on Directory with modifies --> 2788N/A <
function name="loadOfModifies">
2788N/A This function creates a load of modifies against Directory. It is only for entries with uid=
user.xxx. 2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
4153N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
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 name="dsInstancePort" type="required">
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 name="dsInstanceDn" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN"/>
2788N/A <
function-
arg-
def name="dsInstancePswd" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="partialDNToModify" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN"/>
2788N/A <
function-
arg-
def name="attributeName" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="newAttributeValue" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="listAttributes" type="optional" default="' '">
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 name="changetype" type="required">
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 name="numEntries" type="required">
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 name="clientID" type="optional">
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 name="expectedRC" type="optional" default="0">
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 curr_dn="uid=user.%s,%s" % (curr_rdn_num, partialDNToModify)
2788N/A '****From client, %s, Modifying %s' % (clientID,curr_dn)
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 ,
2788N/A 'attributeName' : 'description' ,
2788N/A 'newAttributeValue' : 'New description for %s' % curr_dn ,
2788N/A 'suppressTestStatus' : '1' }
2788N/A <
function name="addAnEntry">
2788N/A This function modifies an entry in the Directory Server
2788N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname"/>
2788N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
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 name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
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 name="dsInstancePort" type="required">
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 name="dsInstanceDn" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN"/>
2788N/A <
function-
arg-
def name="dsInstancePswd" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="DNToAdd" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN"/>
2788N/A <
function-
arg-
def name="listAttributes" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string"/>
2788N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
3194N/A Expected return code value. Default value is 0
3194N/A Wildcard 'noCheck' to not check the RC
2788N/A </
function-
arg-
description>
3951N/A <
function-
arg-
def name="knownIssue" type="optional" default="None">
3951N/A Known issue. Corresponds to an issue number.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
2788N/A <!-- Set common ldap arguments --> 2788N/A <
call function="'_ldapCommonArgs'"/>
2788N/A <
iterate var="anAttributeToAdd" in="listAttributes">
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A <
call function="'runCommand'" >
2788N/A { 'name' : 'Add New Entry',
2788N/A 'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
4724N/A This function renames an entry, either by a modRDN or by a modDN
4724N/A <
function-
arg-
def name="location" 4724N/A default="STAF_REMOTE_HOSTNAME">
4724N/A </
function-
arg-
description>
4724N/A <
function-
arg-
property name="type" value="hostname"/>
4724N/A <
function-
arg-
def name="dsPath" 4724N/A default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
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 name="dsInstanceHost" 4724N/A default="STAF_REMOTE_HOSTNAME">
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 name="dsInstancePort" type="required">
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 name="dsInstanceDn" type="required">
4724N/A </
function-
arg-
description>
4724N/A <
function-
arg-
property name="type" value="DN"/>
4724N/A <
function-
arg-
def name="dsInstancePswd" type="required">
4724N/A </
function-
arg-
description>
4724N/A <
function-
arg-
property name="type" value="string"/>
4724N/A <
function-
arg-
def name="DNToModify" type="required">
4724N/A </
function-
arg-
description>
4724N/A <
function-
arg-
property name="type" value="DN"/>
4724N/A <
function-
arg-
def name="newRDN" 4724N/A New rdn name : ie uid=jdoe_bis. If not passed, the newRDN will be the
4724N/A </
function-
arg-
description>
4724N/A <
function-
arg-
property name="type" value="string"/>
4724N/A <
function-
arg-
def name="deleteOldRDN" 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 name="newSuperior" 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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
4724N/A Known issue. Corresponds to an issue number.
4724N/A </
function-
arg-
description>
4724N/A <
function-
arg-
property name="type" value="string" />
4724N/A <!-- Set common ldap arguments --> 4724N/A <
call function="'_ldapCommonArgs'" />
4724N/A STAFCmdParams=' '.join(STAFCmdParamsList)
4724N/A <
call function="'runCommand'" >
4724N/A 'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
4035N/A <!-- Modify an attribute --> 4035N/A <
function name="saslSearch">
4035N/A This function searches the Directory Server using SASL authentication
4035N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
4035N/A </
function-
arg-
description>
4035N/A <
function-
arg-
property name="type" value="hostname"/>
4035N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
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 name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
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 name="dsInstancePort" type="required">
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 name="dsScope" type="optional">
4035N/A </
function-
arg-
description>
4035N/A <
function-
arg-
property name="type" value="string"/>
4035N/A <
function-
arg-
def name="dsBaseDN" type="required">
4035N/A </
function-
arg-
description>
4035N/A <
function-
arg-
property name="type" value="DN"/>
4035N/A <
function-
arg-
def name="dsFilter" type="required">
4035N/A </
function-
arg-
description>
4035N/A <
function-
arg-
property name="type" value="string"/>
4035N/A <
function-
arg-
def name="mechanism" type="required">
4035N/A </
function-
arg-
description>
4035N/A <
function-
arg-
property name="type" value="string"/>
4035N/A <
function-
arg-
def name="authenticationId" type="required">
4035N/A </
function-
arg-
description>
4035N/A <
function-
arg-
property name="type" value="DN"/>
4035N/A <
function-
arg-
def name="password" type="required">
4035N/A </
function-
arg-
description>
4035N/A <
function-
arg-
property name="type" value="string"/>
4035N/A <
function-
arg-
def name="authorizationId" type="optional">
4035N/A </
function-
arg-
description>
4035N/A <
function-
arg-
property name="type" value="DN"/>
4035N/A <
function-
arg-
def name="realm" type="optional">
4035N/A </
function-
arg-
description>
4035N/A <
function-
arg-
property name="type" value="string"/>
4035N/A <
function-
arg-
def name="protection" type="optional">
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 name="strength" type="optional">
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 name="maxbuffersize" type="optional">
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 name="suppressTestStatus" type="optional" default="0">
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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
4035N/A Known issue. Corresponds to an issue number.
4035N/A </
function-
arg-
description>
4035N/A <
function-
arg-
property name="type" value="string" />
4035N/A <!-- Set common ldap arguments --> 4035N/A <
call function="'_ldapCommonArgs'"/>
4035N/A STAFCmdParams=' '.join(STAFCmdParamsList)
4035N/A <
if expr="suppressTestStatus == '1'">
4035N/A <
call function="'runCommand'" >
4035N/A { 'name' : 'Modify An Attribute value',
4035N/A 'arguments' : '%s %s' % (STAFCmd,STAFCmdParams),
4724N/A <
function name="SearchExternalChangelog">
4724N/A This function searches the external changelog
4724N/A <
function-
arg-
def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">
4724N/A </
function-
arg-
description>
4724N/A <
function-
arg-
property name="type" value="hostname"/>
4724N/A <
function-
arg-
def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
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 name="dsInstanceHost" type="optional">
4724N/A </
function-
arg-
description>
4724N/A <
function-
arg-
property name="type" value="hostname"/>
4724N/A <
function-
arg-
def name="dsInstancePort" type="optional">
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 name="dsInstanceDn" type="optional">
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 name="dsInstancePswd" type="optional">
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 name="dsScope" type="optional">
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 name="dsBaseDN" type="optional">
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 name="dsFilter" type="required">
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 name="extraParams" type="optional">
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 name="attributes" type="optional">
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 name="changelogCookie" 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 name="changeNumberFilter" 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 name="expectedRC" type="optional" default="0">
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 name="knownIssue" type="optional" default="None">
4724N/A Known issue. Corresponds to an issue number.
4724N/A </
function-
arg-
description>
4724N/A <
function-
arg-
property name="type" value="string" />
4724N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
4724N/A <!-- Set common ldap arguments --> 4724N/A <
call function="'_ldapCommonArgs'"/>
4724N/A control = '1.3.6.1.4.1.26027.1.5.4:false:%s' % changelogCookie
4724N/A searchFilter = '&%s%s' % (changeNumberFilter, dsFilter)
4724N/A STAFCmdParams=' '.join(STAFCmdParamsList)
4724N/A '%s %s' % (STAFCmd, STAFCmdParams)
4724N/A <
call function="'runCommand'">
4724N/A 'arguments' : STAFCmdParams,