This function resolves common admin arguments
This function upgrades DS using the upgrade script
Location of target host
Pathname to installation root
Help option
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
{
'location' : location ,
'entry' : '%s/Legal/license_to_accept.txt' % dsPath ,
'attribute' : 'TYPE'
}
'%s %s' % (STAFCmd, STAFCmdParams)
{ 'location' : location,
'name' : 'Upgrade DS Script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'path' : dsPath,
'expectedRC': expectedRC,
'knownIssue': knownIssue
}
This function sets up a Directory Server using a script
Location of target host
Hostname of target host
Pathname to installation root
Directory server port number
Directory server admin port number
Directory server SSL port number
Directory server JMX port number
Base DN (only single base DN supported).
Bind DN
Bind password
Bind password file
Enable as a Windows Service
Do not start server after setup
Help option
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
{ 'location' : dsHost,
'type' : 'shared',
'variable' : 'Job%s_ServerInfo' % STAXParentID
}
{
'location' : location ,
'entry' : '%s/Legal/license_to_accept.txt' % dsPath ,
'attribute' : 'TYPE'
}
'%s %s' % (STAFCmd, STAFCmdParams)
{ 'location' : location,
'name' : 'Setup DS Script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'path' : dsPath,
'expectedRC': expectedRC,
'knownIssue': knownIssue
}
This function sets up a Directory Server using a script
Location of target host
Hostname of target host
Pathname to installation root
Directory server port number
Directory server admin port number
Directory server SSL port number
Directory server JMX port number
Base DN (only single base DN supported).
Bind DN
Bind password
Bind password file
Enable as a Windows Service
Do not start server after setup
Help option
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
'%s %s' % (STAFCmd, STAFCmdParams)
{ 'location' : location,
'name' : 'Setup DS Script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'path' : dsPath,
'expectedRC': expectedRC,
'knownIssue': knownIssue
}
This function starts a Directory Server
Location of target host
Pathname to installation root
Directory server version
Directory server system info
Do not detach directory server from process
Help option
Directory server build information
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
'%s %s' % (STAFCmd, STAFCmdParams)
{
'location' : STAF_REMOTE_HOSTNAME ,
'entry' : '%s/lib/emma.jar' % dsPath ,
'attribute' : 'TYPE'
}
{ 'location' : STAXServiceMachine,
'foldername' : resultsCoveragePath
}
{ 'location' : STAF_REMOTE_HOSTNAME,
'foldername' : remoteCoveragePath
}
{ 'location' : STAF_REMOTE_HOSTNAME,
'foldername' : ecPath
}
{
'location' : STAF_REMOTE_HOSTNAME,
'foldername' : ecPath,
'extension' : 'ec'
}
{ 'srcfile' : '%s/emma.properties.%s' % (local.temp,len(existingECs)),
'destfile' : '%s/classes/emma.properties' % dsPath,
'remotehost' : STAF_REMOTE_HOSTNAME }
{ 'location' : STAF_REMOTE_HOSTNAME,
'srcfile' : '%s/coverage.em' % dsPath,
'destfile' : '%s/coverage.em' % remoteCoveragePath,
'remotehost' : STAF_REMOTE_HOSTNAME }
{ 'location' : STAF_REMOTE_HOSTNAME,
'srcfile' : '%s/coverage.em' % dsPath,
'destfile' : '%s/coverage.em' % resultsCoveragePath,
'remotehost' : STAF_REMOTE_HOSTNAME }
{ 'location' : location,
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'location' : location,
'expectedRC': expectedRC,
'knownIssue': knownIssue
}
STAXResult
This function starts a Directory Server using the script
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server admin port number
Use SSL for secure communication with the server
Use StartTLS for secure communication with the server
Bind DN
Bind password
Bind password file
SASL bind options
Use the proxied authorization control with the given authorization ID
Reason the server is being stopped or restarted
Attempt to automatically restart the server once it has stopped
Time to begin the shutdown in YYYYMMDDhhmmss format (local time)
Trust all server SSL certificates
Certificate keystore path
Certificate keystore PIN
Certificate keystore PIN file
Certificate trust store path
Certificate trust store PIN
Certificate trust store PIN file
Help option
Number of iterations (for isStopped())
Number of seconds to wait between iterations (for isStopped())
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
'%s %s' % (STAFCmd, STAFCmdParams)
{ 'location' : location,
'name' : 'Stop DS Script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
'knownIssue': knownIssue
}
{ 'location' : location,
'dsPath' : '%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME),
'noOfLoops' : noOfLoops,
'noOfMilliSeconds' : 6000
}
{ 'location' : location,
'dsPath' : dsPath,
'noOfLoops' : noOfLoops,
'noOfMilliSeconds' : noOfMilliSeconds
}
'Getting tail of error log on %s/logs/errors' % dsPath
{ 'location' : location,
'filename' : '%s/logs/errors' % dsPath
}
savSTAXResult
This function performs an import of an ldif file
Location of target host
Pathname to installation root
Directory server host name
Directory server port number
Directory server admin port number
Bind DN
Bind password
The identifier for the task
The name of the ldif file
Optional the name of the database backend
Column at which to wrap long lines
Optional exclude attributes
Optional exported ldif data file compressed
Optional exported ldif data file encrypted
Optional append exported ldif data
Optional do not perform any schema validation
Optional path to a MakeLDIF template to generate the import data.
Optional identify entries that were skipped during the import
Optional overwrite the specified skip file or reject file
Optional replace existing data with the content from the import
Optional file to hold any rejected entries during the import
Optional exclude branches
Optional include branches
Optional exclude attributes
Optional include attributes
Optional exclude filters
Optional exclude filters
Optional generate a signed hash of the export data
Optional extra parameters for specific test cases
Number of ldap check tries when checking if task is complete
Sleep time in milliseconds between ldap check tries
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
Indicates the task is recurring and will be scheduled
according to the value argument expressed in crontab(5)
compatible time/date pattern
{ 'location' : location,
'folderslist' : foldersToCreate
}
'%s %s' % (STAFCmd, STAFCmdParams)
'Start import-ldif'
{ 'location' : location,
'name' : 'Import Script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'expectedRC' : expectedRC,
'knownIssue' : knownIssue
}
'Check import-ldif task successfully completed'
{
'dsPath' : dsPath,
'dsInstanceAdminPort' : dsInstanceAdminPort,
'dsInstanceHost' : dsInstanceHost ,
'dsInstanceDn' : dsInstanceDn ,
'dsInstancePswd' : dsInstancePswd ,
'outputToCheck' : resultString
}
savSTAXResult
This function verifies an import of an ldif file
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Directory server admin port number
Bind DN
Bind password
The baseDN for the search operation
Entries expected to be present after import
Optional entries expected to be missing after import
Optional attributes expected to be present after import
Optional attributes expected to be missing after import
Optional no of entries expected after import
Optional main suffix for the import
Optional start the Directory Server after import
{ 'location' : myLocation,
'dsPath' : myPath }
{ 'location' : myLocation,
'dsPath' : myPath,
'dsInstanceHost' : myhost ,
'dsInstancePort' : myport ,
'dsInstanceDn' : mydn ,
'dsInstancePswd' : mypswd ,
'noOfLoops' : 10 ,
'noOfMilliSeconds' : 2000 }
'Expected number of entries is %s' % expectedNoEntries
{ 'location' : myLocation ,
'dsPath' : myPath,
'dsInstanceHost' : myhost ,
'dsInstancePort' : myport ,
'dsInstanceDn' : mydn ,
'dsInstancePswd' : mypswd ,
'dsBaseDN' : mybasedn ,
'dsFilter' : 'objectclass=*',
'dsAttributes' : 'dn',
'dsCountEntries' : True
}
{ 'expectedString' : 'Total number of matching entries: %s' % expectedNoEntries,
'returnString' : returnString ,
'expectedRC' : expectedRC ,
}
{ 'location' : myLocation ,
'dsPath' : myPath,
'dsInstanceHost' : myhost ,
'dsInstancePort' : myport ,
'dsInstanceDn' : mydn ,
'dsInstancePswd' : mypswd ,
'dsBaseDN' : '%s' % expectedEntry ,
'dsScope' : 'base' ,
'dsFilter' : 'objectclass=*',
'dsAttributes' : 'dn'
}
{ 'location' : myLocation ,
'dsPath' : myPath,
'dsInstanceHost' : myhost ,
'dsInstancePort' : myport ,
'dsInstanceDn' : mydn ,
'dsInstancePswd' : mypswd ,
'dsBaseDN' : '%s' % missingEntry ,
'dsScope' : 'base' ,
'dsFilter' : 'objectclass=*' ,
'attributes' : 'dn' ,
'expectedRC' : 32
}
{ 'location' : myLocation ,
'dsPath' : myPath,
'dsHost' : myhost ,
'dsAdminPort' : myadminport ,
'dsBindDN' : mydn ,
'dsBindPwd' : mypswd }
This function performs an on line export task of an ldif file
Location of target host
Pathname to installation root
Directory server host name
Directory server port number
Directory server admin port number
Bind DN
Bind password
The identifier for the task
The name of the ldif file
Optional the name of the database backend
Column at which to wrap long lines
Optional exclude attributes
Optional exported ldif data file compressed
Optional exported ldif data file encrypted
Optional append exported ldif data
Optional exclude branches
Optional include branches
Optional exclude attributes
Optional include attributes
Optional exclude filters
Optional exclude filters
Optional generate a signed hash of the export data
Optional extra parameters for specific test cases
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
Indicates the task is recurring and will be scheduled
according to the value argument expressed in crontab(5)
compatible time/date pattern
{ 'location' : location,
'folderslist' : foldersToCreate
}
'%s %s' % (STAFCmd, STAFCmdParams)
'Start export-ldif'
{ 'location' : location,
'name' : 'Export Script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'expectedRC' : expectedRC
}
'Check export-ldif task successfully completed'
{
'dsPath' : dsPath,
'dsInstanceAdminPort' : dsInstanceAdminPort,
'dsInstanceHost' : dsInstanceHost ,
'dsInstanceDn' : dsInstanceDn ,
'dsInstancePswd' : dsInstancePswd ,
'outputToCheck' : resultString
}
savSTAXResult
This function performs an off line backup
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server admin port number
Bind DN
Bind password
Optional the name of the database backend
The directory where the backup files will be placed
Optional extra parameters for specific test cases
Start time for task
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
Indicates the task is recurring and will be scheduled
according to the value argument expressed in crontab(5)
compatible time/date pattern
Use the provided identifier for the backup
{ 'location' : location,
'folderslist' : foldersToCreate
}
'%s %s' % (STAFCmd, STAFCmdParams)
'Start backup'
{ 'location' : location,
'name' : 'Backup Script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
'knownIssue': knownIssue
}
STAXResult
This function performs an on line backup task
Location of target host
Pathname to installation root
Directory server host name
Directory server port number
Bind DN
Bind password
The identifier for the task
Path to the target directory for the backup file(s)
Optional the name of the database backend
Optional back up all backends in the server
Optional perform an incremental backup rather than a full backup
Optional use the provided identifier for the backup
Optional backup contents compressed
Optional backup contents encrypted
Optional generate a signed hash of the backup data
Optional generate a hash of the backup data
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
'Copy backup task ldif file.'
{ 'location' : STAXServiceMachine,
'srcfile' : tmpTaskLdif,
'destfile' : taskLdif,
'remotehost' : myLocation }
{ 'location' : myLocation,
'dsPath' : myPath,
'taskLabel' : 'Online Backup Task',
'dsHost' : dsInstanceHost,
'dsPort' : dsInstancePort,
'dsBindDn' : dsInstanceDn,
'dsBindPswd' : dsInstancePswd,
'dsTaskLdif' : taskLdif,
'expectedRC' : expectedRC }
{ 'location' : myLocation,
'dsPath' : myPath,
'dsTaskDn' : taskDN,
'dsHost' : dsInstanceHost,
'dsPort' : dsInstancePort,
'dsBindDn' : dsInstanceDn,
'dsBindPswd' : dsInstancePswd }
'Check CheckLdapTask returns RC=0'
{ 'returncode' : RC ,
'result' : STAXResult }
This function performs an off line restore
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server admin port number
Bind DN
Bind password
The directory where the backup files will be placed
Optional extra parameters for specific test cases
Start time for task
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
Indicates the task is recurring and will be scheduled
according to the value argument expressed in crontab(5)
compatible time/date pattern
Use the provided identifier for the backup
'%s %s' % (STAFCmd, STAFCmdParams)
{ 'location' : location,
'name' : 'Restore Script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
'knownIssue': knownIssue
}
STAXResult
This function performs an on line restore task of a backup file
Location of target host
Pathname to installation root
Directory server host name
Directory server port number
Bind DN
Bind password
The identifier for the task
The name of the backup directory
Optional the name of the backupId
Optional verify the contents of the backup but do not restore it
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
'Copy restore task ldif file.'
{ 'location' : STAXServiceMachine,
'srcfile' : tmpTaskLdif,
'destfile' : taskLdif,
'remotehost' : myLocation }
{ 'location' : myLocation,
'dsPath' : myPath,
'taskLabel' : 'Online Restore Task',
'dsHost' : dsInstanceHost,
'dsPort' : dsInstancePort,
'dsBindDn' : dsInstanceDn,
'dsBindPswd' : dsInstancePswd,
'dsTaskLdif' : taskLdif,
'expectedRC' : expectedRC }
{ 'location' : myLocation,
'dsPath' : myPath,
'dsTaskDn' : taskDN,
'dsHost' : dsInstanceHost,
'dsPort' : dsInstancePort,
'dsBindDn' : dsInstanceDn,
'dsBindPswd' : dsInstancePswd }
'Check CheckLdapTask returns RC=0'
{ 'returncode' : RC ,
'result' : STAXResult }
This function performs an on line export task for shutdown of the directory
Location of target host
Pathname to installation root
Directory server host name
Directory server port number
Bind DN
Bind password
The identifier for the task
Number of iterations (for isStopped())
Number of seconds to wait between iterations (for isStopped())
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
'Copy shutdown task ldif (%s) to %s' % (tmpTaskLdif,taskLdif)
{ 'location' : STAXServiceMachine,
'srcfile' : tmpTaskLdif,
'destfile' : taskLdif,
'remotehost' : myLocation }
{ 'location' : myLocation,
'dsPath' : myPath,
'taskLabel' : 'Online Export Task',
'dsHost' : dsInstanceHost,
'dsPort' : dsInstancePort,
'dsBindDn' : dsInstanceDn,
'dsBindPswd' : dsInstancePswd,
'dsTaskLdif' : taskLdif,
'expectedRC' : expectedRC }
{ 'location' : location,
'dsPath' : '%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME),
'noOfLoops' : noOfLoops,
'noOfMilliSeconds' : noOfMilliSeconds
}
{ 'location' : location,
'dsPath' : dsPath,
'noOfLoops' : noOfLoops,
'noOfMilliSeconds' : noOfMilliSeconds
}
STAFCmdRC
This function performs an on line export task for restart of the directory
Location of target host
Pathname to installation root
Directory server host name
Directory server port number
Bind DN
Bind password
The identifier for the task
Expected return code value. Default value is 0
Wildcard 'noCheck' to not check the RC
'Copy restart task ldif (%s) to %s' % (tmpTaskLdif,taskLdif)
{ 'location' : STAXServiceMachine,
'srcfile' : tmpTaskLdif,
'destfile' : taskLdif,
'remotehost' : myLocation }
{ 'location' : myLocation,
'dsPath' : myPath,
'taskLabel' : 'Online Export Task',
'dsHost' : dsInstanceHost,
'dsPort' : dsInstancePort,
'dsBindDn' : dsInstanceDn,
'dsBindPswd' : dsInstancePswd,
'dsTaskLdif' : taskLdif,
'expectedRC' : expectedRC }
{ 'noOfLoops' : 10 ,
'noOfMilliSeconds' : 2000 }
STAFCmdRC
This function performs a dynamic schema add task
Location of target host
Pathname to installation root
Directory server host name
Directory server port number
Bind DN
Bind password
The identifier for the task
The name of the ldif file that contains the schema updates
'Copy schema task ldif file %s to %s.' % (tmpTaskLdif,taskLdif)
{ 'location' : STAXServiceMachine,
'srcfile' : tmpTaskLdif,
'destfile' : taskLdif,
'remotehost' : myLocation }
'Copy schema update ldif file.'
{ 'location' : myLocation,
'srcfile' : '%s/schema/ldifs/%s' % (remote.data,ldifFile),
'destfile' : '%s/%s/config/schema/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME,ldifFile),
'remotehost' : myLocation }
{ 'location' : myLocation,
'dsPath' : myPath,
'taskLabel' : 'Online Schema Task',
'dsHost' : dsInstanceHost,
'dsPort' : dsInstancePort,
'dsBindDn' : dsInstanceDn,
'dsBindPswd' : dsInstancePswd,
'dsTaskLdif' : taskLdif }
{ 'location' : myLocation,
'dsPath' : myPath,
'dsTaskDn' : taskDN,
'dsHost' : dsInstanceHost,
'dsPort' : dsInstancePort,
'dsBindDn' : dsInstanceDn,
'dsBindPswd' : dsInstancePswd }
This function performs a leave lockdown task
Location of target host
Pathname to installation root
Directory server host name
Directory server port number
Bind DN
Bind password
The identifier for the task
'Copy task ldif file.'
{ 'location' : STAXServiceMachine,
'srcfile' : tmpTaskLdif,
'destfile' : taskLdif,
'remotehost' : myLocation }
{ 'location' : myLocation,
'dsPath' : myPath,
'taskLabel' : 'Online Schema Task',
'dsHost' : dsInstanceHost,
'dsPort' : dsInstancePort,
'dsBindDn' : dsInstanceDn,
'dsBindPswd' : dsInstancePswd,
'dsTaskLdif' : taskLdif }
{ 'location' : myLocation,
'dsPath' : myPath,
'dsTaskDn' : taskDN,
'dsHost' : dsInstanceHost,
'dsPort' : dsInstancePort,
'dsBindDn' : dsInstanceDn,
'dsBindPswd' : dsInstancePswd }
This function starts a task using the ldap task interface
Location of target host
Location of target host
Pathname to installation root
Directory server host name
Directory server port number
Bind DN
Bind password
Ldif file for task
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
'%s %s' % (STAFCmd, STAFCmdParams)
'%s' % myLocation
'%s' % STAFCmd
'%s' % STAFCmdParams
'%s' % dsBinPath
['PATH=/bin:/usr/bin:%s' % dsBinPath, 'JAVA_HOME=%s' % JAVA_HOME]
'%s' % dsTaskLdif
{ 'returncode' : STAFCmdRC,
'result' : STAFCmdResult,
'expected' : expectedRC
}
[STAFCmdRC, STAFCmdResult[0][1]]
This function checks a task using the ldap task interface
Location of target host
Dn of the task to be performed
Pathname to installation root
Directory server host name
Directory server port number
Bind DN
Bind password
Number of ldap check tries when checking if task is complete
Sleep time in milliseconds between ldap check tries
'LOOP number %s - %s %s' % (myCounter, STAFCmd, STAFCmdParams)
{ 'name' : 'Search On line Import Task',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'location' : myLocation,
'expectedRC' : 'noCheck'
}
'%s' % STAFCmdResult
[taskRC, STAFCmdResult[0][1]]
'%s' % STAFCmdResult
[taskRC, STAFCmdResult[0][1]]
'%s' % STAFCmdResult
'Sleeping for %s ms' % sleepMilliSeconds
{ 'sleepForMilliSeconds' : sleepMilliSeconds }
[taskRC, STAFCmdResult[0][1]]
This function shows server status using the status script
Location of target host
Pathname to installation root
Bind DN
Bind password
Help option
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
'%s %s' % (STAFCmd, STAFCmdParams)
{ 'location' : location,
'name' : 'Status Script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'path' : dsPath,
'expectedRC': expectedRC,
'knownIssue': knownIssue
}
STAXResult
This function executes the base64 encode decode utility with script
Location of target host
Pathname to installation root
The subcommand for base64 (encode or decode)
The raw data to be base64 encoded
The path to a file containing the raw data to be base64 encoded
The path to a file to which the base64-encoded data should be written
The base64-encoded data to be decoded
The path to a file containing the base64-encoded data to be decoded
The path to a file to which the raw base64-decoded data should be written
Help option
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
'%s %s' % (STAFCmd, STAFCmdParams)
{ 'location' : location,
'name' : 'Base 64 %s Script' % subcommand,
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'path' : dsPath,
'expectedRC': expectedRC,
'knownIssue': knownIssue
}
STAXResult
This function performs a manage-tasks command line
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server admin port number
Bind DN
Bind password
Bind password file
Certificate keystore path
Nickname of certificate for SSL client authentication
SASL bind options
Certificate trust store path
Use StartTLS to secure communication with the server
Certificate trust store PIN
Certificate keystore PIN file
Certificate trust store PIN file
Certificate keystore PIN
Trust all server SSL certificates
Use SSL for secure communication with the server
Specify the task ID to cancel
Display information for a particular task
Display information for a particular task
Use quiet mode (no output)
Display Directory Server version information
Display this usage information
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
'%s %s' % (STAFCmd, STAFCmdParams)
{ 'location' : location,
'envCmd' : [ 'LANG=C' , 'LC_ALL=C' ] ,
'name' : 'manage-tasks Script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'expectedRC' : expectedRC,
'knownIssue' : knownIssue
}
STAXResult
This function execute the rebuild-index tool
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server adminport number
Bind DN
Bind password
Specify the base DN for which to perform the verification
Specify the name of indexes for which to perform the verification
This should be passed as a python array like
[ 'uid','telephonenumber' ]
Rebuild all indexes
Rebuild all degraded indexes
Clear degraded state
Path to temporary directory for index scratch files
Default value is import-tmp
Display this usage information
Display Directory Server version information
Start time for task
Indicates the task is recurring and will be scheduled
according to the value argument expressed in crontab(5)
compatible time/date pattern
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
{
'name' : 'Rebuild index script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'location' : location,
'expectedRC' : expectedRC,
'knownIssue' : knownIssue
}
'Check rebuild-index task successfully completed'
{
'dsPath' : dsPath,
'dsInstanceAdminPort' : dsInstanceAdminPort,
'dsInstanceHost' : dsInstanceHost ,
'dsInstanceDn' : dsInstanceDn ,
'dsInstancePswd' : dsInstancePswd ,
'outputToCheck' : resultString
}
savSTAXResult
This function execute the verify-index tool
Location of target host
Pathname to installation root
Specify the base DN for which to perform the verification
Specify the name of indexes for which to perform the verification
This should be passed as a python array like
[ 'uid','telephonenumber' ]
Verify that an index is clean
Count the number of errors found during the verification
Display this usage information
Display Directory Server version information
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
{
'name' : 'Verify index script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'location' : location,
'expectedRC' : expectedRC,
'knownIssue' : knownIssue
}
STAXResult
This function execute the list-backends tool
Location of target host
Pathname to installation root
Specify the baseDN from which the list-backends utility
should list the backend ID
Specify the backend ID from which the tool should display
the associated base DN
Display this usage information
Display Directory Server version information
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
{
'name' : 'List backends script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'location' : location,
'expectedRC' : expectedRC,
'knownIssue' : knownIssue
}
STAXResult
This function execute the dbtest tool
Location of target host
Pathname to installation root
The subcommand for dbtest
Base DN of the entry container to debug
Backend ID of the local DB backend to debug
Name of the database container to debug
Only show records with keys that should be ordered after the
provided value using the comparator for the database container
Only show records with keys that should be ordered before the
provided value using the comparator for the database container
Skip decoding the local database to their appropriate types.
Only show records whose data is no smaller than the provided value
Only show records whose data is no larger than the provided value
Display this usage information
Display Directory Server version information
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
Known issue. Corresponds to an issue number.
{
'name' : 'Dbtest script',
'command' : STAFCmd,
'arguments' : STAFCmdParams,
'location' : location,
'expectedRC' : expectedRC,
'knownIssue': knownIssue
}
STAXResult