NAME

YaPI::LdapServer

PREFACE

This package is the public Yast2 API to managing a LDAP Server.

SYNOPSIS

use YaPI::LdapServer

$bool = Init()

 Initializes the API, needs to be called first, before any
 other API call.

\@dbList = ReadDatabaseList()

 Returns a list of configured databases.

$bool = AddDatabase(\%valueMap)

 Creates a new database

$bool = EditDatabase($suffix,\%valueMap)

 Edit the database section with the suffix $suffix.

\%valueMap = ReadDatabase($suffix)

 Read the database section with the suffix $suffix.

\@indexList = ReadIndex($suffix)

 Returns a List of Maps with all index statements for this database

$bool = EditIndex($suffix,\%indexMap)

 Add a new index statement %indexMap to the database section

\@aclList = ReadAcl($suffix)

 Returns a List of Maps with the ACL for this database

$bool = WriteAcl($suffix,\@aclList)

 Replace the existing ACLs of a database

\@list = ReadSchemaList()

 Returns a list of all included schema items

$bool = AddSchema($schemaFile)

 Add an additional Schema item

\@list = ReadAllowList()

 Returns a list of allow statements.

$bool = WriteAllowList(\@list)

 Replaces the complete allow option with the specified list

$loglevel = ReadLoglevel()

 Read the loglevel bitmask.

$bool = AddLoglevel($bit)

 Set the given loglevel bit to 1 in the current bitmask.

$bool = DeleteLoglevel($bit)

 Set the given loglevel bit to 0 in the current bitmask.

$bool = WriteLoglevel($loglevel)

 Replaces the loglevel bitmask.

ModifyService($status)

 Turn on/of the LDAP server runnlevel script

SwitchService($status)

 Start/Stop the LDAP server

$status = ReadService()

 Read out the state of the LDAP server runlevel script

\%valueMap = ReadTLS()

 Return the current TLS settings

$bool = WriteTLS(\%valueMap)

 Write the TLS options in the configuration file.

$bool = CheckCommonServerCertificate()

 Check, if a common server certificate is available.

$bool = ConfigureCommonServerCertificate()

 Configure the LDAP server to use the common server certificate.

$bool = ImportCertificates(\%valueMap)

 Import certificates and configure TLS for the LDAP Server.

$bool = ReadSLPEnabled()

 Read if SLP is enabled in /etc/sysconfig/openldap

$bool = WriteSLPEnabled($bool)

 Activate/Deactivate SLP Registering in /etc/sysconfig/openldap

DESCRIPTION