Solstice Enterprise Manager 4.1 CORBA Gateway Administration Guide Doc Set ContentsPreviousNextIndex

Chapter 3

Administering the System

This chapter describes how to configure the SEM CORBA Gateway as well as how to start, stop, and troubleshoot CORBA Gateway processes.

This chapter describes the following topics:

3.1 Configuring SEM CORBA Gateway

To configure SEM CORBA Gateway, you must configure its individual component gateways. You can configure these gateways by modifying their corresponding configuration files (see TABLE 3-1) and restarting the SEM CORBA Gateway to reflect the changes. By default, the configuration files are located at /var/opt/SUNWconn/em/conf directory.

TABLE 3-1   SEM CORBA Gateway Configuration Files
File Description
em_corba_epr.conf
 Configuration file for Event Port Registry
em_corba_rgw.conf
 Configuration file for Request Gateway
em_corba_eds.conf
 Configuration file for Event Distribution Server
em_corba_mgw.conf
 Configuration file for Metadata Gateway


To modify a configuration file, set the values of its environment variable to the appropriate values if different from the default values. TABLE 3-2 describes the SEM CORBA Gateway configuration variables.

TABLE 3-2   SEM CORBA Gateway Configuration Variables
Variable Description
EM_MIS_DEFAULT_HOST
 Name of MIS to which SEM CORBA Gateway connects.
EM_CORBA_EPR_LOG_FILE
 The file used by Event Port Registry to log messages.
EM_CORBA_EPR_DEBUG_PORT
 Debug port for remote dynamic debugging of Event Port Registry.
EM_CORBA_RGW_LOG_FILE
 The file used by Request Gateway to log messages.
EM_CORBA_RGW_DEBUG_PORT
 Debug port for remote dynamic debugging of Request Gateway.
EM_CORBA_RGW_MAX_POOL_THREAD
 Shared pool sizes for reply thread pools and other thread pools.
EM_CORBA_MGW_LOG_FILE
 The file used by Metadata Gateway to log messages.
EM_CORBA_MGW_DEBUG_PORT
 Debug port for remote dynamic debugging of Metadata Gateway.


Note – If you run em_services with the -reload or -r option after you modify the configuration files, your modifications will be lost.

To make your changes permanent, modify and save the relevant configuration file in the directory /opt/SUNWconn/em/build/acct (assuming you installed Solstice EM in the default /opt location).

Caution – Be careful with permanent modifications. You may lose original default values unless you have a backup copy.

3.1.1 Start-up Options for SEM CORBA Gateway

The SEM CORBA Gateway requires the following command line arguments during start-up:

For VisiBroker:

-ORBInitRef NameService=iioploc://$SYSTEMID:$EM_CNS_PORT/NameService

The SYSTEMID and EM_CNS_PORT environment variables specify the system on which naming services are to be located and the port through which the naming services will be contacted. The SYSTEMID variable is defined in the em_cgw_services script file and the EM_CNS_PORT variable is defined in the em_corba_env.csh and em_corba_env.sh files.

For Orbacus:

-ORBservice NameService corbaloc::$SYSTEMID:$EM_CNS_PORT/NameService

The SYSTEMID and EM_CNS_PORT environment variables specify the system on which naming services are to be located and the port through which the naming services will be contacted. The SYSTEMID variable is defined in the em_cgw_services script file and the EM_CNS_PORT variable is defined in the em_corba_env.csh and em_corba_env.sh files.

For Orbix:

-ORBdomain_name ${IT_DOMAIN_NAME} -ORBconfig_domains_dir
${IT_CONFIG_DOMAINS_DIR}

The IT_DOMAIN_NAME environment variable specifies the configuration domain name to use. The IT_CONFIG_DOMAINS_DIR environment variable specifies the directory containing the configuration file DomainName.cfg.

Generally the SEM CORBA Gateway services are started, using em_cgw_services, which is invoked by the following command:

em_cgw_services -start

This command will also try to start the naming service on the host machine. This will work fine for VisiBroker and Orbacus. In case of Orbix, to be able to run naming service, the host machine should have an Orbix server runtime environment. If the Orbix sever runtime environment is setup on a machine other than the host machine and naming service is started on that machine, it is possible for SEM CORBA Gateway services to use the naming service. In such a case, you will have to suitably modify the em_cgw_services script so as to not start or stop the Orbix services.

Note – The Orbix client runtime environment should be installed on the machine on which you want to deploy the Orbix client applications.

3.1.2 Setting the Default Root Naming Context

The default root naming context is specified by the environment variable EM_CORBA_ROOT_NAMING_CONTEXT and the default value is the hostname where em_cgw_services is run. You can use this variable to distribute the ORB and CosNamingExtFactory to a machine different from the one on which the SEM CORBA Gateway is running.

3.1.3 Configuring the CORBA Event Port Registry

TABLE 3-3 describes the configuration of CORBA Event Port Registry (EPR), while CODE EXAMPLE 3-1 shows a sample EPR configuration file.

TABLE 3-3   CORBA EPR Configuration
Action Procedure
To log errors or output messages from the Event Port Registry
 Set the EM_CORBA_EPR_LOG_FILE environment variable in the em_corba_epr.conf configuration file to the name of the log file to use. The default value of the variable is /var/opt/SUNWconn/em/debug/em_corba_epr.log
To configure the debug port for troubleshooting
 Set the EM_CORBA_EPR_DEBUG_PORT environment variable in em_corba_epr.conf to the debug port. The default value is 6660. For more information on troubleshooting, See Section 3.3 Troubleshooting SEM CORBA Gateway Processes.


CODE EXAMPLE 3-1   Sample EPR Configuration File
# Copyright 06/01/99 Sun Microsystems, Inc. All Rights Reserved.


  

  

     

#pragma ident  "@(#)em_corba_epr.conf   1.1 99/06/01 Sun Microsystems"


  

  

     


  

  

     

# CORBA event gateway log file in full path


  

  

     

EM_CORBA_EPR_LOG_FILE:           /var/opt/SUNWconn/em/debug/em_corba_epr.log


  

  

     


  

  

     

# CORBA event gateway debug port


  

  

     

EM_CORBA_EPR_DEBUG_PORT:         6660


  













   3.1.4	 Configuring the 
CORBA Request Gateway






   TABLE 3-4 
describes the configuration of CORBA Request Gateway (RGW), 
while shows a sample RGW configuration file.



    

   TABLE 3-4 	  CORBA RGW 
Configuration
  
 Action

     Description

  

  

    
 To specify the MIS to which the CORBA RGW connects

    
 Set the EM_MIS_DEFAULT_HOST variable in the 
em_corba_rgw.conf configuration 
file to the name of the MIS. The default value is localhost.

  

  

    
 To log errors or output messages from the CORBA 
RGW

    
 Set the EM_CORBA_RGW_LOG_FILE environment 
variable in em_corba_rgw.conf to 
the name of the log file to use. The default value of the 
variable is /var/opt/SUNWconn/em/debug/em_corba_rgw.log

  

  

    
 To configure the debug port for 
troubleshooting

    
 Set the EM_CORBA_RGW_DEBUG_PORT environment 
variable in em_corba_rgw.conf to 
the debug port. The default value is 6666. For more information on 
troubleshooting, refer to Section 3.3 
Troubleshooting SEM CORBA Gateway 
Processes.

  

  

    
 To modify the maximum number of threads 
(thread-pool size) that the CORBA RGW uses if the hardware 
configuration is different from the reference 
configuration

    
 Set the EM_CORBA_RGW_MAX_POOL_THREADS 
environment variable in em_corba_rgw.conf to the maximum number 
of threads. The default value is 3.

  










 CODE EXAMPLE 3-2 	  Sample RGW Configuration File




  
  
  

  

     

