Try OpenEdge Now
skip to main content
Database Administration
Reference : Other Database Administration Utilities : PROCLUSTER utility
 

PROCLUSTER utility

The PROCLUSTER command-line interface provides a user-friendly interface to Clusters. With PROCLUSTER, you can:
*Enable a database for failover
*Disable a cluster-enabled database
*Start and stop a cluster-enabled database
*Query the status of a cluster-enabled database

Syntax

procluster db-name
  [enable [-pf params-file][AI][BI][APW=n][WDOG]
|disable |start |stop |terminate | looksalive |isalaive ]

Parameters

db-name
Specifies the fully qualified path of the database.
enable
Enables a database so that it fails over properly. Before the database can be enabled, it must be created and reside on a shared disk. The database must not be in use when it is enabled as a cluster resource.
When you enable a database as a resource using PROCLUSTER enable, Clusters performs the following:
*Examines the database structure and generates a registration file
*Logs the registration in the database's log file
*Performs the cluster-specific registration
Enabling an OpenEdge database as a cluster resource creates the file <dbname>Resources.cluster. This is a text file that contains names of resources dependent on the database resource. If the database was not enabled with any helper processes or performance enhancers like AIW, APW, BIW, WDOG, the .cluster file will be empty; otherwise, it will contain the resource names of the dependent resources as registered with the cluster manager. Do not edit or delete this file. Clusters manages this file, and deletes it when the database is disabled.
If PROCLUSTER enable is successful, it returns the following message:
The cluster REGISTER command was successful. (10532)
-pf params-file
Specifies the file containing any parameters that the database requires when started.
The parameter file is required to:
*Be named db-name.pf
*Reside in the same directory as the database .db file
*Contain the parameter -cluster protected
*For Solaris only, the length of the mount point of the database cannot exceed 18 characters
AI
Directs PROCLUSTER to enable the after-image files, and an AI writer as resources with a dependency on the database. After-imaging must have previously been enabled on the database. See After-imaging for information on after-imaging.
BI
Directs PROCLUSTER to enable a BI writer as a resource with a dependency on the database.
APW= n
Directs PROCLUSTER to enable n number of asynchronous page writers as a resource with a dependency on the database.
WDOG
Directs PROCLUSTER to enable the Watchdog process as a resource with a dependency on the database.
disable
Removes the identified database resource if the database has been previously enabled for failover. Specifying the database name automatically disables any other optional dependencies specified when the database was enabled.
When you remove a database resource using PROCLUSTER disable, Clusters does the following:
*Shuts down the database if it is running
*Deletes the resource from the cluster manager software once it is in an offline state
Deletes the group from the cluster manager software if the resource is the last resource in the resource group.
start
Starts a cluster-enabled database. The database must have been previously enabled a cluster resource.
Note: PROCLUSTER will append -pfdb-name.pf to the proserve command that is generated to start the database. The start command will fail if this parameter file is not found.
stop
Stops a cluster-protected database. The database must be a cluster resource. When you stop the database with PROCLUSTER stop, Clusters does the following:
*Stops the database
*Notifies the cluster that the resource should be stopped without fail over
terminate
Forces a registered or cluster-protected database to shut down. The database must be a cluster resource.
looksalive
Determines if a resource looks operational by querying the cluster manager cache, if available, or the active system for the status of the specified database. The database must be a cluster resource.
The looksalive exit status returns the following text if the database looks alive:
Resource: db-name State: Looks Alive
The only state of the database that returns a value of Looks Alive is when the database is enabled and started. All other states will return the following:
Resource: db-name State: Not Alive
isaliave
Determines if a resource is actually operational by querying the active system for the status of the specified database.
The isalive exit status returns the following text if the database returns a successful query:
Resource: db-name State: Is Alive
All other states return the following:
Resource: db-name State: Not Alive

Notes

*The PROCLUSTER ENABLE registers the database as a cluster resource, even if there are errors in the command for the helper processes. To correct the errors, you must first use PROCLUSTER DISABLE to unregister the database, then use PROCLUSTER ENABLE to re-register without errors.
*If any of the helper (APW, BIW, or AIW) processes or the watchdog (WDOG) process specified to start with a particular database when the PROCLUSTER START command is issued fails, then they will not be started on another machine during a failover. They produce an OFFLINE status.