dsccreg

Manages the DSCC registry

Synopsis

install-path/bin/dsccreg subcommand [options]

Description

The dsccreg command is used to register server instances on the local system with the Directory Service Control Center (DSCC) registry, which may be remote. Use the dsccreg command with the subcommands described in this man page.

Subcommands

The following subcommands are supported:

dsccreg add-agent [-d TEXT] [-H LOCAL_HOST] [-G AGENT_PWD_FILE] [AGENT_PATH]: Add DSCC agent instance to the DSCC registry.
dsccreg add-server [-B INST_USER_DN] [-G INST_PWD_FILE] [-d TEXT] [-H LOCAL_HOST] [--agent-port PORT] INST_PATH: Add a server instance to the DSCC registry.
dsccreg list-agents: List agents registered with the DSCC registry.
dsccreg list-servers [-a] [--agent][-C]: List server instances registered with the DSCC registry.
dsccreg remove-agent [-H LOCAL_HOST] [-f,--force] [AGENT_PATH]: Remove a DSCC agent instance from the DSCC registry.
dsccreg remove-server [-B INST_USER_DN] [-G INST_PWD_FILE] [-H LOCAL_HOST] INST_PATH: Remove a server instance from the DSCC registry.

Global Options

The following options apply to all commands and subcommands:

-?

--help

Display usage for the command or for the specified subcommand.

-D user-dn

--user-dn user-dn

Bind using the specified user-dn.

By default, the value of the environment variable LDAP_ADMIN_USER is used. If LDAP_ADMIN_USER is not defined, cn=admin,cn=Administrators,cn=dcc is used.

-h hostname

--hostname hostname

Connect to the DSCC registry on the specified host or IP address.

By default, the value of the environment variable DSCC_HOST is used. If DSCC_HOST is not defined, localhost is used.

For example, when mapping the IPv4 address 192.168.0.99 to IPv6, pass the -h option with its argument as -h ::ffff:192.168.0.99.

-i

--no-inter

Do not prompt for confirmation before restarting servers.

-p port-number

--port port-number

Connect to the DSCC registry on the specified port.

By default, the value of the environment variable DSCC_PORT is used. If DSCC_PORT is not defined, 3998 is used.

-u uid

--username uid

Bind using cn=uid,cn=Administrators,cn=dcc.

By default, the value of the environment variable LDAP_ADMIN_USER is used. If LDAP_ADMIN_USER is not defined, cn=admin,cn=Administrators,cn=dcc is used.

-V

--version

Displays the current version of dsccreg. The version is provided in the format year.monthday.time. So version number 2007.1204.0035 was built on December 4th, 2007 at 00h35. If the components used by dsccreg are not aligned, the version of each individual component is displayed.

-v

--verbose

Display extra information for debugging purposes.

-w file

--pwd-file file

Bind using the password specified in file.

By default, the value of the environment variable LDAP_ADMIN_PWF is used. If LDAP_ADMIN_PWF is not defined, dsccreg prompts for a password.

Subcommands Options

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

-a

--all

Display hidden servers, such as the server used by DSCC to manage meta information about the directory service.

--agent

Displays DSCC agent information

--agent-port port

Specifies port as the DSCC agent port to use for communicating with this server instance.

-d desc

--description desc

Use the specified text desc as the description for the server instance.

-d text

--description text

Uses text as the description (default : none).

-B instance-user-dn

--inst-user-dn instance-user-dn

Use the specified bind DN to bind to the instance specified by instance-path.

By default, the dsccreg command uses cn=Directory Manager.

-C

--check-access

Verify that each registered server instance is accessible from DSCC.

-f

--force

Forces removal of the agent instance from the DSCC registry.

-G agent-pwd-file

Uses password from agent_pwd_file to access agent configuration

By default, the dsccreg command prompts for the password.

-G instance-pwd-file

--inst-pwd-file instance-pwd-file

Use the password in the specified file to bind to the instance specified by instance-path.

By default, the dsccreg command prompts for the password.

-H hostname

--current-host hostname

Use the specified host name as the local host.

By default, the dsccreg command uses the local host name returned by the operating system.

-H local_host

local_host is the hostname used by the DSCC registry to connect the DSCC agent (default : given by the OS).

Operands

The following subcommand operands are supported:

AGENT_PATH: Full path to the existing DSCC agent instance. By default, install-path/var/dcc/agent.
INST_PATH: Full path to the server instance.

Environment Variables

The following environment variables are supported:

DSCC_HOST: Bind to the registry on this host.
DSCC_PORT: Bind to the registry on this port number.
LDAP_ADMIN_PWF: Read the bind password from this file.
LDAP_ADMIN_USER: Bind with this user DN or uid.

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:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	11g R1 (11.1.1.7.0)
Stability Level	Evolving