6 Library Oracle Virtual Directory WLST commands

Use these custom WebLogic Scripting Tool (WLST) commands to manage Library Oracle Virtual Directory.

The Library Oracle Virtual Directory commands section lists the Library Oracle Virtual Directory WLST commands and contains links to the command reference details.

6.1 Library Oracle Virtual Directory WLST Commands

This chapter describes the Library Oracle Virtual Directory (libOVD) WLST commands.

Use the WLST commands listed in Table 6-1 to manage a libOVD configuration associated with a specific Oracle Platform Security Services (OPSS) context.

Table 6-1 WLST libOVD Commands

Use this command...	To...	Use with WLST...
addDNAttribute	Add an attribute to the DN attributes list for an existing adapter.	Online
activateLibOVDConfigChanges	Reload the libOVD configuration.	Online
addAttributeExclusionRule	Add a attribute exclusion rule.	Online
addAttributeRule	Add a new attribute mapping rule.	Online
addDomainExclusionRule	Add a domain exclusion rule.	Online
addDomainRule	Add a new domain mapping rule.	Online
addJoinRule	Add a join rule to an existing Join Adapter for a libOVD configuration.	Online
addLDAPHost	Add a new remote host to an existing LDAP adapter.	Online
addMappingContext	Create a new mapping context.	Online
addPlugin	Add a plug-in to an existing adapter or at the global level.	Online
addPluginParam	Add new parameter values to the existing adapter level plug-in or global plug-in.	Online
addToRequestControlExcludeList	Add a control to the Request Control Exclude List for an existing LDAP adapter configuration.	Online
addToRequestControlIncludeList	Add a control to the Request Control Include List for an existing LDAP adapter configuration.	Online
assignViewToAdapter	Assign the given view to an adapter.	Online
createJoinAdapter	Create a new Join Adapter for a libOVD configuration.	Online
createLDAPAdapter	Create a new LDAP adapter for a libOVD configuration.	Online
createLDAPAdapterWithDefaultPlugins	Create a new LDAP adapter with default plug-ins based on the specified directory type.	Online
createView	Create a new view.	Online
deleteAdapter	Delete an existing adapter for a libOVD configuration.	Online
deleteAttributeExclusionRule	Delete a attribute exclusion rule.	Online
deleteAttributeRule	Delete a attribute mapping rule.	Online
deleteDomainExclusionRule	Delete a domain exclusion rule.	Online
deleteDomainRule	Delete a domain mapping rule.	Online
deleteMappingContext	Delete the specified mapping context.	Online
deleteView	Delete the specified view.	Online
getAdapterDetails	Display the details of an existing adapter for a libOVD configuration.	Online
listAdapters	List the name and type of all adapters that are configured for a libOVD configuration.	Online
listAllMappingContextIds	List all the mapping contexts.	Online
listAttributeRules	List all the attribute rules.	Online
listDomainRules	List all the domain rules.	Online
listViews	List all views	Online
modifyLDAPAdapter	Modify the existing LDAP adapter configuration.	Online
modifySocketOptions	Modify the socket options for an existing LDAP adapter configuration.	Online
removeAllRequestControlExcludeList	Remove all controls from the Request Control Exclude List for an existing LDAP adapter configuration.	Online
removeAllRequestControlIncludeList	Remove all controls from a Request Control Include List for an existing LDAP adapter configuration.	Online
removeDNAttribute	Remove an attribute from the DN attributes list for an existing LDAP adapter configuration.	Online
removeFromRequestControlExcludeList	Remove a control from the Request Control Exclude List for an existing LDAP adapter configuration.	Online
removeFromRequestControlIncludeList	Removes a control from the Request Control Include List for an existing LDAP adapter configuration.	Online
removeJoinRule	Remove a join rule from a Join Adapter configured for a libOVD configuration.	Online
removeLDAPHost	Remove a remote host from an existing LDAP adapter configuration.	Online
removePlugin	Remove a plug-in from an existing adapter or at the global level.	Online
removePluginParam	Remove an existing parameter from a configured adapter level plug-in or global plug-in.	Online
replacePluginParam	Replace existing parameter values for an adapter level plug-in or global plug-in.	Online
unassignViewFromAdapter	Un-assign a view from an adapter.	Online
listSSLStoreType	List the type of SSL store in use for libOVD.	Online
enableKSSForSSL	Enable KSS for libOVD.	Online
enableJKSForSSL	Enable JKS for libOVD.	Online
createKeyStoreAndEnableJKSForSSL	Enable JKS for libOVD.	Online
importTrustedCertificateIntoSSLStore	Import given trusted certificate into SSL store.	Online
migrateAllTrustedCertificatesFromJKSToKSS	Migrate all trusted certificates from JKS to KSS store.	Online
migrateTrustedCertificatesFromJKSToKSS	Migrate given trusted certificates from JKS to KSS store.	Online
changeLDAPHostPort	Change given LDAP host and port in an existing LDAP adapter configuration to the new host and port.	Online
removeLDAPHostPort	Remove a remote host and a port from an existing LDAP adapter configuration.	Online
setReadOnlyForLDAPHost	Set the given host and port to read-only/writable in an existing LDAP adapter configuration.	Online
dumpLdapConnectionPoolStats	Dumps the current connection pool statistics for an adapter to a file for the given JVM.	Online
addCipherSuite	Adds cipher suite to an existing LDAP adapter configuration.	Online
removeCipherSuite	Removes cipher suite to an existing LDAP adapter configuration.	Online

6.1.1 addDNAttribute

Online command that adds an attribute to the DN Attributes List.

Description

Adds an attribute to the DN Attributes List for an existing adapter configured for the libOVD configuration associated with an OPSS context.