# Copyright 06/01/99 Sun Microsystems, Inc. All Rights Reserved.


  

  

     


  

  

     

#pragma ident  "@(#)em_corba_rgw.conf   1.1 99/06/01 Sun Microsystems"


  

  

     


  

  

     

# MIS default name


  

  

     

EM_MIS_DEFAULT_HOST:             localhost


  

  

     


  

  

     

# CORBA request gateway log file in full path


  

  

     

EM_CORBA_RGW_LOG_FILE:           /var/opt/SUNWconn/em/debug/em_corba_rgw.log


  

  

     


  

  

     

# CORBA request gateway maximum pool threads


  

  

     

EM_CORBA_RGW_MAX_POOL_THREADS:   3


  

  

     


  

  

     

# CORBA request gateway debug port


  

  

     

EM_CORBA_RGW_DEBUG_PORT:         6666


  













   3.1.5	 Configuring the 
CORBA Event Distribution Server






   As it is possible to start more than one CORBA 
Event Distribution Server (EDS) as part of a given CORBA 
Gateway, and because it is hard to map configuration file 
variables to instances of CORBA EDS, the CORBA EDS does not 
use configuration files to configure itself. Instead, CORBA 
EDS relies on the command-line arguments shown in TABLE 3-5 
for configuration. 



    

   TABLE 3-5 	  CORBA EDS 
Configuration Commands
  
 Command

     Description

  

  

    
 mis

    
 Specifies the MIS from which events should be 
gathered. 

  

  

    
 port

    
 Specifies the debug port.

  

  

    
 log

    
 Specifies the Filename where error or output 
messages are logged. 

  

  

    
 threads

    
 Specifies the Thread-pool size used by CORBA EDS 
instances.

  















   By default, em_cgw_services starts two instances of 
CORBA EDS. To start more or fewer instances, modify the start_corba_event_gw() function in the 
em_cgw_services script located in 
the /opt/SUNWconn/bin directory. 







   CODE EXAMPLE 3-3 shows the default contents of this script, and CODE EXAMPLE 3-4 shows a modified version to start three instances 
of CORBA EDS.






   Note – The CORBA EDS 1 default debug 
port is 6500. The CORBA EDS 2 default debug port is 6502.


 CODE EXAMPLE 3-3 	
  Default Contents of the Script em_cgw_services1




  
  
  

  

     

start_corba_event_gw() {


  

  

     

    start_corba_eds em_corba_eds1.log 6500 3


  

  

     

    debugmsg "Started the first CORBA EDS"


  

  

     


  

  

     

    start_corba_eds em_corba_eds2.log 6502 3


  

  

     

    debugmsg "Started the second CORBA EDS"


  

  

     

}


  








 CODE EXAMPLE 3-4 	
  Modified em_cgw_services Script to Start Up 3 
EDS Gateways




  
  
  

  

     

start_corba_event_gw() {


  

  

     

    start_corba_eds em_corba_eds1.log 6500 3


  

  

     

    debugmsg "Started the first CORBA EDS"


  

  

     


  

  

     

    start_corba_eds em_corba_eds2.log 6502 3


  

  

     

    debugmsg "Started the second CORBA EDS"


  

  

     


  

  

     

    start_corba_eds em_corba_eds3.log 6503 3


  

  

     

    debugmsg "Started the third CORBA EDS"


  

  

     

}


  













   3.1.6	 Configuring the 
CORBA Metadata Gateway






   TABLE 3-6 
describes the configuration of CORBA Metadata Gateway (MGW), 
while CODE EXAMPLE 3-5 shows a sample MGW configuration file.



    

   TABLE 3-6 	  CORBA MGW 
Configuration
  
 Action

     Description

  

  

    
 To specify the MIS to which the CORBA MGW 
connects

    
 Set the EM_MIS_DEFAULT_HOST variable in the 
