<?
xml version="1.0" encoding="UTF-8" standalone="no"?>
! The contents of this file are subject to the terms of the ! Common Development and Distribution License, Version 1.0 only ! (the "License"). You may not use this file except in compliance ! You can obtain a copy of the license at ! See the License for the specific language governing permissions ! and limitations under the License. ! When distributing Covered Code, include this CDDL HEADER in each ! file and include the License file at ! add the following below this CDDL HEADER, with the fields enclosed ! by brackets "[]" replaced with your own identifying information: ! Portions Copyright [yyyy] [name of copyright owner] ! Copyright 2007-2008 Sun Microsystems, Inc. <
function name="_dsconfigCommonArgs">
This function resolves common dsconfig arguments
<!-- Set property value using dsconfig --> <
function name="dsconfigSet" scope="local">
This function modifies a property value using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="objectName" type="required">
<
function-
arg-
description>
Object to modify,
e.g. password validator
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="propertyType" type="optional" default="''">
<
function-
arg-
description>
Property type to modify,
e.g. validator
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="propertyName" type="optional" default="''">
<
function-
arg-
description>
Property to modify,
e.g. enabled
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="attributeName" type="required">
<
function-
arg-
description>
Attribute to modify,
e.g. min-password-length
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="attributeValue" type="optional" default="'none'">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="modifyType" type="optional" default="'set'">
<
function-
arg-
description>
The modify type. Default value is set.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
dsBinPath='%s/%s' % (dsPath,fileFolder)
STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
if modifyType == 'reset':
<
call function="'_dsconfigCommonArgs'" />
STAFCmdParams=' '.join(STAFCmdParamsList)
'%s %s' % (STAFCmd, STAFCmdParams)
<
call function="'runCommand'">
{ 'name' : 'Modify dsconfig object',
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
<!-- Get property value using dsconfig --> <
function name="dsconfigGet" scope="local">
This function get a property value using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="objectName" type="required">
<
function-
arg-
description>
Object to get,
e.g. password validator. it's used to make the subcommand name get-...-prop
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="propertyType" type="required">
<
function-
arg-
description>
Property type to get,
e.g. backend. it's used to make the property type: --backend-name
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="propertyName" type="required">
<
function-
arg-
description>
Property to get,
e.g. userroot
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="attributeName" type="required">
<
function-
arg-
description>
Attribute to get,
e.g. min-password-length
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="extraParams" type="optional">
<
function-
arg-
description>
Optional extra parameters for specific test cases. ie -m
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedAttributeValue" type="optional" default="'none'">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
dsBinPath='%s/%s' % (dsPath,fileFolder)
STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
<
call function="'_dsconfigCommonArgs'" />
STAFCmdParams=' '.join(STAFCmdParamsList)
'%s %s' % (STAFCmd, STAFCmdParams)
<
call function="'runCommand'" >
{ 'name' : 'Get dsconfig object',
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
STAXReason=STAXResult[0][1]
<
if expr="expectedAttributeValue != 'none'">
<
call function="'checktestString'">
{ 'expectedString' : expectedAttributeValue,
'returnString' : STAXReason
<!-- generic wrapper on dsconfig --> <!-- can be used to list, get or set a list of attribues --> <
function name="dsconfig" scope="local">
This function lists, get or set a list of attributes using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" type="optional" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="subcommand" type="required">
<
function-
arg-
description>
dsconfig subcommand to execute
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="objectType" type="optional">
<
function-
arg-
description>
Object type to modify,
e.g. backend-name
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="objectName" type="optional">
<
function-
arg-
description>
object name to modify,
e.g. userroot
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="optionsString" type="optional">
<
function-
arg-
description>
String containing the dsconfig options.
e.g. --set enabled:true --set key-store-pin:servercert
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
dsBinPath='%s/%s' % (dsPath,fileFolder)
STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
<
call function="'_dsconfigCommonArgs'" />
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'">
{ 'name' : 'execute dsconfig subcommand',
'arguments' : STAFCmdParams,
'expectedRC': expectedRC,
<!-- Modify password policy using dsconfig --> <
function name="modifyPwdPolicy">
This function modifies a password policy using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="propertyName" type="required">
<
function-
arg-
description>
Property to modify,
e.g. enabled
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="attributeName" type="required">
<
function-
arg-
description>
Attribute to modify,
e.g. min-password-length
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="attributeValue" type="optional" default="'none'">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="modifyType" type="optional" default="'set'">
<
function-
arg-
description>
The modify type. Default value is set.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
call function="'dsconfigSet'">
'dsInstanceHost' : dsInstanceHost,
'dsInstanceAdminPort' : dsInstanceAdminPort,
'dsInstanceDn' : dsInstanceDn,
'dsInstancePswd' : dsInstancePswd,
'objectName' : 'password-policy',
'propertyType' : 'policy',
'propertyName' : propertyName,
'attributeName' : attributeName,
'attributeValue' : attributeValue,
'modifyType' : modifyType,
'expectedRC' : expectedRC
<!-- Modify password validator using dsconfig --> <
function name="modifyPwdValidator">
This function modifies a password validator using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="propertyName" type="required">
<
function-
arg-
description>
Property to modify,
e.g. enabled
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="attributeName" type="required">
<
function-
arg-
description>
Attribute to modify,
e.g. match-attribute
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="attributeValue" type="optional" default="'none'">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="modifyType" type="optional" default="'set'">
<
function-
arg-
description>
The modify type. Default value is set.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="knownIssue" type="optional" default="None">
<
function-
arg-
description>
Known issue. Corresponds to an issue number.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
call function="'dsconfigSet'">
'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
<!-- Modify password policy using dsconfig --> <
function name="modifyGlobal">
This function modifies a global attribute value using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="attributeName" type="required">
<
function-
arg-
description>
Attribute to modify,
e.g. bind-with-dn-requires-password
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="attributeValue" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
dsBinPath='%s/%s' % (dsPath,fileFolder)
STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
<
call function="'_dsconfigCommonArgs'" />
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'">
{ 'name' : 'Modify dsconfig object',
'arguments' : STAFCmdParams,
<!-- Modify identity mapper using dsconfig --> <
function name="modifyIdentityMapper">
This function modifies an identity mapper using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="mapperName" type="required">
<
function-
arg-
description>
Mapper to modify,
e.g. Exact Match
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="attributeName" type="required">
<
function-
arg-
description>
Attribute to modify,
e.g. match-attribute
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="attributeValue" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="modifyType" type="optional" default="'set'">
<
function-
arg-
description>
The modify type. Default value is set.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
call function="'dsconfigSet'">
'dsInstanceHost' : dsInstanceHost,
'dsInstanceAdminPort' : dsInstanceAdminPort,
'dsInstanceDn' : dsInstanceDn,
'dsInstancePswd' : dsInstancePswd,
'objectName' : 'identity-mapper',
'propertyType' : 'mapper',
'propertyName' : mapperName,
'attributeName' : attributeName,
'attributeValue' : attributeValue,
'modifyType' : modifyType,
'expectedRC' : expectedRC
<!-- Modify password policy using dsconfig --> <
function name="modifyGlobalAci">
This function modifies a global aci using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="aciValue" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="opType" type="optional" default="set">
<
function-
arg-
description>
Operation type, one of set, add, and remove
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
dsBinPath='%s/%s' % (dsPath,fileFolder)
STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
if is_windows_platform(mylocation):
<
call function="'_dsconfigCommonArgs'" />
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'">
{ 'name' : 'Modify dsconfig object',
'arguments' : STAFCmdParams,
<!-- Modify password policy using dsconfig --> <
function name="modifySaslMech">
This function modifies a sasl mechanism using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="handlerName" type="required">
<
function-
arg-
description>
Handle to modify,
e.g. DIGEST-MD5
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="propertyName" type="required">
<
function-
arg-
description>
Property to modify,
e.g. realm
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="propertyValue" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="modifyType" type="optional" default="'set'">
<
function-
arg-
description>
The modify type. Default value is set.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
call function="'dsconfigSet'">
'dsInstanceHost' : dsInstanceHost,
'dsInstanceAdminPort' : dsInstanceAdminPort,
'dsInstanceDn' : dsInstanceDn,
'dsInstancePswd' : dsInstancePswd,
'objectName' : 'sasl-mechanism-handler',
'propertyType' : 'handler',
'propertyName' : handlerName,
'attributeName' : propertyName,
'attributeValue' : propertyValue,
'modifyType' : modifyType,
'expectedRC' : expectedRC
<
function name="addIndex">
This function eases adding JEB DB indexes
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="host" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="adminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="rootDN" default="DIRECTORY_INSTANCE_DN">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="rootPwd" default="DIRECTORY_INSTANCE_PSWD">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="backendID" default="DIRECTORY_INSTANCE_BE" <
function-
arg-
description>
The Back-end ID on to which to add an index
</
function-
arg-
description>
<
function-
arg-
def name="indexAttribute" type="required">
<
function-
arg-
description>
ldap attribute on to which to add indexing
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="indexTypes" type="required">
<
function-
arg-
description>
This has to be provided as a python array like
[ 'presence', 'substring' ]
</
function-
arg-
description>
<
function-
arg-
property name="type" value="enum">
<
function-
arg-
property-
description>
This argument can only have one of those values
</
function-
arg-
property-
description>
<
function-
arg-
property-
data type="choice" value="'equality'" />
<
function-
arg-
property-
data type="choice" value="'ordering'" />
<
function-
arg-
property-
data type="choice" value="'presence'" />
<
function-
arg-
property-
data type="choice" value="'substring'" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
dsBinPath='%s/%s' % (dsPath,fileFolder)
dsconfigCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
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))
<
call function="'runCommand'">
{ 'name' : 'dsconfig addIndex',
'arguments' : dsconfigParams,
<
function name="modifyIndex">
This function eases modifying JEB DB indexes
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="host" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="adminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="rootDN" default="DIRECTORY_INSTANCE_DN">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="rootPwd" default="DIRECTORY_INSTANCE_PSWD">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="backendID" default="DIRECTORY_INSTANCE_BE" <
function-
arg-
description>
The Back-end ID on to which to add an index
</
function-
arg-
description>
<
function-
arg-
def name="indexAttribute" type="required">
<
function-
arg-
description>
ldap attribute on to which add indexing
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="operation">
<
function-
arg-
description>
This parameters defines the operation to be performed.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="enum">
<
function-
arg-
property-
description>
This argument can only have one of the following values
</
function-
arg-
property-
description>
<
function-
arg-
property-
data type="choice" value="'add'" />
<
function-
arg-
property-
data type="choice" value="'remove'" />
<
function-
arg-
property-
data type="choice" value="'reset'" />
<
function-
arg-
property-
data type="choice" value="'set'" />
<
function-
arg-
def name="indexProperty" type="required">
<
function-
arg-
description>
the property to manipulate if the operation is add or set
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="indexPropertyValue" type="optional">
<
function-
arg-
description>
the value for the provided property
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
dsBinPath='%s/%s' % (dsPath,fileFolder)
dsconfigCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
operationArguments = indexProperty
operationArguments = '%s:%s' % (indexProperty, indexPropertyValue)
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)
<
call function="'runCommand'">
{ 'name' : 'dsconfig modifyIndex',
'arguments' : dsconfigParams,
<
function name="removeIndex">
This function eases removing JEB DB indexes from STAX
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="host" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="adminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="rootDN" default="DIRECTORY_INSTANCE_DN">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="rootPwd" default="DIRECTORY_INSTANCE_PSWD">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="backendID" default="DIRECTORY_INSTANCE_BE" <
function-
arg-
description>
The Back-end ID on to which to remove an index from
</
function-
arg-
description>
<
function-
arg-
def name="indexAttribute" type="required">
<
function-
arg-
description>
ldap attribute on to which to remove indexing
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
dsBinPath='%s/%s' % (dsPath,fileFolder)
dsconfigCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
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)
<
call function="'runCommand'">
{ 'name' : 'dsconfig removeIndex',
'arguments' : dsconfigParams,
<!-- Create synchronization provider using dsconfig --> <
function name="createSyncProvider">
This function creates a synchronization provider using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" type="required">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="providerName" default="MultimasterSync">
<
function-
arg-
description>
Name for the synchronization provider
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="providerType" default="MultimasterType">
<
function-
arg-
description>
Synchronization provider type
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
dsBinPath='%s/%s' % (dsPath,fileFolder)
STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
<
call function="'_dsconfigCommonArgs'" />
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'">
{ 'name' : 'Modify dsconfig object',
'arguments' : STAFCmdParams,
<!-- List synchronization providers using dsconfig --> <
function name="listSyncProviders">
This function list the synchronization providers using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" type="required">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
dsBinPath='%s/%s' % (dsPath,fileFolder)
STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
<
call function="'_dsconfigCommonArgs'" />
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'">
{ 'name' : 'List synchronization providers',
'arguments' : STAFCmdParams,
<!-- Create a replication server using dsconfig --> <
function name="createReplicationServer">
This function creates a replication server under a given synchronization provider using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" type="required">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="providerName" default="MultimasterSync">
<
function-
arg-
description>
Name for the synchronization provider
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="replicationPort" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="replicationServerId" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="ID number" />
<
function-
arg-
def name="replicationServerList" type="required">
<
function-
arg-
description>
List of replication servers (as in host:replicationServerPort)
</
function-
arg-
description>
<
function-
arg-
property name="type" value="list" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
dsBinPath='%s/%s' % (dsPath,fileFolder)
STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
for replServer in replicationServerList :
<
call function="'_dsconfigCommonArgs'" />
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'">
{ 'name' : 'Modify dsconfig object',
'arguments' : STAFCmdParams,
<!-- Create a replication server using dsconfig --> <
function name="CreateBackendWithScript">
This function creates a backend server under a given synchronization provider using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" type="required">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="dsBackendID" default="DIRECTORY_INSTANCE_BE">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="dsBaseDN" default="DIRECTORY_INSTANCE_SFX">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="dsLdapDB" <
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="dsImportTempDir" <
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
baseDNOption='--set base-dn:"%s"' % dsBaseDN
dsBinPath='%s/%s' % (dsPath,fileFolder)
STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
<
call function="'_dsconfigCommonArgs'" />
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'">
{ 'name' : 'Modify dsconfig object',
'arguments' : STAFCmdParams,
<!-- Create a multimaster domain using dsconfig --> <
function name="createMultimasterDomain">
This function creates a multimaster domain under a given synchronization provider using dsconfig
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" type="required">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="providerName" default="MultimasterSync">
<
function-
arg-
description>
Name for the synchronization provider
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="domainName" type="required">
<
function-
arg-
description>
Name for multimaster domain
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="replicationDn" type="required">
<
function-
arg-
description>
DN of the replicated suffix
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="serverId" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="ID number" />
<
function-
arg-
def name="replicationServerList" type="required">
<
function-
arg-
description>
List of replication servers (as in host:replicationServerPort)
</
function-
arg-
description>
<
function-
arg-
property name="type" value="list" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
dsBinPath='%s/%s' % (dsPath,fileFolder)
STAFCmd='%s/%s%s' % (dsBinPath,DSCONFIG,fileExt)
for replServer in replicationServerList :
<
call function="'_dsconfigCommonArgs'" />
STAFCmdParams=' '.join(STAFCmdParamsList)
<
call function="'runCommand'">
{ 'name' : 'Modify dsconfig object',
'arguments' : STAFCmdParams,
<
function name="GetDSConfigProperties">
This function get the value of the given server's attributes
It will call dsconfig, then extract the attributes value.
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="dsInstanceHost" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
Directory server hostname or IP address
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsInstanceAdminPort" default="DIRECTORY_INSTANCE_ADMIN_PORT">
<
function-
arg-
description>
Directory server admin port number
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Port number" />
<
function-
arg-
def name="dsInstanceDn" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="DN" />
<
function-
arg-
def name="dsInstancePswd" type="required">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="subcommand" type="required">
<
function-
arg-
description>
dsconfig subcommand to execute
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="optionsString" type="optional">
<
function-
arg-
description>
String containing the dsconfig options
e.g. --backend-name userRoot --property base-dn
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="myVariableName" type="required">
<
function-
arg-
description>
Variable containing the dsconfig properties
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
optionsString = '%s --script-friendly' % optionsString
optionsString = '--script-friendly'
<
call function="'dsconfig'">
'dsInstanceHost' : dsInstanceHost ,
'dsInstanceAdminPort' : dsInstanceAdminPort ,
'dsInstanceDn' : dsInstanceDn ,
'dsInstancePswd' : dsInstancePswd ,
'subcommand' : subcommand ,
'optionsString' : optionsString ,
'expectedRC' : expectedRC
vars()[myVariableName] = create_property_table(STAXResult[0][1], '\t')
<
function name="disconnectReplicationServers">
This function breaks the connection among a group of replication servers
by resetting the replication-server attribute in the replication server of
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="serverList" type="required">
<
function-
arg-
description>
List of the servers whose replication servers are to be disconnected.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Server-list"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
<
paralleliterate var="server" in="serverList">
'Disconnecting \nreplication server: %s \nin server: %s' \
% (replServer, ldapServer)
<!-- Remove peer RS from replicated domain --> <
call function="'dsconfig'">
'subcommand' : 'set-replication-server-prop',
'objectType' : 'provider-name',
'objectName' : 'Multimaster Synchronization',
'optionsString' : '--reset replication-server',
'expectedRC' : expectedRC
<
function name="reconnectReplicationServers">
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
<
function-
arg-
def name="location" default="STAF_REMOTE_HOSTNAME">
<
function-
arg-
description>
</
function-
arg-
description>
<
function-
arg-
property name="type" value="hostname" />
<
function-
arg-
def name="dsPath" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
<
function-
arg-
description>
Pathname to installation root
</
function-
arg-
description>
<
function-
arg-
property name="type" value="filepath" />
<
function-
arg-
def name="serverList" type="required">
<
function-
arg-
description>
List of the servers whose replication servers are to be reconnected.
</
function-
arg-
description>
<
function-
arg-
property name="type" value="Server-list"/>
<
function-
arg-
def name="expectedRC" type="optional" default="0">
<
function-
arg-
description>
Expected return code value. Default value is 0.
Wildcard 'noCheck' to not check the RC
</
function-
arg-
description>
<
function-
arg-
property name="type" value="string" />
mainServer = serverList[0]
<
iterate var="server" in="serverList">
optionString = ' '.join(optionList)
replServers = ' '.join(replServerList)
'Reconnecting \nreplication servers: %s \nin server: %s:%s' \
<!-- Remove peer RS from replicated domain --> <
call function="'dsconfig'">
'subcommand' : 'set-replication-server-prop',
'objectType' : 'provider-name',
'objectName' : 'Multimaster Synchronization',
'optionsString' : optionString,
'expectedRC' : expectedRC