Syntax

addDNAttribute(adapterName, attributeName, [contextName])

Table 6-2 addDNAttribute Arguments

Argument	Definition
adapterName	Name of the adapter to be updated.
attributeName	Name of the new DN attribute to be added.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is default.

Example

The following example adds memberof attribute to ldap1 adapter:

addDNAttribute(adapterName='ldap1', attributeName='memberof', contextName='default')

6.1.2 activateLibOVDConfigChanges

Online command that reloads the libOVD configuration.

Description

Reloads the libOVD configuration associated with a specific OPSS context.

Syntax

activateLibOVDConfigChanges([contextName])

Table 6-3 activateLibOVDConfigChanges Arguments

Argument	Definition
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is default.

Example

The following command reloads the default libOVD configuration for a specified OPSS context:

activateLibOVDConfigChanges('default')

6.1.3 addAttributeExclusionRule

Online command that adds an attribute exclusion rule.

Description

Adds an attribute exclusion rule to the exclusion list.

Syntax

addAttributeExclusionRule(attribute, mappingContextId, [contextName])

Table 6-4 addAttributeExclusionRule Arguments

Argument	Definition
attribute	Name of the attribute to be added to the exclusion list.
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is default.

Example

The following command add objectsid to the exclusion list:

addAttributeExclusionRule('objectsid','userrole')

6.1.4 addAttributeRule

Online command that adds a new attribute mapping rule.

Description

Adds a new attribute mapping rule to the libOVD configuration associated with a specific OPSS context..

Syntax

addAttributeRule(srcAttrs, srcObjectClass, srcAttrType, dstAttr, dstObjectClass, dstAttrType, mappingExpression, direction, mappingContextId, [contextName])

Table 6-5 addAttributeRule Arguments

Argument	Definition
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is default.

Example

The following command creates a mapping rule for the libOVD configuration. Here, the lastname is mapped to the cn.

addAttributeRule('lastname','','','sn','','','','Inbound','userrole')

6.1.5 addDomainExclusionRule

Online command that adds a domain exclusion rule.

Description

Adds a domain exclusion rule to the exclusion list.

Syntax

addDomainExclusionRule(domain, mappingContextId, [contextName])

Table 6-6 addDomainExclusionRule Arguments

Argument	Definition
domain	Distinguished name (DN) of the attribute to be added to the exclusion list.
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command adds cn=group,dc=oracle,dc=com to the exclusion list:

addDomainExclusionRule('cn=group,dc=oracle,dc=com','userrole')

6.1.6 addDomainRule

Online command that adds a new domain mapping rule.

Description

Adds a new domain mapping rule.

Syntax

addDoma]inRule(srcDomain, destDomain, domainConstructRule, mappingContextId, [contextName])

Table 6-7 addDomainRule Arguments

Argument	Definition
srcDomain	Source domain.
destDomain	Destination domain
domainConstructRule	Name of the attribute to be added to the exclusion list.
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is default.

Example

The following command creates a domain mapping rule:

addDomainRule('dc=oracle,dc=com', 'dc=oracle,dc=com', '', 'defaultContext', 'default')

6.1.7 addJoinRule

Online command that adds a join rule to a Join Adapter.

Description

Adds a join rule to an existing Join Adapter for the libOVD configuration associated with the specified OPSS context.

Syntax

addJoinRule(adapterName, secondary, condition, [joinerType], [contextName])

Table 6-8 addJoinRule Arguments

Argument	Definition
adapterName	Name of the Join Adapter to be modified.
secondary	Name of the adapter to join to.
condition	The attribute(s) to join on.
joinerType	Optional. Defines the type of Join. Values can be Simple (default), Conditional, OneToMany, or Shadow.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is default.

Examples

The following commands create different join rules for an existing Join adapter:

addJoinRule('join1','secondaryldap','cn=cn', 'Simple', 'default')

addJoinRule('join1','secondaryldap','cn=cn', 'Conditional', 'default')

addJoinRule(adapterName='join1', secondary='LDAP3', condition='uid=cn', JoinerType='OneToMany')

addJoinRule(adapterName='join1', secondary='LDAP2',condition='uid=cn', contextName='myContext')

6.1.8 addLDAPHost

Online command that adds a new remote host.

Description

Adds a new remote host (host and port) to an existing LDAP adapter. By default, the new host is configured in Read-Write mode with percentage set to 100.

Syntax

addLDAPHost(adapterName, host, port, [contextName])

Table 6-9 addLDAPHost Arguments

Argument	Definition
adapterName	Name of the Join Adapter to be modified.
host	Remote LDAP host to which the LDAP adapter will communicate.
port	Remote LDAP host port.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following commands add a host and a port to an existing LDAP adapter:

addLDAPHost(adapterName='ldap1', host='myhost.example.com', port=389)

addLDAPHost('ldap1', 'myhost.example.com','389', 'myContext')

6.1.9 addMappingContext

Online command that creates a new mapping context.

Description

Creates a new mapping context for the libOVD configuration associated with the specified OPSS context.

Syntax

addMappingContext(mappingContextId, [contextName])

Table 6-10 addMappingContext Arguments

Argument	Definition
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command creates a mapping context for the libOVD configuration:

addMappingContext('defaultContext','context')

6.1.10 addPlugin

Online command that adds a plug-in to an existing adapter or at the global level.

Description

Adds a plug-in to an existing adapter or at the global level. The "i"th key corresponds to "i"th value. The plug-in is added to default chain.

Syntax

addPlugin(pluginName, pluginClass, paramKeys, paramValues, [adapterName], [contextName])

Table 6-11 addPlugin Arguments

