Getting Help With dsconfig

The dsconfig command has extensive online help that is accessed using the --help option.

Global Usage

Use the following command to display dsconfig's global usage:

$ dsconfig --help

Finding the Correct Subcommand

The global usage information does not include the list of available subcommands. To retrieve the list of subcommands, use one of the --help-xxx options, where xxx determines the group of subcommands to be displayed.

Note - Use the --help-all option used to display all of the available subcommands.

For example, to find all the subcommands relating to caching and back-end configuration, use the following command:

$ dsconfig --help-core-server

Getting Help for an Individual Subcommand

When you have determined which subcommand you want, you can get more detailed help on that subcommand by using the subcommand's --help option as follows:

$ dsconfig create-monitor-provider --help

Displaying a Summary of a Component's Properties

The dsconfig command has built-in documentation for all of the components and their properties. This documentation can be accessed by using the list-properties subcommand. For example, a summary of the properties associated with a work queue can be displayed by using the following command:

$ dsconfig list-properties -c work-queue

Note - If the -c option is not specified, a summary of the properties for all components is displayed.

Displaying Detailed Help on a Property

The summary table displays only brief usage information for each property. More detailed information are available using the verbose mode of the list-properties subcommand:

$ dsconfig list-properties -c work-queue --property num-worker-threads -v

Note - If the --property option is not specified, verbose help is provided for all the work-queue properties.