Oracle® Fusion Middleware Man Page Reference for Oracle Directory Server Enterprise Edition 11g Release 1 (11.1.1.7.0) Part Number E28967-01 |
|
|
PDF · Mobi · ePub |
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-dnBind 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
hostnameConnect 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-numberConnect 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
uidBind 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
fileBind 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
portSpecifies port
as the DSCC agent port to use for communicating with this server instance.
-d
desc--description
descUse the specified text desc as the description for the server instance.
-d
text--description
textUses text as the description (default : none).
-B
instance-user-dn--inst-user-dn
instance-user-dnUse 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-fileUses 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-fileUse 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
hostnameUse 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_hostlocal_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:
Full path to the existing DSCC agent instance. By default, install-path/var/dcc/agent
.
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
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 |
See Also