Argument	Definition
pluginName	Name of the plug-in to be created.
pluginClass	Class of the plug-in.
paramKeys	Init Param Keys separated by "|".
paramValues	Init Param Values separated by "|".
adapterName	Optional. Name of the adapter to be modified. If not specified, the plug-in is added at the global level.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Examples

The following commands add a plug-in to an existing adapter:

wls:/mydomain/serverConfig> addPlugin(adapterName='ldap1', pluginName='VirtualAttr',pluginClass='oracle.ods.virtualization.engine.chain.plugins.virtualattr.VirtualAttributePlugin', paramKeys='AddAttribute | MatchFilter | ContainerDN', paramValues='cn=%uid% | objectclass=person | dc=oracle,dc=com')

wls:/mydomain/serverConfig> addPlugin(pluginName='VirtualAttr',pluginClass='oracle.ods.virtualization.engine.chain.plugins.virtualattr.VirtualAttributePlugin', paramKeys='AddAttribute | MatchFilter | ContainerDN', paramValues='cn=%uid% | objectclass=person | dc=oracle,dc=com')
 
wls:/mydomain/serverConfig> addPlugin(pluginName='DMSMetrics',pluginClass='oracle.ods.virtualization.engine.chain.plugins.DMSMetrics.MonitorPerformance', paramKeys='None',paramValues='None',adapterName='ldap1',contextName='default')

6.1.11 addPluginParam

Online command that adds new parameter values to the existing adapter level plug-in or global plug-in.

Description

Adds new parameter values to the existing adapter level plug-in or the global plug-in. If the parameter already exists, the new value is added to the existing set of values. The "i"th key corresponds to "i"th value.

Syntax

addPluginParam(pluginName, paramKeys, paramValues, [adapterName], [contextName])

Table 6-12 addPluginParam Arguments

Argument	Definition
pluginName	Name of the plug-in to be modified.
paramKeys	Init Param Keys separated by "|".
paramValues	Init Param Values separated by "|".
adapterName	Optional Name of the adapter to be modified. If not specified, the global plug-in is modified.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Examples

The following commands add a new plug-in parameter for an existing plug-in:

wls:/mydomain/serverConfig> addPluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramKeys='ReplaceAttribute | MatchFilter', paramValues='cn=%uid% | objectclass=person')

wls:/mydomain/serverConfig> addPluginParam(pluginName='VirtualAttr', paramKeys='ReplaceAttribute | MatchFilter', par)

6.1.12 addToRequestControlExcludeList

Online command that adds a control to the Request Control Exclude List.

Description

Adds a control to the Request Control Exclude List for an existing LDAP adapter configuration.

Syntax

addToRequestControlExcludeList(adapterName, control, [contextName])

Table 6-13 addToRequestControlExcludeList Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be modified.
control	LDAP control object identifier (OID).
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command adds 2.16.840.1.113894.1.8.31 control to ldap1 adapter's Request Control Exclude List:

addToRequestControlExcludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

6.1.13 addToRequestControlIncludeList

Online command that adds a control to the Request Control Include List.

Description

Adds a control to the Request Control Include List for an existing LDAP adapter configuration.

Syntax

addToRequestControlIncludeList(adapterName, control, [contextName])

Table 6-14 addToRequestControlIncludeList Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be modified.
control	LDAP control object identifier (OID).
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command adds 2.16.840.1.113894.1.8.31 control to ldap1 adapter's Request Control Include List:

addToRequestControlIncludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

6.1.14 assignViewToAdapter

Online command that assigns a view to an LDAP adapter.

Description

Assigns a view to an LDAP adapter in the libOVD configuration associated with an OPSS context.

Syntax

assignViewToAdapter(viewName, adapterName, [contextName])

Table 6-15 assignViewToAdapter Arguments

Argument	Definition
viewName	Name of the view.
adapterName	Name of the LDAP adapter.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command assigns userView to ldap1 adapter:

assignViewToAdapter('userView','ldap1', 'default')

6.1.15 createJoinAdapter

Online command that creates a new join adapter.

Description

Creates a new join adapter for the libOVD configuration associated with an OPSS context.

Syntax

createJoinAdapter(adapterName, root, primaryAdapter, [bindAdapter],[contextName])

Table 6-16 createJoinAdapter Arguments

Argument	Definition
adapterName	Name of the Join Adapter to be created.
primaryAdapter	Specifies the identifier of the primary adapter, which is the adapter searched first in the join operation.
root	root
bindAdapter	Specifies identifier of the bind adapter(s), which are the adapter(s) whose proxy account is used to bind in the LDAP operation. By default, primaryAdapter is set as bindAdapter.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Examples

The following commands create a Join adapter:

createJoinAdapter('join1','dc=join','primaryldap','myldap', 'myContext')

createJoinAdapter(adapterName='join1', root='dc=join', primaryAdapter='myldap')

6.1.16 createLDAPAdapter

Online command that creates a new LDAP adapter.

Description

Creates a new LDAP adapter for the libOVD configuration associated with an OPSS context.

Syntax

createLDAPAdapter(adapterName, root, host, port, remoteBase, [isSecure], [bindDN], [bindPasswd], [passCred], [contextName])

Table 6-17 createLDAPAdapter Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be created.
root	Virtual Namespace of the LDAP adapter.
host	Remote LDAP host with which the LDAP adapter will communicate.
port	Remote LDAP host port number.
remoteBase	Location in the remote DIT to which root corresponds.
isSecure	Optional. Boolean value that enables secure SSL/TLS connections to the remote hosts when set to true. The default is false.
bindDN	Optional. Proxy BindDN used to communicate with remote host. Default is "".
bindPasswd	Optional. Proxy BindPasswd used to communicate with the remote host. Default is "".
passCred	Optional. Controls the credentials, if any, the libOVD configuration will pass to the back-end (remote host) LDAP server. Values can be Always (default), None, or BindOnly.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Examples

