This function resolves common dsconfig arguments
This function modifies a property value using dsconfig
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
Object to modify, e.g. password validator
Property type to modify, e.g. validator
Property to modify, e.g. enabled
Attribute to modify, e.g. minimum-password-length
New attribute value
Expected return code value. Default value is 0
'%s %s' % (STAFCmd, STAFCmdParams)
'%s' % location
'%s' % STAFCmd
'%s' % STAFCmdParams
'%s' % dsBinPath
['PATH=/bin:/usr/bin:%s' % dsBinPath]
STAXReason
This function modifies a password policy using dsconfig
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
Property to modify, e.g. enabled
Attribute to modify, e.g. minimum-password-length
New attribute value
Expected return code value. Default value is 0
{ 'location' : '%s' % location ,
'dsPath' : '%s' % dsPath ,
'dsInstanceHost' : '%s' % dsInstanceHost ,
'dsInstancePort' : '%s' % dsInstancePort ,
'dsInstanceDn' : '%s' % dsInstanceDn ,
'dsInstancePswd' : '%s' % dsInstancePswd ,
'objectName' : 'password-policy' ,
'propertyType' : 'policy' ,
'propertyName' : '%s' % (propertyName) ,
'attributeName' : '%s' % (attributeName) ,
'attributeValue' : '%s' % (attributeValue) ,
'expectedRC' : expectedRC }
{ 'returncode' : STAXCode ,
'result' : STAXReason ,
'expected' : expectedRC }
STAXReason
This function modifies a global attribute value using dsconfig
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
Attribute to modify, e.g. bind-with-dn-requires-password
New attribute value
Expected return code value. Default value is 0
'%s %s' % (STAFCmd, STAFCmdParams)
'%s' % location
'%s' % STAFCmd
'%s' % STAFCmdParams
'%s' % dsBinPath
['PATH=/bin:/usr/bin:%s' % dsBinPath]
{ 'returncode' : STAXCode ,
'result' : STAXReason ,
'expected' : expectedRC }
STAXReason
This function modifies an identity mapper using dsconfig
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
Mapper to modify, e.g. Exact Match
Attribute to modify, e.g. match-attribute
New attribute value
Expected return code value. Default value is 0
{ 'location' : '%s' % location ,
'dsPath' : '%s' % dsPath ,
'dsInstanceHost' : '%s' % dsInstanceHost ,
'dsInstancePort' : '%s' % dsInstancePort ,
'dsInstanceDn' : '%s' % dsInstanceDn ,
'dsInstancePswd' : '%s' % dsInstancePswd ,
'objectName' : 'identity-mapper' ,
'propertyType' : 'mapper' ,
'propertyName' : '%s' % (mapperName) ,
'attributeName' : '%s' % (attributeName) ,
'attributeValue' : '%s' % (attributeValue) ,
'expectedRC' : expectedRC }
{ 'returncode' : STAXCode ,
'result' : STAXReason ,
'expected' : expectedRC }
STAXReason
This function modifies a global aci using dsconfig
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
New property value
Operation type, one of set, add, and remove
Expected return code value. Default value is 0
'%s %s' % (STAFCmd, STAFCmdParams)
'%s' % location
'%s' % STAFCmd
'%s' % STAFCmdParams
'%s' % dsBinPath
['PATH=/bin:/usr/bin:%s' % dsBinPath, 'JAVA_HOME=%s' % JAVA_HOME]
{ 'returncode' : STAXCode ,
'result' : STAXReason ,
'expected' : expectedRC }
STAXReason
This function modifies a sasl mechanism using dsconfig
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
Handle to modify, e.g. DIGEST-MD5
Property to modify, e.g. realm
New property value
Expected return code value. Default value is 0
{ 'location' : '%s' % location ,
'dsPath' : '%s' % dsPath ,
'dsInstanceHost' : '%s' % dsInstanceHost ,
'dsInstancePort' : '%s' % dsInstancePort ,
'dsInstanceDn' : '%s' % dsInstanceDn ,
'dsInstancePswd' : '%s' % dsInstancePswd ,
'objectName' : 'sasl-mechanism-handler' ,
'propertyType' : 'handler' ,
'propertyName' : '%s' % (handlerName) ,
'attributeName' : '%s' % (propertyName) ,
'attributeValue' : '%s' % (propertyValue) ,
'expectedRC' : expectedRC }
{ 'returncode' : STAXCode ,
'result' : STAXReason ,
'expected' : expectedRC }
STAXReason
This function eases adding JEB DB indexes
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
The Back-end ID on to which to add an index
ldap attribute on to which to add indexing
type of index to add
This has to be provided as a python array like
[ 'presence', 'substring' ]
This argument can only have one of those values
'Running [%s %s]' % (dsconfigCmd, dsconfigParams)
'%s' % location
'%s' % dsconfigCmd
'%s' % dsconfigParams
'%s' % dsBinPath
['PATH=/bin:/usr/bin:%s' % dsBinPath, 'JAVA_HOME=%s' % JAVA_HOME]
'%s returned [%s] with [%s]' % (dsconfigCmd, RC,STAXResult)
RC, STAXResult
This function eases modifying JEB DB indexes
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
The Back-end ID on to which to add an index
ldap attribute on to which add indexing
This parameters defines the operation to be performed.
This argument can only have one of the following values
the property to manipulate if the operation is add or set
the value for the provided property
'%s %s' % (dsconfigCmd, dsconfigParams)
'%s' % location
'%s' % dsconfigCmd
'%s' % dsconfigParams
'%s' % dsBinPath
['PATH=/bin:/usr/bin:%s' % dsBinPath, 'JAVA_HOME=%s' % JAVA_HOME]
STAXReason
This function eases removing JEB DB indexes from STAX
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
The Back-end ID on to which to remove an index from
ldap attribute on to which to remove indexing
'Running [%s %s]' % (dsconfigCmd, dsconfigParams)
'%s' % location
'%s' % dsconfigCmd
'%s' % dsconfigParams
'%s' % dsBinPath
['PATH=/bin:/usr/bin:%s' % dsBinPath, 'JAVA_HOME=%s' % JAVA_HOME]
'%s returned [%s] with [%s]' % (dsconfigCmd, RC,STAXResult)
RC, STAXResult
This function creates a synchronization provider using dsconfig
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
Name for the synchronization provider
Synchronization provider type
Expected return code value. Default value is 0
'%s %s' % (STAFCmd, STAFCmdParams)
'%s' % location
'%s' % STAFCmd
'%s' % STAFCmdParams
'%s' % dsBinPath
['PATH=/bin:/usr/bin:%s' % dsBinPath]
{ 'returncode' : STAXCode ,
'result' : STAXReason ,
'expected' : expectedRC }
STAXReason
This function creates a replication server under a given synchronization provider using dsconfig
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
Name for the synchronization provider
Replication port number
Replication server ID
List of replication servers (as in host:replicationServerPort)
Expected return code value. Default value is 0
'%s %s' % (STAFCmd, STAFCmdParams)
'%s' % location
'%s' % STAFCmd
'%s' % STAFCmdParams
'%s' % dsBinPath
['PATH=/bin:/usr/bin:%s' % dsBinPath]
{ 'returncode' : STAXCode ,
'result' : STAXReason ,
'expected' : expectedRC }
STAXReason
This function creates a multimaster domain under a given synchronization provider using dsconfig
Location of target host
Pathname to installation root
Directory server hostname or IP address
Directory server port number
Bind DN
Bind password
Name for the synchronization provider
Name for multimaster domain
DN of the replicated suffix
Server ID
List of replication servers (as in host:replicationServerPort)
Expected return code value. Default value is 0
'%s %s' % (STAFCmd, STAFCmdParams)
'%s' % location
'%s' % STAFCmd
'%s' % STAFCmdParams
'%s' % dsBinPath
['PATH=/bin:/usr/bin:%s' % dsBinPath]
{ 'returncode' : STAXCode ,
'result' : STAXReason ,
'expected' : expectedRC }
STAXReason