dsccsetup

- Set up Directory Service Control Center

Synopsis

install-path/bin/dsccsetup [subcommand] [options]

Description

The dsccsetup command is used to deploy Directory Service Control Center (DSCC) in an application server, and to register local agents of the administration framework. Use the dsccsetup command with the subcommands described in this man page.

SUBCOMMANDS

The following subcommands are supported:

dsccsetup ads-create [-w file] [-p PORT] [-P PORT]

Initialize the DSCC registry, a local Directory Server instance for private use by DSCC to store configuration information. DSCC requires that this instance reside locally on the host where you run DSCC. Therefore, if you replicate the data in the instance for high availability, set up one DSCC per replica host.

If you do not provide the Directory Manager password for the DSCC registry in the file passed to the -w option, the command prompts for the password.

The default port numbers used by the instance are 3998 for LDAP, and 3999 for LDAPS. If those ports are already used, then dsccsetup randomly chooses some ports. If you want to use specific ports, then use the -p and -P options.

The default instance path of DSCC registry is /var/opt/SUNWdsee7/dcc/ads on Solaris systems in native mode and install-path/var/dcc/ads on other platforms.

The base DN for the suffix containing configuration information is cn=dscc.

Use the dsccsetup status subcommand to read actual values for the DSCC registry instance.

dsccsetup ads-delete

Delete the Directory Server instance used by DSCC to store configuration information.

This subcommand undo the work performed by the dsccsetup ads-create command. If you delete the DSCC registry, all the server registrations are deleted but the Server instances remain unaffected.

Use the -i when not using the command interactively.

dsccsetup cacao-reg [-t]

Register the local DSCC agent with the Common Agent Container, cacao.

Use the -t option if you want to start the Common Agent Container manually at a later time.

dsccsetup cacao-unreg

Remove the local DSCC agent registration information from cacao.

dsccsetup complete-patch [-t]

Performs actions required after applying a patch.

Use the -t option if you want to start the Common Agent Container and server instances manually at a later time.

dsccsetup dismantle [-t]

Undo DSCC initialization by performing cacao-unreg, ads-delete, and war-file-delete.

Use the -i when not using the command interactively.

Use the -t option if you want to start the Common Agent Container manually at a later time.

dsccsetup initialize [-t] [-w file]

Initialize DSCC by performing cacao-reg, ads-create, and war-file-create.

Use the -i when not using the command interactively.

Use the -t option if you want to start the Common Agent Container manually at a later time.

If you do not provide the Directory Manager password for the DSCC registry in the file passed to the -w option, the command prompts for the password.

dsccsetup mfwk-reg [-t]

Register the local Directory Server monitoring agent for Java Enterprise System Monitoring Framework with the Common Agent Container, cacao.

Use the -t option if you want to start the Common Agent Container manually at a later time.

dsccsetup mfwk-unreg

Remove the local Directory Server monitoring agent registration information from cacao.

dsccsetup prepare-patch

Perform actions that are required before applying a patch.

This subcommand stops the server instances and the Common Agent Container. Once prepare-patch is completed, none of the executables from the current installation is running. Thus the installation can be safely patched.

dsccsetup status

Display whether DSCC has been registered with Common Agent Container. Also, display whether the DSCC registry has been initialized.

dsccsetup war-file-create [--overwrite] [OUTPUT_WAR_FILE]

Generate the WAR file for deploying DSCC in an application server.

dsccsetup war-file-delete [OUTPUT_WAR_FILE]

Delete the WAR file.

GLOBAL OPTIONS

The following options apply to all commands and subcommands:

-?

--help

Display usage for the command or for the specified subcommand.

-i

--no-inter

Do not prompt for confirmation before performing the operation.

-V

--version

Displays the current version of dsccsetup. The version is provided in the format year.monthday.time. So version number 2009.0601.0035 was built on June 1st, 2009 at 00h35. If the components used by dsccsetup are not aligned, the version of each individual component is displayed.

-v

--verbose

Display extra information for debugging purposes.

SUBCOMMAND OPTIONS

The following options apply to the subcommands where they are specified:

--overwrite

Overwrites the existing WAR file.

-p PORT

Uses PORT for the LDAP port (Default: 3998 or random)

-P PORT

Uses PORT for the LDAPS port (Default: 3999 or random).

-t

--norestart

Do not start the Common Agent Container after performing the operation.

You can restart the Common Agent Container using the cacaoadm command.

-w file

--pwd-file file

Use the Directory Service Manager password specified in file.

By default, dsccsetup prompts for a password.

Operands

The following operands are supported:

OUTPUT_WAR_FILE

Name of the WAR file.

Exit Status

The following exit status values are returned:

0

Successful completion

non-zero

An error occurred.

Attributes

See attributes(5) for descriptions of the following attributes:

See Also

cacaoadm(1M), smcwebserver(1M)