The following commands create an LDAP adapter:

createLDAPAdapter("testLDAP", "dc=us,dc=oracle,dc=com", "myhost.example.com", 3060, "dc=uk,dc=oid", false, "cn=testuser", "welcome1", "Always", "myContext"

createLDAPAdapter(adapterName='ldap1', root='dc=com', host='myhost.example.com', port=5566, remoteBase='dc=oid')

6.1.17 createLDAPAdapterWithDefaultPlugins

Online command that creates a new LDAP adapter.

Description

Creates a new LDAP adapter with default plug-ins based on the directory type for the libOVD configuration associated with an OPSS context.

Syntax

createLDAPAdapterWithDefaultPlugins(adapterName, directoryType, root, host, port, remoteBase, [isSecure], [bindDN], [bindPasswd], [contextName])

Table 6-18 createLDAPAdapterWithDefaultPlugins Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be created.
directoryType	Directory type. The value can be one of the following directories: OID - Oracle Internet Directory OUD - Oracle Unified Directory SUNONE- Sun Java System Directory Server OVD - Oracle Virtual Directory ACTIVE_DIRECTORY - Microsoft Active Directory EDIRECTORY - Novell eDirectory OPEN_LDAP - Open LDAP WLS_OVD - Oracle WebLogic Server OVD TIVOLI - IBM Tivoli Directory Server
root	Virtual Namespace of the LDAP adapter.
host	Remote LDAP host to which LDAP adapter should communicate.
port	Remote host port.
remoteBase	Location in the remote DIT to which the root corresponds.
isSecure	Optional. Boolean value that enables secure SSL/TLS connections to the remote hosts when set to true. The Default is false.
bindDN	Optional. Proxy BindDN used to communicate with remote host. Default is "".
bindPasswd	Optional. Proxy BindPasswd used to communicate with the remote host. Default is "".
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Examples

The following commands create an LDAP adapter with default plug-ins based on the directory type:

wls:/mydomain/serverConfig> createLDAPAdapterWithDefaultPlugins("testLDAP", "OID", "dc=us,dc=oracle,dc=com", "myhost.example.domain.com", 3060, "dc=uk,dc=oid", false, "cn=testuser", "welcome1", "myContext")

wls:/mydomain/serverConfig> createLDAPAdapterWithDefaultPlugins(adapterName='ldap1', directoryType="OID", root='dc=com', host='myhost.example.domain.com', port=5566, remoteBase='dc=oid',bindDN="cn=testuser",bindPasswd="welcome1",contextName='default')

6.1.18 createView

Online command that creates a new view.

Description

Creates a new view for the libOVD configuration associated with an OPSS context.

Syntax

createView(viewName, [contextName])

Table 6-19 createView Arguments

Argument	Definition
viewName	Name of the new view.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command create a view named, userView:

createView('userView','default')

6.1.19 deleteAdapter

Online command that deletes an existing adapter.

Description

Deletes an existing adapter for the libOVD configuration associated with an OPSS context.

Syntax

deleteAdapter(adapterName, [contextName])

Table 6-20 deleteAdapter Arguments

Argument	Definition
adapterName	Name of the Join Adapter to be deleted.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command deletes join1 adapter:

deleteAdapter(adapterName='join1') deleteAdapter('join1', 'default'))

6.1.20 deleteAttributeExclusionRule

Online command that deletes an attribute exclusion rule.

Description

Deletes an attribute exclusion rule for the libOVD configuration associated with an OPSS context.

Syntax

deleteAttributeExclusionRule(attribute, mappingContextId, [contextName])

Table 6-21 deleteAttributeExclusionRule Arguments

Argument	Definition
attribute	Name of the attribute to be removed from the exclusion list.
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command deletes the objectsid attribute exclusion rule for the associated libOVD configuration:

deleteAttributeExclusionRule('objectsid','userrole')

6.1.21 deleteAttributeRule

Online command that delete an attribute mapping rule.

Description

Deletes an attribute mapping rule for the libOVD configuration associated with an OPSS context.

Syntax

deleteAttributeRule(srcAttrs, dstAttr, mappingContextId, [contextName])

Table 6-22 deleteEntityRelation Arguments

Argument	Definition
srcAttrs	Source attributes.
dstAttr	Destination attribute.
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command deletes the lastname attribute mapping rule from cn:

deleteAttributeRule('lastname','sn')

6.1.22 deleteDomainExclusionRule

Online command that deletes a domain exclusion rule.

Description

Deletes a domain exclusion rule for the libOVD configuration associated with an OPSS context.

Syntax

deleteDomainExclusionRule(domain, mappingContextId, [contextName])

Table 6-23 deleteEntityRelation Arguments

Argument	Definition
domain	Distinguished Name of the container to be removed from the exclusion list.
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command deletes 'cn=group,dc=oracle,dc=com' domain exclusion rule:

deleteDomainExclusionRule('cn=group,dc=oracle,dc=com')

6.1.23 deleteDomainRule

Online command that deletes a domain mapping rule.

Description

Deletes a domain mapping rule for the libOVD configuration associated with an OPSS context.

Syntax

deleteDomainRule(srcDomain, destDomain, mappingContextId, [contextName])

Table 6-24 deleteDomainRule Arguments

Argument	Definition
srcDomain	Source domain.
destDomain	Destination domain.
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command deletes 'dc=oracle,dc=com' domain mapping rule:

deleteDomainRule('dc=oracle,dc=com','dc=oracle,dc=com','userrole')

6.1.24 deleteMappingContext

Online command that deletes a mapping context.

