Skip Navigation Links | |
Exit Print View | |
Oracle Fusion Middleware Command-Line Usage Guide for Oracle Unified Directory 11g Release 1 (11.1.1) |
1. Server Administration Commands
Code Generated by the create-rc-script Command
Oracle Directory Server Enterprise Edition LDAP Connection Options
Oracle Unified Directory LDAP Connection Options
Replication Gateway Configuration Options
Oracle Directory Server Enterprise Edition Server Options
Replication Gateway Security Options
Oracle Unified Directory Server Options
Removing a Replication Gateway Server
Oracle Unified Directory Server Connection Options
Oracle Directory Server Enterprise Edition Server Connection Options
The dsconfig command configures a directory server instance.
dsconfig [subcommands] [globalOptions]
The dsconfig command enables you to create, manage, and remove the base configuration for a server instance. The server configuration is organized as a set of components that dsconfig can access by using one or more subcommands. All components have zero or more configurable properties. These properties can be queried and modified to change the behavior of the component.
The dsconfig command accesses the server over SSL through the administration connector (described in Managing Administration Traffic to the Server in Oracle Fusion Middleware Administration Guide for Oracle Unified Directory).
Unless you specify all configuration parameters and the -n (--no-prompt) option, dsconfig runs in interactive mode. Interactive mode works much like a wizard, walking you through every aspect of the server configuration. For more information, see Using dsconfig in Interactive Mode in Oracle Fusion Middleware Administration Guide for Oracle Unified Directory.
The dsconfig command provides help functions that list the component subcommands needed to manage your configurations.
Display subcommands relating to the core server.
Display subcommands relating to caching and the back ends.
These subcommands are not supported for Oracle Unified Directory proxy.
Display subcommands relating to logging.
Display subcommands relating to the directory server replication.
These subcommands are not supported for Oracle Unified Directory proxy.
Display subcommands relating to security.
Display subcommands relating to caching and user management.
These subcommands are not supported for Oracle Unified Directory proxy.
Display all subcommands.
The following subcommand lists the directory server's objects and properties.
Displays the managed objects and properties. Option types are as follows:
Property values are readable.
Property values are writable.
The property is mandatory.
The property is single-valued.
Administrative action is required for changes to take effect.
Suboptions are as follows:
-t, --type type. Component type.
-c, --category category. Category of the component. The value for type must be one of the component types associated with the category that is specified using the --category suboption.
--inherited. Modifies the display output to show the inherited properties of components.
--advanced. Modifies the display output to show the advanced properties of components.
--property property. The name of a property to be displayed.
The following subcommands configure the core server. When objects are created using dsconfig, their names are case-insensitive. If you create two objects, whose names differ in case only, dsconfig returns an error stating that an object with that name already exists.
Creates alert handlers. Suboptions are as follows:
--handler-name name. Name of the new alert handler.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. Type of alert handler that should be created (default: generic). The value of type can be one of custom, jmx, or smtp.
This command is not supported for the proxy.
Creates attribute syntaxes. Suboptions are as follows:
--syntax-name name. Name of the new attribute syntax.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. Type of attribute syntax that should be created (default: generic). The value of type can be one of attribute-type-description, directory-string, generic, or telephone-number.
Creates connection handlers. Suboptions are as follows:
--handler-name name. Name of the new connection handler.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. Type of connection handler that should be created (default: generic). The value of type can be one of custom, jmx, ldap, snmp, or ldif.
This command is supported only for the proxy.
Creates distribution algorithms. Suboptions are as follows:
--element-name name. Name of the distribution workflow element.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. Type of distribution algorithm that should be created. The value for type can be one of: capacity, dnpattern, lexico, or numeric.
This command is supported only for the proxy.
Creates distribution partitions. Suboptions are as follows:
--element-name name. The name of the distribution workflow element.
--partition-name name. The name of the new distribution partition.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. Type of extension that should be created. The value of type can be one of capacity, dnpattern, lexico, or numeric.
This command is not supported for the proxy.
Creates extended operation handlers. Suboptions are as follows:
--handler-name name. Name of the new extended operation handler.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type . Type of extended operation handler that should be created (default: generic). The value of type can be one of cancel, custom, get-connection-id, get-symmetric-key, password-modify, password-policy-state, start-tls, or who-am-i.
Creates extensions. Suboptions are as follows:
--extension-name name. Name of the new extension.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. Type of extension that should be created. The value of type can be one of custom, global-index-catalog, or ldap-server.
The value global-index-catalog is not supported for Oracle Unified Directory proxy. See gicadm.
This command is supported only for the proxy.
To manage the global index see gicadm.
This command is supported only for the proxy.
To manage the global index see gicadm.
This command is not supported for the proxy.
Creates group implementations. Suboptions are as follows:
--implementation-name name. Name of the new group implementation.
--advanced. Allows the configuration of advanced properties during interactive mode.
-t, --type type. The type of group implementation that should be created. The value for type can be one of custom, dynamic. static, or virtual-static.
This command is supported only for the proxy.
Creates load balancing algorithms. Suboptions are as follows:
--element-name name. The name of the load balancing workflow element.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. Type of load balancing algorithm that should be created. The value of type can be failover, generic, optimal, proportional, saturation, or searchfilter. The default value is generic.
This command is supported only for the proxy.
Creates load balancing routes. Suboptions are as follows:
--element-name name. The name of the load balancing workflow element.
--route-name name. The name of the new load balancing route.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. Type of load balancing algorithm that should be created. The value of type can be failover, generic, optimal, proportional, saturation, or searchfilter. The default value is generic.
This command is not supported for the proxy.
Creates matching rules. Suboptions are as follows:
--rule-name name. Name of the new matching rule.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. Type of matching rule that should be created. The value of type can be one of approximate, equality, ordering, substring.
Creates monitor providers. Suboptions are as follows:
--provider-name name. Name of the new monitor provider.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t, --type type. The type of monitor provider that should be created. The value for type can be one of the following: client-connection, custom, entry-cache, memory-usage, stack-trace, system-info, or version.
This command is supported only for the proxy.
Creates network groups. Suboptions are as follows:
--group-name name. The name of the new network group.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
This command is supported only for the proxy.
Creates network group resource limits. Suboptions are as follows:
--group-name name. The name of the network group.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t, --typetype. The type of quality of service policy that should be created. The value for type can be one of the following: affinity, referral, request-filtering, or resource-limits
Creates plug-ins. Suboptions are as follows:
--plugin-name name. Name of the new plug-in.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. Type of plug-in that should be created (default: generic). The value of type can be one of custom, entry-uuid, last-mod, ldap-attribute-description-list, password-policy-import, profiler, referential-integrity, seven-bit-clean, or unique-attribute.
This command is not supported for the proxy.
Creates virtual attributes. Suboptions are as follows:
--name name. Name of the new virtual attribute.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. Type of virtual attribute that should be created (default: generic). The value of type can be one of custom, entry-dn, entry-uuid, has-subordinates, is-member-of, member, num-subordinates, subschema-subentry, or user-defined.
This command is supported only for the proxy.
Creates workflows. Suboptions are as follows:
--workflow-name name. The name of the new workflow. This name will also be used as the value of the workflow-idproperty.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
This command is supported only for the proxy.
Creates workflow elements. Suboptions are as follows:
--element-name name. The name of the new workflow element. This name will also be used as the value of the workflow-element-idproperty.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t, --type type. The type of Workflow Element which should be created. The value of type can be one of: custom, distribution, load-balancing, db-local-backend, or proxy-ldap. The value db-local-backend is not supported for Oracle Unified Directory proxy
Deletes alert handlers. Suboptions are as follows:
--handler-name name. Name of the alert handler.
-f,--force. Ignore nonexistent alert handlers.
This command is not supported for the proxy.
Deletes attribute syntaxes. Suboptions are as follows:
--syntax-name name. Name of the attribute syntax.
-f,--force. Ignore nonexistent attribute syntaxes.
Deletes connection handlers. Suboptions are as follows:
--handler-name name. Name of the connection handler.
-f,--force. Ignore nonexistent connection handlers.
This command is supported only for the proxy.
Deletes distribution algorithm. Suboptions are as follows:
--element-name name. The name of the distribution workflow element.
-f,--force. Ignore nonexistent distribution algorithms.
This command is supported only for the proxy.
Deletes distribution partitions. Suboptions are as follows:
--element-name name. The name of the distribution workflow element.
--partition-name name. The name of the distribution partition.
-f,--force. Ignore nonexistent distribution partitions.
Deletes extended operation handlers. Suboptions are as follows:
--handler-name name. The name of the extended operation handler.
-f,--force. Ignore nonexistent extended operation handlers.
Deletes extension. Suboptions are as follows:
--extension-name name. The name of the extension.
-f,--force. Ignore nonexistent extensions.
This command is supported only for the proxy. To manage the global index see gicadm.
This command is supported only for the proxy. To manage the global index see gicadm.
This command is not supported for the proxy.
Deletes group implementations. Suboptions are as follows:
--implementation-name name. Name of the group implementation.
-f,--force. Ignore nonexistent group implementations.
This command is supported only for the proxy.
Deletes load balancing routes. Suboptions are as follows:
--element-name name. The name of the load balancing workflow element.
--route-name name. The name of the load balancing route.
-f,--force. Ignore nonexistent load balancing routes.
This command is supported only for the proxy.
Deletes load balancing algorithm. Suboptions are as follows:
--element-name name. The name of the load balancing workflow element.
-f,--force. Ignore nonexistent load balancing algorithms.
This command is not supported for the proxy.
Deletes matching rules. Suboptions are as follows:
--rule-name name. Name of the matching rule.
-f,--force. Ignore nonexistent matching rules.
Deletes monitor providers. Suboptions are as follows:
--provider-name name. Name of the monitor provider.
-f,--force. Ignore nonexistent monitor providers.
This command is supported only for the proxy.
Deletes network group. Suboptions are as follows:
--group-name name. The name of the network group.
-f,--force. Ignore nonexistent network groups.
This command is supported only for the proxy.
Deletes network group quality of service policy. Suboptions are as follows:
--group-name name. The name of the network group.
--policy-type namne. The name of the QOS policy.
-f,--force. Ignore nonexistent network group resource limits.
Deletes plug-ins. Suboptions are as follows:
--plugin-name name. Name of the plug-in.
-f,--force. Ignore nonexistent plug-ins.
This command is not supported for the proxy.
Deletes virtual attributes. Suboptions are as follows:
--name name. Name of the virtual attribute.
-f,--force. Ignore nonexistent virtual attributes.
This command is supported only for the proxy.
Deletes workflow. Suboptions are as follows:
--workflow-name name. The name of the workflow.
-f,--force. Ignore nonexistent workflows.
This command is supported only for the proxy.
Deletes workflow elements. Suboptions are as follows:
--element-name name. The name of the workflow element.
-f,--force. Ignore nonexistent workflow elements.
Shows administration connector properties. Suboptions are as follows:
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows alert handler properties. Suboptions are as follows:
--handler-name name. Name of the alert handler.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the alert handler.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is not supported for the proxy.
Shows attribute syntax properties. Suboptions are as follows:
--syntax-name name. Name of the attribute syntax.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the attribute syntax.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows extended operation handler properties. Suboptions are as follows:
--handler-name name. Name of the extended operation handler.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the extended operation handler.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Shows distribution algorithm properties. Suboptions are as follows:
--element-name name. The name of the distribution workflow element.
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Shows distribution partition properties. Suboptions are as follows:
--element-name name. The name of the distribution workflow element.
--partition-name name. The name of the distribution partition.
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows extended operation handler properties. Suboptions are as follows:
--handler-name name. The name of the extended operation handler.
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows extension properties. Suboptions are as follows:
--extension-name name. The name of the extension.
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows global properties. Suboptions are as follows:
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the global configuration.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy. To manage the global index see gicadm.
This command is supported only for the proxy. To manage the global index see gicadm.
This command is not supported for the proxy.
Shows group implementation properties. Suboptions are as follows:
--implementation-name name. Name of the group implementation.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the group implementation.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Shows load balancing algorithm properties. Suboptions are as follows:
--element-name name. The name of the load balancing workflow element.
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Shows load balancing route properties. Suboptions are as follows:
--element-name name. The name of the load balancing workflow element.
--route-name name. The name of the load balancing route.
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
This command is not supported for the proxy.
Shows matching rule properties. Suboptions are as follows:
--rule-name name. Name of the matching rule.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the matching rule.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows monitor provider properties. Suboptions are as follows:
--provider-name name. Name of the monitor provider.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the monitor provider.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Shows network group properties. Suboptions are as follows:
--group-name name. The name of the network group.
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Shows network group quality of service policy properties. Suboptions are as follows:
--group-name name. The name of the network group.
--policy-type name. The name of the quality of service policy.
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows plug-in properties. Suboptions are as follows:
--plugin-name name. Name of the plug-in.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the plug-in.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows plug-in root properties. Suboptions are as follows:
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the plug-in root.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows Root DN properties. Suboptions are as follows:
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the Root DN.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows root DSE back end properties. Suboptions are as follows:
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the root DSE back end.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is not supported for the proxy.
Shows virtual attribute properties. Suboptions are as follows:
--name name. Name of the virtual attribute.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the virtual attribute.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows work queue properties. Suboptions are as follows:
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the work queue.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-E,--record. Modifies the display output to show one property value per line.
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Show workflow element properties. Suboptions are as follows:
--element-name name. The name of the workflow element.
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Shows workflow properties. Suboptions are as follows:
--workflow-name name. The name of the workflow.
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing alert handlers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is not supported for the proxy.
Lists existing attribute syntaxes. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing connection handlers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Lists existing distribution algorithms. Suboptions are as follows:
--element-name name. The name of the distribution workflow element.
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Lists existing distribution partitions. Suboptions are as follows:
--element-name name. The name of the distribution workflow element.
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing extended operation handlers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Lists existing extensions. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy. To manage the global index see gicadm.
This command is supported only for the proxy. To manage the global index see gicadm.
This command is not supported for the proxy.
Lists existing group implementations. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Lists existing load balancing algorithm. Suboptions are as follows:
--element-name name. The name of the load balancing workflow element.
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Lists existing load balancing routes. Suboptions are as follows:
--element-name name. The name of the load balancing workflow element.
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is not supported for the proxy.
Lists existing matching rules. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing monitor providers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Lists existing network group quality of service policies. Suboptions are as follows:
--group-name name. The name of the network group.
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Lists existing network groups. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing plug-ins. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is not supported for the proxy.
Lists existing virtual attributes. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Lists existing workflow elements. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Lists existing workflows. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is supported only for the proxy.
Modifies existing administration connector properties. Suboptions are as follows:
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies alert handler properties. Suboptions are as follows:
--handler-name name Name of the alert handler.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is not supported for the proxy.
Modifies attribute syntax properties. Suboptions are as follows:
--syntax-name name Name of the attribute syntax.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies connection handler properties. Suboptions are as follows:
--handler-name name Name of the connection handler.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is supported only for the proxy.
Modifies distribution algorithm properties. Suboptions are as follows:
--element-name name. The name of the distribution workflow element.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is supported only for the proxy.
Modifies distribution partition properties. Suboptions are as follows:
--element-name name. The name of the distribution workflow element.
--partition-name name. The name of the distribution partition.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies extended operation handler properties. Suboptions are as follows:
--handler-name name Name of the extended operation handler.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies global configuration properties. Suboptions are as follows:
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is supported only for the proxy. To manage the global index see gicadm.
This command is supported only for the proxy. To manage the global index see gicadm.
This command is not supported for the proxy.
Modifies group implementation properties. Suboptions are as follows:
--implementation-name name Name of the group implementation.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is supported only for the proxy.
Modifies load-balancing algorithm properties. Suboptions are as follows:
--element-name name. The name of the load balancing workflow element.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is supported only for the proxy.
Modifies load balancing algorithm properties. Suboptions are as follows:
--element-name name. The name of the load balancing workflow element.
--route-name name. The name of the load balancing route.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is not supported for the proxy.
Modifies matching rule properties. Suboptions are as follows:
--rule-name name Name of the matching rule.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies monitor provider properties. Suboptions are as follows:
--provider-name name Name of the monitor provider.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is supported only for the proxy.
Modifies network group properties. Suboptions are as follows:
--group-name name. The name of the network group.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is supported only for the proxy.
Modifies network group quality of service policy properties. Suboptions are as follows:
--group-name name. The name of the network group.
--policy-type name. The name of the QOS policy.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies plug-in properties. Suboptions are as follows:
--plugin-name name Name of the plug-in.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies plug-in root properties. Suboptions are as follows:
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies root DN properties. Suboptions are as follows:
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies root DSE back end properties. Suboptions are as follows:
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is not supported for the proxy.
Modifies virtual attribute properties. Suboptions are as follows:
--name name Name of the virtual attribute.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies work queue properties. Suboptions are as follows:
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is supported only for the proxy.
Modifies workflow element properties. Suboptions are as follows:
--element-name name. The name of the workflow element.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is supported only for the proxy.
Modifies workflow properties. Suboptions are as follows:
--workflow-name name. The name of the workflow.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
The following subcommands configure caching and back ends.
These commands are not supported with Oracle Unified Directory proxy.
Creates entry caches. Suboptions are as follows:
--cache-name name. The name of the new entry cache.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of entry cache that should be created. The value for type can be one of custom, fifo, file-system, or soft-reference.
Creates local DB indexes. Suboptions are as follows:
--element-name name. Name of the local DB back end workflow element.
--index-name name. Name of the new local DB index, which will also be used as the value of the attribute property. This specifies the name of the attribute for which the index is to be maintained.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
Creates local DB VLV indexes. Suboptions are as follows:
--element-name name. Name of the local DB back end workflow element.
--index-name name. Name of the new local DB VLV index, which is also used as the value of the name property. This property specifies a unique name for this VLV index.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
Deletes local DB indexes. Suboptions are as follows:
--element-name name. Name of the local DB back end workflow element.
--index-name name. Name of the local DB index.
-f,--force. Ignore nonexistent local DB indexes.
Deletes local DB VLV indexes. Suboptions are as follows:
--element-name name. Name of the local DB back end workflow element.
--index-name name. Name of the local DB VLV index.
-f,--force. Ignore nonexistent local DB VLV indexes.
Shows entry cache properties. Suboptions are as follows:
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the entry cache.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows local DB index properties. Suboptions are as follows:
--element-name name. Name of the local DB back end workflow element.
--index-name name. Name of the local DB index.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the local DB index.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows root DSE backend properties. Suboptions are as follows:
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the root DSE back end.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows the local DB VLV index properties. Suboptions are as follows:
--element-name name. Name of the local DB back end.
--index-name name. Name of the local DB VLV index.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the local DB VLV index.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing local DB VLV indexes. Suboptions are as follows:
--element-name name. Name of the local DB back end workflow element.
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Modifies Entry Cache properties. Suboptions are as follows:
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies local DB Index properties. Suboptions are as follows:
--element-name name. Name of the local DB back end workflow element.
--index-name name. Name of the local DB Index.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies root DSE back end properties. Suboptions are as follows:
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies local DB VLV Index properties. Suboptions are as follows:
--element-name name. Name of the local DB back end element name.
--index-name name. Name of the local DB VLV Index.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
The following subcommands configure a server's logging settings.
Creates debug targets. Suboptions are as follows:
--publisher-name name. Name of the debug log publisher.
--target-name java-name. Name of the new debug target, which will also be used as the value of the debug-scope property: The fully-qualified Oracle Unified Directory Java package, class, or method affected by the settings in this target definition. Use the hash symbol (#) to separate the class name and the method name (for example, org.opends.server.core.DirectoryServer#startUp).
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
Creates log publishers. Suboptions are as follows:
--publisher-name name. Name of the new log publisher.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of log publisher that should be created. The value for type can be one of file-based-access, file-based-debug, or file-based-error.
Creates Log Retention Policies. Suboptions are as follows:
--policy-name name. Name of the new log retention policy.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of log retention policy that should be created. The value for type can be one of file-count, free-disk-space, or size-limit.
Creates log rotation policies. Suboptions are as follows:
--policy-name name. Name of the new log rotation policy.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of log rotation policy that should be created. The value for type can be one of fixed-time, size-limit, or time-limit.
Deletes debug targets. Suboptions are as follows:
--publisher-name name. Name of the debug log publisher.
--target-name name. Name of the debug target.
-f,--force. Ignore nonexistent debug targets.
Deletes log publishers. Suboptions are as follows:
--publisher-name name. Name of the log publisher.
-f,--force. Ignore nonexistent log publishers.
Deletes Log Retention Policies. Suboptions are as follows:
--policy-name name. Name of the log retention policy.
-f,--force. Ignore nonexistent Log Retention Policies.
Deletes log rotation policies. Suboptions are as follows:
--policy-name name. Name of the log rotation policy.
-f,--force. Ignore nonexistent log rotation policies.
Shows debug target properties. Suboptions are as follows:
--publisher-name name. Name of the debug log publisher.
--target-name name. Name of the debug target.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the debug target.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows log publisher properties. Suboptions are as follows:
--publisher-name name. Name of the log publisher.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the log publisher.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows log retention policy properties. Suboptions are as follows:
--policy-name name. Name of the log retention policy.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the log retention policy.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows log rotation policy properties. Suboptions are as follows:
--policy-name name. Name of the log rotation policy.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the log rotation policy.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing debug targets. Suboptions are as follows:
--publisher-name name. Name of the debug log publisher.
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing log publishers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing Log Retention Policies. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing log rotation policies. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Modifies debug target properties. Suboptions are as follows:
--publisher-name name. Name of the debug log publisher.
--target-name name. Name of the debug target.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies log publisher properties. Suboptions are as follows:
--publisher-name name. Name of the log publisher.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies log retention policy properties. Suboptions are as follows:
--policy-name name. Name of the log retention policy.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies log rotation policy properties. Suboptions are as follows:
--policy-name name. Name of the log rotation policy.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
The following subcommands configure server replication.
These subcommands are not supported with Oracle Unified Directory proxy.
Creates replication domains. Suboptions are as follows:
--provider-name name. Name of the multi-master synchronization provider.
--domain-name name. Name of the new replication domain.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
Creates replication servers. Suboptions are as follows:
--provider-name name. Name of the multi-master synchronization provider.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
Creates synchronization providers. Suboptions are as follows:
--provider-name name. Name of the new synchronization provider.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of synchronization provider that should be created. The value for type is multimaster.
Deletes replication domains. Suboptions are as follows:
--provider-name name. Name of the synchronization provider.
--domain-name name. Name of the replication domain.
-f,--force. Ignore nonexistent replication domains.
Deletes replication servers. Suboptions are as follows:
--provider-name name. Name of the synchronization provider.
-f,--force. Ignore nonexistent replication servers.
Deletes synchronization providers. Suboptions are as follows:
--provider-name name. Name of the synchronization provider.
-f,--force. Ignore nonexistent synchronization providers.
Shows replication domain properties. Suboptions are as follows:
--provider-name name. Name of the multi-master synchronization provider.
--domain-name name. Name of the replication domain.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the replication domain.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows replication server properties. Suboptions are as follows:
--provider-name name. Name of the multi-master synchronization provider.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the replication server.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows synchronization provider properties. Suboptions are as follows:
--provider-name name. Name of the synchronization provider.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the synchronization provider.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing replication domains. Suboptions are as follows:
--provider-name name. Name of the replication synchronization provider.
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing replication server. Suboptions are as follows:
--provider-name name. Name of the replication synchronization provider.
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing synchronization providers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Modifies replication domain properties. Suboptions are as follows:
--provider-name name. Name of the replication synchronization provider.
--domain-name name. Name of the replication domain.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies synchronization provider properties. Suboptions are as follows:
--provider-name name. Name of the synchronization provider.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
The following subcommands configure a server's security settings.
Creates certificate mappers. Suboptions are as follows:
--mapper-name name. Name of the new certificate mapper.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of certificate mapper that should be created (default: generic). The value for type can be one of custom, fingerprint, subject-attribute-to-user-attribute, subject-dn-to-user-attribute, or subject-equals-dn.
Creates identity mappers. Suboptions are as follows:
--mapper-name name. Name of the new identity mapper.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of identity mapper that should be created. The value for type can be one of exact-match or regular-expression.
Creates key manager providers. Suboptions are as follows:
--provider-name name. Name of the new key manager provider.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of key manager provider that should be created (default: generic). The value for type can be one of file-based, generic, or pkcs11.
PKCS#11 is not supported for Oracle Unified Directory proxy.
This command is not supported for the proxy.
Creates SASL mechanism handlers. Suboptions are as follows:
--handler-name name. Name of the new SASL mechanism handler.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of SASL mechanism handler that should be created (default: generic). The value for type can be one of anonymous, cram-md5, digest-md5, external, generic, gssapi, or plain.
Creates trust manager providers. Suboptions are as follows:
--provider-name name. Name of the new trust manager provider.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of trust manager provider that should be created (default: generic). The value for type can be one of blind, file-based, or generic.
Deletes certificate mappers. Suboptions are as follows:
--mapper-name name. Name of the certificate mapper.
-f,--force. Ignore nonexistent certificate mappers.
Deletes identity mappers. Suboptions are as follows:
--mapper-name name. Name of the identity mapper.
-f,--force. Ignore nonexistent identity mappers.
Deletes key manager providers. Suboptions are as follows:
--provider-name name. Name of the key manager provider.
-f,--force. Ignore nonexistent key manager providers.
This command is not supported for the proxy.
Deletes SASL mechanism handlers. Suboptions are as follows:
--handler-name name. Name of the SASL mechanism handler.
-f,--force. Ignore nonexistent SASL mechanism handlers.
Deletes trust manager providers. Suboptions are as follows:
--provider-name name. Name of the trust manager provider.
-f,--force. Ignore nonexistent trust manager providers.
Shows access control handler properties. Suboptions are as follows:
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the access control handler.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows certificate mapper properties. Suboptions are as follows:
--mapper-name name. Name of the certificate mapper.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the certificate mapper.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Show crypto manager properties. Suboptions are as follows:
--advanced. Modifies the display output to show the advanced properties of the crypto manager.
--property property. The name of a property to be displayed.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows identity mapper properties. Suboptions are as follows:
--mapper-name name. Name of the identity mapper.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the identity mapper.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows key manager provider properties. Suboptions are as follows:
--provider-name name. Name of the key manager provider.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the key manager provider.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is not supported for the proxy.
Shows SASL mechanism handler properties. Suboptions are as follows:
--handler-name name. Name of the SASL mechanism handler.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the SASL mechanism handler.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows trust manager provider properties. Suboptions are as follows:
--provider-name name. Name of the trust manager provider.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the trust manager provider.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing certificate mappers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing identity mappers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing key manager providers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
This command is not supported for the proxy.
Lists existing SASL mechanism handlers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing trust manager providers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Modifies access control handler properties. Suboptions are as follows:
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies certificate mapper properties. Suboptions are as follows:
--mapper-name name. Name of the certificate mapper.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies crypto manager properties. Suboptions are as follows:
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies identity mapper properties. Suboptions are as follows:
--mapper-name name. Name of the identity mapper.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies key manager provider properties. Suboptions are as follows:
--provider-name name. Name of the key manager provider.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
This command is not supported for the proxy.
Modifies SASL mechanism handler properties. Suboptions are as follows:
--handler-name name. Name of the SASL mechanism handler.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies trust manager provider properties. Suboptions are as follows:
--provider-name name. Name of the trust manager provider.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
The following subcommands configure a server's user management settings.
These subcommands are not supported with Oracle Unified Directory proxy.
Creates account status notification handlers. Suboptions are as follows:
--handler-name name. Name of the new account status notification handler.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of account status notification handler that should be created (default: custom). The value for type can be one of custom, error-log, or smtp.
Creates certificate mappers. Suboptions are as follows:
--mapper-name name. Name of the new certificate mapper.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of certificate mapper that should be created (default: custom). The value for type can be one of custom, fingerprint, subject-attribute-to-user-attribute, subject-dn-to-user-attribute, or subject-equals-dn.
Creates identity mappers. Suboptions are as follows:
--mapper-name name. Name of the new identity mapper.
--advanced Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of identity mapper that should be created. The value for type can be one of exact-match or regular-expression.
Creates password generators. Suboptions are as follows:
--generator-name name. Name of the new password generator.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of password generator that should be created (default: generic). The value for type can be one of generic or random.
Creates password policies. Suboptions are as follows:
--policy-name name. Name of the new password policy.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
Creates password storage schemes. Suboptions are as follows:
--scheme-name name. Name of the new password storage scheme.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of password storage scheme that should be created (default: generic). The value for type can be one of aes, base64, blowfish, clear, crypt, custom, md5, rc4, salted-md5, salted-sha1, salted-sha256, salted-sha384, salted-sha512, sha1, or triple-des.
Creates password validators. Suboptions are as follows:
--validator-name name. Name of the new password validator.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
-t,--type type. The type of password validator that should be created (default: generic). The value for type can be one of attribute-value, character-set, dictionary, generic, length-based, repeated-characters, similarity-based, or unique-characters.
Deletes account status notification handlers. Suboptions are as follows:
--handler-name name. Name of the account status notification handler.
-f,--force. Ignore nonexistent account status notification handlers.
Deletes certificate mappers. Suboptions are as follows:
--mapper-name name. Name of the certificate mapper.
-f,--force. Ignore nonexistent certificate mappers.
Deletes identity mappers. Suboptions are as follows:
--mapper-name name. Name of the identity mapper.
-f,--force. Ignore nonexistent identity mappers.
Deletes password generators. Suboptions are as follows:
--generator-name name. Name of the password generator.
-f,--force. Ignore nonexistent password generators.
Deletes password policies. Suboptions are as follows:
--policy-name name. Name of the password policy.
-f,--force. Ignore nonexistent password policies.
Deletes password storage schemes. Suboptions are as follows:
--scheme-name name. Name of the password storage scheme.
-f,--force. Ignore nonexistent password storage schemes.
Deletes password validators. Suboptions are as follows:
--validator-name name. Name of the password validator.
-f,--force. Ignore nonexistent password validators.
Shows account status notification handler properties. Suboptions are as follows:
--handler-name name. Name of the account status notification handler.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the account status notification handler.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows certificate mapper properties. Suboptions are as follows:
--mapper-name name. Name of the certificate mapper.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the certificate mapper.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows identity mapper properties. Suboptions are as follows:
--mapper-name name. Name of the identity mapper.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the identity mapper.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows password generator properties. Suboptions are as follows:
--generator-name name. Name of the password generator.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the password generator.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows password policy properties. Suboptions are as follows:
--policy-name name. Name of the password policy.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the password policy.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows password storage scheme properties. Suboptions are as follows:
--scheme-name name. Name of the password storage scheme.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the password storage scheme.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Shows password validator properties. Suboptions are as follows:
--validator-name name. Name of the password validator.
--property property. The name of a property to be displayed.
--advanced. Modifies the display output to show the advanced properties of the password validator.
-E,--record. Modifies the display output to show one property value per line.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing account status notification handlers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing certificate mappers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing identity mappers. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing password generators. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing password policies. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing password storage schemes. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Lists existing password validators. Suboptions are as follows:
--property property. The name of a property to be displayed.
-z,--unit-size unit. Displays size data using the specified unit. The value for unit can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).
-m,--unit-time unit. Displays time data using the specified unit. The value for unit can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).
Modifies account status notification handler properties. Suboptions are as follows:
--handler-name name. Name of the account status notification handler.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies certificate mapper properties. Suboptions are as follows:
--mapper-name name. Name of the certificate mapper.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies identity mapper properties. Suboptions are as follows:
--mapper-name name. Name of the identity mapper.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies password generator properties. Suboptions are as follows:
--generator-name name. Name of the password generator.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies password policy properties. Suboptions are as follows:
--policy-name name. Name of the password policy.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies password storage scheme properties. Suboptions are as follows:
--scheme-name name. Name of the password storage scheme.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
Modifies password validator properties. Suboptions are as follows:
--validator-name name. Name of the password validator.
--advanced. Allows the configuration of advanced properties during interactive mode.
--set property:value. Assigns a value to a property, where property is the name of the property and value is the single value to be assigned. Specify the same property multiple times to assign more than one value to it.
--reset property. Resets a property back to its default values, where property is the name of the property to be reset.
--add property:value. Adds a single value to a property, where property is the name of the property and value is the single value to be added.
--remove property:value. Removes a single value from a property, where property is the name of the property and value is the single value to be removed.
The dsconfig command accepts an option in either its short form (for example, -h hostname) or its long form equivalent (for example, --hostname hostname).
Allows the configuration of advanced components and properties.
The dsconfig command contacts the directory server over SSL through the administration connector (described in Managing Administration Traffic to the Server in Oracle Fusion Middleware Administration Guide for Oracle Unified Directory). These connection options are used to contact the directory server.
Use the bind DN to authenticate to the server. This option is used when performing simple authentication and is not required if SASL authentication is to be used. The default value for this option is cn=Directory Manager.
SASL is not supported for Oracle Unified Directory proxy.
Contact the server on the specified hostname or IP address. If this option is not provided, a default of localhost is used.
Use the bind password in the specified file when authenticating to the server. This option must not be used in conjunction with --bindPassword.
Use the client keystore certificate in the specified path.
Use the specified certificate for client authentication.
Use the specified options for SASL authentication.
SASL is not supported for Oracle Unified Directory proxy.
Contact the server at the specified administration port. If this option is not provided, the administration port of the local configuration is used.
Use the client trust store certificate in the specified path. This option is not needed if --trustAll is used, although a trust store should be used when working in a production environment.
Use the password needed to access the certificates in the client trust store. This option is only required if --trustStorePath is used and the specified trust store requires a password in order to access its contents (which most trust stores do not require). This option must not be used in conjunction with --trustStorePasswordFile.
Use the password in the specified file to access the certificates in the client keystore. This option is only required if --keyStorePath is used. This option must not be used in conjunction with --keyStorePassword.
Use the password in the specified file to access the certificates in the client trust store. This option is only required if --trustStorePath is used and the specified trust store requires a password in order to access its contents (most trust stores do not require this). This option must not be used in conjunction with --trustStorePassword.
Use the bind password when authenticating to the server. This option can be used for simple authentication as well as password-based SASL mechanisms. This option must not be used in conjunction with --bindPasswordFile. To prompt for the password, type -w -.
SASL is not supported for Oracle Unified Directory proxy.
Use the password needed to access the certificates in the client keystore. This option is only required if --keyStorePath is used. This option must not be used in conjunction with --keyStorePasswordFile.
Trust all server SSL certificates that the server presents. This option can be used for convenience and testing purposes, but for security reasons a trust store should be used to determine whether the client should accept the server certificate. If the client and the server are running in the same instance, there is no certificate interaction.
Specify the full path to the file, where the equivalent non-interactive commands will be written when this command is run in interactive mode.
Display the equivalent non-interactive option in the standard output when this command is run in interactive mode.
Specifies the path to a file that contains a set of dsconfig commands to be executed. This option supports line splitting, backslash ('\'), quotes (") escaped quotes (\") inside a quoted string, and hash for comments ('#').
Use non-interactive mode. If some data in the command is missing, you are not prompted and the command will fail.
Indicate that the command will not use a properties file to get the default command-line options.
Specify the path to the properties file that contains the default command-line options.
Run in quiet mode. No output will be generated unless a significant error occurs during the process.
Run in “script friendly” mode. Display the output in a format that can be easily parsed by a script.
Run in verbose mode, displaying diagnostics on standard output.
Display command-line usage information for the command and exit without making any attempt to stop or restart the server.
Display the version information for the server and exit rather than attempting to run this command.
The following examples show how to use the server commands.
For more information, see System Requirements and Certification in Oracle Fusion Middleware Installation Guide for Oracle Unified Directory.
For additional dsconfig examples, see Managing the Server Configuration With dsconfig in Oracle Fusion Middleware Administration Guide for Oracle Unified Directory.
Example 1-6 Viewing the Global Help Subcommands and Global Options
The following command displays the available global help subcommands and global options for the server:
$ dsconfig --help
Example 1-7 Viewing a Component's Subcommand Help Information
The following command displays the help information for the database subcommands:
$ dsconfig --help-database
Example 1-8 Viewing Help on an Individual Subcommand
The following command displays the help information for the create-local-db-index subcommand:
$ dsconfig create-local-db-index --help
Example 1-9 Displaying a Component's Properties
The following command displays the properties for local-db-index. If -t is not specified, the command displays the properties for all components.
$ dsconfig list-properties -c local-db-index Option Types: r -- Property value(s) are readable w -- Property value(s) are writable m -- The property is mandatory s -- The property is single-valued a -- Administrative action is required for changes to take effect Component Type Property Options Syntax ------------------------------------------------------------------------------ local-db-index generic attribute r-ms- OID local-db-index generic index-entry-limit rw-sa INTEGER local-db-index generic index-extensible-matching-rule rw--a LOCALE | OID local-db-index generic index-type rwm-a TYPE
The following command displays the properties for crypto-manager.
$ dsconfig list-properties -c crypto-manager Option Types: r -- Property value(s) are readable w -- Property value(s) are writable m -- The property is mandatory s -- The property is single-valued a -- Administrative action is required for changes to take effect Component Type Property Options Syntax ---------------------------------------------------------------------- crypto-manager generic key-wrapping-transformation rw-s- STRING crypto-manager generic ssl-cert-nickname rw-sa STRING crypto-manager generic ssl-cipher-suite rw--- STRING crypto-manager generic ssl-encryption rw-s- BOOLEAN crypto-manager generic ssl-protocol rw--- STRING
Example 1-10 Parameters Supported by the -F, --batchFile subcommand
This section describes the various parameters supported by the -F, --batchFile subcommand.
Executing the -F, --batchFile subcommand using the line splitting approach. The file /tmp/batch contains the following set of commands:
create-workflow-element \ --type db-local-backend \ --set base-dn:cn=myexample,cn=com \ --set enabled:true \ --element-name myBackend
Running the -F, --batchFile subcommand.
dsconfig -X -w password -F /tmp/batch -n
Executing the -F, --batchFile subcommand using quotes (") and escaped quotes (\") inside a quoted string. The file /tmp/batch contains the following set of commands:
set-access-control-handler-prop \ --add global-aci:"(targetattr != \"description || mail\") \ (version 3.0; acl \"Allow self entry modification except for \ description and mail attributes\"; allow (write)userdn =\"ldap:///self\";) "
Running the -F, --batchFile subcommand.
dsconfig -X -w password -F /tmp/batch -n
An exit code of 0 indicates that the operation completed successfully. An exit code of 1 or greater indicates that an error occurred during processing.
The server supports the use of a properties file that passes in any default option values used with the dsconfig command. The properties file is convenient when working in different configuration environments, especially in scripted or embedded applications. For more information, see Using a Properties File With Server Commands.
The following options can be stored in a properties file:
bindDN
bindPassword
bindPasswordFile
certNickname
hostname
keyStorePassword
keyStorePasswordFile
keyStorePath
port
saslOption
SASL is not supported for Oracle Unified Directory proxy.
trustAll
trustStorePassword
trustStorePasswordFile
trustStorePath
useSSL
useStartTLS
Entries in the properties file have the following format:
toolname.propertyname=propertyvalue
For example:
dsconfig.trustAll=Yes
UNIX and Linux: instance-dir/OUD/bin/dsconfig
Windows: instance-dir\OUD\bat\dsconfig.bat