config-diff

Description

Compares Metrics Engine configurations and produces a dsconfig batch file needed to bring the source inline with the target.

Its uses include comparing multiple servers for configuration differences, producing a batch file to reconfigure a server from scratch from the out-of-the-box configuration, and comparing a local server against an expected configuration.

Both the source and the target configurations can be retrieved over LDAP, accessed from the local server's file system, extracted from a specific file, or retrieved from every server in a configuration server group. Also, with the exception of accessing a configuration from a specific file, the source and/or target configurations can be compared as they existed at any point in the past, including the baseline, pre-installation configuration.

Some configuration differences (those that will always differ between instances, like instance-name) are excluded by default to reduce the amount of spurious output, but these can be included by specifying the --includeExpectedDifferences command. Further differences can be excluded with the --exclude option.

This tool attempts to generate a batch file that can be applied to the source server without any errors. However, there are some edge case configurations that the tool is not sophisticated enough to handle. For example, it cannot handle two peer configuration objects that would require swapping values for a property (e.g. evaluation-order-index) that must be unique within the server. It will still generate a dsconfig batch file that includes these changes, but they might be rejected by the server. In these rare cases, the batch file can be hand edited so that it can be applied to a running server or it can be applied with the server shut down using 'dsconfig --offline'.

Examples

config-diff --sourceHost server1 --sourceBindDN "cn=Directory Manager" \
     --sourceBindPassword password --targetHost server2

config-diff --sourceLocal --sourceBaseline --targetLocal \
     --exclude differs-after-install --outputFile configuration-steps.dsconfig

config-diff --sourceLocal --targetLocal --targetDate -2w

config-diff --sourceConfigGroup --targetHost server1 \
     --targetBindDN "cn=Directory Manager" --targetBindPassword password \
     --targetBaseline --targetPreDiffBatchFile standard-config.dsconfig \
     --exclude differs-by-location --exclude differs-after-install \
     --outputDir non-compliance-config-changes/

Arguments

-V
--version

-H
--help

--help-debug

-h {host}
--sourceHost {host}

-p {port}
--sourcePort {port}

--sourceUseSSL

--sourceUseStartTLS

-D {bindDN}
--sourceBindDN {bindDN}

-w {bindPassword}
--sourceBindPassword {bindPassword}

--sourceBindPasswordFile {bindPasswordFile}

--sourceSASLOption {name=value}

--sourceLocal

--sourceFile my-config.ldif

--sourceConfigGroup

--sourceBaseline

--sourceDate [2013-08-10T12:30 or -2d]

--sourcePreDiffBatchFile pre-diff-changes.dsconfig

--targetHost {host}

--targetPort {port}

--targetUseSSL

--targetUseStartTLS

--targetBindDN {bindDN}

--targetBindPassword {bindPassword}

--targetBindPasswordFile {bindPasswordFile}

--targetSASLOption {name=value}

--targetLocal

--targetFile my-config.ldif

--targetConfigGroup

--targetBaseline

--targetDate [2013-08-13T12:30 or -2d]

--targetPreDiffBatchFile pre-diff-changes.dsconfig

--outputFile config-differences.dsconfig

--outputDir config-differences/

--includeExpectedDifferences

--exclude [differs-by-location, differs-after-install]

-X
--trustAll

-K {keyStorePath}
--keyStorePath {keyStorePath}

-W {keyStorePassword}
--keyStorePassword {keyStorePassword}

-u {keyStorePasswordFile}
--keyStorePasswordFile {keyStorePasswordFile}

-N {nickname}
--certNickname {nickname}

-P {trustStorePath}
--trustStorePath {trustStorePath}