Description

Deletes the specified mapping context for the libOVD configuration associated with an OPSS context.

Syntax

deleteMappingContext(mappingContextId, [contextName])

Table 6-25 deleteMappingContext Arguments

Argument	Definition
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command deletes a mapping context for a libOVD configuration:

deleteMappingContext('defaultContext','context)

6.1.25 deleteView

Online command that deletes a view.

Description

Deletes a view for the libOVD configuration associated with an OPSS context.

Syntax

createView(viewName, [contextName])

Table 6-26 createView Arguments

Argument	Definition
viewName	Name of the view to delete.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command deletes userView view:

deleteView('userView','default')

6.1.26 getAdapterDetails

Online command that displays the details of an existing adapter.

Description

Displays the details of an existing adapter configured for the libOVD configuration associated with an OPSS context.

Syntax

getAdapterDetails(adapterName, [contextName])

Table 6-27 getAdapterDetails Arguments

Argument	Definition
adapterName	Name of the adapter that contains the details to be displayed.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Examples

The following commands display the details of ldap1 and join1 adapter respectively:

getAdapterDetails(adapterName='ldap1', contextName='default')

getAdapterDetails(adapterName='join1')

6.1.27 listAdapters

Online command that lists the name and type of all adapters.

Description

Lists the name and type of all adapters that are configured for the libOVD configuration associated with an OPSS context.

Syntax

listAdapters([contextName])

Table 6-28 listAdapters Arguments

Argument	Definition
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command displays the name and type of all adapters configured for a libOVD configuration:

listAdapters()

listAdapters(contextName='myContext')

6.1.28 listAllMappingContextIds

Online command that lists all mapping contexts.

Description

Lists the mapping contexts associated with the specified OPSS context.

Syntax

listAllMappingContextIds([contextName])

Table 6-29 listAllMappingContextIds Arguments

Argument	Definition
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command lists all the mapping contexts:

listAllMappingContextIds('default')

6.1.29 listAttributeRules

Online command that lists all the attribute rules.

Description

List all the attribute rules in the format SOURCE_ATTRIBUTE:DESTINATION_ATTRIBUTE:DIRECTION.

Syntax

listAttributeRules(mappingContextId, [contextName])

Table 6-30 listAttributeRules Arguments

Argument	Definition
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command lists all the attribute rules:

listAttributeRules('defaultContext','default')

6.1.30 listDomainRules

Online command that lists all domain rules.

Description

Lists all the domain rules in the format of SOURCE_DOMAIN:DESTINATION_DOMAIN.

Syntax

listDomainRules(mappingContextId, [contextName])

Table 6-31 listDomainRules Arguments

Argument	Definition
mappingContextId	Name of the mapping context.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command lists all domain rules:

listDomainRules('defaultContext','default')

6.1.31 listViews

Online command that lists all views

Description

Lists all views for a libOVD configuration associated with an OPSS context.

Syntax

listViews([contextName])

Table 6-32 listViews Arguments

Argument	Definition
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command lists all views:

listViews('default')

6.1.32 modifyLDAPAdapter

Modifies parameters in an LDAP adapter.

Description

Modifies the following LDAP adapter parameters:

• Remote Base

• Root

• Secure

• BindDN

• BindPassword

• PassCredentials

• MaxPoolSize

• MaxPoolChecks

• MaxPoolWait

• InitialPoolSize

• PoolCleanupInterval

• MaxPoolConnectionIdleTime

• Active

• PingProtocol

• PingBindDN

• PingBindPassword

• PageSize

• HeartBeatInterval

• OperationTimeout

• SearchCountLimit

• Visible

• Critical

• InclusionFilter

• ExclusionFilter

• DNPattern

• RequestControlAllowServerSupported

• MaxPoolConnectionReuseTime

• ConnectTimeout

• PoolConnectionReclaimTime

• Protocols

Syntax

modifyLDAPAdapter(adapterName, attribute, value, [contextName])

Table 6-33 modifyLDAPAdapter Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be modified.
attribute	Name of the attribute to be modified.
value	New value for the attribute.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Examples

The following examples illustrate how to set attributes in ldap1:

modifyLDAPAdapter(adapterName='ldap1', attribute='Root', value='dc=us, dc=oracle, dc=com', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='RemoteBase', value='dc=org', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PassCredentials', value='BindOnly', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='BindDN', value='cn=proxyuser,dc=com', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='BindPassword', value='testwelcome123', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='Secure', value=true, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolSize', value=500, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolChecks', value=10, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolWait', value=120000, contextName='mydefault') [value is in milliseconds] 

modifyLDAPAdapter(adapterName='ldap1', attribute='InitialPoolSize', value=10, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PoolCleanupInterval', value=300, contextName='mydefault') [value is in seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolConnectionIdleTime', value=300, contextName='mydefault')  [value is in seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='Active', value=false, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PingProtocol', value='LDAP', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PingBindDN', value='cn=proxyuser', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PingBindPassword', value='welcome1', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PageSize', value=500, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='HeartBeatInterval', value=120, contextName='mydefault') [value is in seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='OperationTimeout', value=120000, contextName='mydefault') [value is in milliseconds] 

modifyLDAPAdapter(adapterName='ldap1', attribute='SearchCountLimit', value=100, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='Visible', value='Yes', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='Critical', value='false', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='InclusionFilter', value='objectclass=inetorgperson#base', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='ExclusionFilter', value='uniquemember=*#base', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='DNPattern', value='(.*)cn=[a-z0-9]*$', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='RequestControlAllowServerSupported', value=false, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolConnectionReuseTime', value=3600, contextName='mydefault') [value is in seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='ConnectTimeout', value=10000, contextName='mydefault') [value is in milli seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='PoolConnectionReclaimTime', value=180, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='Protocols', value='TLSv1.2', contextName='mydefault')

6.1.33 modifySocketOptions

Online command that modifies socket options.

Description

Modifies socket options for an existing LDAP adapter configuration.

Syntax

modifySocketOptions(adapterName, reuseAddress, keepAlive, tcpNoDelay, readTimeout, [contextName])

Table 6-34 modifySocketOptions Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be modified.
reuseAddress	Value of reuseAddress.
keepAlive	Value of keepAlive.
tcpNoDelay	Value of tcpNoDelay.
readTimeout	Value of readTimeout in seconds.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command modifies the socket option for ldap1 adapter:

modifySocketOptions(adapterName='ldap1', reuseAddress=true, keepAlive=true, tcpNoDelay=true, readTimeout=180000, contextName='default')

6.1.34 removeAllRequestControlExcludeList

Online command that removes all controls from the Request Control Exclude List.

Description

Removes all controls from the Request Control Exclude List for an existing LDAP adapter configuration.

Syntax

removeAllRequestControlExcludeList(adapterName, [contextName])

Table 6-35 removeAllRequestControlExcludeList Arguments

Argument	Definition
adapterName	Name of the adapter to be updated.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command removes all controls from ldap1 adapter's Request Control Exclude List:

removeAllRequestControlExcludeList(adapterName='ldap1', contextName='default')

6.1.35 removeAllRequestControlIncludeList

Online command that removes all controls from the Request Control Include List.

Description

Removes all controls from the Request Control Include List for an existing LDAP adapter configuration.

Syntax

removeAllRequestControlIncludeList(adapterName, [contextName])

Table 6-36 removeAllRequestControlIncludeList Arguments

Argument	Definition
adapterName	Name of the adapter to be updated.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command removes all controls from ldap1 adapter's Request Control Include List:

removeAllRequestControlIncludeList(adapterName='ldap1', contextName='default')

6.1.36 removeDNAttribute

Online command that removes a attribute from the DN Attributes List.

Description

Removes a attribute from the DN Attributes List for an existing adapter that is configured for the libOVD associated with an OPSS context.

Syntax

removeDNAttribute(adapterName attributeName, [contextName])

Table 6-37 removeDNAttribute Arguments

Argument	Definition
adapterName	Name of the adapter to be updated.
attributeName	Name of the new DN attribute to be removed.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command removes memberof attribute from ldap1 adapter's attribute list:

removeDNAttribute(adapterName='ldap1', attributeName='memberof', contextName='default')

6.1.37 removeFromRequestControlExcludeList

Online command that removes a control from the Request Control Exclude List.

Description

Removes a control from the Request Control Exclude List for an existing LDAP adapter configuration.

Syntax

removeFromRequestControlExcludeList(adapterName, control, [contextName])

Table 6-38 removeFromRequestControlExcludeList Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be modified.
control	LDAP control object identifier (OID).
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command removes 2.16.840.1.113894.1.8.31 control from ldap1 adapter's Request Control Exclude List:

removeFromRequestControlExcludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

6.1.38 removeFromRequestControlIncludeList

Online command that removes a control from the Request Control Include List.

Description

Removes a control from the Request Control Include List for an existing LDAP adapter configuration.

Syntax

removeFromRequestControlIncludeList(adapterName, control, [contextName])

Table 6-39 removeFromRequestControlIncludeList Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be modified.
control	LDAP control object identifier (OID).
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command removes 2.16.840.1.113894.1.8.31 control from ldap1 adapter's Request Control Include List:

removeFromRequestControlIncludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

6.1.39 removeJoinRule

Online command that removes a join rule from a Join Adapter.

Description

Removes a join rule from a Join Adapter configured for the libOVD configuration associated with the specified OPSS context.

Syntax

removeJoinRule(adapterName, secondary, [contextName])

Table 6-40 removeJoinRule Arguments

Argument	Definition
adapterName	Name of the Join Adapter to be modified.
secondary	The join rules corresponding to this secondary adapter are removed from the Join Adapter.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Examples

The following command removes 2.16.840.1.113894.1.8.31 control from ldap1 adapter's Request Control Include List:

removeJoinRule('join1','secondaryldap1', 'default')

removeJoinRule(adapterName='join1', secondary='LDAP3')

6.1.40 removeLDAPHost

Online command that removes a remote host from an existing LDAP adapter.

Description

Removes a remote host (host:port) from an existing LDAP adapter.

Syntax

removeLDAPHost(adapterName, host, [contextName])

Table 6-41 removeLDAPHost Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be modified.
host	Location of a remote LDAP host with which the LDAP adapter will communicate.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command removes the host and port from ldap1 adapter:

removeLDAPHost(adapterName='ldap1', host='myhost.example.com')

removeLDAPHost('ldap1', 'myhost.example.com', 'myContext')

6.1.41 removePlugin

Online command that removes a plug-in from an existing adapter.

Description

Removes a plug-in from an existing adapter or at the global level.

Syntax

removePlugin(pluginName, [adapterName], [contextName])

Table 6-42 removePlugin Arguments

Argument	Definition
pluginName	Name of the plug-in to be removed.
adapterName	Optional. Name of the adapter to be modified. If not specified, the global plug-in is removed.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following commands remove VirtualAttr plug-in from ldap1 adapter:

removePlugin(adapterName='ldap1', pluginName='VirtualAttr')

removePlugin(pluginName='VirtualAttr')

6.1.42 removePluginParam

Online command that removes an existing parameter from a configured adapter level plug-in.

Description

Removes an existing parameter from a configured adapter level plug-in or a global plug-in. This command removes all values of a particular parameter from the plug-in.

Syntax

removePluginParam(pluginName, paramKey, [adapterName], [contextName])

Table 6-43 removePluginParam Arguments

Argument	Definition
pluginName	Name of the plug-in to be modified.
paramKey	Parameter to be removed.
adapterName	Optional. Name of the adapter to be modified. If not specified, the global plug-in is modified.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following commands remove the plug-in parameter ReplaceAttribute from VirtualAttr plug-in:

removePluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramKey='ReplaceAttribute')

removePluginParam(pluginName='VirtualAttr', paramKey='ReplaceAttribute')

6.1.43 replacePluginParam

Online command that replaces parameter values for a plug-in.

Description

Replaces existing parameter values for the specified adapter level plug-in or global plug-in.

Syntax

replacePluginParam(pluginName, paramName, paramValues, [adapterName,][contextName])

Table 6-44 replacePluginParam Arguments

Argument	Description
pluginName	Name of the plug-in to be modified.
paramName	Name of the parameter to be replaced.
paramValues	New values of the parameter. For more than one new value, separate each new parameter value are by a "|".
adapterName	Optional. Name of the adapter to be modified. If not specified, the global plug-in is modified.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Examples

The following commands replace the parameter values for the associated plug-in for an adapter:

replacePluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramName='ReplaceAttribute', paramValues='cn=%uid%')

