Checks that the ldap server is running Location of target host Pathname to installation root Number of iterations Number of seconds to wait between iterations Directory server hostname or IP address Directory server port number Bind DN Bind password Name of output file descriptor { 'tagName' : 'isAlive', 'fileFd' : fileFd } { 'fileFd' : fileFd, 'content' : 'Check if server %s:%s is alive' % (myhost,myport) } { 'location' : mylocation, 'dsPath' : mypath, 'dsInstanceHost' : myhost, 'dsInstancePort' : myport, 'dsInstanceDn' : mydn, 'dsInstancePswd' : mypswd, 'dsScope' : 'base', 'dsBaseDN' : 'cn=config', 'dsFilter' : 'objectclass=*', 'dsAttributes' : 'dn', 'expectedRC' : 'noCheck', 'fileFd' : fileFd } { 'sleepForMilliSeconds' : noOfMilliSeconds, 'silentMode' : 'TRUE', 'fileFd' : fileFd } { 'fileFd' : fileFd, 'content' : 'server is not alive, ldapsearch not responding' } { 'fileFd' : fileFd, 'content' : 'Server is alive' } { 'fileFd' : fileFd, 'content' : 'server is not alive' } {'fileFd' : fileFd} returnValue This function verifies that the tree of an instance belonging to an instances list (ie instance[n]) is synchronized with instance[n+1] Location of target host Server that should be taken as reference. List of the instances objectclass to verify against the instance instance must belong to this list Suffix of the tree to verify. Prefix for tmp files Name of output file descriptor { 'tagName' : 'verifyTrees', 'fileFd' : fileFd } { 'fileFd' : fileFd, 'content' : 'Verify tree %s taking %s as reference.' % (suffixDn, referenceServerPath) } { 'location' : location, 'dsPath' : dsPath, 'dsInstanceHost' : instance.getHost(), 'dsInstancePort' : instance.getLDAPPort(), 'dsInstanceDn' : DIRECTORY_INSTANCE_DN, 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD, 'dsBaseDN' : suffixDn, 'dsFilter' : 'objectclass=*', 'dsAttributes' : dsAttributes, 'outputFile' : referenceTree, 'fileFd' : fileFd } { 'fileFd' : fileFd} [1, None] { 'location' : location, 'dsPath' : dsPath, 'dsInstanceHost' : instance2.getHost(), 'dsInstancePort' : instance2.getLDAPPort(), 'dsInstanceDn' : DIRECTORY_INSTANCE_DN, 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD, 'dsBaseDN' : suffixDn, 'dsFilter' : 'objectclass=*', 'dsAttributes' : dsAttributes, 'outputFile' : sampleTree, 'fileFd' : fileFd } { 'location' : location, 'fileName' : sampleTree } 'WARNING!! : file emtpy %s' % sampleTree { 'location' : location, 'dsPath' : dsPath, 'sourceLdif' : sampleTree, 'targetLdif' : referenceTree, 'outputLdif' : treeDiffs, 'fileFd' : fileFd } { 'returncode' : myRC, 'result' : messageInfo, 'fileFd' : fileFd } { 'fileFd' : fileFd} [myRC, failedServers] This function performs an ldapsearch Location of target host Pathname to installation root Specifies dereference alias policy Specifies to only include attribute type names Use the LDAP assertion control with the provided filter Continue processing even if there are errors Use the persistent search control Count the number of entries returned by the server Use the authorization identity control File containing a list of search filter strings Display this usage information Use the specified character set for command-line input Bind password file Use a request control with the provided information Certificate keystore path Certificate keystore PIN file Certificate keystore PIN Maximum length of time in seconds to allow for the search Use the LDAP matched values control with the provided filter Show what would be done but do not perform any operation SASL bind options Certificate trust store path Certificate trust store PIN Certificate trust store PIN file Use StartTLS to secure communication with the server Use the SASL EXTERNAL authentication mechanism Use SSL for secure communication with the server Trust all server SSL certificates Nickname of certificate for SSL client authentication Use the proxied authorization control with the given authorization ID Use the password policy request control Use the simple paged results control with the given page size Sort the results using the provided sort order Use the virtual list view control to retrieve the specified results page Use geteffectiverights control with the provided authzid Specifies geteffectiverights control specific attribute list LDAP protocol version number Maximum number of entries to return from the search Do not wrap long lines Use verbose mode Directory Server Host Name Directory Server Port Number Directory Server Manager DN Directory Server Manager Password The scope of the search operation The baseDN for the search operation The filter for the search operation Only return these attributes Output file containing the search result in ldif format. Expected return code value. Default value is 0. Wildcard 'noCheck' to not check the RC Name of output file descriptor { 'name' : 'LDAP Search %s on %s:%s' % (dsBaseDN,dsInstanceHost,dsInstancePort), 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'path' : dsBinPath, 'outputFile': outputFile, 'expectedRC': expectedRC, 'fileFd' : fileFd } STAXResult This function modifies an entry in the Directory Server Location of target host Pathname to installation root Directory server hostname or IP address Directory server port number Bind DN Bind password DN to add Attributes to add Expected return code value. Default value is 0 Wildcard 'noCheck' to not check the RC Name of output file descriptor { 'tagName' : 'addAnEntry', 'fileFd' : fileFd } { 'fileFd' : fileFd, 'content' : '%s %s' % (STAFCmd, STAFCmdParams) } '%s' % location '%s/bin/java' % JAVA_HOME '%s %s' % (STAFCmd,STAFCmdParams) ['PATH=/bin:/usr/bin:%s/bin' % dsPath, 'JAVA_HOME=%s' % JAVA_HOME,'CLASSPATH=%s/phases/shared/java' % LOCAL_TESTS_DIR] { 'returncode' : STAXCode, 'result' : STAXReason, 'fileFd' : fileFd } {'fileFd' : fileFd} STAXResult This function modifies an entry in the Directory Server Location of target host Pathname to installation root Directory server hostname or IP address Directory server port number Bind DN Bind password DN to modify Attribute to modify New Attribute Value List of attributes name and value to modify. The format is name:value Type of modification, can be delete, add, replace Supress the call to checkTestRC Expected return code value. Default value is 0 Wildcard 'noCheck' to not check the RC Name of output file descriptor { 'tagName' : 'Modify An Attribute value', 'fileFd' : fileFd } { 'fileFd' : fileFd, 'content' : '%s %s' % (STAFCmd, STAFCmdParams) } '%s' % location '%s/bin/java' % JAVA_HOME '%s %s' % (STAFCmd,STAFCmdParams) ['PATH=/bin:/usr/bin:%s/bin' % dsPath, 'JAVA_HOME=%s' % JAVA_HOME,'CLASSPATH=%s/phases/shared/java' % LOCAL_TESTS_DIR] { 'returncode' : STAXCode, 'result' : STAXReason, 'fileFd' : fileFd } {'fileFd' : fileFd} [RC,STAXResult] This function modifies an entry in the Directory Server Location of target host Pathname to installation root Directory server hostname or IP address Directory server port number Bind DN Bind password Entry to be modified in the Directory Server in ldif format Optional extra parameters for specific test cases Expected return code value. Default value is 0 Wildcard 'noCheck' to not check the RC Name of output file descriptor { 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'path' : dsBinPath, 'name' : 'Modify Entry from ldif file', 'expectedRC': expectedRC, 'fileFd' : fileFd } STAXResult Location of target host instance installation path Name of output file descriptor { 'tagName' : 'checkLogs', 'fileFd' : fileFd } { 'location' : location, 'string2grep' : 'ERROR', 'expect2Find' : FALSE, 'caseSensitive' : FALSE, 'file' : '%s/logs/errors' % installDir, 'fileFd' : fileFd } { 'location' : location, 'string2grep' : 'exception', 'expect2Find' : FALSE, 'caseSensitive' : FALSE, 'file' : '%s/logs/errors' % installDir, 'fileFd' : fileFd } { 'fileFd' : fileFd} _errNum