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 admin 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. min-password-length New attribute value The modify type. Default value is set. 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) { 'name' : 'Modify dsconfig object', 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'expectedRC': expectedRC, 'knownIssue': knownIssue } STAXResult This function get a property value using dsconfig Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin port number Bind DN Bind password Object to get, e.g. password validator. it's used to make the subcommand name get-...-prop Property type to get, e.g. backend. it's used to make the property type: --backend-name Property to get, e.g. userroot Attribute to get, e.g. min-password-length Optional extra parameters for specific test cases. ie -m expected attribute value 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) { 'name' : 'Get dsconfig object', 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'expectedRC': expectedRC, 'knownIssue': knownIssue } { 'expectedString' : expectedAttributeValue, 'returnString' : STAXReason } STAXReason This function lists, get or set a list of attributes using dsconfig Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin port number Bind DN Bind password dsconfig subcommand to execute Object type to modify, e.g. backend-name object name to modify, e.g. userroot String containing the dsconfig options. e.g. --set enabled:true --set key-store-pin:servercert Expected return code value. Default value is 0. Wildcard 'noCheck' to not check the RC Known issue. Corresponds to an issue number. { 'name' : 'execute dsconfig subcommand', 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'expectedRC': expectedRC, 'knownIssue': knownIssue } STAXResult This function modifies a password policy using dsconfig Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin port number Bind DN Bind password Property to modify, e.g. enabled Attribute to modify, e.g. min-password-length New attribute value The modify type. Default value is set. Expected return code value. Default value is 0 { 'location' : location, 'dsPath' : dsPath, 'dsInstanceHost' : dsInstanceHost, 'dsInstanceAdminPort' : dsInstanceAdminPort, 'dsInstanceDn' : dsInstanceDn, 'dsInstancePswd' : dsInstancePswd, 'objectName' : 'password-policy', 'propertyType' : 'policy', 'propertyName' : propertyName, 'attributeName' : attributeName, 'attributeValue' : attributeValue, 'modifyType' : modifyType, 'expectedRC' : expectedRC } STAXResult This function modifies a password validator using dsconfig Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin port number Bind DN Bind password Property to modify, e.g. enabled Attribute to modify, e.g. match-attribute New attribute value The modify type. Default value is set. Expected return code value. Default value is 0 Known issue. Corresponds to an issue number. { 'location' : location, 'dsPath' : dsPath, 'dsInstanceHost' : dsInstanceHost, 'dsInstanceAdminPort' : dsInstanceAdminPort, 'dsInstanceDn' : dsInstanceDn, 'dsInstancePswd' : dsInstancePswd, 'objectName' : 'password-validator', 'propertyType' : 'validator', 'propertyName' : propertyName, 'attributeName' : attributeName, 'attributeValue' : attributeValue, 'modifyType' : modifyType, 'expectedRC' : expectedRC, 'knownIssue' : knownIssue } STAXResult 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 admin 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. Wildcard 'noCheck' to not check the RC { 'name' : 'Modify dsconfig object', 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'expectedRC': expectedRC } STAXResult This function modifies an identity mapper using dsconfig Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin port number Bind DN Bind password Mapper to modify, e.g. Exact Match Attribute to modify, e.g. match-attribute New attribute value The modify type. Default value is set. Expected return code value. Default value is 0 { 'location' : location, 'dsPath' : dsPath, 'dsInstanceHost' : dsInstanceHost, 'dsInstanceAdminPort' : dsInstanceAdminPort, 'dsInstanceDn' : dsInstanceDn, 'dsInstancePswd' : dsInstancePswd, 'objectName' : 'identity-mapper', 'propertyType' : 'mapper', 'propertyName' : mapperName, 'attributeName' : attributeName, 'attributeValue' : attributeValue, 'modifyType' : modifyType, 'expectedRC' : expectedRC } STAXResult This function modifies a global aci using dsconfig Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin 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. Wildcard 'noCheck' to not check the RC { 'name' : 'Modify dsconfig object', 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'expectedRC': expectedRC } STAXResult This function modifies a sasl mechanism using dsconfig Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin port number Bind DN Bind password Handle to modify, e.g. DIGEST-MD5 Property to modify, e.g. realm New property value The modify type. Default value is set. Expected return code value. Default value is 0 { 'location' : location, 'dsPath' : dsPath, 'dsInstanceHost' : dsInstanceHost, 'dsInstanceAdminPort' : dsInstanceAdminPort, 'dsInstanceDn' : dsInstanceDn, 'dsInstancePswd' : dsInstancePswd, 'objectName' : 'sasl-mechanism-handler', 'propertyType' : 'handler', 'propertyName' : handlerName, 'attributeName' : propertyName, 'attributeValue' : propertyValue, 'modifyType' : modifyType, 'expectedRC' : expectedRC } STAXResult This function eases adding JEB DB indexes Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin 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 Expected return code value. Default value is 0. Wildcard 'noCheck' to not check the RC { 'name' : 'dsconfig addIndex', 'location' : location, 'command' : dsconfigCmd, 'arguments' : dsconfigParams, 'expectedRC': expectedRC } STAXResult This function eases modifying JEB DB indexes Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin 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 Expected return code value. Default value is 0. Wildcard 'noCheck' to not check the RC { 'name' : 'dsconfig modifyIndex', 'location' : location, 'command' : dsconfigCmd, 'arguments' : dsconfigParams, 'expectedRC': expectedRC } STAXResult 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 Expected return code value. Default value is 0. Wildcard 'noCheck' to not check the RC { 'name' : 'dsconfig removeIndex', 'location' : location, 'command' : dsconfigCmd, 'arguments' : dsconfigParams, 'expectedRC': expectedRC } 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 admin port number Bind DN Bind password Name for the synchronization provider Synchronization provider type Expected return code value. Default value is 0. Wildcard 'noCheck' to not check the RC { 'name' : 'Modify dsconfig object', 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'expectedRC': expectedRC } STAXResult This function list the synchronization providers using dsconfig Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin port number Bind DN Bind password Expected return code value. Default value is 0. Wildcard 'noCheck' to not check the RC { 'name' : 'List synchronization providers', 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'expectedRC': expectedRC } STAXResult 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 admin 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. Wildcard 'noCheck' to not check the RC { 'name' : 'Modify dsconfig object', 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'expectedRC': expectedRC } STAXResult This function creates a backend server under a given synchronization provider using dsconfig Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin port number Bind DN Bind password Name backend base dn back end db for based dn temporary import dir Expected return code value. Default value is 0. Wildcard 'noCheck' to not check the RC { 'name' : 'Modify dsconfig object', 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'expectedRC': expectedRC } STAXResult 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 admin 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. Wildcard 'noCheck' to not check the RC { 'name' : 'Modify dsconfig object', 'location' : location, 'command' : STAFCmd, 'arguments' : STAFCmdParams, 'expectedRC': expectedRC } STAXResult This function get the value of the given server's attributes It will call dsconfig, then extract the attributes value. Location of target host Pathname to installation root Directory server hostname or IP address Directory server admin port number Bind DN Bind password dsconfig subcommand to execute e.g. get-backend-prop String containing the dsconfig options e.g. --backend-name userRoot --property base-dn Variable containing the dsconfig properties Expected return code value. Default value is 0. Wildcard 'noCheck' to not check the RC { 'location' : location , 'dsPath' : dsPath , 'dsInstanceHost' : dsInstanceHost , 'dsInstanceAdminPort' : dsInstanceAdminPort , 'dsInstanceDn' : dsInstanceDn , 'dsInstancePswd' : dsInstancePswd , 'subcommand' : subcommand , 'optionsString' : optionsString , 'expectedRC' : expectedRC } STAXResult This function breaks the connection among a group of replication servers by resetting the replication-server attribute in the replication server of a given list of servers. Location of target host Pathname to installation root List of the servers whose replication servers are to be disconnected. Expected return code value. Default value is 0. Wildcard 'noCheck' to not check the RC 'Disconnecting \nreplication server: %s \nin server: %s' \ % (replServer, ldapServer) { 'location' : server.getHostname(), 'dsPath' : '%s/%s' % (server.getDir(),OPENDSNAME), 'dsInstanceHost' : server.getHostname(), 'dsInstanceAdminPort' : server.getAdminPort(), 'dsInstanceDn' : server.getRootDn(), 'dsInstancePswd' : server.getRootPwd(), 'subcommand' : 'set-replication-server-prop', 'objectType' : 'provider-name', 'objectName' : 'Multimaster Synchronization', 'optionsString' : '--reset replication-server', 'expectedRC' : expectedRC } STAXResult This function re-establishes the connection among a group of replication servers by setting the replication-server attribute in the replication server of a server with the replication servers of a given list of servers Location of target host Pathname to installation root List of the servers whose replication servers are to be reconnected. Expected return code value. Default value is 0. Wildcard 'noCheck' to not check the RC 'Reconnecting \nreplication servers: %s \nin server: %s:%s' \ % (replServers, mainServer.getHostname(), mainServer.getPort()) { 'location' : mainServer.getHostname(), 'dsPath' : '%s/%s' \ % (mainServer.getDir(),OPENDSNAME), 'dsInstanceHost' : mainServer.getHostname(), 'dsInstanceAdminPort' : mainServer.getAdminPort(), 'dsInstanceDn' : mainServer.getRootDn(), 'dsInstancePswd' : mainServer.getRootPwd(), 'subcommand' : 'set-replication-server-prop', 'objectType' : 'provider-name', 'objectName' : 'Multimaster Synchronization', 'optionsString' : optionString, 'expectedRC' : expectedRC } STAXResult