replacePluginParam(adapterName='ldap1', pluginName='UserManagement', paramName='mapAttribute', paramValues='orclguid=objectGuid | uniquemember=member')

6.1.44 unassignViewFromAdapter

Online command that unassigns a view from an adapter.

Description

Unassigns a view from an LDAP adapter configuration.

Syntax

unassignViewFromAdapter(viewName, adapterName, [contextName])

Table 6-45 unassignViewFromAdapter Arguments

Argument	Definition
viewName	Name of the view.
adapterName	Name of the LDAP adapter.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default is "default".

Example

The following command unassigns userView associated with ldap1 adapter:

unassignViewFromAdapter('userView','ldap1', 'default')

6.1.45 listSSLStoreType

Online command that lists the type of SSL store in use.

Description

This command lists the type of SSL store in use for libOVD (JKS or KSS).

Syntax

listSSLStoreType(contextName=[contextName])

Table 6-46 listSSLStoreType Arguments

Argument	Definition
contextName	Name of the OPSS context with which libOVD configuration is associated. The default value is default.

Example

This following command list the SSL store types in use:

listSSLStoreType(contextName='default')

6.1.46 enableKSSForSSL

Online command to enable KSS for libOVD.

Description

This command enables KSS for SSL, and disables JKS if it was enabled before. For more information about KSS, see Oracle® Fusion Middleware Securing Applications with Oracle Platform Security Services.

