10139N/A<?
xml version="1.0" encoding="UTF-8"?>
10139N/A ! The contents of this file are subject to the terms of the 10139N/A ! Common Development and Distribution License, Version 1.0 only 10139N/A ! (the "License"). You may not use this file except in compliance 10139N/A ! See the License for the specific language governing permissions 10139N/A ! and limitations under the License. 10139N/A ! When distributing Covered Code, include this CDDL HEADER in each 10139N/A ! If applicable, add the following below this CDDL HEADER, with the 10139N/A ! fields enclosed by brackets "[]" replaced with your own identifying 10139N/A ! Portions Copyright [yyyy] [name of copyright owner] 13496N/A This use of <informalexample> is mild tag abuse. 13496N/A It serves as a single container element for all the elements here. 10139N/A The <
command>dsconfig</
command> command provides many subcommands.
10139N/A Subcommands let you create, list, and delete entire configuration components,
10139N/A and also let you get and set component properties.
10139N/A Subcommands therefore have names that reflect these five actions.
10139N/A <
listitem><
para>create-<
replaceable>component</
replaceable></
para></
listitem>
10139N/A <
listitem><
para>list-<
replaceable>component</
replaceable>s</
para></
listitem>
10139N/A <
listitem><
para>delete-<
replaceable>component</
replaceable></
para></
listitem>
10139N/A <
listitem><
para>get-<
replaceable>component</
replaceable>-prop</
para></
listitem>
10139N/A <
listitem><
para>set-<
replaceable>component</
replaceable>-prop</
para></
listitem>
10139N/A Here, <
replaceable>component</
replaceable> names are names of managed object types.
10139N/A Subcommand <
replaceable>component</
replaceable> names
10139N/A are lower-case, hyphenated versions of the friendly names.
10139N/A When you act on an actual configuration component,
10139N/A you provide the name of the component as an option argument.
13496N/A For example, the Log Publisher component has these corresponding subcommands.
10139N/A <
listitem><
para><
command>create-log-publisher</
command></
para></
listitem>
10139N/A <
listitem><
para><
command>list-log-publishers</
command></
para></
listitem>
10139N/A <
listitem><
para><
command>delete-log-publisher</
command></
para></
listitem>
10139N/A <
listitem><
para><
command>get-log-publisher-prop</
command></
para></
listitem>
10139N/A <
listitem><
para><
command>set-log-publisher-prop</
command></
para></
listitem>
10139N/A When you create or delete Log Publisher components
10139N/A and when you get and set their configuration properties,
10139N/A you provide the name of the actual log publisher,
10139N/A which you can find by using the <
command>list-log-publishers</
command> subcommand.
10139N/A --bindDN "cn=Directory Manager" \
10139N/A------------------------------:------------------------:--------
10139N/AFile-Based Access Logger : file-based-access : true
10139N/AFile-Based Audit Logger : file-based-audit : false
10139N/AFile-Based Debug Logger : file-based-debug : false
10139N/AFile-Based Error Logger : file-based-error : true
10139N/AFile-Based HTTP Access Logger : file-based-http-access : false
10139N/AReplication Repair Logger : file-based-error : true</
computeroutput>
10139N/A --publisher-name "File-Based Access Logger" \
10139N/A --bindDN "cn=Directory Manager" \
10139N/A<
computeroutput>Property : Value(s)
10139N/A----------------:--------------------------------------------------------------
10139N/Arotation-policy : 24 Hours Time Limit Rotation Policy, Size Limit Rotation
10139N/A Many subcommands let you set property values.
10139N/A Notice in the reference for the subcommands below
10139N/A that specific options are available for handling multi-valued properties.
10139N/A Whereas you can assign a single property value
13773N/A by using the <
option>--set</
option> option,
13773N/A you assign multiple values to a multi-valued property
13773N/A by using the <
option>--add</
option> option.
13496N/A You can reset the values of the multi-valued property
13496N/A by using the <
option>--reset</
option> option.
13057N/A Use the following options to view help for subcommands.
13057N/A <
term><
command>dsconfig --help-all</
command></
term>
12380N/A <
term><
command>dsconfig --help-core-server</
command></
term>
12315N/A Display subcommands relating to core server
12106N/A <
term><
command>dsconfig --help-database</
command></
term>
12091N/A Display subcommands relating to caching and back-ends
11265N/A <
term><
command>dsconfig --help-logging</
command></
term>
11066N/A Display subcommands relating to logging
10812N/A <
term><
command>dsconfig --help-replication</
command></
term>
10636N/A Display subcommands relating to replication
10488N/A <
term><
command>dsconfig --help-security</
command></
term>
10312N/A Display subcommands relating to authentication and authorization
10139N/A <
term><
command>dsconfig --help-user-management</
command></
term>
10139N/A Display subcommands relating to user management
10139N/A For help with individual subcommands,
10139N/A either use <
command>dsconfig <
replaceable>subcommand</
replaceable> --help</
command>,
10139N/A or start <
command>dsconfig</
command> in interactive mode,
10139N/A without specifying a subcommand.
10139N/A To view all component properties,
10139N/A use the <
command>dsconfig list-properties</
command> command.