10g (9.0.4)
Part Number B12118-01
 Home |
 Solution Area |
 Contents |
 Index |
| Oracle® Internet Directory Administrator's Guide 10g (9.0.4) Part Number B12118-01 |
|
Syntax for LDIF and Command-Line Tools, 3 of 10
This section tells how to use command-line tools for starting, stopping, restarting, and monitoring Oracle Internet Directory servers. It contains these topics:
Use the OID Monitor to initiate, monitor, and terminate directory server processes. If you elect to install a replication server, OID Monitor controls it. When you issue commands through OID Control Utility (OIDCTL) to start or stop directory server instances, your commands are interpreted by this process.
Starting OID Monitor restarts any Oracle Internet Directory processes that were previously stopped.
To start the OID Monitor:
oidmon [connect=connect_string] [host=virtual/host_name][sleep=seconds] start
Table A-1 Arguments for Starting OID Monitor
For example:
oidmon connect=dbs1sleep=15 start
To start OID Monitor on a virtual host:
oidmon connect=dbsl host=virtual_host start
Stopping the OID Monitor also stops all other Oracle Internet Directory processes.
To stop the OID Monitor daemon, at the system prompt, type:
oidmon [connect=connect_string][host=virtual/host_name]stop
For example:
oidmon connect=dbs1 stop
While starting and stopping OID Monitor, use the host parameter to specify the virtual host name. The syntax is:
oidmon [connect=connect_string] host=virtual_host start|stop
OID Control Utility is a command-line tool for starting and stopping the directory server. The commands are interpreted and executed by the OID Monitor process.
This section contains these topics:
Use the OID Control Utility to start and stop Oracle directory server instances.
The syntax for starting an Oracle directory server instance is:
oidctl connect=connect_stringserver=oidldapdinstance=server_instance_number[configset=configset_number][host=virtual/host_name][flags=' -p port_number -work maximum_number_of_worker_threads_per_server -debug debug_level -l change_ logging'-server number_of_server_processes]start
| Argument | Description |
|---|---|
|
|
Specifies a debug level during Oracle directory server instance startup |
|
|
Turns replication change logging on and off. To turn it off, enter
Turning off change logging for a given node by specifying |
|
|
Specifies a port number during server instance startup. The default port number is 389. |
|
|
Specifies the number of server processes to start on this port |
|
|
Specifies the SSL port number during server instance startup. Default port if not set is 636. See Also:
|
|
|
Specifies the maximum number of worker threads for this server |
|
|
Configset number used to start the server. This defaults to |
|
|
If you already have a |
|
|
Specifies the virtual host or rack nodes on which to start the directory server |
|
|
Instance number of the server to start. Should be a number between 1 and 1000. |
|
|
Type of server to start (valid values are OIDLDAPD and OIDREPLD). This is not case-sensitive. |
|
|
Starts the server specified in the |
For example, to start a directory server instance whose net service name is dbs1, using configset5,at port 12000, with a debug level of 1024, an instance number 3, and in which change logging is turned off, type at the system prompt:
oidctl connect=dbs1server=oidldapd instance=3 configset=5 flags='-p 12000'
-debug 1024 -lstart
When starting and stopping an Oracle directory server instance, the server name and instance number are mandatory, as are the commands start or stop. All other arguments are optional.
All keyword value pairs within the flags arguments must be separated by a single space.
Single quotes are mandatory around the flags.
The configset identifier defaults to zero (configset0) if not set.
At the system prompt, type:
oidctl connect=connect_string server=oidldapd instance=server_instance_number stop
For example:
oidctl connect=dbs1server=oidldapd instance=3 stop
If the directory server fails to start, you can override all user-specified configuration parameters to start the directory server and then return the configuration sets to a workable state by using the ldapmodify operation.
To start the directory server by using its hard-coded default parameters instead of the configuration parameters stored in the directory, type at the system prompt:
oidctl connect=connect_string flags='-p port_number -f'
The -f option in the flags starts the server with hard-coded configuration values, overriding any defined configuration sets except for the values in configset0.
To see debug log files generated by the OID Control Utility, navigate to $ORACLE_HOME/ldap/log.
Use the OID Control Utility to start and stop Oracle directory replication server instances.
The syntax for starting the Oracle directory replication server is:
oidctl connect=connect_string server=oidrepld instance=server_instance_number [configset=configset_number] flags=' -p directory_server_port_number -d debug_ level -h directory_server_host_name -m [true | false]-z transaction_size ' start
For example, to start the replication server with an instance=1, at port 12000, with debugging set to 1024, type at the system prompt:
oidctl connect=dbs1 server=oidrepld instance=1 flags='-p 12000 -h eastsun11 -d 1024' start
When starting and stopping an Oracle directory replication server, the -h flag, which specifies the host name, is mandatory. All other flags are optional.
All keyword value pairs within the flags arguments must be separated by a single space.
Single quotes are mandatory around the flags.
The configset identifier defaults to zero (configset0) if not set.
At the system prompt, type:
oidctl connect=connect_string server=OIDREPLD instance=server_instance_number stop
For example:
oidctl connect=dbs1server=oidrepld instance=1 stop
The Oracle directory integration and provisioning server executable, odisrv, resides in the $ORACLE_HOME/bin directory.
The way you start the directory integration and provisioning server depends on whether your installation is:
In this case, your installation includes, among other server and client components, the OID Monitor and the OID Control Utility. In such installations, you start and stop the directory integration and provisioning server by using these tools.
In this case, the way you start the directory integration and provisioning server depends on whether you are using the Oracle Directory Integration and Provisioning platform for high availability.
tnsnames.ora file with the right host and SID to which the OID Monitor must connect.
You can start the directory integration and provisioning server in either SSL mode for tighter security, or non-SSL mode. You need to use a connect string to connect to the database.
To start the directory integration and provisioning server in non-SSL mode:
ps -ef | grep oidmon
If OID Monitor is not running, then start it by following the instructions in "The OID Monitor (oidmon) Syntax".
oidctl [connect=connect_string] server=odisrv [instance=instance_number] [config=configuration_set_number] [flags="[host=hostname] [port=port_number] [debug=debug_level] [refresh=interval_between_refresh]
[grpID=group_identifier_of_provisioning_profile]
[maxprofiles=number_of_profiles]
[ sslauth=ssl_mode ]"] start
Table A-5 describes the arguments in this command.
| Argument | Description |
|---|---|
|
|
If you already have a |
|
|
Type of server to start. In this case, the server you are starting is |
|
|
Specifies the instance number to assign to the directory integration and provisioning server. This instance number must be unique. OID Monitor verifies that the instance number is not already associated with a currently running instance of this server. If it is associated with a currently running instance, then OID Monitor returns an error message. |
|
|
Specifies the number of the configuration set that the directory integration and provisioning server is to execute. This argument is mandatory. |
|
|
Oracle directory server host name |
|
|
Oracle directory server port number |
|
|
The required debugging level of the directory integration and provisioning server See Also: Table 10-2 for a description of the various debug levels |
|
|
Specifies the interval, in minutes, between server refreshes for any changes in the integration profiles. |
|
|
Specifies the maximum number of profiles that can be executed concurrently for this server instance |
|
|
SSL modes:
|
In a client-only installation, where the OID Monitor and OID Control tools are not available, the Oracle directory integration and provisioning server can be started without OID Monitor or OID Control Utility, either in non-SSL mode or, for tighter security, in SSL mode. The parameters described in Table A-5 remain the parameters for each type of invocation.
To start the directory integration and provisioning server, enter the following at the command line:
odisrv [host=host_name] [port=port_number]
config=configuration_set_number [instance=instance_number] [debug=debug_level] [refresh=interval_between_refresh] [maxprofiles=number_of_profiles] [sslauth=ssl_mode]
The way you stop the directory integration and provisioning server depends on the tool that you used to start it.
If you started the directory integration and provisioning server by using OID Monitor and the OID Control utility, then you use them to stop it, as follows:
ps -ef | grep oidmon
If OID Monitor is not running, then start it by following the instructions in "The OID Monitor (oidmon) Syntax".
oidctl [connect=connect_string] server=odisrv instance=instance stop
In a client-only installation, where the OID Monitor and OID Control tools are not available, the Oracle directory integration and provisioning server can be started without OID Control. To stop the server without these tools, use the stopodiserver.sh tool, which is located in the $ORACLE_HOME/ldap/admin directory.
|
Note: To run shell script tools on the Windows operating system, you need one of the following UNIX emulation utilities:
|
|
See Also:
"The StopOdiServer.sh Tool Syntax" for instructions about using the stopodiserver.sh tool |
When you want to refresh the server cache immediately, rather than at the next scheduled time, use the RESTART command. When the Oracle Internet Directory server restarts, it maintains the same parameters it had before it stopped.
To restart an Oracle Internet Directory server instance, at the system prompt, type:
oidctl connect=connect_string server={oidldapd|oidrepld|odisrv}
instance=server_instance_number restart
OID Monitor must be running whenever you restart directory server instances.
If you try to contact a server that is not running, you receive from the SDK the error message 81--LDAP_SERVER_DOWN.
If you change a configuration set entry that is referenced by an active server instance, you must stop that instance and restart it to effect the changed value in the configuration set entry on that server instance. You can either issue the STOP command followed by the START command, or you can use the RESTART command. RESTART both stops and restarts the server instance.
For example, suppose that Oracle directory server instance1 is started, using configset3, and with the net service name dbs1. Further, suppose that, while instance1 is running, you change one of the attributes in configset3. To enable the change in configset3 to take effect on instance1, you enter the following command:
oidctl connect=dbs1 server=oidldapd instance=1 restart
If there are more than one instance of the Oracle directory server running on that node using configset3, then you can restart all the instances at once by using the following command syntax:
oidctl connect=dbs1 server=oidldapd restart
Note that this command restarts all the instances running on the node, whether they are using configset3 or not.
When starting a directory server, a directory replication server, or a directory integration and provisioning server, use the host parameter to specify the virtual host name.
To start a directory server on a virtual host:
oidctl [connect=connect_string] host=virtual_host_name server=oidldapd instance=instance_number configset=configset_number flags= "..." start
To stop a directory server on a virtual host:
oidctl host=virtual_host_name server=oidldapd instance=instance_number stop
To start a directory replication server on a virtual host:
oidctl [connect=connect_string] host=virtual_host_name server=oidrepld instance=instance_number flags= "..." start
To stop a directory replication server on a virtual host:
oidctl host=virtual_host_name server=oidrepld instance=instance_number stop
To start a directory integration and provisioning server on a virtual host:
oidctl [connect=connect_string] host=virtual_host_name server=odisrv instance=instance_number configset=configset_number flags= "..." start
To stop a directory integration and provisioning server on a virtual host:
oidctl host=virtual/host_name server=odisrv instance=instance_number stop
When the directory server is started to run on the virtual host, it binds and listens to requests on the specified LDAP port on the IP address or IP addresses that correspond to the virtual host only.
When communicating with the directory server, the directory replication server uses the virtual host name. Further, the replicaID attribute that represents the unique replication identification for the Oracle Internet Directory node is generated once. It is independent of the host name and hence requires no special treatment in cold failover configuration.
When communicating with the directory server, the directory integration and provisioning server uses the virtual host name.
|
 Copyright © 1999, 2003 Oracle Corporation. All Rights Reserved. |
|