Skip to content

Commit 4917fa1

Browse files
committed
Add CLI details about dynamic lists
1 parent c87c512 commit 4917fa1

1 file changed

Lines changed: 56 additions & 1 deletion

File tree

docs/389ds/design/dynamic-lists-design.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,62 @@ dynamicListAttr: member
7474

7575
- **dynamicListObjectclass** specifies the objectclass that an entry must have to be considered a dynamic entry
7676
- **dynamicListUrlAttr** specifies the attribute in the dynamic entry that contains the LDAP URI
77-
- **dynamicListAttr** specifies the attribute that will contain the DN of the entries that match the LDAP URI. This attribute stores the DN of an entry, so the attribute configured **MUST** have a DN syntax. Note - this can be bypassed by requesting an attribute in the LDAP URI (See Example section)
77+
- **dynamicListAttr** specifies the attribute that will contain the DN of the entries that match the LDAP URI. This attribute stores the DN of an entry, so the attribute configured **MUST** have a DN syntax. Note - this can be bypassed by requesting an attribute in the LDAP URI (See Examples section)
78+
79+
You can also use a *shared config entry* with this plugin. The benefit here is that the configuration will replicate to all the servers for easier management.
80+
81+
nsslapd-pluginConfigArea: cn=dynamic lists config,dc=example,dc=com
82+
83+
CLI Usage
84+
---------
85+
86+
Here are the core options in the CLI
87+
```
88+
usage: dsconf instance [-v] [-j] plugin dynamic-lists [-h] {show,enable,disable,status,set,config-entry} ...
89+
90+
positional arguments:
91+
{show,enable,disable,status,set,config-entry}
92+
action
93+
show Displays the plugin configuration
94+
enable Enables the plugin
95+
disable Disables the plugin
96+
status Displays the plugin status
97+
set Edit the plugin settings
98+
config-entry Manage the config entry
99+
```
100+
101+
Here are the "set" options
102+
103+
```
104+
usage: dsconf [-v] [-j] instance plugin dynamic-lists set [-h] [--objectclass OBJECTCLASS] [--url-attr URL_ATTR]
105+
[--list-attr LIST_ATTR] [--config-entry CONFIG_ENTRY]
106+
options:
107+
-v, --verbose Display verbose operation tracing during command execution
108+
-j, --json Return result in JSON object
109+
-h, --help show this help message and exit
110+
--objectclass OBJECTCLASS
111+
Specifies the objectclass to identify entry that has a dynamic list (dynamicListObjectclass)
112+
--url-attr URL_ATTR Specifies the attribute that contains the URL of the dynamic list (dynamicListUrlAttr)
113+
--list-attr LIST_ATTR
114+
Specifies the attribute used to store the values of the dynamic list. The attribute must have a DN syntax
115+
(dynamicListAttr)
116+
--config-entry CONFIG_ENTRY
117+
The value to set as nsslapd-pluginConfigArea
118+
```
119+
120+
And finally here are the config-entry options
121+
122+
```
123+
usage: dsconf [-v] [-j] instance plugin dynamic-lists config-entry [-h] {add,set,show,delete} ...
124+
125+
positional arguments:
126+
{add,set,show,delete}
127+
action
128+
add Add the config entry
129+
set Edit the config entry
130+
show Display the config entry
131+
delete Delete the config entry and remove the reference in the plugin entry
132+
```
78133

79134
Examples
80135
--------

0 commit comments

Comments
 (0)