Table Of Contents
Server Administration and Configuration
B.1 Managing OSS Client Profiles for CTM GateWay/CORBA
B.1.1 Create an OSS Client Profile
B.1.2 Modify an OSS Client Profile
B.1.3 Delete an OSS Client Profile
B.1.4 View Currently Logged-In CTM GateWay/CORBA OSS Users
B.1.5 Delete Currently Logged-In CTM GateWay/CORBA OSS Users
B.2 Encryption Between CTM and GateWay/CORBA
B.3 Using Multiple Naming Servers
B.4 Naming Convention for Published CORBA Objects
B.5 Configuring CTM GateWay/CORBA
B.6 Using the CLI to Start and Stop CTM GateWay/CORBA Services
B.7 Installation
Server Administration and Configuration
This appendix includes information on the administration and configuration of CTM GateWay/CORBA. It provides the following information:
•
Managing OSS Client Profiles for CTM GateWay/CORBA
•
Encryption Between CTM and GateWay/CORBA
•
Using Multiple Naming Servers
•
Naming Convention for Published CORBA Objects
•
Configuring CTM GateWay/CORBA
•
Using the CLI to Start and Stop CTM GateWay/CORBA Services
•
Installation
B.1 Managing OSS Client Profiles for CTM GateWay/CORBA
The following sections describe how to create, modify, and delete an OSS client profile for CTM GateWay/CORBA.
B.1.1 Create an OSS Client Profile
The CTM GateWay/CORBA authenticates the OSS against a previously created user profile before allowing access to CTM. You can create up to sixteen OSS client profiles for CTM GateWay/CORBA sessions. Each OSS profile defines CTM GateWay/CORBA parameters, such as the OSS profile name, password, and IP address.
OSS client profiles are stored in the CTM GateWay/CORBA Users Table.
Step 1
Log into the CTM client with the appropriate user access profile.
Step 2
In the Domain Explorer window, choose Administration > GW/CORBA Users.
Step 3
In the GW/CORBA Users Table, choose Edit > Add (or click the Create a New User icon) to open the Add GW/CORBA User dialog box.
Step 4
In the Add GW/CORBA User dialog box, enter the following OSS client information:
•
OSS Profile Name—The name of the OSS profile.
•
Password—The password the OSS client uses to log into the CTM server. Confirm the password in the Confirm Password field.
Step 5
Click OK. Changes take effect immediately. The GW/CORBA Users Table gets a refresh event. If automatic refresh is turned on, the new OSS client profile appears as a new row in the table. If automatic refresh is turned off, click the Refresh button to see the new OSS client profile in the table.
Note
The GW/CORBA Users Table displays the profile for each OSS client that uses a CTM GateWay/CORBA service. You can view the GW/CORBA Users Table by choosing Administration > GW/CORBA Users in the Control Panel.
B.1.2 Modify an OSS Client Profile
Step 1
Log into the CTM client with the appropriate user access profile.
Step 2
In the Domain Explorer window, choose Administration > GW/CORBA Users.
Step 3
In the GW/CORBA Users Table, select an OSS client profile to modify; then, click the Modify User Properties icon. The Modify GW/CORBA User dialog box opens.
Step 4
Modify the following OSS client information, as appropriate:
•
OSS Profile—Modify the OSS profile.
•
Password—Modify the password that the OSS client uses to log into the CTM server.
•
Confirm Password—Enter the password again for confirmation.
Step 5
Click OK. Changes take effect immediately.
B.1.3 Delete an OSS Client Profile
Step 1
Log into the CTM client with the appropriate user access profile.
Step 2
In the Domain Explorer window, choose Administration > GW/CORBA Users.
Step 3
In the GW/CORBA Users Table, select an OSS client profile to delete; then, choose Edit > Delete (or click the Delete User icon).
Step 4
Click OK in the confirmation dialog box. The OSS client profile name is deleted from the GW/CORBA Users Table.
Note
If the OSS is connected to CTM when the profile is deleted, CTM does not terminate the OSS session.
Note
Naming service uses port 14005 for all CTM-related naming service instances. The port is hard-coded and can be changed only by changing the startup script jcorbagw.sh.
B.1.4 View Currently Logged-In CTM GateWay/CORBA OSS Users
Step 1
Log into the CTM client with the appropriate user access profile.
Step 2
In the Domain Explorer window, choose Administration > GW/CORBA Users.
Step 3
In the GW/CORBA Users Table, click the Show Logged In GateWay/CORBA Users icon. In the Active GW/CORBA Users Table, a list of currently logged-in users is displayed, including the OSS profile name, IP address to which the user is logged in, and the login time.
B.1.5 Delete Currently Logged-In CTM GateWay/CORBA OSS Users
Step 1
Log into the CTM client with the appropriate user access profile.
Step 2
In the Domain Explorer window, choose Administration > GW/CORBA Users.
Step 3
In the GW/CORBA Users Table, click the Show Logged In GateWay/CORBA Users icon.
Step 4
In the Active GW/CORBA Users Table, a list of currently logged-in users is displayed, including the OSS profile name, IP address to which the user is logged-in, and the login time. Select an OSS user to delete; then, choose Administration > Log Out GateWay CORBA User (or click the Log Out GateWay CORBA User icon).
The user session that is used to connect to the GateWay/CORBA service will be cleared from CTM GateWay/CORBA. You will notice the loss of session during the next ping cycle or when you try to perform an operation on another manager. Some examples of user operations are:
•
If the user is connected and performs a query operation on the EMS. The OSS user starts to query the EMS by getting a fresh object reference from the manager through an emsSession query. Since the session has been cleared by the GateWay/CORBA service, the OSS user will receive an exception and hence notice the loss of session.
•
CTM client forcefully logs out the user. The OSS user will not immediately notice the loss of session when the CTM client force a logout. To immediately log out the user, the GateWay/CORBA service needs to make a call to the NMS session interface, which forces the OSS client applications to modify their shutdown application. This is not a preferred method.
•
The GateWay/CORBA service clears the session information of the user from its internal memory and database.
B.2 Encryption Between CTM and GateWay/CORBA
CTM R6.0 uses improved encryption of usernames and passwords for network security.
You can set the CTM client Control Panel to send encrypted usernames and passwords to CTM GateWay/CORBA.
Step 1
Log into the CTM client with the appropriate user access profile.
Step 2
In the Domain Explorer window, choose Administration > Control Panel.
Step 3
Click the GateWay/CORBA Service icon to open the GateWay/CORBA Service property sheet.
Step 4
Click the Global tab.
Step 5
Check the Enable Encryption for Username and Password check box.
Step 6
Click Save; then, click Yes in the confirmation dialog box. Changes take effect immediately.
If the OSS clients enable the encryption feature, they must provide implementation for RSA-based encryption by retrieving the RSA Public Key or the Public Key Pair from GateWay/CORBA and by using cryptographic libraries.
•
To obtain the RSA Public Key from CTM, use the emsSessionFactory::EmsSessionFactory_I::getEmsPublicKey API. See the "3.4.2 emsSessionFactory::EmsSessionFactory_I::getEmsPublicKey" section on page 3-31 for details.
•
To obtain the RSA Public Key Pair from CTM, use the emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair API. See the "3.4.3 emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair" section on page 3-32 for details.
CTM returns the string representation of the RSA Public Key or Public Key Pair, encoded in the Base64 encoding scheme. OSS clients should use Base64 decoders to decode the public key and get the byte[] of the public key from the decoded public key string. The byte[] corresponding to the public key represents the key in its primary encoded format (X.509 SubjectPublicKeyInfo). Using this byte[] and cryptographic libraries, the RSA Public Key can be created.
One example of the security provider is Bouncy Castle Provider.
Use the public key to encrypt the username and password. Before passing the encrypted username and password to CTM for login, OSS clients should encode the encrypted username and password by using Base64 encoders to obtain the string equivalent of the encrypted data.
Note
Use cryptographic libraries implementing RSA Public Key encryption supporting the "PKCS #1 v2.0 EME-PKCS1-v1_5 (PKCS #1 v1.5 block type 2), PKCS1Padding" encoding scheme. CTM does not provide these cryptographic libraries.
B.3 Using Multiple Naming Servers
CTM registers with multiple naming servers. Add the following parameters to the CTM_server_installation_directory/cfg/corbagw.properties config file:
corbagw.namingservice.ServerList=ctmc4-u80,ctm7-u60
(default value is empty)
corbagw.namingservice.RootIORLoc=/namingroot.ior
(default value)
The first parameter lists all hosts on which naming service is running. These hosts should be reachable from the CTM server host. In addition, the Hypertext Transfer Protocol (HTTP) server must be running on all naming service hosts. The naming service root Interoperable Object Reference (IOR) must be published in a file. The location and name of the file are defined by the second parameter.
In addition to these naming service hosts, CTM registers itself with the local naming service. This naming service is bundled with CTM.
B.4 Naming Convention for Published CORBA Objects
CTM GateWay/CORBA publishes two top-level objects: EMSSessionFactory and NotificationChannel. CTM creates these objects and registers them with the CORBA name server.
CTM GateWay/CORBA creates naming contexts under the root as shown in Figure B-1. The last context in the tree must have a different name. To change this value in the CTM client GUI:
Step 1
Log into the CTM client with the appropriate CTM user access profile.
Step 2
In the Domain Explorer window, click the CTM Domain node.
Step 3
In the Management Domain Properties sheet, click the Identification tab.
Step 4
In the EMS Domain section, look for EMS ID. The value of this field should be used as the "id" field for context, where "kind" equals "EMS." The default value is CTM. By using different names, you can install multiple instances of CTM and use a centralized naming server and repository.
Figure B-1 Naming Scheme for CTM GateWay/CORBA Objects
B.5 Configuring CTM GateWay/CORBA
Step 1
From the Domain Explorer, select Administration > Control Panel.
Step 2
In the Control Panel, select GateWay/CORBA Service. Configure the following properties:
Note
If CTM GateWay/CORBA is running, changes to the config file do not take effect dynamically. You must restart CTM GateWay/CORBA for the changes to take effect. The following properties can be changed to modify CTM GateWay/CORBA functionality:
•
Encryption for username and password—This property defines whether the username and password that will be used for the CTM GateWay/CORBA client will be encrypted.
•
Heartbeat for notification channel—This property is the rate at which the notification service is checked. A zero entry means not to check the notification service.
•
Maximum number of simultaneous sessions—This property is the number of CTM GateWay/CORBA sessions that can be active at the same time. Range is from 4 to 25.
•
Maximum events per consumer—CTM GateWay/CORBA uses this property to set the MaxEventsPerConsumer administrative QoS parameter of the notification channel. The notification server uses this property to bound the maximum number of events in a given channel that are allowed to queue at any given time. The default value is 0, where the notification server does not impose a limit on the maximum number of events that can be queued. If no limits are imposed on the queue, the notification server might run out of memory if a client behaves incorrectly. The server must keep all events in memory until they are consumed by all registered consumers.
Caution 
Any change to this value should be made with extreme caution. If you set the value too low, the NMS will not receive all notifications. If you set the value too high, the CTM notification server will run out of memory. The current value is set to handle alarm bursts of 10,000 events per minute.
•
Notification service name—This property defines the service name that the resolve_initial_reference function uses to get a reference to the notification service. The CTM GateWay/CORBA installation installs the notification service automatically. To use your own notification service, modify this parameter.
Tip
You do not need to change this parameter if you plan to use the notification service that is bundled with CTM GateWay/CORBA.
•
Notification service naming context—NamingContext defines the naming context of NotificationService. This property is used when resolve_initial_reference fails to resolve NotificationService. CTM GateWay/CORBA contacts the naming service to resolve the name context defined in this property. The value of this property must match the value published by your notification server.
Tip
You do not need to change this parameter if you plan to use the notification service that is bundled with CTM GateWay/CORBA.
•
Notification service factory IOR filename—The FactoryIORFile property defines the path to a text file that contains the IOR of NotificationService. This property is used only after resolve_initial_reference and naming service fail. CTM GateWay/CORBA opens the file as defined by the URL format in this property and attempts to retrieve the IOR from this file. This parameter lets you run your notification service on a different host to improve performance.
Tip
You do not need to change this parameter if you plan to use the notification service that is bundled with CTM GateWay/CORBA.
•
Notification service listening port number—This property is used to set the port that the notification service uses to listen for incoming requests. The port number is set in the IOR for the notification service. The use IOR and use IOR endpoint properties will be set properly. Default port number is zero, which signifies the port number to be allocated by the operating system.
•
Session port number—This property configures the IIOP listening port. The CTM GateWay/CORBA service listens to CORBA requests on this port. If this property is not specified in the corbagw.properties file, the listener port number is allocated by the operating system.
•
Name service server list—The ServerList property defines where the name servers are running. This property takes a comma-separated list of host names.
•
Name service root IOR—The RootIORLoc property defines the path used to find the naming service IOR on each host defined in ServerList. The complete path is constructed as http://<item_of_Server> <List RootIORLoc>.
•
Error level—This property by default is disabled. If the NMS requires CTP-related transmission parameters to be included as part of any object reporting TerminationPoint_T structure, then this property should be set to true. However, ManagedElementMgr_I.getTP interface will always return transmission parameters as part of TerminationPoint_T structure and is independent of this property setting.
B.6 Using the CLI to Start and Stop CTM GateWay/CORBA Services
If you are a CTM user with administrative privileges, you can start and stop CTM GateWay/CORBA services from the command line. You need a CTM username and password for the SysAdmin or SuperUser profile.
•
To start a GateWay/CORBA service, enter the following on the command line:
/opt/CiscoTransportManagerServer/bin/gwcorba-start
•
To stop a GateWay/CORBA service, enter the following on the command line:
/opt/CiscoTransportManagerServer/bin/gwcorba-stop
Note
After entering the commands, provide the username and password when instructed.
If the GateWay/CORBA service is already running when you enter the gwcorba-start script, the script simply exits with the message "GWCORBA already running."
If the GateWay/CORBA service is already stopped when you enter the gwcorba-stop script, the script simply exits with the message "GWCORBA not running."
Note
The GateWay/CORBA Service can take up to 60 seconds to initialize after the GUI status has changed to indicate that the service is up. The status is an indication of the successful initiation of the service startup, not successful initialization.
B.7 Installation
The CTM installation program installs the CTM GateWay/CORBA component, which includes OpenFusion 4.2 Notification Service from Prism Technologies, Inc. IDL files are installed under the /opt/CiscoTransportManagerServer/idl directory. Refer to Cisco Transport Manager Release 6.0 Installation Guide for more information.