em_corba_mgw.conf configuration file to 
the name of the MIS. The default value is localhost.

  

  

    
 To log errors or output messages from the 
gateway

    
 Set the EM_CORBA_MGW_LOG_FILE environment 
variable in em_corba_mgw.conf to 
the name of the log file to use. The default value of is 
/var/opt/SUNWconn/em/debug/em_corba_mgw.log

  

  

    
 To configure the debugging port for 
troubleshooting

    
 Set the EM_CORBA_MGW_DEBUG_PORT environment 
variable in em_corba_mgw.conf to 
the debug port. The default value is 6664. For more information on 
troubleshooting, refer to Section 3.3 
Troubleshooting SEM CORBA Gateway 
Processes.

  










 CODE EXAMPLE 3-5 	
  Sample MGW Configuration 
File 


  
  

     


  

  

     

copyright 06/01/99 Sun Microsystems, Inc. All Rights Reserved.


  

  

     

#pragma ident  "@(#)em_corba_mgw.conf   1.1 99/06/01 Sun Microsystems"


  

  

     


  

  

     

# MIS default name


  

  

     

EM_MIS_DEFAULT_HOST:             localhost


  

  

     


  

  

     

# CORBA metadata gateway log file in full path


  

  

     

EM_CORBA_MGW_LOG_FILE:           /var/opt/SUNWconn/em/debug/em_corba_mgw.log


  

  

     


  

  

     

# CORBA metadata gateway debug port


  

  

     

EM_CORBA_MGW_DEBUG_PORT:         6664


  






 






   3.1.7	 Configuring 
Authentication Modules






   You can use the CORBA Gateway to develop and use 
your own authentication modules. For information on how to 
develop your own authentication modules, refer to Chapter 2 
"Interacting With SEM CORBA Gateway" in Developing CORBA 
Applications.






   To use your own authentication module (library), 
do the following:





 	1.	 Stop the CORBA Gateway.



  
  

     

em_cgw_services -stop


  











 	2.	 Replace the existing 
authentication library libauth_server.so.1 on the machine 
where the CORBA Gateway is running, with your authentication 
library. 



 	3.	 Restart the CORBA 
Gateway.



  
  

     

em_cgw_services -start


  













   3.2	 Starting and 
Stopping CORBA Gateway Processes 






   To start or stop CORBA Gateway processes, use one 
of the following commands:






   3.3	 Troubleshooting SEM 
CORBA Gateway Processes






   You can troubleshoot CORBA Gateway processes as 
follows:






   3.3.1	 Checking the Log 
Files






   When troubleshooting SEM CORBA Gateways, first 
check the log files associated with the individual SEM CORBA 
Gateway processes. These files contain the error messages 
that are logged by the Gateway. TABLE 3-7 
describes the log files that are generated by default, by the 
CORBA Gateway. These files are present in the /var/opt/SUNWconn/em/debug directory. 




    

   TABLE 3-7 	  CORBA Gateway Log 
Files
  
 File

     Description

  

  

    
 em_corba_epr.log

    
 EPR log file 

  

  

    
 em_corba_rgw.log

    
 RGW log file 

  

  

    
 em_corba_mgw.log

    
 MGW log file 

  

  

    
 em_corba_eds1.log

    
 CORBA EDS 1 log file 

  

  

    
 em_corba_eds2.log

    
 CORBA EDS 2 log file 

  















   You can specify different files to be used as log 
files by changing the values of the log file configuration 
variables (see Section3.1 
Configuring SEM CORBA Gateway for more information).


 CODE EXAMPLE 3-6 	  Sample Log File Contents for the Request 
Gateway1 




  
  
  

  

     

rgw_debug: Started the thread safe PMI scheduler


  

  

     

rgw_debug: Obtained initial name service reference


  

  

     

rgw_trace: JIDM::ProxyAgentController - created


  

  

     

rgw_debug: JIDM::ProxyAgentController is ready


  

  

     

