description-dsconfig-subcommands.xml revision 73adb2e3dbaa8a9f6448cefccb7933f68c3c7348
10139N/A<?xml version="1.0" encoding="UTF-8"?>
10139N/A<!--
10139N/A ! CDDL HEADER START
12217N/A !
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 ! with the License.
10139N/A !
10139N/A ! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
10139N/A ! or http://forgerock.org/license/CDDLv1.0.html.
10139N/A ! See the License for the specific language governing permissions
10139N/A ! and limitations under the License.
13773N/A !
10139N/A ! When distributing Covered Code, include this CDDL HEADER in each
10139N/A ! file and include the License file at legal-notices/CDDLv1_0.txt.
10139N/A ! If applicable, add the following below this CDDL HEADER, with the
10139N/A ! fields enclosed by brackets "[]" replaced with your own identifying
13344N/A ! information:
10139N/A ! Portions Copyright [yyyy] [name of copyright owner]
12773N/A !
12773N/A ! CDDL HEADER END
12773N/A !
10139N/A ! Copyright 2015 ForgeRock AS.
10627N/A !
13034N/A-->
13054N/A<!--
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-->
10139N/A<informalexample
10139N/A xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
10139N/A xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
10139N/A xsi:schemaLocation='http://docbook.org/ns/docbook
10139N/A http://docbook.org/xml/5.0/xsd/docbook.xsd'
10139N/A xmlns:xinclude='http://www.w3.org/2001/XInclude'>
10139N/A
10139N/A <para>
10139N/A The <command>dsconfig</command> command provides many subcommands.
10139N/A </para>
10139N/A
10139N/A <para>
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 </para>
10139N/A
10139N/A <itemizedlist>
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 </itemizedlist>
10139N/A
10139N/A <para>
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.
10139N/A </para>
10139N/A
10139N/A <itemizedlist>
12740N/A <para>
13496N/A For example, the Log Publisher component has these corresponding subcommands.
10139N/A </para>
10139N/A
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 </itemizedlist>
10139N/A
10139N/A <para>
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 </para>
12773N/A
12773N/A <screen>
12773N/A$ <userinput>dsconfig \
12773N/A list-log-publishers \
12773N/A --hostname opendj.example.com \
10139N/A --port 4444 \
10139N/A --bindDN "cn=Directory Manager" \
10139N/A --bindPassword password \
10139N/A --trustAll</userinput>
10139N/A<computeroutput>
10139N/ALog Publisher : Type : enabled
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
10139N/A$ <userinput>dsconfig \
10139N/A get-log-publisher-prop \
10139N/A --publisher-name "File-Based Access Logger" \
10139N/A --property rotation-policy \
10139N/A --hostname opendj.example.com \
10139N/A --port 4444 \
10139N/A --bindDN "cn=Directory Manager" \
10139N/A --bindPassword password \
10139N/A --trustAll</userinput>
10139N/A<computeroutput>Property : Value(s)
10139N/A----------------:--------------------------------------------------------------
10139N/Arotation-policy : 24 Hours Time Limit Rotation Policy, Size Limit Rotation
10139N/A : Policy</computeroutput>
10139N/A </screen>
10139N/A
10139N/A <para>
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.
13496N/A </para>
13344N/A
13344N/A <xinclude:include href="itemizedlist-duration.xml" />
13344N/A
13057N/A <para>
13057N/A Use the following options to view help for subcommands.
13057N/A </para>
13034N/A
13057N/A <variablelist>
13034N/A <varlistentry>
13057N/A <term><command>dsconfig --help-all</command></term>
12571N/A <listitem>
12571N/A <para>
12480N/A Display all subcommands
12480N/A </para>
12480N/A </listitem>
12380N/A </varlistentry>
12380N/A <varlistentry>
12380N/A <term><command>dsconfig --help-core-server</command></term>
12315N/A <listitem>
12315N/A <para>
12315N/A Display subcommands relating to core server
12217N/A </para>
12217N/A </listitem>
12217N/A </varlistentry>
12106N/A <varlistentry>
12106N/A <term><command>dsconfig --help-database</command></term>
12106N/A <listitem>
12091N/A <para>
12091N/A Display subcommands relating to caching and back-ends
12091N/A </para>
11416N/A </listitem>
11416N/A </varlistentry>
11416N/A <varlistentry>
11265N/A <term><command>dsconfig --help-logging</command></term>
11265N/A <listitem>
11265N/A <para>
11066N/A Display subcommands relating to logging
11066N/A </para>
11066N/A </listitem>
10812N/A </varlistentry>
10812N/A <varlistentry>
10812N/A <term><command>dsconfig --help-replication</command></term>
10636N/A <listitem>
10636N/A <para>
10636N/A Display subcommands relating to replication
10627N/A </para>
10627N/A </listitem>
10627N/A </varlistentry>
10488N/A <varlistentry>
10488N/A <term><command>dsconfig --help-security</command></term>
10488N/A <listitem>
10312N/A <para>
10312N/A Display subcommands relating to authentication and authorization
10312N/A </para>
10139N/A </listitem>
10139N/A </varlistentry>
10139N/A <varlistentry>
10139N/A <term><command>dsconfig --help-user-management</command></term>
10139N/A <listitem>
10139N/A <para>
10139N/A Display subcommands relating to user management
10139N/A </para>
10139N/A </listitem>
10139N/A </varlistentry>
10139N/A </variablelist>
10139N/A
10139N/A <para>
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 </para>
10139N/A
10139N/A <para>
10139N/A To view all component properties,
10139N/A use the <command>dsconfig list-properties</command> command.
10139N/A </para>
10139N/A</informalexample>
10139N/A