Syntax

enableKSSForSSL(contextName=[contextName])

Table 6-47 enableKSSForSSL Arguments

Argument	Definition
contextName	Optional. Name of the OPSS context with which libOVD configuration is associated. The default value is default.

Example

The following command enables KSS for SSL:

enableKSSForSSL(contextName='default')

6.1.47 enableJKSForSSL

Online command to enable JKS for libOVD.

Description

This command enables JKS for SSL, and disables KSS if it was enabled before. The command assumes that the libOVD adapters.jks file exists.

Syntax

enableJKSForSSL(contextName=[contextName])

Table 6-48 enableJKSForSSL Arguments

Argument	Definition
contextName	Optional. Name of the OPSS context with which libOVD configuration is associated. The default value is default.

Example

The following command enables JKS for SSL:

enableJKSForSSL(contextName='default')

6.1.48 createKeyStoreAndEnableJKSForSSL

Online command to enable JKS for SSL.

Description

This command enables JKS for SSL, and disables KSS if it was enabled before. The command creates the libOVD adapters.jks file.

Syntax

createKeyStoreAndEnableJKSForSSL(keystorePassword=[password], contextName=[contextName])

Table 6-49 createKeyStoreAndEnableJKSForSSL Arguments

Argument	Definition
keystorePassword	Password for libOVD adapters.jks file.
contextName	Optional. Name of the OPSS context with which libOVD configuration is associated. The default value is default.

Example

The following command enable JKS for SSL:

createKeyStoreAndEnableJKSForSSL(keystorePassword='welcome1', contextName='default')

6.1.49 importTrustedCertificateIntoSSLStore

Online command to import trusted certificate into SSL store.

Description

This command imports the provided trusted certificate into SSL store.

Syntax

importTrustedCertificateIntoSSLStore(certificateFileName=[cert_file],aliasName=[aliasName],contextName=[contextName])

Table 6-50 importTrustedCertificateIntoSSLStore Arguments

Argument	Definition
certificateFileName	File name that contains the certificate.
aliasName	Alias name for the certificate.
contextName	Optional. Name of the OPSS context with which libOVD configuration is associated. The default value is default.

Example

The following command imports the provided trusted certificate into SSL store:

importTrustedCertificateIntoSSLStore(certificateFileName='/tmp/cert.txt',aliasName='myCert1',contextName='default')

6.1.50 migrateAllTrustedCertificatesFromJKSToKSS

Online command to migrate all trusted certificates from JKS-based libOVD truststore to KSS store.

Description

This command migrates all trusted certificates from JKS-based libOVD truststore to KSS store.

Syntax

migrateAllTrustedCertificatesFromJKSToKSS(contextName=[contextName])

Table 6-51 migrateAllTrustedCertificatesFromJKSToKSS Arguments

Argument	Definition
contextName	Optional. Name of the OPSS context with which libOVD configuration is associated. The default value is default.

Example

The following command migrates all trusted certificates from JKS-based libOVD truststore to KSS store:

migrateAllTrustedCertificatesFromJKSToKSS(contextName='default')

6.1.51 migrateTrustedCertificatesFromJKSToKSS

Online command to migrate given trusted certificates from JKS-based libOVD truststore to KSS store.

Description

This command migrates the given trusted certificates from JKS-based libOVD truststore to KSS store.

Syntax

migrateTrustedCertificatesFromJKSToKSS(aliasNames=[alias_names], contextName=[contextName])

Table 6-52 migrateTrustedCertificatesFromJKSToKSS Arguments

Argument	Definition
aliasNames	List of alias names to migrate separated by a comma.
contextName	Optional. Name of the OPSS context with which libOVD configuration is associated. The default value is default.

Example

The following command migrates the specified trusted certificates from JKS-based libOVD truststore to KSS store:

migrateTrustedCertificatesFromJKSToKSS (aliasNames='alias1,alias2', contextName='default')

6.1.52 changeLDAPHostPort

Online command to change given LDAP host and port in an existing LDAP adapter configuration to a new host and port.

Description

This command changes given LDAP host and port in an existing LDAP adapter configuration to a new host and port.

Syntax

changeLDAPHostPort(adapterName=[adapterName], oldHost=[oldHost], oldPort=[oldPort], newHost=[newHost], newPort=[newPort], contextName=[contextName])

Table 6-53 changeLDAPHostPort Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be modified.
oldHost	Old LDAP host.
oldPort	Old LDAP port.
newHost	New LDAP host.
newPort	New LDAP port.
contextName	Optional. Name of the OPSS context with which libOVD configuration is associated. The default value is default.

Example

The following command changes given LDAP host and port in an existing LDAP adapter configuration to a new host and port:

changeLDAPHostPort(adapterName='ldap1', oldHost='oldhost.example.domain.com', oldPort=389, newHost='newhost.example.domain.com', newPort=389)

6.1.53 removeLDAPHostPort

Online command to remove a remote host and a port from an existing LDAP adapter configuration.

Description

This command removes a remote host and a port from an existing LDAP adapter configuration.

Syntax

removeLDAPHostPort(adapterName=[adapterName], host=[host], port=[port], contextName=[contextName])

Table 6-54 removeLDAPHostPort Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be modified.
host	Remote LDAP host.
port	Remote LDAP port.
contextName	Optional. Name of the OPSS context with which libOVD configuration is associated. The default value is default.

Example

The following command removes a remote host and a port from an existing LDAP adapter configuration:

removeLDAPHostPort(adapterName='ldap1', host='myhost.example.domain.com', port=389)

6.1.54 setReadOnlyForLDAPHost

Online command to set the given host and port to read-only/writable in an existing LDAP adapter configuration.

Description

This command sets the given host and port to read-only/writable in an existing LDAP adapter configuration.

Syntax

setReadOnlyForLDAPHost(adapterName=[adapterName], host=[host], port=[port], readOnly=[true/false], contextName=[contextName])

Table 6-55 setReadOnlyForLDAPHost Arguments

Argument	Definition
adapterName	Name of the LDAP adapter to be modified.
host	LDAP host.
port	LDAP port.
readOnly	It has values: true or false.
contextName	Optional. Name of the OPSS context with which libOVD configuration is associated. The default value is default.

Example

The following command sets the given host and port to read-only in an existing LDAP adapter configuration:

setReadOnlyForLDAPHost(adapterName='ldap1', host='myhost.example.domain.com', port=389, readOnly=true)

6.1.55 dumpLdapConnectionPoolStats

Online command that dumps the current connection pool statistics for an adapter to a file for the given JVM on which WLS is configured.

Description

This command dumps the current connection pool statistics for an adapter to a file for the given JVM on which WLS is configured.

Syntax

dumpLdapConnectionPoolStats(fileName=[fileName], adapterName=[adapterName], contextName=[contextName])

Table 6-56 dumpLdapConnectionPoolStats Arguments

Argument	Definition
fileName	Refers to the full path of the file.
adapterName	Name of the LDAP adapter.
contextName	Optional. Name of the OPSS context with which libOVD configuration is associated. The default value is default.

Example

The following example dumps the connection pool statistics for ldap1 adapter into the specified file:

dumpLdapConnectionPoolStats('/tmp/poolstats1.txt','ldap1', 'default')

6.1.56 addCipherSuite

Online command that adds cipher suites to an existing LDAP adapter configuration.

Description

Adds cipher suites to an existing LDAP adapter configuration.

Syntax

addCipherSuite(adapterName, cipherSuite, [contextName])

Table 6-57 addCipherSuite Arguments

Argument	Definition
adapterName	Name of the adapter to be updated.
cipherSuite	Name of the cipher suite to be added.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default value is default.

Example

The following example adds a cipher suite TLS_DHE_RSA_WITH_AES_128_CBC_SHA to an existing adapter, ldap1:

addCipherSuite("ldap1", 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA', "myContext")

6.1.57 removeCipherSuite

Online command that removes cipher suites from an existing LDAP adapter configuration.

Description

Removes cipher suite from an existing LDAP adapter configuration

Syntax

removeCipherSuite(adapterName, cipherSuite, [contextName])

Table 6-58 removeCipherSuite Arguments

Argument	Definition
adapterName	Name of the adapter to be updated.
cipherSuite	Name of the cipher suite to be removed.
contextName	Optional. Name of the OPSS context with which the libOVD configuration is associated. Default value is default.

Example

The following example deletes the cipher suite TLS_DHE_RSA_WITH_AES_128_CBC_SHA from ldap1 configuration:

removeCipherSuite("ldap1", 'TLS_DHE_RSA_WITH_AES_128_CBC_SHA', "myContext")