rgw_debug: JIDM::ProxyAgentFinder is ready


  

  

     

rgw_debug: SEM::AuthenticationProxy is ready


  

  

     

rgw_debug: Ready to accept client requests


  

  

     

rgw_trace: ProxyAgentFinderImpl::access_domain() starts


  

  

     

rgw_trace: JIDM::ProxyAgentFinder - validating key and access criteria


  

  

     

rgw_trace: JIDM::ProxyAgentFinder - authenticating user profile in [faith MIS]


  

  

     

rgw_trace: ProxyAgentFinderImpl::find_matching_proxy_agent() starts


  

  

     

rgw_trace: JIDMProxyAgentImpl::JIDMProxyAgentImpl() start


  

  

     

rgw_trace: JIDMProxyAgentImpl::JIDMProxyAgentImpl() end


  

  

     

rgw_debug: OSIMgmtExt::ProxyAgent is ready


  

  

     

rgw_trace: ProxyAgentFinderImpl::returning this - access_domain() ends


  

  

     

rgw_trace: JIDMProxyAgentImpl::access_criteria() start


  

  

     

rgw_trace: GetPendingRequest::translate_request() start


  

  

     

rgw_debug: message type = get request


  

  

     

rgw_debug: id = 0


  

  

     

rgw_debug: source =


  

  

     

rgw_debug:   aclass = PRIM, atag = 2


  

  

     

  aval = "[0xff][0xff][0x2][0xe3][0xc4][0x1][0x4][0x81][0x9e][0xe6][0xa3]"


  

  

     

rgw_debug: dest =


  

  

     

rgw_debug:   aclass = PRIM, atag = 2


  

  

     

  aval = "[0xff][0xff][0x2][0x15][0xb3][0x1][0x4][0x81][0x9e][0xe6][0xa3]"


  

  

     

rgw_debug: remote =


  

  

     

rgw_debug:   aclass = DEF, atag = 0


  

  

     

  aval = Du: no data unit allocated


  

  

     

rgw_debug: mode = CONFIRMED


  

  

     

rgw_debug: app_context = Du: no data unit allocated


  

  

     

rgw_debug: oc =


  

  

     

rgw_debug:  Tag  Len Value


  










 




   3.3.2	 Using Dynamic 
Debugging






   You may occasionally need to use the em_debug command to turn on dynamic 
debugging for SEM CORBA Gateway. The output of em_debug is particularly useful if you 
have to file a bug against the SEM CORBA Gateway. TABLE 3-8 
describes the debug objects that you can enable: 



    

   TABLE 3-8 	  CORBA Gateway 
Debugging Objects
  
 Error 
Objects

     Debug 
Objects

     Corresponding 
Gateway

  

  

    
 rgw_error

    
 rgw_debug

    
 RGW

  

  

    
 mgw_error

    
 mgw_debug

    
 MGW

  

  

    
 epr_error

    
 epr_debug

    
 EPR

  

  

    
 egw_error

    
 egw_debug

    
 CORBA EDS

  















   The debug objects1 
print out extensive debug statements, which will involve 
printing the contents of a message going back and forth 
between SEM CORBA Gateway and MIS. The debug statements are 
not actual error indicators but are a trace of events that 
occur leading to the error.






   For example, to see the error messages from the 
RGW, you can enter the following command:



  
  

     

em_debug -port 6666 -c 'on rgw_error' 


  














   The em_debug command 
sends messages to the window in which the command is 
executed. If you expect a large number of messages to be 
generated, you could redirect the output of the command to a 
file which you can view with a text-editor or by executing 
the tail -f command. 






   




  
 1
 Enabling debug objects degrades the 
performance of the system because of the large number of 
messages that get generated. It is recommended that you 
disable debug objects when you no longer need the debug 
information.



















Sun Microsystems, Inc.

Copyright information. All rights 
reserved.






Doc Set  |  
Contents
  |  
Previous
  |  
Next
  |  
Index