<?xml version="1.0" encoding="UTF-8"?>
|
<adm:package name="org.opends.server.admin.std"
|
xmlns:adm="http://www.opends.org/admin"
|
xmlns:ldap="http://www.opends.org/admin-ldap">
|
<adm:synopsis>
|
Core OpenDS Directory Server administrative components.
|
</adm:synopsis>
|
<adm:property name="listen-port" mandatory="true">
|
<adm:synopsis>
|
Specifies the port number on which the
|
<adm:user-friendly-name />
|
will listen for connections from clients.
|
</adm:synopsis>
|
<adm:description>
|
Only a single port number may be provided.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:syntax>
|
<adm:integer lower-limit="1" upper-limit="65535" />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:oid>1.3.6.1.4.1.26027.1.1.57</ldap:oid>
|
<ldap:name>ds-cfg-listen-port</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="use-ssl">
|
<adm:synopsis>
|
Indicates whether the
|
<adm:user-friendly-name />
|
should use SSL.
|
</adm:synopsis>
|
<adm:description>
|
If enabled, the
|
<adm:user-friendly-name />
|
will use SSL to encrypt communication with the clients.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>false</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:boolean />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:oid>1.3.6.1.4.1.26027.1.1.137</ldap:oid>
|
<ldap:name>ds-cfg-use-ssl</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="ssl-cert-nickname">
|
<adm:TODO>Need a better default description.</adm:TODO>
|
<adm:synopsis>
|
Specifies the nickname (also called the alias) of the certificate
|
that the
|
<adm:user-friendly-name />
|
should use when performing SSL communication.
|
</adm:synopsis>
|
<adm:description>
|
This is only applicable when the
|
<adm:user-friendly-name />
|
is configured to use SSL.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:component-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:alias>
|
<adm:synopsis>
|
Let the server decide.
|
</adm:synopsis>
|
</adm:alias>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string></adm:string>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:oid>1.3.6.1.4.1.26027.1.1.120</ldap:oid>
|
<ldap:name>ds-cfg-ssl-cert-nickname</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="key-store-pin">
|
<adm:synopsis>
|
Specifies the clear-text PIN needed to access the
|
<adm:user-friendly-name />
|
.
|
</adm:synopsis>
|
<adm:description>
|
Changes to this configuration attribute will take effect the next
|
time that the key manager is accessed.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>jks</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:oid>1.3.6.1.4.1.26027.1.1.51</ldap:oid>
|
<ldap:name>ds-cfg-key-store-pin</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="key-store-pin-property">
|
<adm:TODO>Better syntax for property name?</adm:TODO>
|
<adm:synopsis>
|
Specifies the name of the Java property that contains the
|
clear-text PIN needed to access the
|
<adm:user-friendly-name />
|
.
|
</adm:synopsis>
|
<adm:description>
|
Changes to this configuration attribute will take effect the next
|
time that the key manager is accessed.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:undefined />
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:oid>1.3.6.1.4.1.26027.1.1.54</ldap:oid>
|
<ldap:name>ds-cfg-key-store-pin-property</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="key-store-pin-environment-variable">
|
<adm:synopsis>
|
Specifies the name of the environment variable that contains the
|
clear-text PIN needed to access the
|
<adm:user-friendly-name />
|
.
|
</adm:synopsis>
|
<adm:description>
|
Changes to this configuration attribute will take effect the next
|
time that the key manager is accessed.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:undefined />
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:oid>1.3.6.1.4.1.26027.1.1.52</ldap:oid>
|
<ldap:name>ds-cfg-key-store-pin-environment-variable</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="key-store-pin-file">
|
<adm:TODO>Should use a file-based property definition?</adm:TODO>
|
<adm:synopsis>
|
Specifies the path to the text file whose only contents should be
|
a single line containing the clear-text PIN needed to access the
|
<adm:user-friendly-name />
|
.
|
</adm:synopsis>
|
<adm:description>
|
Changes to this configuration attribute will take effect the next
|
time that the key manager is accessed.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:undefined />
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:oid>1.3.6.1.4.1.26027.1.1.53</ldap:oid>
|
<ldap:name>ds-cfg-key-store-pin-file</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="key-manager-provider-dn">
|
<adm:synopsis>
|
Specifies the DN of the configuration entry for the key manager
|
provider that should be used with this
|
<adm:user-friendly-name />
|
.
|
</adm:synopsis>
|
<adm:description>
|
Changes to this attribute will take effect immediately, but only
|
for subsequent attempts to access the key manager provider for
|
associated client connections.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:undefined />
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:dn>
|
<adm:base>cn=key manager providers,cn=config</adm:base>
|
</adm:dn>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:oid>1.3.6.1.4.1.26027.1.1.310</ldap:oid>
|
<ldap:name>ds-cfg-key-manager-provider-dn</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="trust-manager-provider-dn">
|
<adm:synopsis>
|
Specifies the DN of the configuration entry for the trust manager
|
provider that should be used with this
|
<adm:user-friendly-name />
|
.
|
</adm:synopsis>
|
<adm:description>
|
Changes to this attribute will take effect immediately, but only
|
for subsequent attempts to access the trust manager provider for
|
associated client connections.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:undefined />
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:dn>
|
<adm:base>cn=trust manager providers,cn=config</adm:base>
|
</adm:dn>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:oid>1.3.6.1.4.1.26027.1.1.311</ldap:oid>
|
<ldap:name>ds-cfg-trust-manager-provider-dn</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
</adm:package>
|
