OpenLDAP
OpenLDAP Lightweight Directory Access Protocol Server
Overview
OpenLDAP:
OpenLDAP Lightweight Directory Access Protocol Server
This is a minimal implementation of a service module to support deployment of the OpenLDAP "slapd" process.
The assumption is made that "slapd" will run as the ControlTier framework user on a non-standard, non-privileged port.
Additionally, the OpenLDAP package must be pre-installed on the system and the "slapd.conf" file manually configured. A future version of this module will no doubt generate this configuration file from model data and a template.
Design
- Super Type
- Service
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name |
Constraints
Allowed Child Dependencies
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- Node
- Site
Attributes
Exported Attributes
| Name | Property | Description |
|---|---|---|
| basedir | deployment-basedir |
Base directory location for "etc/openldap/slapd.conf" and other runtime files. |
| install-root | deployment-install-root |
OpenLDAP installation directory locating "libexec/slapd". |
Defaults for Imported Attributes
| Name | Default | Description |
|---|---|---|
| timeout | 10 |
Start/stop command default timeout in seconds. |
| urlList | ldap://*:3890/ |
Default URL list used to start "slapd" on a non-privileged port. |
Commands
assertServiceIsDown
Check whether the OpenLDAP "slapd" process is down
- Usage
- assertServiceIsDown [-basedir <>]
Options
| Option | Description |
|---|---|
| basedir | Base directory |
assertServiceIsUp
Check whether the OpenLDAP "slapd" process is up
- Usage
- assertServiceIsUp [-basedir <>]
Options
| Option | Description |
|---|---|
| basedir | Base directory |
startService
Start the OpenLDAP "slapd" process
- Usage
- startService [-basedir <>] [-installroot <>] [-timeout <>] [-urllist <>]
Options
| Option | Description |
|---|---|
| basedir | Base directory |
| installroot | Installation directory |
| timeout | Timeout in seconds |
| urllist | List of URLs to serve |
stopService
Stop the OpenLDAP "slapd" process
- Usage
- stopService [-basedir <>] [-timeout <>]
Options
| Option | Description |
|---|---|
| basedir | Base directory |
| timeout | Timeout in seconds |
Related Types
The following types are defined for use with OpenLDAP.
OpenLDAPSetting
Overview
OpenLDAPSetting:
OpenLDAP configuration setting
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |
OpenLDAPTimeout
Overview
OpenLDAPTimeout:
Startup and shutdown timeout period in seconds
Design
- Super Type
- OpenLDAPSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| timeout | settingValue |
OpenLDAPUrlList
Overview
OpenLDAPUrlList:
Startup and shutdown timeout period in seconds
Design
- Super Type
- OpenLDAPSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| urlList | settingValue |