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-2010 Sun Microsystems, Inc. 2788N/A <
function name="_dsconfigCommonArgs">
2788N/A This function resolves common dsconfig arguments
2788N/A <!-- Set property value using dsconfig --> 3951N/A <
function name="dsconfigSet" scope="local">
2788N/A This function modifies a property value using dsconfig
2788N/A <
function-
arg-
def name="location" 2788N/A default="STAF_REMOTE_HOSTNAME">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname" />
3853N/A <
function-
arg-
def name="dsPath" 4153N/A 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" />
3853N/A <
function-
arg-
def name="dsInstanceHost" 3853N/A 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" />
3853N/A <
function-
arg-
def name="dsInstanceAdminPort" 3853N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
3853N/A Directory server admin 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="objectName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="propertyType" type="optional" default="''">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="propertyName" type="optional" default="''">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="attributeName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="attributeValue" type="optional" default="'none'">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="modifyType" type="optional" default="'set'">
2788N/A The modify type. Default value is set.
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>
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>
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
2788N/A <
call function="'_dsconfigCommonArgs'" />
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'Modify dsconfig object',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <!-- Get property value using dsconfig --> 2788N/A <
function name="dsconfigGet" scope="local">
2788N/A This function get a property value using dsconfig
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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" 2788N/A 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="dsInstanceAdminPort" 3853N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
2788N/A Directory server admin port number
3853N/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="objectName" type="required">
2788N/A Object to get,
e.g. password validator. it's used to make the subcommand name get-...-prop
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="propertyType" type="required">
2788N/A Property type to get,
e.g. backend. it's used to make the property type: --backend-name
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="propertyName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="attributeName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="extraParams" type="optional">
2788N/A Optional extra parameters for specific test cases. ie -m
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="expectedAttributeValue" type="optional" default="'none'">
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
3194N/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>
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
2788N/A <
call function="'_dsconfigCommonArgs'" />
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A '%s %s' % (STAFCmd, STAFCmdParams)
2788N/A <
call function="'runCommand'" >
2788N/A { 'name' : 'Get dsconfig object',
2788N/A 'arguments' : STAFCmdParams,
2788N/A STAXReason=STAXResult[0][1]
2788N/A <
if expr="expectedAttributeValue != 'none'">
2788N/A <
call function="'checktestString'">
3194N/A { 'expectedString' : expectedAttributeValue,
3194N/A 'returnString' : STAXReason
2788N/A <!-- generic wrapper on dsconfig --> 2788N/A <!-- can be used to list, get or set a list of attribues --> 2788N/A <
function name="dsconfig" scope="local">
3951N/A This function lists, get or set a list of attributes using dsconfig
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
4153N/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" 2788N/A 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" />
3853N/A <
function-
arg-
def name="dsInstanceAdminPort" 3853N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
3853N/A Directory server admin port number
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="Port number" />
2788N/A <
function-
arg-
def name="dsInstanceDn" 2788N/A default="DIRECTORY_INSTANCE_DN">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN" />
2788N/A <
function-
arg-
def name="dsInstancePswd" 2788N/A default="DIRECTORY_INSTANCE_PSWD">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="subcommand" type="required">
2788N/A dsconfig subcommand to execute
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="objectType" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="objectName" type="optional">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="optionsString" type="optional">
2788N/A String containing the dsconfig options.
e.g. --set enabled:true --set key-store-pin:servercert
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.
3951N/A Wildcard 'noCheck' to not check the RC
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
3951N/A <
function-
arg-
def name="expectedString" type="optional" default="None">
2788N/A Expected return string value.
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="knownIssue" type="optional" default="None">
2788N/A Known issue. Corresponds to an issue number.
2788N/A </
function-
arg-
description>
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
3951N/A <
call function="'_dsconfigCommonArgs'" />
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
3194N/A <
call function="'runCommand'">
2788N/A { 'name' : 'execute dsconfig subcommand',
2788N/A 'arguments' : STAFCmdParams,
2788N/A 'expectedString' : expectedString,
2788N/A <!-- Modify password policy using dsconfig --> 2788N/A <
function name="modifyPwdPolicy">
2788N/A This function modifies a password policy using dsconfig
4153N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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" />
3853N/A <
function-
arg-
def name="dsInstanceHost" 3853N/A 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="dsInstanceAdminPort" 2788N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
2788N/A Directory server admin 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="propertyName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="attributeName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="attributeValue" type="optional" default="'none'">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="modifyType" type="optional" default="'set'">
2788N/A The modify type. Default value is set.
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
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
call function="'dsconfigSet'">
2788N/A 'dsInstanceHost' : dsInstanceHost,
2788N/A 'dsInstanceAdminPort' : dsInstanceAdminPort,
2788N/A 'dsInstanceDn' : dsInstanceDn,
3194N/A 'dsInstancePswd' : dsInstancePswd,
2788N/A 'objectName' : 'password-policy',
2788N/A 'propertyName' : propertyName,
2788N/A 'attributeName' : attributeName,
2788N/A 'attributeValue' : attributeValue,
2788N/A <!-- Modify password validator using dsconfig --> 2788N/A <
function name="modifyPwdValidator">
2788N/A This function modifies a password validator using dsconfig
4153N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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" />
3853N/A <
function-
arg-
def name="dsInstanceHost" 3853N/A 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="dsInstanceAdminPort" 2788N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
2788N/A Directory server admin 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="propertyName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="attributeName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="attributeValue" type="optional" default="'none'">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="modifyType" type="optional" default="'set'">
3951N/A The modify type. Default value is set.
3951N/A </
function-
arg-
description>
3951N/A <
function-
arg-
property name="type" value="string" />
3951N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
3951N/A Expected return code value. Default value is 0
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
3853N/A <
function-
arg-
def name="knownIssue" type="optional" default="None">
3853N/A Known issue. Corresponds to an issue number.
3853N/A </
function-
arg-
description>
3853N/A <
call function="'dsconfigSet'">
3951N/A 'dsInstanceHost' : dsInstanceHost,
3951N/A 'dsInstanceAdminPort' : dsInstanceAdminPort,
2788N/A 'dsInstanceDn' : dsInstanceDn,
2788N/A 'dsInstancePswd' : dsInstancePswd,
2788N/A 'objectName' : 'password-validator',
3194N/A 'propertyType' : 'validator',
2788N/A 'propertyName' : propertyName,
2788N/A 'attributeName' : attributeName,
2788N/A 'attributeValue' : attributeValue,
2788N/A <!-- Modify password policy using dsconfig --> 2788N/A <
function name="modifyGlobal">
2788N/A This function modifies a global attribute value using dsconfig
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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" />
3853N/A <
function-
arg-
def name="dsInstanceHost" 2788N/A default="STAF_REMOTE_HOSTNAME">
3853N/A Directory server hostname or IP address
3853N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname" />
2788N/A <
function-
arg-
def name="dsInstanceAdminPort" 2788N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
2788N/A Directory server admin 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="attributeName" type="required">
2788N/A Attribute to modify,
e.g. bind-with-dn-requires-password
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
3194N/A <
function-
arg-
def name="attributeValue" 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">
2788N/A Expected return code value. Default value is 0.
2788N/A Wildcard 'noCheck' to not check the RC
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
2788N/A <
call function="'_dsconfigCommonArgs'" />
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'Modify dsconfig object',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <!-- Modify identity mapper using dsconfig --> 2788N/A <
function name="modifyIdentityMapper">
2788N/A This function modifies an identity mapper using dsconfig
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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" />
3853N/A <
function-
arg-
def name="dsInstanceHost" 2788N/A default="STAF_REMOTE_HOSTNAME">
3853N/A Directory server hostname or IP address
3853N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname" />
2788N/A <
function-
arg-
def name="dsInstanceAdminPort" 2788N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
2788N/A Directory server admin 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="mapperName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="attributeName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="attributeValue" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="modifyType" type="optional" default="'set'">
2788N/A The modify type. Default value is set.
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">
3853N/A Expected return code value. Default value is 0
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
call function="'dsconfigSet'">
2788N/A 'dsInstanceHost' : dsInstanceHost,
2788N/A 'dsInstanceAdminPort' : dsInstanceAdminPort,
2788N/A 'dsInstanceDn' : dsInstanceDn,
2788N/A 'dsInstancePswd' : dsInstancePswd,
3194N/A 'objectName' : 'identity-mapper',
2788N/A 'propertyName' : mapperName,
2788N/A 'attributeName' : attributeName,
2788N/A 'attributeValue' : attributeValue,
2788N/A <!-- Modify password policy using dsconfig --> 2788N/A <
function name="modifyGlobalAci">
2788N/A This function modifies a global aci using dsconfig
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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" />
3853N/A <
function-
arg-
def name="dsInstanceHost" 2788N/A default="STAF_REMOTE_HOSTNAME">
2788N/A Directory server hostname or IP address
3853N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="hostname" />
2788N/A <
function-
arg-
def name="dsInstanceAdminPort" 2788N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
2788N/A Directory server admin 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="aciValue" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
3194N/A <
function-
arg-
def name="opType" type="optional" default="set">
2788N/A Operation type, one of set, add, and remove
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.
2788N/A Wildcard 'noCheck' to not check the RC
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
2788N/A if is_windows_platform(mylocation):
2788N/A <
call function="'_dsconfigCommonArgs'" />
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'Modify dsconfig object',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <!-- Modify password policy using dsconfig --> 2788N/A <
function name="modifySaslMech">
2788N/A This function modifies a sasl mechanism using dsconfig
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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" />
3853N/A <
function-
arg-
def name="dsInstanceHost" 2788N/A 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="dsInstanceAdminPort" 2788N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
2788N/A Directory server admin 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="handlerName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="propertyName" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="propertyValue" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="modifyType" type="optional" default="'set'">
2788N/A The modify type. Default value is set.
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
3853N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
3853N/A Expected return code value. Default value is 0
3853N/A </
function-
arg-
description>
3853N/A <
function-
arg-
property name="type" value="string" />
3853N/A <
call function="'dsconfigSet'">
3853N/A 'dsInstanceHost' : dsInstanceHost,
2788N/A 'dsInstanceAdminPort' : dsInstanceAdminPort,
2788N/A 'dsInstanceDn' : dsInstanceDn,
2788N/A 'dsInstancePswd' : dsInstancePswd,
3194N/A 'objectName' : 'sasl-mechanism-handler',
2788N/A 'propertyType' : 'handler',
2788N/A 'propertyName' : handlerName,
2788N/A 'attributeName' : propertyName,
2788N/A 'attributeValue' : propertyValue,
2788N/A This function eases adding JEB DB indexes
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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="host" 2788N/A 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="adminPort" 2788N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
2788N/A Directory server admin port number
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="Port number" />
2788N/A <
function-
arg-
def name="rootDN" 2788N/A default="DIRECTORY_INSTANCE_DN">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN" />
2788N/A <
function-
arg-
def name="rootPwd" 2788N/A default="DIRECTORY_INSTANCE_PSWD">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="backendID" 2788N/A default="DIRECTORY_INSTANCE_BE" 2788N/A The Back-end ID on to which to add an index
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
def name="indexAttribute" type="required">
2788N/A ldap attribute on to which to add indexing
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="indexTypes" type="required">
2788N/A This has to be provided as a python array like
2788N/A [ 'presence', 'substring' ]
2788N/A </
function-
arg-
description>
3194N/A <
function-
arg-
property name="type" value="enum">
3194N/A <
function-
arg-
property-
description>
3194N/A This argument can only have one of those values
3194N/A </
function-
arg-
property-
description>
3194N/A <
function-
arg-
property-
data type="choice" value="'equality'" />
3194N/A <
function-
arg-
property-
data type="choice" value="'ordering'" />
3194N/A <
function-
arg-
property-
data type="choice" value="'presence'" />
2788N/A <
function-
arg-
property-
data type="choice" value="'substring'" />
2788N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
2788N/A Expected return code value. Default value is 0.
2788N/A Wildcard 'noCheck' to not check the RC
3853N/A </
function-
arg-
description>
3194N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A dsconfigCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
2788N/A dsconfigParams = 'create-local-db-index -n -X -h %s -p %s -D "%s" -w %s --backend-name %s --index-name %s --set index-type:%s' % (host,adminPort,rootDN,rootPwd,backendID, indexAttribute, ' --set index-type:'.join(indexTypes))
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'dsconfig addIndex',
2788N/A 'arguments' : dsconfigParams,
2788N/A <
function name="modifyIndex">
2788N/A This function eases modifying JEB DB indexes
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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="host" 2788N/A 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="adminPort" 2788N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
2788N/A Directory server admin port number
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="Port number" />
2788N/A <
function-
arg-
def name="rootDN" 2788N/A default="DIRECTORY_INSTANCE_DN">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN" />
2788N/A <
function-
arg-
def name="rootPwd" 2788N/A default="DIRECTORY_INSTANCE_PSWD">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="backendID" 2788N/A default="DIRECTORY_INSTANCE_BE" 2788N/A The Back-end ID on to which to add an index
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
def name="indexAttribute" type="required">
2788N/A ldap attribute on to which add indexing
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="operation">
2788N/A This parameters defines the operation to be performed.
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="enum">
2788N/A <
function-
arg-
property-
description>
2788N/A This argument can only have one of the following values
2788N/A </
function-
arg-
property-
description>
2788N/A <
function-
arg-
property-
data type="choice" value="'add'" />
2788N/A <
function-
arg-
property-
data type="choice" value="'remove'" />
2788N/A <
function-
arg-
property-
data type="choice" value="'reset'" />
2788N/A <
function-
arg-
property-
data type="choice" value="'set'" />
2788N/A <
function-
arg-
def name="indexProperty" type="required">
3194N/A the property to manipulate if the operation is add or set
3194N/A </
function-
arg-
description>
3194N/A <
function-
arg-
property name="type" value="string" />
3194N/A <
function-
arg-
def name="indexPropertyValue" type="optional">
3194N/A the value for the provided property
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.
2788N/A Wildcard 'noCheck' to not check the RC
2788N/A </
function-
arg-
description>
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A dsconfigCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
3194N/A operationArguments = indexProperty
2788N/A operationArguments = '%s:%s' % (indexProperty, indexPropertyValue)
2788N/A dsconfigParams = 'set-local-db-index-prop -n -X -h %s -p %s -D "%s" -w %s --backend-name %s --index-name %s --%s %s' % ( host, adminPort, rootDN, rootPwd, backendID, indexAttribute, operation, operationArguments)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'dsconfig modifyIndex',
2788N/A 'arguments' : dsconfigParams,
2788N/A <
function name="removeIndex">
2788N/A This function eases removing JEB DB indexes from STAX
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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="host" 2788N/A 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="adminPort" 2788N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
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="rootDN" 2788N/A default="DIRECTORY_INSTANCE_DN">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN" />
2788N/A <
function-
arg-
def name="rootPwd" 2788N/A default="DIRECTORY_INSTANCE_PSWD">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="backendID" 2788N/A default="DIRECTORY_INSTANCE_BE" 3194N/A The Back-end ID on to which to remove an index from
3194N/A </
function-
arg-
description>
3194N/A <
function-
arg-
def name="indexAttribute" type="required">
3194N/A ldap attribute on to which to remove indexing
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.
2788N/A Wildcard 'noCheck' to not check the RC
3853N/A </
function-
arg-
description>
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A dsconfigCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
2788N/A dsconfigParams = 'delete-local-db-index -n -X -h %s -p %s -D "%s" -w %s --backend-name %s --index-name %s' % (host,adminPort,rootDN,rootPwd,backendID, indexAttribute)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'dsconfig removeIndex',
2788N/A 'arguments' : dsconfigParams,
2788N/A <!-- Create synchronization provider using dsconfig --> 2788N/A <
function name="createSyncProvider">
2788N/A This function creates a synchronization provider using dsconfig
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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" 2788N/A 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="dsInstanceAdminPort" type="required">
2788N/A Directory server admin 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="providerName" 2788N/A Name for the synchronization provider
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="providerType" 2788N/A Synchronization provider type
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.
2788N/A Wildcard 'noCheck' to not check the RC
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
2788N/A <
call function="'_dsconfigCommonArgs'" />
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'Modify dsconfig object',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <!-- List synchronization providers using dsconfig --> 2788N/A <
function name="listSyncProviders">
2788N/A This function list the synchronization providers using dsconfig
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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" 2788N/A 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="dsInstanceAdminPort" type="required">
2788N/A Directory server admin 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" />
3194N/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="expectedRC" type="optional" default="0">
2788N/A Expected return code value. Default value is 0.
2788N/A Wildcard 'noCheck' to not check the RC
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
2788N/A <
call function="'_dsconfigCommonArgs'" />
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'List synchronization providers',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <!-- Create a replication server using dsconfig --> 2788N/A <
function name="createReplicationServer">
2788N/A This function creates a replication server under a given synchronization provider using dsconfig
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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" 2788N/A 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="dsInstanceAdminPort" type="required">
2788N/A Directory server admin 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="providerName" 2788N/A Name for the synchronization provider
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="replicationPort" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="Port number" />
2788N/A <
function-
arg-
def name="replicationServerId" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="ID number" />
3194N/A <
function-
arg-
def name="replicationServerList" type="required">
2788N/A List of replication servers (as in host:replicationServerPort)
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="list" />
2788N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
2788N/A Expected return code value. Default value is 0.
2788N/A Wildcard 'noCheck' to not check the RC
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
2788N/A for replServer in replicationServerList :
2788N/A <
call function="'_dsconfigCommonArgs'" />
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'Modify dsconfig object',
3361N/A 'arguments' : STAFCmdParams,
3361N/A <!-- Create a replication server using dsconfig --> 3361N/A <
function name="CreateBackendWithScript">
3361N/A This function creates a backend server under a given synchronization provider using dsconfig
4153N/A <
function-
arg-
def name="location" 3361N/A default="STAF_REMOTE_HOSTNAME">
3361N/A </
function-
arg-
description>
3361N/A <
function-
arg-
property name="type" value="hostname" />
3361N/A <
function-
arg-
def name="dsPath" 3361N/A default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
3361N/A Pathname to installation root
3361N/A </
function-
arg-
description>
3853N/A <
function-
arg-
property name="type" value="filepath" />
3853N/A <
function-
arg-
def name="dsInstanceHost" 3361N/A default="STAF_REMOTE_HOSTNAME">
3361N/A Directory server hostname or IP address
3361N/A </
function-
arg-
description>
3361N/A <
function-
arg-
property name="type" value="hostname" />
3361N/A <
function-
arg-
def name="dsInstanceAdminPort" type="required">
3361N/A Directory server admin port number
3361N/A </
function-
arg-
description>
3361N/A <
function-
arg-
property name="type" value="Port number" />
3361N/A <
function-
arg-
def name="dsInstanceDn" type="required">
3361N/A </
function-
arg-
description>
3361N/A <
function-
arg-
property name="type" value="DN" />
3361N/A <
function-
arg-
def name="dsInstancePswd" type="required">
3361N/A </
function-
arg-
description>
3361N/A <
function-
arg-
property name="type" value="string" />
3361N/A <
function-
arg-
def name="dsBackendID" 3361N/A default="DIRECTORY_INSTANCE_BE">
3361N/A </
function-
arg-
description>
3361N/A <
function-
arg-
property name="type" value="string" />
3361N/A <
function-
arg-
def name="dsBaseDN" 3361N/A default="DIRECTORY_INSTANCE_SFX">
3361N/A </
function-
arg-
description>
3361N/A <
function-
arg-
property name="type" value="string" />
3361N/A <
function-
arg-
def name="dsLdapDB" 3361N/A </
function-
arg-
description>
3361N/A <
function-
arg-
property name="type" value="string" />
3361N/A <
function-
arg-
def name="dsImportTempDir" 3361N/A </
function-
arg-
description>
3361N/A <
function-
arg-
property name="type" value="string" />
3361N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
3361N/A Expected return code value. Default value is 0.
3361N/A Wildcard 'noCheck' to not check the RC
3361N/A </
function-
arg-
description>
3361N/A baseDNOption='--set base-dn:"%s"' % dsBaseDN
3361N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
3361N/A STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
3361N/A <
call function="'_dsconfigCommonArgs'" />
3361N/A STAFCmdParams=' '.join(STAFCmdParamsList)
3361N/A <
call function="'runCommand'">
3361N/A { 'name' : 'Modify dsconfig object',
2788N/A 'arguments' : STAFCmdParams,
2788N/A <!-- Create a multimaster domain using dsconfig --> 2788N/A <
function name="createMultimasterDomain">
2788N/A This function creates a multimaster domain under a given synchronization provider using dsconfig
2788N/A <
function-
arg-
def name="location" 2788N/A 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" 2788N/A 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" 2788N/A 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="dsInstanceAdminPort" type="required">
2788N/A Directory server admin 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="providerName" 2788N/A Name for the synchronization provider
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="domainName" type="required">
2788N/A Name for multimaster domain
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A <
function-
arg-
def name="replicationDn" type="required">
2788N/A DN of the replicated suffix
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="DN" />
2788N/A <
function-
arg-
def name="serverId" type="required">
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="ID number" />
3194N/A <
function-
arg-
def name="replicationServerList" type="required">
2788N/A List of replication servers (as in host:replicationServerPort)
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="list" />
2788N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
2788N/A Expected return code value. Default value is 0.
2788N/A Wildcard 'noCheck' to not check the RC
2788N/A </
function-
arg-
description>
2788N/A <
function-
arg-
property name="type" value="string" />
2788N/A dsBinPath='%s/%s' % (dsPath,fileFolder)
2788N/A STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
2788N/A for replServer in replicationServerList :
2788N/A <
call function="'_dsconfigCommonArgs'" />
2788N/A STAFCmdParams=' '.join(STAFCmdParamsList)
2788N/A <
call function="'runCommand'">
2788N/A { 'name' : 'Modify dsconfig object',
3626N/A 'arguments' : STAFCmdParams,
3626N/A <
function name="GetDSConfigProperties">
3626N/A This function get the value of the given server's attributes
3626N/A It will call dsconfig, then extract the attributes value.
3626N/A <
function-
arg-
def name="location" 3626N/A default="STAF_REMOTE_HOSTNAME">
3626N/A </
function-
arg-
description>
3626N/A <
function-
arg-
property name="type" value="hostname" />
3626N/A <
function-
arg-
def name="dsPath" 3626N/A default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
3626N/A Pathname to installation root
3626N/A </
function-
arg-
description>
3626N/A <
function-
arg-
property name="type" value="filepath" />
3853N/A <
function-
arg-
def name="dsInstanceHost" 3626N/A default="STAF_REMOTE_HOSTNAME">
3626N/A Directory server hostname or IP address
3626N/A </
function-
arg-
description>
3626N/A <
function-
arg-
property name="type" value="hostname" />
3626N/A <
function-
arg-
def name="dsInstanceAdminPort" 3626N/A default="DIRECTORY_INSTANCE_ADMIN_PORT">
3626N/A Directory server admin port number
3626N/A </
function-
arg-
description>
3626N/A <
function-
arg-
property name="type" value="Port number" />
3626N/A <
function-
arg-
def name="dsInstanceDn" type="required">
3626N/A </
function-
arg-
description>
3626N/A <
function-
arg-
property name="type" value="DN" />
3626N/A <
function-
arg-
def name="dsInstancePswd" type="required">
3626N/A </
function-
arg-
description>
3626N/A <
function-
arg-
property name="type" value="string" />
3626N/A <
function-
arg-
def name="subcommand" type="required">
3626N/A dsconfig subcommand to execute
3626N/A </
function-
arg-
description>
3626N/A <
function-
arg-
property name="type" value="string" />
3626N/A <
function-
arg-
def name="optionsString" type="optional">
3626N/A String containing the dsconfig options
3626N/A e.g. --backend-name userRoot --property base-dn
3626N/A </
function-
arg-
description>
3626N/A <
function-
arg-
property name="type" value="string" />
3626N/A <
function-
arg-
def name="myVariableName" type="required">
3626N/A Variable containing the dsconfig properties
3626N/A </
function-
arg-
description>
3626N/A <
function-
arg-
property name="type" value="string" />
3626N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
3626N/A Expected return code value. Default value is 0.
3626N/A Wildcard 'noCheck' to not check the RC
3626N/A </
function-
arg-
description>
3626N/A <
function-
arg-
property name="type" value="string" />
3853N/A optionsString = '%s --script-friendly' % optionsString
3853N/A optionsString = '--script-friendly'
3853N/A <
call function="'dsconfig'">
3626N/A 'dsInstanceHost' : dsInstanceHost ,
3626N/A 'dsInstanceAdminPort' : dsInstanceAdminPort ,
3626N/A 'dsInstanceDn' : dsInstanceDn ,
3626N/A 'dsInstancePswd' : dsInstancePswd ,
3626N/A 'subcommand' : subcommand ,
3626N/A 'optionsString' : optionsString ,
3626N/A vars()[myVariableName] = create_property_table(STAXResult[0][1], '\t')
3810N/A <
function name="disconnectReplicationServers">
3810N/A This function breaks the connection among a group of replication servers
3810N/A by resetting the replication-server attribute in the replication server of
3810N/A <
function-
arg-
def name="location" 3810N/A default="STAF_REMOTE_HOSTNAME">
3810N/A </
function-
arg-
description>
3810N/A <
function-
arg-
property name="type" value="hostname" />
3810N/A <
function-
arg-
def name="dsPath" 3810N/A default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
3810N/A Pathname to installation root
3810N/A </
function-
arg-
description>
3810N/A <
function-
arg-
property name="type" value="filepath" />
3810N/A <
function-
arg-
def name="serverList" type="required">
3810N/A List of the servers whose replication servers are to be disconnected.
3810N/A </
function-
arg-
description>
3810N/A <
function-
arg-
property name="type" value="Server-list"/>
3810N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
3810N/A Expected return code value. Default value is 0.
3810N/A Wildcard 'noCheck' to not check the RC
3810N/A </
function-
arg-
description>
3810N/A <
function-
arg-
property name="type" value="string" />
3810N/A <
paralleliterate var="server" in="serverList">
3853N/A 'Disconnecting \nreplication server: %s \nin server: %s' \
3853N/A <!-- Remove peer RS from replicated domain --> 3853N/A <
call function="'dsconfig'">
3810N/A 'subcommand' : 'set-replication-server-prop',
3810N/A 'objectType' : 'provider-name',
3810N/A 'objectName' : 'Multimaster Synchronization',
3810N/A 'optionsString' : '--reset replication-server',
3810N/A <
function name="reconnectReplicationServers">
3810N/A This function re-establishes the connection among a group of replication
3810N/A servers by setting the replication-server attribute in the replication
3810N/A server of a server with the replication servers of a given list of servers
3810N/A <
function-
arg-
def name="location" 3810N/A default="STAF_REMOTE_HOSTNAME">
3810N/A </
function-
arg-
description>
3810N/A <
function-
arg-
property name="type" value="hostname" />
3810N/A <
function-
arg-
def name="dsPath" 3810N/A default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">
3810N/A Pathname to installation root
3810N/A </
function-
arg-
description>
3810N/A <
function-
arg-
property name="type" value="filepath" />
3810N/A <
function-
arg-
def name="serverList" type="required">
3810N/A List of the servers whose replication servers are to be reconnected.
3810N/A </
function-
arg-
description>
3810N/A <
function-
arg-
property name="type" value="Server-list"/>
3810N/A <
function-
arg-
def name="expectedRC" type="optional" default="0">
3810N/A Expected return code value. Default value is 0.
3810N/A Wildcard 'noCheck' to not check the RC
3810N/A </
function-
arg-
description>
3810N/A <
function-
arg-
property name="type" value="string" />
3810N/A <
iterate var="server" in="serverList">
3810N/A optionString = ' '.join(optionList)
3853N/A replServers = ' '.join(replServerList)
3853N/A 'Reconnecting \nreplication servers: %s \nin server: %s:%s' \
3853N/A <!-- Remove peer RS from replicated domain --> 3853N/A <
call function="'dsconfig'">
3810N/A 'subcommand' : 'set-replication-server-prop',
3810N/A 'objectType' : 'provider-name',
3810N/A 'objectName' : 'Multimaster Synchronization',
3810N/A 'optionsString' : optionString,