Table Of Contents
Managing Southbound and Northbound Interfaces
12.1 How Do I Manage Southbound Interfaces?
12.1.1 Southbound Port Details
12.1.2 Using a Static CORBA Listener Port on the CTM Server
12.1.3 Client-Server Communication Protocols
12.1.4 Changing the CTM Server Port
12.2 How Do I Manage Northbound Interfaces?
12.2.1 Managing CTM GateWay/SNMP
12.2.2 Managing CTM GateWay/TL1
12.2.3 Managing CTM GateWay/CORBA
Managing Southbound and Northbound Interfaces
CTM uses protocols such as CORBA, SNMP, TL1, and HTTP to provide southbound and northbound interfaces to communicate with NEs and OSSs.
This chapter contains the following information:
•
How Do I Manage Southbound Interfaces?
•How Do I Manage Northbound Interfaces?
12.1 How Do I Manage Southbound Interfaces?
The CTM server communicates with NEs through the DCN by using several protocols (CORBA, HTTP, TL1, SNMP, and so on).
You can access NEs in CTM through:
•NE Explorer—Provides detailed rack, shelf, and card-level views of an NE. Detailed NE attributes and parameters are viewable and configurable.
•Craft Interface—Depending on the NE model, CTM provides access to NE craft interfaces such as CTC, Cisco Edge Craft, CiscoView, web browsers, and the CLI. Table 2-4 on page 2-9 lists the available craft interfaces by NE model.
12.1.1 Southbound Port Details
This section explains the ports that CTM uses to communicate with NEs.
Table 12-1 lists the ports that CTM uses to communicate with ONS 15216 NEs.
Table 12-1 Port Information for the ONS 15216
Port
|
ONS 15216
|
Inbound or Outbound?
|
TL1 telnet
|
3083
|
Outbound
|
CLI
|
23, 8023
|
Outbound
|
CTM GateWay/SNMP set/trap
Note CTM GateWay/SNMP uses port 8765 as an internal port.
|
161, 162
|
Outbound
|
TFTP
|
69
|
Inbound
|
Table 12-2 lists the ports that CTM uses to communicate with ONS 15302 and ONS 15305 NEs.
Table 12-2 Port Information for the ONS 15302 and ONS 15305
Port
|
ONS 15302, ONS 15305
|
CLI
|
23
|
CTM GateWay/SNMP
Note CTM GateWay/SNMP uses port 8765 as an internal port.
|
161
|
Table 12-3 lists the ports that CTM and CTC use to communicate with CTC-based NEs.
Table 12-3 Port Information for CTC-Based NEs
Port
|
NE
|
CORBA listener port on the Timing Communications and Control Card (TCC+/TCC2) (NE)
|
Configurable with:
•TCC+/TCC2 fixed (57790, Outbound)
•Standard Internet Inter-ORB Protocol (IIOP) port (683, Outbound)
•User-defined constant
Note Configure the port in the NE Explorer (Network > Address subtab). For more information, see 4.4.4 Viewing and Changing the Network Address—CTC-Based NEs, page 4-37.
|
CORBA listener port on CTM server (callback)
|
Dynamic (current functionality)
Note To make the port static, see Using a Static CORBA Listener Port on the CTM Server.
|
HTTP
|
From any CTC or CTM port to HTTP port 80 (Outbound) on the NE
|
TL1 port on TCC+/TCC2 (NE)
|
From any CTC or CTM port to TCP port 3082, 2361 (Outbound)
|
Software download, backup, restore port on TCC+/TCC2 (NE)
|
From any CTC or CTM port to TCP port 9999 (Outbound; data transfer) on the NE
|
Software activate/revert diagnostics port on CTM server
|
Dynamically allocated in the range of ports 9500 to 9550 (Outbound) to allow multiple concurrent activate/revert operations
|
CTC launched from CTM Domain Explorer
|
•From any CTC port to the IIOP port on the NE
•From any NE port to the IIOP port on CTC
•From any CTC port to HTTP port 80 (Outbound) on the NE
•Either port is configurable in the CTC.INI (Windows) or .ctcrc (UNIX):
– Dynamic (default)
–Standard IIOP port (683, Outbound)
–User-defined constant
|
L2 Service Resync port
|
From any port on CTM to port 20xx on the NE, where xx is the ML card slot number
|
CTM GateWay/SNMP
Note CTM GateWay/SNMP uses port 8765 as an internal port.
|
From any NE port to SNMP trap port 162 (Inbound) on the CTM server
|
Table 12-4 lists the ports that CTM uses to communicate with ONS 155xx NEs.
Table 12-4 Port Information for the ONS 155xx
Port
|
ONS 155xx
|
Inbound or Outbound?
|
HTTP
|
80/81
|
Outbound
|
TL1
|
TCP 3082, 3083
|
Outbound
|
IOS CLI
|
TCP 23 (telnet)
|
Outbound
|
Software download, backup, restore
|
69 (TFTP server)
|
Inbound
|
CTM GateWay/SNMP requests
Note CTM GateWay/SNMP uses port 8765 as an internal port.
|
UDP 161
|
Outbound
|
SNMP traps
|
UDP 162
|
Inbound
|
CiscoView (if CiscoView is cross-launched by CTM to manage ONS 155xx NEs)
|
TCP 1741
|
Inbound (CTM client to CTM server)
|
Table 12-5 lists the ports that CTM uses to communicate with ONS 1580x NEs.
Table 12-5 Port Information for the ONS 1580x
Port
|
ONS 1580x
|
Inbound or Outbound?
|
TL1
|
1000
|
Outbound
|
Telnet to OS
|
23
|
Outbound
|
TFTP
|
69
|
Inbound
|
Table 12-6 lists the ports that CTM uses to communicate with the CRS-1.
Table 12-6 Port Information for the CRS-1
Port
|
CRS-1
|
Inbound or Outbound?
|
SSH CLI
|
22
|
Outbound
|
Telnet CLI
|
23
|
Outbound
|
TFTP (for PM data collection, memory backup, and memory restore)
|
69
|
Inbound and outbound1
|
HTTPS
|
443
|
Outbound
|
CORBA naming service
|
10001
|
Outbound
|
CORBA notifications
|
Dynamic
|
Outbound
|
Table 12-7 lists the ports that CTM uses to communicate with the Catalyst 6509.
Table 12-7 Port Information for the Catalyst 6509
Port
|
CRS-1
|
Inbound or Outbound?
|
SNMP operations
|
161
|
Outbound
|
SNMP traps
|
162
|
Inbound
|
12.1.2 Using a Static CORBA Listener Port on the CTM Server
Step 1 Log into the CTM server workstation as the root user.
Step 2 Change the directory to /opt/CiscoTransportManagerServer/bin.
Step 3 Edit the jne454.sh file by inserting a new line before the -classpath line:
-Dong.orb.iioplistenerport=<port_number> \
For example, if the port number is 5555, enter:
-Dong.orb.iioplistenerport=5555 \
Step 4 Start the CTM server.
12.1.3 Client-Server Communication Protocols
CTM uses the following protocols for client-server communication:
•CORBA
•JMOCO (Cisco proprietary TCP/IP-based request/response protocol)
•Telnet
•Java Database Connectivity (JDBC)
Table 12-8 lists the ports that the CTM server uses to communicate with CTM clients.
Table 12-8 CTM Server and Client Ports
Module or Protocol
|
Port
|
Inbound or Outbound?
|
JMOCO port
|
27613 (configurable)
|
Inbound
|
CORBA IIOP listener port on CTM server
|
Dynamic
|
—
|
GateWay/TL1 OSS listener port
|
26715 (configurable)
|
Inbound
|
SNMP command port
|
161
Note Port 161 is used only for communication between SNMP-managed NEs and the CTM server, not for communication between the CTM client and server.
|
Outbound
|
SNMP trap port
|
162
Note Port 162 is used only for communication between SNMP-managed NEs and the CTM server, not for communication between the CTM client and server.
|
Inbound
|
SNMP trap forwarding port
|
8765 (configurable)
|
—
|
JNDI port
|
1099
|
Inbound
|
CORBA naming service
|
14005
|
Inbound
|
CORBA notification service
|
Dynamic
|
|
Database listener port
|
1521 (configurable)
|
Inbound
|
CORBA OS agent port
|
14000
|
—
|
CTC debug port
|
9401 (if unavailable, uses the next available port)
|
Inbound
|
CTM server Telnet debug port
|
9403
|
Inbound
|
Telnet proxy port on CTM server
|
10023 to 10087
|
Inbound
|
12.1.4 Changing the CTM Server Port
Use the NE Service pane to change the TCP port number of the CTM server. All CTM clients use the JMOCO port to connect to the CTM server. See Table 12-8 for information about the JMOCO port.
Step 1 In the Domain Explorer window, choose Administration > Control Panel.
Step 2 In the Control Panel window, click NE Service to open the NE Service pane. Click the NE Poller tab.
Step 3 Change the server port in the CTM Server Port field. The server port in the Active column displays the current port. The server port in the After Restart column displays the port that is active after the server is restarted.
Step 4 Click Save. Changes to this parameter take effect only after the server is restarted.
12.2 How Do I Manage Northbound Interfaces?
CTM GateWay is an architectural component that provides northbound EMS-to-NMS interface mediation. CTM GateWay allows service providers to integrate CTM with their OSSs by using open, standard interfaces.
CTM supports three gateway modules that provide northbound EMS-to-NMS interface mediation. Not all NE types are supported by each module. Table 2-3 on page 2-4 shows the NE types supported by each gateway module.
12.2.1 Managing CTM GateWay/SNMP
SNMP is a network management protocol used almost exclusively in TCP/IP networks. SNMP allows you to monitor and control network devices, manage configurations, collect statistics, check performance, and monitor security.
CTM's GateWay/SNMP feature provides an SNMP trap forwarding service, where any trap received by CTM will be forwarded to the set of defined trap destinations. Traps are autonomous notifications sent by an SNMP agent to an SNMP manager, such as HP Open View. CTM GateWay/SNMP does not support southbound SNMP relaying (SNMP SET, GET, and GETNEXT).
The primary advantage of CTM GateWay/SNMP is to limit the amount of traffic on the wide-area DCN. Imagine NEs deployed over a wide geographic area and a centralized network operations center where the management systems are located. If there are five OSs required to receive NE traps, instead of having each NE send five traps over the wide area to each OS, send a single trap to CTM, which can then relay the trap locally in the NOC to the other OSs. NE configuration is also simpler because only one trap destination needs to be configured on each NE.
CTM GateWay/SNMP supports SNMPv1 and SNMPv2c traps. SNMPv2c traps contain the CTM host IP address in the source address of the IP packet. In order for the OS to determine which NE sent the trap, the trap must be defined with a variable binding that indicates the source NE.
CTM GateWay/SNMP is applicable to any NE with an SNMP interface.
Note Table 2-3 on page 2-4 shows the NEs that support CTM GateWay/SNMP.
Figure 12-1 shows the CTM GateWay/SNMP communications architecture within a service provider's OSS environment.
Figure 12-1 CTM GateWay/SNMP Communications Architecture
12.2.1.1 Starting and Stopping the CTM GateWay/SNMP Service
CTM GateWay/SNMP is a CTM process that can be separately started and stopped through the Control Panel. NEs must be configured with the CTM server IP address as a trap destination for traps to be sent from the NEs to CTM.
Step 1 In the Domain Explorer window, choose Administration > Control Panel.
Step 2 In the Control Panel window, click GateWay/SNMP Service. Table 12-9 describes the fields in the GateWay/SNMP Service pane.
Step 3 In the Status area, click the Start button to start CTM GateWay/SNMP. Notice that the service status toggles to Active.
Step 4 Click Stop to stop the service. The service status toggles to Not Active.
Note The CTM GateWay/SNMP 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.
12.2.1.2 Adding and Removing a CTM GateWay/SNMP Host
You can configure up to 16 SNMP trap destination hosts for CTM GateWay/SNMP. (No duplication check is enforced.)
Step 1 In the Domain Explorer window, choose Administration > Control Panel.
Step 2 In the Control Panel window, click GateWay/SNMP Service. Table 12-9 describes the fields in the GateWay/SNMP Service pane.
Step 3 In the SNMP Hosts field, enter the IP address of the SNMP forwarding host; then, click Add. To remove an SNMP host, select the IP address of the host and click Remove.
Step 4 Repeat for each host to be added or removed; then, click Save.
Table 12-9 Field Descriptions for GateWay/SNMP Service Pane
Field
|
Description
|
Service Status
|
Displays the current status of the service: Active or Not Active.
|
Service Action
|
Allows you to stop or start the CTM GateWay/SNMP service. Notice that the Service Action button toggles between Stop or Start and the Service Status field changes accordingly.
|
SNMP Hosts
|
Displays the IP address of the host where each SNMP trap will be forwarded. You can enter up to 16 IP addresses. Use the Add and Remove buttons to add or remove host IP addresses.
|
12.2.1.3 Configuring SNMP on NEs
SNMP must be configured for each NE that uses CTM GateWay/SNMP. This section contains the following procedures:
•Configuring SNMP for the ONS 15200
•Configuring SNMP for the ONS 15216 EDFA2 and EDFA3
•Configuring SNMP for the ONS 15302 and ONS 15305
•Configuring SNMP for CTC-Based NEs
•Configuring SNMP for the ONS 15501, ONS 15530, and ONS 15540
For additional information, refer to the NE user documentation.
Note When configuring SNMP on NEs, make sure that no other SNMP daemon is running on the designated CTM server host.
Note If you enter the showctm command after configuring SNMP, CTM GateWay/SNMP is not shown. This is because the showctm command shows all of the CTM processes and CTM GateWay/SNMP is not a separate process. Use the Service Monitor table to view the status of CTM GateWay/SNMP.
12.2.1.3.1 Configuring SNMP for the ONS 15200
Step 1 Enter the following command to Telnet to the NE:
Step 2 Log in with the appropriate user profile.
Step 3 Enter the following commands at the prompts:
NCB:> configure management
Mgmt:# create community public
Mgmt:# create trap <name>
<name>: ipaddress <IP_address_of_CTM_server>
Mgmt:# commit community public
Mgmt:# commit trap <name>
Note Use the CLI to configure the CTM server IP address on the NE.
12.2.1.3.2 Configuring SNMP for the ONS 15216 EDFA2 and EDFA3
For the ONS 15216 EDFA2 and EDFA3, SNMP trap entries are automatically added when the NE is added to CTM. See 5.3.8 Using SNMP, page 5-15 for more information.
12.2.1.3.3 Configuring SNMP for the ONS 15302 and ONS 15305
For information on how to configure SNMP for the ONS 15302 and ONS 15305, refer to the Cisco ONS 15302 Installation and Operations Guide or Cisco ONS 15305 Installation and Operations Guide.
12.2.1.3.4 Configuring SNMP for CTC-Based NEs
Step 1 Select a CTC-based NE in the Domain Explorer tree and choose Configuration > NE Explorer (or click the Open NE Explorer tool).
Step 2 In the node properties pane, click the Network tab; then, click the SNMP subtab.
Step 3 (Not applicable to the ONS 15600) To allow SNMP proxy, check the Allow SNMP Proxy check box.
Step 4 (Not applicable to the ONS 15600) To use the SNMP management software with the NE, check the Allow SNMP Set check box.
Step 5 (Not applicable to the ONS 15600) Click Apply.
Step 6 Click Create. The Create SNMP Trap Destination dialog box opens. Table 12-10 provides descriptions.
Step 7 Enter the information described in Table 12-10.
Step 8 After making your selections, click OK.
Step 9 Click Apply.
Table 12-10 Field Descriptions for the Create SNMP Trap Destination Dialog Box
Field
|
Description
|
IP Address
|
Enter the IP address of your NMS.
|
Community Name
|
Enter the SNMP community name. For a description of SNMP community names, refer to the SNMP information in the NE reference guide.
Note The community name is a form of authentication and access control. The community name assigned to the ONS 15600 is case-sensitive and must match the community name of the NMS.
|
UDP Port
|
Set the UDP port for SNMP. The default port is 162. Allowed UDP port values are 162, 391, and values between 1024 and 65535.
|
Trap Version
|
Set the Trap Version field for either SNMPv1 or SNMPv2. See your NMS documentation to determine whether to use SNMPv1 or SNMPv2.
|
Max Traps per Second (not applicable to the ONS 15600)
|
Enter the maximum number of traps per second that will be sent to the SNMP manager. A zero value indicates that there is no maximum and all traps are sent to the SNMP manager.
|
12.2.1.3.5 Configuring SNMP for the ONS 15501, ONS 15530, and ONS 15540
Configuring SNMP on ONS 15501, ONS 15530, and ONS 15540 NEs is a prerequisite for adding an NE to CTM. If SNMP is not configured on the NE, refer to the instructions in the relevant hardware configuration guide.
12.2.2 Managing CTM GateWay/TL1
CTM GateWay/TL1 provides EMS-to-NMS interface mediation, which allows up to twenty five (configurable) OSSs to receive native TL1-based alarm, event, and performance monitoring reports from CTM simultaneously. CTM GateWay/TL1 forwards autonomous TL1 messages from the NEs to the OSS and manages TL1 commands and responses between the OSS and the NEs.
TL1 is a standard Man-Machine Language (MML) developed by Telcordia Technologies (formerly Bellcore) in the mid-1980s as a basis for interoperability across multivendor technologies. In a series of published standards, Telcordia defined the TL1 language and a number of messages specific to technology, such as transport and access NEs. As deployment of TL1-based NEs increased throughout North America, Telcordia and other vendors developed OSS software applications by using TL1 as the NE management protocol.
With CTM GateWay/TL1, service providers can use their TL1-based OSSs to manage the TL1-capable NEs in the CTM management domain without significant interface development. In addition, only a single Telnet session is needed to interface to the CTM domain manager and manage a complete subnetwork of NEs through TL1.
Note Table 2-3 on page 2-4 shows the NEs that support CTM GateWay/TL1.
There are a number of advantages to using CTM GateWay/TL1 as opposed to having an OS connected directly to each NE:
•In the case of multiple OSs, a single TL1 session on the NE can be shared
•Using the Domain Manager Mode (DMM) feature of CTM GateWay/TL1, the OSS is not required to log into each NE, but only has to log into CTM itself to gain access to all the NEs
•Event forwarding discriminators (EFDs), or filters, can be configured in CTM GateWay/TL1 to customize which autonomous notifications are forward to the OS
•DMM commands provide the ability for OSs to discover which NEs are in the network
Note CTM GateWay/TL1 reports all TL1 messages in Greenwich Mean Time (GMT).
Figure 12-2 shows the CTM GateWay/TL1 communications architecture within a service provider's OSS environment.
Figure 12-2 CTM GateWay/TL1 Communications Architecture
The CTM GateWay/TL1 message set is based on the following Telcordia standards:
•GR-833-CORE: OTGR: Network Maintenance: Network Element and Transport Surveillance Messages. Issue 2, November 1996.
•SR-1665: NMA Operations System Generic Transport Network Element Interface Support. Issue 1, December 1997.
•SR-NWT-002723: Applicable TL1 Messages for SONET Network Elements. Issue 1, June 1993.
12.2.2.1 Setting the CTM GateWay/TL1 Username and Password
CTM requires the specification of a TL1 username and password that it can use to log into each NE that will be supported though CTM GateWay/TL1. This username and password are specified in one of the following locations:
•Control Panel for each NE model
•Domain Explorer > Network Element Properties pane > NE Authentication tab for each node
The changes to the username and password take effect after CTM reconnects to the NE either by restarting CTM GateWay/TL1 or by setting the NE's operational state to Out of Service and to In Service again.
12.2.2.1.1 Setting the CTM GateWay/TL1 Username and Password from the Control Panel
Step 1 In the Domain Explorer window, choose Administration > Control Panel.
Step 2 Click Security Properties; then, click the ONS 15216 EDFA2, ONS 15216 EDFA3, ONS 15216 OADM, ONS 15310, ONS 15327, ONS 15454, ONS 15454 SDH, ONS 155XX, ONS 15600, or ONS 158XX tab.
Step 3 In the GateWay/TL1 - NE Connection area, enter the username and password.
Note For the ONS 15800, ONS 15801, and ONS 15808, the CTM GateWay/TL1 username and password are the same as those used for general CTM connectivity to the NE.
Note The GateWay/TL1 - NE Connection area is not applicable for ONS 15454 SDH releases earlier than R5.0.
Step 4 Retype the password as confirmation.
Step 5 Click Save.
12.2.2.1.2 Setting the CTM GateWay/TL1 Username and Password from the Domain Explorer
Step 1 In the Domain Explorer tree, click an ONS 15216 EDFA2, ONS 15216 EDFA3, ONS 15216 OADM, ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 155XX, ONS 15600 SONET, or ONS 1580x NE.
Step 2 In the Network Element Properties pane, click the NE Authentication tab.
Step 3 In the GateWay/TL1 - NE Connection area, enter the username and password.
Note The ONS 15454 SDH R5.0 supports a TL1 interface. The GateWay/TL1 - NE Connection area is not available for ONS 15454 SDH releases earlier than R5.0.
Step 4 Retype the password as confirmation.
Step 5 Click Save.
Note If no username and password are configured in the NE Authentication tab of the Domain Explorer, CTM GateWay/TL1 uses the username and password specified in the Control Panel.
12.2.2.2 Using the GateWay/TL1 Service Pane
Use the GateWay/TL1 Service pane in the Control Panel window to start and stop the CTM GateWay/TL1 Service and configure TL1-specific parameters. TL1-specific parameters are listed in Table 12-11. In the Domain Explorer, choose Administration > Control Panel; then, click GateWay/TL1 Service.
Table 12-11 Field Descriptions for CTM GateWay/TL1 Service Pane
Field
|
Description
|
Status
|
Service Status
|
Displays the current status of the CTM GateWay/TL1 service: Active or Not Active.
|
Service Action
|
Allows you to stop or start the CTM GateWay/TL1 service. The Service Action button toggles between Stop or Start, and the Service Status field changes accordingly.
|
GateWay/TL1 Polling
|
GateWay/TL1 Poll Frequency
|
Allows you to set the CTM GateWay/TL1 Poll frequency, in seconds. The minimum time is 60 seconds; the maximum time is 60 minutes. Changes occur when CTM GateWay/TL1 is restarted.
|
GateWay/TL1 Connection Parameters
|
GateWay/TL1 Timeout
|
Allows you to set the CTM GateWay/TL1 connection timeout, in seconds. The minimum timeout value is 240 seconds (4 minutes); the maximum value is 1 day.
|
GateWay/TL1 Connections
|
Allows you to set the number of CTM GateWay/TL1 connections.
|
Apply Timeout to
|
You can apply the timeout feature for the following:
•Login command (ACT-USER): The session will be closed if the ACT-USER command is not performed before the requested timeout and if the Listener Mode is disabled.
•All valid TL1 command: The session will be closed if a valid command is not sent by the OSS to CTM before the requested timeout and if the Listener Mode is disabled.
Changes occur when CTM GateWay/TL1 is restarted.
|
GateWay/TL1 Advisory Message
|
Enable Advisory Message
|
Allows you to display and configure an advisory message that appears after a successful login to CTM GateWay/TL1. Check or uncheck the Enable Advisory Message check box to enable or disable the message display.
|
Message Content
|
Allows you to enter the text of the advisory message. The message cannot exceed 255 ASCII characters. Non-ASCII characters are not supported. It is not necessary to restart CTM GateWay/TL1 after updating the message.
|
TID/SID for CTM
|
Displays the target identifier (TID) and/or source identifier (SID) used by the EMS. It can be configured for DMM operation. The default value is "CTM." If the TID/SID information is changed, restart the CTM GateWay/TL1 service to make the new TID/SID take effect.
|
Error Level
|
Allows you to select the error level to include in the error log for the CTM GateWay/TL1 service. Critical, major, minor, and informational errors are logged to the database; trace and debug information is logged to a log file.
Caution CTM performance will degrade significantly if the trace or debug option is left on. All operations will slow down and you might lose alarm and event notifications. Use trace or debug only when troubleshooting with a customer support engineer.
Note Trace and debug information does not appear in the error log.
|
12.2.2.3 Starting or Stopping CTM GateWay/TL1
The CTM GateWay/TL1 service can be stopped or started by using either the Control Panel or the CLI.
12.2.2.3.1 Starting or Stopping CTM GateWay/TL1 from the Control Panel
Step 1 In the Domain Explorer window, choose Administration > Control Panel.
Step 2 Click GateWay/TL1 Service to open the GateWay/TL1 Service pane.
Step 3 In the Global tab > Status area, click the Start button to start GateWay/TL1 or the Stop button to stop the service.
Note The CTM GateWay/TL1 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.
12.2.2.3.2 Starting or Stopping CTM GateWay/TL1 Using the CLI
Step 1 Log into the CTM server with administrative privileges.
Step 2 Enter the following command to run the script that will start CTM GateWay/TL1:
Step 3 Enter the following command to run the script that will stop CTM GateWay/TL1:
Step 4 Enter your username and password.
12.2.2.4 Configuring the TL1 Timeout
The TL1 timeout determines the number of seconds that CTM maintains an active TL1 connection before closing it. If the CTM server does not return a response in time, TL1 automatically times out.
Step 1 In the Domain Explorer, choose Administration > Control Panel.
Step 2 Click GateWay/TL1 Service to open the GateWay/TL1 Service pane.
Step 3 In the Global tab, fill in the following fields:
•GateWay/TL1 Poll Frequency
•GateWay/TL1 Timeout
•GateWay/TL1 Connections
•Apply Timeout to (see Table 12-12 for a summary of timeout behavior)
Step 4 Click Save. All changes take effect when CTM GateWay/TL1 is restarted.
Table 12-12 Timeout Behavior
Listener Mode
|
DMM
|
Timeout Applicable
|
Apply Timeout to ACT-USER
|
Apply Timeout to All Valid TL1 Command
|
Yes
|
Yes
|
No
|
Not applicable
|
Not applicable
|
Yes
|
No
|
No
|
No
|
Yes
|
Yes
|
Session is closed if the ACT-USER is not performed before the given timeout.
|
Session is closed if user does not send any valid command including ACT-USER.
|
No
|
No
|
Yes
|
12.2.2.5 Configuring the TID/SID in CTM GateWay/TL1
Step 1 In the Domain Explorer, choose Administration > Control Panel.
Step 2 Click GateWay/TL1 Service to open the GateWay/TL1 Service pane.
Step 3 In the Global tab, enter the new TID or SID for CTM GateWay/TLI in the TID/SID for CTM field.
Step 4 Click Save. All changes take effect when CTM GateWay/TL1 is restarted.
12.2.2.6 Defining CTM GateWay/TL1 Advisory Messages
CTM allows you to define an advisory message on the successful connection of CTM GateWay/TL1 to the OSS.
Step 1 In the Domain Explorer, choose Administration > Control Panel.
Step 2 Click GateWay/TL1 Service to open the GateWay/TL1 Service pane.
Step 3 In the Global tab, check the Enable Advisory Message check box, and enter the text of your advisory message in the Message Content field.
Step 4 Click Save.
12.2.2.7 Setting CTM GateWay/TL1 Error Levels
Note For more information about error levels, see Chapter 9, "Managing Faults."
Step 1 In the Domain Explorer, choose Administration > Control Panel.
Step 2 Click GateWay/TL1 Service to open the GateWay/TL1 Service pane.
Step 3 In the Global tab, select an error level in the Error Level field.
Step 4 Click Save.
12.2.2.8 Viewing the GateWay/TL1 Users Table
The GateWay/TL1 Users table displays a profile for each OSS client that uses a CTM GateWay/TL1 service. With that profile, depending on the Listener Mode parameter value, it is possible to allow an OSS to receive autonomous messages from the CTM managed NEs before the OSS establishes a session with them. Also, the DMM parameter specifies whether the OSS can access some database information with the commands listed previously.
You can add, modify, or delete CTM GateWay/TL1 OSS profiles using the GateWay/TL1 Users table. To view the GateWay/TL1 Users table, choose Administration > GateWay/TL1 Users in the Domain Explorer window. Table 12-13 provides descriptions.
Table 12-13 Field Descriptions for GateWay/TL1 Users Table
Column Name
|
Description
|
OSS Profile Name
|
OSS client profile name. Each client has a unique alphanumeric name. This name corresponds with the user ID that will be used to log into CTM GateWay/TL1 for access to DMM functionality. The profile name cannot contain spaces or a colon (:), semicolon (;), or comma (,).
|
OSS IP Address
|
IP address of the OSS client that is authenticated by CTM GateWay/TL1 during the initial connection request made by the OSS.
|
Listener Mode
|
If enabled, the OSS client receives autonomous TL1 messages from allowed NEs when the OSS client connects to CTM. If disabled, autonomous TL1 messages are not forwarded until the OSS successfully logs into NEs by using the ACT-USER command.
|
Domain Manager Mode
|
If enabled, a TL1 command subset is available to the OSS for direct communication with CTM. TL1 commands include:
•ACT-USER
•CANC-USER
•RTRV-HDR
•RTRV-NE-EMS
•RTRV-SUBNTWK-EMS
•RTRV-ALM-EMS
•RTRV-ALM-ALL
•RTRV-ALM-ENV
If disabled, the TL1 command subset is not available to the OSS.
|
Event Forwarding Discriminator State
|
If enabled, indicates that the CTM GateWay/TL1 session uses an EFD profile. EFD profiles set the parameters for forwarding TL1 messages to the OSS client. If disabled, an EFD profile is not used in the CTM GateWay/TL1 session.
|
Event Forwarding Discriminator Name
|
If an EFD profile is used in the OSS client session, EFD Name indicates the name of that profile.
|
12.2.2.9 Managing OSS Client Profiles
The following sections detail how to create, modify, and delete OSS client profiles.
12.2.2.9.1 Creating an OSS Client Profile
Each OSS profile defines CTM GateWay/TL1 parameters, such as the OSS IP address, permissions, listener mode, and DMM. OSS client profiles are stored in the GateWay/TL1 Users table.
Step 1 In the Domain Explorer window, choose Administration > GateWay/TL1 Users. The GateWay/TL1 Users table opens.
Step 2 Choose Edit > Add (or click the Create a New User tool). The Add GateWay/TL1 User dialog box opens. Table 12-14 describes the fields in the dialog box.
Step 3 Fill in the fields described in Table 12-14.
Step 4 Click OK. The new profile is listed in the GateWay/TL1 Users table.
Table 12-14 Field Descriptions for Add/Modify GateWay/TL1 User Dialog Box
Field
|
Description
|
OSS Profile Name
|
Enter the name of the OSS profile. The profile name cannot contain spaces or a colon (:), semicolon (;), or comma (,).
|
Password
|
Enter the password that the OSS client uses to log into the CTM server. The password must:
•Contain from six to 64 characters
•Contain at least two alphabetic characters (A-Z, a-z)
•Contain at least one numeric character (0-9)
•Contain at least one special character (. % & ! + #)
•Not contain a colon (:), semicolon (;), or comma (,).
|
Confirm Password
|
Re-enter the password to confirm it.
|
OSS IP Address
|
Enter the OSS IP address.
|
Listener Mode
|
If enabled, the OSS client connects to CTM. If disabled, the OSS does not receive autonomous TL1 messages until it successfully logs into the CTM by using the ACT_USER command.
|
Domain Manager Mode
|
If enabled, a TL1 command subset is available to the OSS for direct communication with CTM. TL1 commands include ACT-USER, CANC-USER, RTRV-HDR, and RTRV-NE. If disabled, the TL1 command subset is not available to the OSS.
|
EFD State
|
If enabled, the OSS uses the EFD profile selected under EFD Name to filter the events forwarded to it. If disabled, an EFD profile is not used.
|
EFD Name
|
If EFD State is enabled, displays the EFD profile name. You can select one of 12 EFD profiles delivered with CTM, or click Create to create a new profile. The maximum length of an EFD name is 64 characters.
|
12.2.2.9.2 Modifying an OSS Client Profile
Step 1 In the Domain Explorer window, choose Administration > GateWay/TL1 Users. The GateWay/TL1 Users table opens.
Step 2 Select the OSS client profile to modify; then, choose Edit > Modify (or click the Modify User Properties tool). The Modify GateWay/TL1 User dialog box opens. Table 12-14 describes the fields in the dialog box.
Step 3 Modify the fields described in Table 12-14.
Note If there are active users logged into CTM using the OSS profile being modified, CTM GateWay/TL1 does not allow you to modify the OSS Profile Name, Password, and OSS IP Address fields. The Listener Mode, Domain Manager Mode, EFD State, and EFD Name fields can be modified.
Step 4 Click OK. The updated profile is listed in the GateWay/TL1 Users table.
12.2.2.9.3 Deleting an OSS Client Profile
Step 1 In the Domain Explorer window, choose Administration > GateWay/TL1 Users. The GateWay/TL1 Users table opens.
Step 2 Select the OSS client profile to delete; then, choose Edit > Delete (or click the Delete User tool).
Step 3 Click OK in the confirmation dialog box.
Note CTM GateWay/TL1 does not allow an OSS profile to be deleted if there are active users logged in using that OSS profile.
12.2.2.10 Managing EFD Profiles
The following sections detail how to view, create, modify, and delete EFD profiles.
12.2.2.10.1 Viewing the EFD Table
The GateWay/TL1 Event Forwarding Discriminator table displays EFD profiles for OSS clients that use the CTM GateWay/TL1 service. EFD profiles define the parameters for filtering and forwarding alarms and events, which helps limit the flow of messages to the OSS.
Step 1 In the Domain Explorer window, choose Administration > GateWay/TL1 Users. The GateWay/TL1 Users table opens.
Step 2 Choose Administration > GW/TL1 EFD Table. Table 12-15 provides descriptions.
Table 12-15 Field Descriptions for GateWay/TL1 Event Forwarding Discriminator Table
Column Name
|
Description
|
Event Forwarding Discriminator Name
|
EFD profile name. Each profile has a unique alphanumeric name. CTM is delivered with twelve EFD profiles. You can create new profiles. See Creating an EFD Profile.
|
Alarm Reporting
|
If enabled, NE alarms (REPT ALM) are forwarded to the OSS client. If disabled, NE alarms are not forwarded to the OSS client.
|
Event Reporting
|
If enabled, NE events (REPT EVT) are forwarded to the OSS client. If disabled, NE events are not forwarded to the OSS client.
|
PM Reporting
|
If enabled, NE performance monitoring events (REPT PM) are forwarded to the OSS client. If disabled, NE PM events are not forwarded to the OSS client.
|
Critical
|
If enabled, critical severity alarms are forwarded to the OSS client. (Alarm reporting must be enabled.) If disabled, NE critical alarms are not forwarded to the OSS client.
|
Major
|
If enabled, major severity alarms are forwarded to the OSS client. (Alarm reporting must be enabled.) If disabled, NE major alarms are not forwarded to the OSS client.
|
Minor
|
If enabled, minor severity alarms are forwarded to the OSS client. (Alarm reporting must be enabled.) If disabled, minor alarms are not forwarded to the OSS client.
|
Denied NE Target IDs
|
NE target IDs whose alarms and events are not forwarded to the OSS client.
|
Denied NE Access IDs
|
NE access IDs used to filter forwarded alarms and events. Denied Access IDs can filter one or more of the following: DS1, EC1, T1, T3, VT1, OC12, OC3, OC48, OC192, STS1, STS3c, STS12c, STS48c, CHASSIS (equipment alarms), ENET (Ethernet), BITS, ENV (environmental alarms), SYNCN (synchronization messages), and ALL.
|
12.2.2.10.2 Creating an EFD Profile
Each OSS client profile can include an EFD profile, which allows filtering of alarms and events that are forwarded to the OSS. CTM is delivered with 12 EFD profiles.
Table 12-16 Event Forwarding Discriminator Profiles
EFD Name
|
Event Type
|
Alarm Severity
|
Target Identifier
|
Access Identifier
|
Alarm
|
Event
|
PM
|
Critical
|
Major
|
Minor
|
Alarms & Events
|
X
|
X
|
—
|
X
|
X
|
X
|
All
|
All
|
Alarms Only
|
X
|
—
|
—
|
X
|
X
|
X
|
All
|
All
|
All Pass
|
X
|
X
|
X
|
X
|
X
|
X
|
All
|
All
|
Critical Alarms Only
|
X
|
—
|
—
|
X
|
—
|
—
|
All
|
All
|
Equipment Alarms Only
|
X
|
—
|
—
|
X
|
X
|
X
|
All
|
—
|
Events Only
|
—
|
X
|
—
|
—
|
—
|
—
|
All
|
All
|
Facility Alarms Only
|
X
|
—
|
—
|
X
|
X
|
X
|
All
|
—
|
Major Alarms Only
|
X
|
—
|
—
|
—
|
X
|
—
|
All
|
All
|
Major & Higher Alarms
|
X
|
—
|
—
|
X
|
X
|
—
|
All
|
All
|
Minor Alarms Only
|
X
|
—
|
—
|
—
|
—
|
X
|
All
|
All
|
Minor & Higher Alarms
|
X
|
—
|
—
|
X
|
X
|
X
|
All
|
All
|
PM Only
|
—
|
—
|
X
|
—
|
—
|
—
|
All
|
All
|
To create an EFD profile:
Step 1 In the Domain Explorer window, choose Administration > GateWay/TL1 Users. The GateWay/TL1 Users table opens.
Step 2 Choose Administration > GW/TL1 EFD Table.
Step 3 In the GW/TL1 Event Forwarding Discriminator table, choose Edit > Add EFD Profile. The Create Event Forwarding Discriminator Profile wizard appears. Table 12-17 describes the fields in the wizard.
Step 4 Fill in the following fields:
•Name
•Event Type
•Alarm Severity
Step 5 Click Next.
Step 6 Choose a target ID; then, click Next.
Step 7 Choose an access ID; then, click Finish.
The new EFD profile appears in the GW/TL1 Event Forwarding Discriminator table.
Table 12-17 Field Descriptions for Create Event Forwarding Discriminator Profile Wizard
Field
|
Description
|
Event Forwarding Discriminator Profile
|
Name
|
Enter the name of the EFD profile. The maximum length of an EFD name is 64 alphanumeric characters. The name cannot contain special characters.
|
Event Type
|
Select the type of event to forward to the OSS:
•Alarm Reporting: If selected, forwards NE alarm messages (REPT ALM) to the OSS.
•PM Reporting: If selected, forwards NE performance monitoring messages (REPT PM) to the OSS.
•Event Reporting: If selected, forwards NE event messages (REPT EVT) to the OSS.
|
Alarm Severity
|
If Alarm Reporting is selected under Event Type, select the severity of alarms to forward to the OSS:
•Critical: If selected, forwards critical NE alarms to the OSS.
•Major: If selected, forwards major NE alarms to the OSS.
•Minor: If selected, forwards minor NE alarms to the OSS.
|
Choose Target IDs
|
Available
|
Choose the target IDs of NEs whose TL1 messages you want forwarded to the OSS. NEs in the Available column will have their TL1 messages forwarded to the OSS. All TL1-capable NEs in the CTM management domain display in the Available column by default. Use the Add and Remove buttons to move target IDs between the Available column and the Denied column.
|
Denied
|
Autonomous messages from NE target IDs in this column will not be forwarded to the OSS.
|
Choose Access IDs
|
Available
|
Choose TL1 access IDs for which autonomous TL1 messages will be forwarded to the OSS. All access IDs are available by default. Use the Add and Remove buttons to move access IDs between the Available column and the Denied column.
|
Denied
|
Autonomous messages from NEs that include access IDs in this column will not be forwarded to the OSS.
|
12.2.2.10.3 Modifying an EFD Profile
Use the Modify Event Forwarding Discriminator Profile wizard to modify an EFD profile for OSSs that use the CTM GateWay/TL1 service to receive TL1 messages from NEs that support a TL1 interface.
EFD profiles define the parameters for filtering and forwarding TL1 messages from NEs to the OSS.
Step 1 In the Domain Explorer window, choose Administration > GateWay/TL1 Users. The GateWay/TL1 Users table opens.
Step 2 Choose Administration > GW/TL1 EFD Table.
Step 3 In the GW/TL1 Event Forwarding Discriminator table, select the EFD profile to modify; then, choose Edit > Modify EFD Profile. The Modify Event Forwarding Discriminator Profile wizard opens. Table 12-18 describes the fields in the wizard.
Step 4 Modify the following fields, as necessary:
•Name
•Event Type
•Alarm Severity
Step 5 Click Next.
Step 6 Modify the list of target IDs, as necessary; then, click Next.
Step 7 Modify the list of access IDs, as necessary; then, click Finish.
The modified EFD profile appears in the GW/TL1 Event Forwarding Discriminator table.
Table 12-18 Field Descriptions for Modify Event Forwarding Discriminator Profile Wizard
Field
|
Description
|
Event Forwarding Discriminator Profile
|
Name
|
Modify the name of the EFD profile. The maximum length of an EFD name is 64 alphanumeric characters. The name cannot contain special characters.
|
Event Type
|
Modify the type of events to forward to the OSS:
•Alarm Reporting: If selected, forwards NE alarm messages (REPT ALM) to the OSS.
•PM Reporting: If selected, forwards NE performance monitoring messages (REPT PM) to the OSS.
•Event Reporting: If selected, forwards NE event messages (REPT EVT) to the OSS.
|
Alarm Severity
|
If Alarm Reporting is selected under Event Type, modify the severity of alarms to forward to the OSS:
•Critical: If selected, forwards critical NE alarms to the OSS.
•Major: If selected, forwards major NE alarms to the OSS.
•Minor: If selected, forwards minor NE alarms to the OSS.
|
Choose Target IDs
|
Available
|
Modify the target IDs of NEs whose TL1 messages you want forwarded to the OSS. NEs in the Available column will have their TL1 messages forwarded to the OSS. Use the Add and Remove buttons to move target IDs between the Available column and the Denied column.
|
Denied
|
Autonomous messages from NE target IDs in this column will not be forwarded to the OSS.
|
Choose Access IDs
|
Available
|
Modify TL1 access IDs for which autonomous TL1 messages will be forwarded to the OSS. Use the Add and Remove buttons to move access IDs between the Available column and the Denied column.
|
Denied
|
Autonomous messages from NEs that include access IDs in this column will not be forwarded to the OSS.
|
12.2.2.10.4 Deleting an EFD Profile
Note An EFD profile can be deleted from the EFD table only if the profile is not associated with an OSS client.
Step 1 In the Domain Explorer window, choose Administration > GateWay/TL1 Users. The GateWay/TL1 Users table opens.
Step 2 Choose Administration > GW/TL1 EFD Table.
Step 3 In the GW/TL1 Event Forwarding Discriminator table, select the EFD profile to delete; then, choose Edit > Delete EFD Profile.
Step 4 Click OK in the confirmation dialog box.
12.2.2.11 Viewing Active CTM GateWay/TL1 Users
You can monitor and log out the connected OSS TL1 clients in the Logged In GateWay/TL1 Users table.
Step 1 In the Domain Explorer window, choose Administration > GateWay/TL1 Users. The GateWay/TL1 Users table opens.
Step 2 Choose Administration > Logged In GateWay TL1 Users. The CTM Active GWTL1 Users table opens. Table 12-19 provides descriptions.
Table 12-19 Field Descriptions for CTM Active GWTL1 Users Table
Field
|
Description
|
OSS Profile Name
|
Name of the OSS profile. Each client has a unique alphanumeric name. The profile name cannot contain spaces or a colon (:), semicolon (;), or comma (,).
|
OSS IP Address
|
IP address of the OSS client that is authenticated by CTM GateWay/TL1 during the initial connection request made by the OSS.
|
Session ID
|
Unique session ID.
|
Time of First Connection
|
Time of the user's first connection to the server.
|
Listener Mode
|
If enabled, the OSS client receives autonomous TL1 messages from allowed NEs when the OSS client connects to CTM. If disabled, autonomous TL1 messages are not forwarded until the OSS successfully logs into NEs by using the ACT-USER command.
|
Domain Manager Mode
|
If enabled, a TL1 command subset is available to the OSS for direct communication with CTM. TL1 commands include ACT-USER, CANC-USER, RTRV-HDR, and RTRV-NE. If disabled, the TL1 command subset is not available to the OSS.
|
12.2.2.12 Logging Out an Active CTM GateWay/TL1 User
Step 1 In the Domain Explorer window, choose Administration > GateWay/TL1 Users. The GateWay/TL1 Users table opens.
Step 2 Choose Administration > Logged In GateWay TL1 Users. The CTM Active GWTL1 Users table opens.
Step 3 Select a user and choose Administration > Log Out GateWay TL1 User.
12.2.2.13 Establishing Connectivity Between CTM GateWay/TL1 and the OSS
To achieve connectivity between the OSS and CTM GateWay/TL1, establish a direct Telnet session to the CTM server on port 26715. To enable this connection, start the CTM GateWay/TL1 service on the CTM server.
CTM GateWay/TL1 allows the OSS to connect to all NEs in the CTM management domain by using one TCP/IP socket connection. The TID multiplexes the single logical connection to the actual NEs managed by CTM.
To verify connectivity to the CTM server, the OSS pings the CTM server IP address. (If DMM is enabled, the OSS can also verify connectivity by issuing a RTRV-HDR TL1 command.) However, connectivity between the OSS and the CTM server does not guarantee that the CTM GateWay/TL1 service is operational. Assuming that the CTM GateWay/TL1 service is started, the OSS should also monitor the state of the TCP/IP port socket connection because it reflects the operational state of the CTM GateWay/TL1 service.
12.2.2.13.1 Monitoring Connectivity Between the OSS and the NE
The OSS does not connect directly to an NE; rather, CTM acts as a transparent agent to the OSS (manager). The OSS establishes a logical connection with CTM through the CTM GateWay/TL1 port and inherits connectivity with the entire NE management domain.
The OSS can monitor the connectivity state of each NE by using the RTRV-HDR TL1 command. This assumes that connectivity between the OSS and CTM is established. If the NE is available, a normal response is returned. If there is no response, communication with the target NE is lost.
Note Know the connectivity state between the OSS and CTM and the operational state of the CTM GateWay/TL1 service before interpreting a nonresponse from an NE as a loss of communication.
12.2.2.13.2 Logging Into the NE
After establishing a TCP/IP socket connection with CTM by using the CTM GateWay/TL1 port, the OSS sends an ACT-USER TL1 command to log into each NE as identified by its TID. To log into an NE, the OSS must use a previously configured username and password.
The NE authenticates the user ID (UID) and the password identifier (PID), which are passed within the ACT-USER command string. After the OSS logs in, all NE autonomous message reporting supported by CTM GateWay/TL1 is enabled by default, as indicated by the associated EFD profile.
12.2.2.14 Understanding Domain Manager Mode Commands and Responses
When DMM is enabled in the OSS client profile, the OSS uses the following TL1 commands to communicate directly with CTM to obtain information about TL1-capable NEs that CTM manages:
•ACT-USER
•CANC-USER
•RTRV-ALM-ALL
•RTRV-ALM-EMS
•RTRV-ALM-ENV
•RTRV-HDR
•RTRV-NE-EMS
•RTRV-SUBNTWK-EMS
The following sections describe the DMM commands in detail.
Note For information about TL1 commands and responses that can be used in CTM GateWay/TL1 sessions with CTM-supported NEs, refer to the NE hardware documentation.
12.2.2.14.1 ACT-USER
The OSS uses the ACT-USER command to log into CTM GateWay/TL1.
Table 12-20 ACT-USER—Domain Manager Mode
Item
|
Description
|
Input Format
|
ACT-USER:TID:UID:CTAG::PID;
where:
•TID is the target identifier of the CTM server where the command is directed (equivalent to the SID).
•UID is the OSS profile name that logs into the CTM server.
•CTAG is the correlation tag that correlates command and response messages.
•PID is the password identifier, which is the CTM password assigned to the OSS client.
|
Normal Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^COMPLD cr lf
;
where:
•SID is the source identifier of the CTM server that generates the response message (equivalent to the TID).
•DATE is the current date in YYYY-MM-DD format.
•TIME is the current time in HH:MM:SS format.
|
Error Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^DENY cr lf
^^^ERRCDE cr lf
^^^"ERROR DESCRIPTION" cr lf
^^^/*ERROR TEXT*/ cr lf
;
where:
•ERRCDE is the error code associated with the error response. See Table 12-32 for values.
•ERROR DESCRIPTION is the supporting information for the error code (when applicable).
•ERROR TEXT is the detailed text description of the condition.
The default error response to an invalid or incorrect TID field is:
cr lf lf
^^^DATE^TIME cr lf
M^^CTAG^DENY cr lf
^^^ERRCDE cr lf
^^^"ERROR DESCRIPTION" cr lf
;
|
Example
|
Command:
ACT-USER:CTM:OSS:1990::ROOT;
Normal response:
CTM 2004-05-01 12:30:45
M 1990 COMPLD
;
Error response (for a blank PID field):
CTM 2004-05-01 12:30:45
M 1990 DENY
IDNV
/* Input, Data Not Valid */
;
|
Note If DMM is enabled, CTM GateWay/TL1 allows direct access to the NE. There is no need to use an individual ACT-USER command to every NE.
12.2.2.14.2 CANC-USER
The OSS uses the CANC-USER command to log out of CTM GateWay/TL1.
Note In DMM, the CANC-USER command logs out the OSS client from all of the NEs that are available in the CTM domain.
Table 12-21 CANC-USER—Domain Manager Mode
Item
|
Description
|
Input Format
|
CANC-USER:TID:UID:CTAG;
where:
•TID is the target identifier of the CTM server where the command is directed (equivalent to the SID).
•UID is the OSS profile name that logs into the CTM server.
•CTAG is the correlation tag that correlates command and response messages.
|
Normal Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^COMPLD cr lf
;
where:
•SID is the source identifier of the CTM server that generates the response message (equivalent to the TID).
•DATE is the current date in YYYY-MM-DD format.
•TIME is the current time in HH:MM:SS format.
|
Error Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^DENY cr lf
^^^ERRCDE cr lf
^^^"ERROR DESCRIPTION" cr lf
^^^/*ERROR TEXT*/ cr lf
;
where:
•ERRCDE is the error code associated with the error response. See Table 12-32 for values.
•ERROR DESCRIPTION is the supporting information for the error code (when applicable).
•ERROR TEXT is the detailed text description of the condition.
|
Example
|
Command:
CANC-USER:CTM:OSS1:1991;
Normal response:
CTM 2004-05-01 12:30:45
M 1991 COMPLD
;
|
12.2.2.14.3 RTRV-ALM-ALL
The OSS uses the RTRV-ALM-ALL command to retrieve all alarm information associated with the CTM management domain.
Table 12-22 RTRV-ALM-ALL—Domain Manager Mode
Item
|
Description
|
Input Format
|
RTRV-ALM-ALL:[TID]:[AID]:CTAG::[NTFCNCDE][,,,,];
where:
•TID is the provisioned target identifier of the CTM server where the command is directed. If the TID is not specified, it is assumed by default.
•AID is the access identifier that identifies the CTM server entity where the command applies. The format is defined as:
NEID[\NEAID]
where:
–NEID is the identifier of the NE (equivalent to the SID).
–NEAID is the access identifier of the NE (equivalent to the AID).
•CTAG is the correlation tag that correlates command and response messages.
•NTFCNCDE is the notification code associated with the alarm requested.
|
Normal Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^COMPLD cr lf
RSPBLK + ;
where:
•SID is the provisioned SID of the CTM server.
•DATE is the current date in YYYY-MM-DD format.
•TIME is the current time in HH:MM:SS format.
•CTAG is the correlation tag that correlates command and response messages.
•RSPBLK is the response block. The format is defined as:
^^^NEID\NEAID:NTFCNCDE,CONDTYPE,SRVEFF,OCRDAT,OCRTM,LOCN,DIRN:*CONDESCR* "cr lf
where:
–NEID is the identifier of the NE.
–NEAID is the access identifier of the NE.
–NTFCNCDE is the two-character notification code with the following possible values: CR (critical), MJ (major), MN (minor), and CL (standing condition cleared).
|
Normal Response
(continued)
|
–CONDTYPE is the single type of alarm condition being reported on this particular line.
–SRVEFF is the effect on service caused by the alarm condition. Values are SA (service affecting) and NSA (not service affecting).
–OCRDAT is the date when the alarm was raised in month of year-day of month (MOY-DOM) format.
–OCRTM is the time when the alarm was raised in hour of day-minute of hour (HOD-MOH) format.
–LOCN is the location where the monitored parameter originates and refers to the entity identified by the NEAID.
–DIRN is the direction to which the monitored parameter applies and is relative to the entity identified by the NEAID.
–CONDDESCR is the detailed text description of the trouble. This field is limited to 64 characters enclosed in escaped quotes (\"), for a maximum of 68 characters (counting the escaped quotes).
|
|
Example
|
Command:
RTRV-ALM-ALL:CTM:ONS1\:1999:MJ;
Normal response:
CTM 00-08-28 17:11:26
M 99 COMPLD
"ONS1\OC48:CR,LOS,SA,08-27,18-45,,:/*Loss of Signal*/"
"ONS1\STS-1-2:MJ,RFI-P,SA,08-27,18-50,,:/* Path Remote Failure Indication*/
;
|
12.2.2.14.4 RTRV-ALM-EMS
The OSS uses the RTRV-ALM-EMS command to retrieve node-based alarm information associated with the CTM management domain.
Note This command has been replaced by the RTRV-ALM-ALL command but is retained for backward compatibility.
Table 12-23 RTRV-ALM-EMS—Domain Manager Mode
Item
|
Description
|
Input Format
|
RTRV-ALM-EMS:TID:[AID]:CTAG::[NTFCNCDE],,;
where:
•TID is the target identifier of the CTM server where the command is directed (equivalent to the SID).
•AID is the access identifier that identifies the CTM server entity where the command applies. The format is defined as:
NEID\NEAID
where:
–NEID is the identifier of the NE (equivalent to the SID). Values are ALL (default) and the empty set { } (null), which is equivalent to ALL.
–NEAID is the access identifier of the NE (equivalent to the AID). The value is the empty set { } (null).
•CTAG is the correlation tag that correlates command and response messages.
•NTFCNCDE is the two-character notification code associated with a single alarm condition. Values are CR (critical), MJ (major), and MN (minor), with the lower conditions indicating a logical AND function where MJ equals MJ+CR, and MN equals MN+MJ+CR. Other values are ALL (default) and the empty set { } (null), which is equivalent to ALL.
|
Normal Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^COMPLD cr lf
RSPBLK + ;
where:
•SID is the source identifier of CTM that is generating the response message (equivalent to TID).
•DATE is the current date in YYYY-MM-DD format.
•TIME is the current time in HH:MM:SS format.
|
Normal Response
(continued)
|
•CTAG is the correlation tag that correlates command and response messages.
•RSPBLK is the response block. The message might contain zero or up to 1,000 or more occurrences of the response block, which has the following format:
^^^AID:NTFCNCDE,CONDTYPE,SRVEFF,OCRDAT,OCRTM,LOCN,DIRN:/*CONDESCR*, "cr lf
where:
–AID is the access identifier that identifies a CTM entry to which the command applies. It has the following format:
where:
NEID is the NE identifier equivalent to the source identifier of the NE.
NEAID is the NE access identifier equivalent to the access identifier of the NE.
–NTFCNCDE is the two-character notification code. Values are CR (critical), MJ (major), MN (minor), and CL (standing condition clear).
–CONDTYPE is the single type of alarm condition being reported on this particular line.
–SRVEFF is the effect on service caused by the alarm condition. Values are SA (service affecting) and NSA (not service affecting).
–OCRDAT is the date when the alarm was raised in month of year-day of month (MOY-DOM) format.
–OCRTM is the time when the alarm was raised in hour of day-minute of hour (HOD-MOH) format.
–LOCN is the location where the monitored parameter originates and refers to the entity identified by the NEAID.
–DIRN is the direction to which the monitored parameter applies and is relative to the entity identified by the NEAID.
–CONDDESCR is the detailed text description of the trouble. This field is limited to 64 characters enclosed in escaped quotes (\"), for a maximum of 68 characters (counting the escaped quotes).
|
Error Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^DENY cr lf
^^^ERRCDE cr lf
^^^"ERROR DESCRIPTION" cr lf
^^^/*ERROR TEXT*/ cr lf
;
where:
•ERRCDE is the error code associated with the error response. See Table 12-32 for values.
•ERROR DESCRIPTION is the supporting information for the error code (when applicable).
•ERROR TEXT is the detailed text description of the condition.
|
Example
|
Command:
RTRV-ALM-EMS:CTM:ONS1\:1999::MJ,,;
Normal response:
CTM 00-08-28 12:30:45
M 1999 COMPLD
"ONS1\OC48:CR,LOS,SA,08-27,18-45,,:/* Loss of Signal */"
"ONS1\STS-1-2:MJ,RFI-P,SA,08-27,18-50,,:/* Path Remote Failure Indication */"
;
Error response:
CTM 2004-08-28 12:30:45
M 1999 DENY
INUP
/* Invalid AID block. Invalid Parameters length */
;
|
12.2.2.14.5 RTRV-ALM-ENV
The OSS uses the RTRV-ALM-ENV command to retrieve environmental alarm information associated with the CTM management domain.
Table 12-24 RTRV-ALM-ENV—Domain Manager Mode
Item
|
Description
|
Input Format
|
RTRV-ALM-ENV:[TID]:[AID]:CTAG::[NTFCNCDE][,];
where:
•TID is the target identifier of the CTM server where the command is directed (equivalent to the SID).
•AID is the access identifier that identifies the CTM server entity where the command applies. The format is defined as:
NEID\NEAID
where:
–NEID is the identifier of the NE (equivalent to the SID). Values are ALL (default) and the empty set { } (null), which is equivalent to ALL.
–NEAID is the access identifier of the NE (equivalent to the AID). The value is the empty set { } (null).
•CTAG is the correlation tag that correlates command and response messages.
•NTFCNCDE is the two-character notification code for the requested environmental alarm.
|
Normal Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^COMPLD cr lf
RSPBLK + ;
where:
•SID is the source identifier of CTM generating the response message (equivalent to TID).
•DATE is the current date in YYYY-MM-DD format.
•TIME is the current time in HH:MM:SS format.
|
Normal Response
(continued)
|
•RSPBLK is the response block. The message might contain zero or up to 1,000 or more occurrences of the response block, which has the following format:
^^^AID:NTFCNCDE,CONDTYPE,SRVEFF,OCRDAT,OCRTM,LOCN,DIRN:/*CONDESCR*, "cr lf
where:
–AID is the access identifier that identifies a CTM entry to which the command applies. It has the following format:
where:
NEID is the NE identifier equivalent to the source identifier of the NE.
NEAID is the NE access identifier equivalent to the access identifier of the NE.
–NTFCNCDE is the two-character notification code. Values are CR (critical), MJ (major), MN (minor), and CL (standing condition clear).
–CONDTYPE is the single type of alarm condition being reported on this particular line.
–SRVEFF is the effect on service caused by the alarm condition. Values are SA (service affecting) and NSA (not service affecting).
–OCRDAT is the date when the alarm was raised in month of year-day of month (MOY-DOM) format.
–OCRTM is the time when the alarm was raised in hour of day-minute of hour (HOD-MOH) format.
–LOCN is the location where the monitored parameter originates and refers to the entity identified by the NEAID.
–DIRN is the direction to which the monitored parameter applies and is relative to the entity identified by the NEAID.
–CONDDESCR is the detailed text description of the trouble. This field is limited to 64 characters enclosed in escaped quotes (\"), for a maximum of 68 characters (counting the escaped quotes).
|
|
Example
|
Command:
RTRV-ALM-ENV:CTM:DEV29\ENV-IN-1:123::MJ,;
Normal response:
CTM 2004-11-19 17:35:56
M 89 COMPLD
"DEV29\ENV-IN-1:CR,APSB,NSA,04-08,06-48,,:/* Byte Failure */"
;
|
12.2.2.14.6 RTRV-HDR
The OSS uses the RTRV-HDR command to retrieve the TID of the CTM server.
Table 12-25 RTRV-HDR—Domain Manager Mode
Item
|
Description
|
Input Format
|
RTRV-HDR:TID::CTAG;
where:
•TID is the target identifier of the CTM server where the command is directed (equivalent to the SID).
•CTAG is the correlation tag that correlates command and response messages.
|
Normal Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^COMPLD cr lf
;
where:
•SID is the source identifier of the CTM server that generates the response message (equivalent to the TID).
•DATE is the current date in YYYY-MM-DD format.
•TIME is the current time in HH:MM:SS format.
|
Error Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^DENY cr lf
^^^ERRCDE cr lf
^^^"ERROR DESCRIPTION" cr lf
^^^/*ERROR TEXT*/ cr lf
;
where:
•ERRCDE is the error code associated with the error response. See Table 12-32 for values.
•ERROR DESCRIPTION is the supporting information for the error code (when applicable).
•ERROR TEXT is the detailed text description of the condition.
|
Example
|
Command:
RTRV-HDR:CTM::1992;
Normal response:
CTM 2004-05-01 12:30:45
M 1992 COMPLD
;
Error response (for an invalid command):
CTM 2004-05-01 12:30:45
M 1992 DENY
ICNV
/* The command verb or modifier is invalid */
;
|
12.2.2.14.7 RTRV-NE-EMS
The OSS uses the RTRV-NE-EMS command to retrieve node-based inventory information associated with the CTM management domain.
Table 12-26 RTRV-NE-EMS—Domain Manager Mode
Item
|
Description
|
Input Format
|
RTRV-NE-EMS:TID::CTAG;
where:
•TID is the target identifier of the CTM server where the command is directed (equivalent to the SID).
•CTAG is the correlation tag that correlates command and response messages.
|
Normal Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^COMPLD cr lf
RSPBLK+;
where:
•SID is the source identifier of the CTM server that generates the response (equivalent to the TID).
•DATE is the current date in YYYY-MM-DD format.
•TIME is the current time in HH:MM:SS format.
•RSPBLK is the response block.
The message might contain one or up to 1,000 or more occurrences of the response block, which has the following format:
^^^"NEID:NEMOD,COMMST,ALMCNT,OPRNST" cr lf
where:
•NEID is the identifier of the NE (equivalent to the SID).
•NEMOD is the model of the NE.
•COMMST is the communication state of the NE. Values are UNAVAIL (unavailable) and AVAIL (available).
•ALMCNT is the total alarm counts associated with all the severity alarms (CR, MJ, MN) impacting the NE managed by CTM. It has the following format:
{# of Critical Alarms} - {# of Major Alarms} - {# of Minor Alarms}
•OPRNST is the operational state of the NE. Values are IS (In Service) and OOS (Out of Service).
|
Error Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^DENY cr lf
^^^ERRCDE cr lf
^^^"ERROR DESCRIPTION" cr lf
^^^/*ERROR TEXT*/ cr lf
;
where:
•ERRCDE is the error code associated with the error response. See Table 12-32 for values.
•ERROR DESCRIPTION is the supporting information for the error code (when applicable).
•ERROR TEXT is the detailed text description of the condition.
|
Example
|
Command:
RTRV-NE-EMS:CTM::1993;
Normal response:
CTM 00-05-01 12:30:45
M 1993 COMPLD
"ONS3:CISCO-ONS-15454,UNAVAIL,2-4-6,IS"
"ONS4:CISCO-ONS-15454,AVAIL,3-5-7,IS"
;
Error response (for an invalid command):
CTM 2004-07-29 12:30:45
M 1995 DENY
ICNV
/* The command verb or modifier is invalid */
;
|
12.2.2.14.8 RTRV-SUBNTWK-EMS
The OSS uses the RTRV-SUBNTWK-EMS command to retrieve subnetwork-based inventory information associated with the CTM management domain.
Table 12-27 RTRV-SUBNTWK-EMS—Domain Manager Mode
Item
|
Description
|
Input Format
|
RTRV-SUBNTWK-EMS:TID::CTAG;
where:
•TID is the target identifier of the CTM server where the command is directed (equivalent to the SID).
•CTAG is the correlation tag that correlates command and response messages.
|
Normal Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^COMPLD cr lf
RSPBLK + ;
where:
•SID is the source identifier of the CTM server that generates the response message (equivalent to the TID).
•DATE is the current date in YYYY-MM-DD format.
•TIME is the current time in HH:MM:SS format.
•RSPBLK is the response block.
The message might contain zero or up to 1,000 occurrences of the response block, which has the following format:
^^^"SUBNTWKID:NEID,ADDR,NEMOD,VERSION,GNE,OPRNST,COMMST" cr lf
where:
•SUBNTWKID is the subnetwork identifier defined in the CTM Subnetwork Explorer for the subnetwork entities managed by CTM.
•NEID is the identifier of the NE (equivalent to the SID).
•ADDR is the IP address of the NE.
•NEMOD is the model of the NE.
•VERSION is the version of software running on the NE.
•GNE is the gateway NE SID associated with the NE.
•OPRNST is the operational state of the NE. Values are IS and OOS.
•COMMST is the communication state of the NE. Values are UNAVAIL and AVAIL.
|
Error Response
|
cr lf lf
^^^SID^DATE^TIME cr lf
M^^CTAG^DENY cr lf
^^^ERRCDE cr lf
^^^"ERROR DESCRIPTION" cr lf
^^^/*ERROR TEXT*/ cr lf
;
where:
•ERRCDE is the error code associated with the error response. See Table 12-32 for values.
•ERROR DESCRIPTION is the supporting information for the error code (when applicable).
•ERROR TEXT is the detailed text description of the condition.
|
Example
|
Command:
RTRV-SUBNTWK-EMS:CTM::1995;
Normal response:
CTM 00-07-29 12:30:45
M 1995 COMPLD
"SFO-01:ONS1,129.11.12.101,CISCO-ONS-15454,2.1.3,ONS1,IS,AVAIL"
"SFO-01:ONS2,129.11.12.102,CISCO-ONS-15454,2.1.3,ONS1,IS,UNAVAIL"
"SFO-01:ONS3,129.11.12.103,CISCO-ONS-15454,1.0.0,ONS1,IS,UNAVAIL"
"LVMR-01:ONS4,129.11.12.104,CISCO-ONS-15327,1.0.0,ONS4,IS,AVAIL"
"LVMR-01:ONS5,129.11.12.105,CISCO-ONS-15327,1.0.0,ONS4,IS,AVAIL"
"SJC-01:ONS6,129.11.12.106,CISCO-ONS-15800,2.4.0,ONS6,OOS,UNAVAIL"
"SJC-01:ONS7,129.11.12.107,CISCO-ONS-15800,2.4.0,ONS6,IS,UNAVAIL"
;
Error response:
CTM 2004-07-29 12:30:45
M 1995 DENY
IITA
/*Input, Invalid Target Identifier */
;
|
12.2.2.15 Understanding Domain Manager Mode Reports
When DMM is enabled in the OSS client profile, the OSS uses the following TL1 reports to communicate directly with CTM to obtain information about the TL1-capable NEs that CTM manages:
•REPT ALM EMS
•REPT DBCHG EMS
•CANC Autonomous Message
12.2.2.15.1 REPT ALM EMS
CTM GateWay/TL1 generates the REPT ALM EMS message to report the loss of communication (LOC) with an NE in the CTM management domain.
Table 12-28 REPT ALM EMS—Domain Manager Mode
Item
|
Description
|
Message
|
cr lf lf
^^^SID^DATE^TIME cr lf
ALMCDE^ATAG^REPT^ALM^EMS cr lf
RSPBLK + ;
where:
•SID is the source identifier of the CTM server that generates the message (equivalent to the TID).
•DATE is the current date in YYYY-MM-DD format.
•TIME is the current time in HH:MM:SS format.
•ALMCDE is the alarm code that identifies the severity of the autonomous message.
•ATAG is the automatic tag that sequences autonomous messages.
•RSPBLK is the response block.
|
Response Block
|
The message must contain at least one occurrence of the response block, which has the following format, sorted according to severity:
^^^"AID:NTFCNCDE,CONDTYPE,SRVEFF,OCRDAT,OCRTM,LOCN,DIRN:/ *CONDDESCR*/" cr lf
where:
•AID is the access identifier that identifies the CTM server entity where the command applies. The format is defined as:
where:
–NEID is the identifier of the NE (equivalent to the SID).
–NEAID is the access identifier of the NE (equivalent to the AID). The NEAID is always null.
|
Response Block
(continued)
|
•NTFCNCDE is the two-character notification code associated with the highest-severity alarm.
•CONDTYPE is the single type of condition being reported. The value is LOC.
•SRVEFF is the service-affecting code that indicates the effect on service caused by the alarm condition.
•OCRDAT is the date when the alarm condition occurred in month of year-day of month (MOY-DOM) format.
•OCRTM is the time of day when the alarm condition occurred in hour of day-minute of hour (HOD-MOH) format.
•LOCN is the location where the monitored parameter originates. LOCN refers to the entity identified by the NEAID.
•DIRN is the direction to which the monitored parameter applies. DIRN is relative to the entity identified by the NEAID.
•CONDDESCR is the detailed text description of the condition.
|
Example
|
CTM 00-07-29 12:30:45
*C 1997 REPT ALM EMS
"ONS1\:CR,LOS,NSA,07-29,12-29,,:/* Loss of Communications */"
;
|
12.2.2.15.2 REPT DBCHG EMS
CTM GateWay/TL1 generates the REPT DBCHG EMS message to report changes to CTM-based information such as added or deleted NEs in the CTM management domain.
Table 12-29 REPT DBCHG EMS—Domain Manager Mode
Item
|
Description
|
Message
|
cr lf lf
^^^SID^DATE^TIME cr lf
ALMCDE^ATAG^REPT^DBCHG cr lf
^^^"TIME=TIME,DATE=DATE,[SOURCE=<SOURCE>],
DBCHGSEQ=DBCHGSEQ:CMDCDE:AID:DATABLK" cr lf
;
where:
•SID is the source identifier of the CTM server that generates the response message (equivalent to the TID).
•DATE is the current date in YYYY-MM-DD format.
•TIME is the current time in HH:MM:SS format.
•ALMCDE is the alarm code that identifies the severity of the autonomous message.
•ATAG is the automatic tag that sequences autonomous messages.
•SOURCE identifies an input-command correlation tag, if present. SOURCE is optional for the CTM server.
•DBCHGSEQ is a sequential number of the database change message that relates to the database record ID number.
•COMMAND is the input command that indicates whether NEs were added or modified in the CTM database. Values are ENT-NE, ED-NE, and DEL-NE.
•AID is the access identifier that identifies the CTM server entity where the autonomous message applies. The format is defined as:
where:
–NEID is the identifier of the NE (equivalent to the SID).
–NEAID is the access identifier of the NE (equivalent to the AID). The value is the empty set { } (null).
|
Response Block
|
•DATABLK is the data block that provides informational parameters associated with the database change. DATABLK has the following format:
"ADDR=ADDR,NEMOD=NEMOD,VERSION=VERSION,GNE=GNE,OPRNST=OPRNST, COMMST=COMMST"
where:
–ADDR is the IP address of the NE.
–NEMOD is the model of the NE.
–VERSION is the version of software running on the NE.
–GNE is the gateway NE SID associated with the NE.
–OPRNST is the operational state of the NE. Values are IS and OOS.
–COMMST is the communication state of the NE. Values are UNAVAIL and AVAIL.
|
Example
|
Sample NE creation autonomous message:
CTM17 00-07-29 12:30:45
A 1961 REPT DBCHG EMS
"TIME=12-30-45,DATE=00-07-29,DBCHGSEQ=371:
ENT-NE:ONS1\:ADDR=129.11.12.129,NEMOD=CISCO-ONS-15454,
VERSION=3.0.0,GNE=ONS1,OPRNST=IS,COMMST=AVAIL"
;
Sample NE modification autonomous message:
CTM18 00-07-29 12:30:45
A 1962 REPT DBCHG EMS
"TIME=12-30-45,DATE=00-07-29,DBCHGSEQ=371:
ED-NE:ONS1\:ADDR=129.11.12.130,NEMOD=CISCO-ONS-15454,
VERSION=3.0.0,GNE=ONS1,OPRNST=IS,COMMST=AVAIL"
;
Sample NE deletion autonomous message:
CTM18 00-07-29 12:30:45
A 1962 REPT DBCHG EMS
"TIME=12-30-45,DATE=00-07-29,DBCHGSEQ=371:
DEL-NE:ONS1\:ADDR=129.11.12.130,NEMOD=CISCO-ONS-15454,
VERSION=3.0.0,GNE=ONS1,OPRNST=IS,COMMST=AVAIL"
;
|
|
12.2.2.15.3 CANC Autonomous Message
CTM GateWay/TL1 generates the CANC autonomous message when the EMS logs out the OSS client if DMM is disabled.
Note When DMM is disabled, CTM GateWay/TL1 logs out the OSS user from all of the NEs that are available in the CTM domain.
Table 12-30 CANC Autonomous Message
Item
|
Description
|
Message
|
cr lf lf
^^^SID^DATE^TIME cr lf
A^^ATAG^CANC cr lf
UID cr lf
;
where:
•SID is the source identifier of the CTM server that generates the message (equivalent to the TID).
•DATE is the current date in YYYY-MM-DD format.
•TIME is the current time in HH:MM:SS format.
•ATAG is the automatic tag that sequences autonomous messages.
•UID is the OSS client profile name.
|
Example
|
CTM 2004-02-04 00:33:36
A 96 CANC
oss
;
|
|
12.2.2.16 TL1 Command Symbols
Table 12-31 outlines the conventions and notations used with TL1 specifications. For information about NE TL1 command usage, refer to the NE documentation.
Table 12-31 TL1 Conventions and Notations
Symbol
|
Description
|
cr
|
A carriage return in ASCII.
|
lf
|
A line feed in ASCII.
|
^
|
A caret indicates that a blank must appear in the message.
Note For readability, some symbols are preceded or followed by blank spaces rather than a caret. The blank spaces are not part of the message.
|
[ ]
|
One or more parameters enclosed within brackets indicates that the parameters are optional. If an empty field (null) is entered for an optional parameter, a default value is automatically substituted in the input field.
|
{ | }
|
A list of two or more parameters enclosed within braces { } and separated by a vertical bar ( | ) indicates that one (and only one) of the parameters from the list must be selected.
|
+
|
A plus sign is a post-fix operator that indicates that the proceeding symbol or group of symbols (enclosed in parentheses) might occur one or more times.
|
;
|
A semicolon marks the end of a message.
|
" "
|
A pair of quotation marks delimits an expression that can be parsed.
|
/* */
|
A pair of these characters (/* and */) delimits free form text.
|
*
|
An asterisk indicates that the preceding symbol might occur zero or more times.
|
,
|
A comma separates parameters within a parameter block.
|
:
|
A colon separates parameter blocks within a command line.
|
\" \"
|
Escape quotes enclose user-defined messages.
|
<
|
The left angle bracket is the ready indicator used in a response to show that the target system is ready to accept new input.
|
>
|
The right angle bracket is the end-of-output character used to indicate that more data associated with the response will follow.
|
&
|
An ampersand (&) is a grouping symbol that allows the user to enter a group of values for a single parameter. Specify the access identifier prefix (that is, T1-<1-8>) each time.
Example: T1-1&T1-5 equals "T1 Number 1 and Number 5."
|
&-
|
An ampersand followed by a hyphen (&-) are grouping symbols that allow the user to enter a group of values for a single parameter. The access identifier prefix (that is, T1-<1-8>) is assumed to be the same type as the previous access identifier prefix type and it must not be repeated each time.
Example: T1-1&5 equals "T1 Number 1 and Number 5."
|
&&
|
Two ampersands together (&&) are ranging symbols that allow the user to specify a range of values for a single parameter. Repeat the access identifier prefix (that is, T1-<1-8>) each time in ascending order.
Example: T1-1&&T1-5 equals "T1 Number 1 through Number 5."
|
&&-
|
Two ampersands followed by a hyphen (&&-) are ranging symbols that allow the user to specify a range of values for a single parameter. The access identifier prefix (that is, T1-<1-8>) is assumed to be the same type as the previous access identifier prefix type and it must not be repeated each time.
Example: T1-1&&-5 equals "T1 Number 1 through Number 5."
|
Note You can use grouping and ranging symbols an unlimited number of times, provided that the overall description of the parameter specified in the TL1 command is fewer than 64 characters in length.
12.2.2.17 TL1 Error Codes
Table 12-32 describes the error codes that are used in TL1 command responses.
Table 12-32 TL1 Error Codes
Error Code
|
Definition
|
Description
|
GNRN
|
Gateway not ready for network element
|
CTM GateWay/TL1 is not ready for the NE.
|
GWBY
|
Gateway is busy
|
CTM GateWay/TL1 has too many outstanding requests.
|
ICNV
|
Input, command not valid
|
The command verb or modifier is invalid.
|
IDNV
|
Input, data not valid
|
A simple or compound parameter value appearing in an input command is invalid.
|
IICM
|
Input, invalid command
|
Invalid command.
|
IICT
|
Input, invalid correlation tag
|
Invalid correlation tag.
|
IITA
|
Input, invalid TID
|
Invalid target identifier.
|
INUP
|
Input, non-null unimplemented parameter
|
Invalid parameter length in AID.
|
IPMS
|
Input, parameter missing
|
A required parameter is missing from an input command.
|
IPNC
|
Input, parameter not consistent
|
Two valid parameter names appearing in an input command are mutually exclusive.
Note The ACT-USER, CANC-USER, and RTRV-HDR commands do not support the IPNC error code.
|
IPNV
|
Input, parameter not valid
|
A parameter name used in an input command is not valid.
|
PIUI
|
Privilege, illegal user identity
|
Error code normally returned when an invalid UID or PID has been supplied in an ACT-USER command.
|
PLNA
|
Privilege, logon not active
|
Privileged login is not active.
|
SSRE
|
System resources exceeded
|
An action requested by an input command was canceled because of limited system resources.
|
SSTP
|
System stopped
|
An action requested by an input command was canceled because of limited system resources.
|
12.2.3 Managing CTM GateWay/CORBA
Note This section provides a high-level overview of CTM GateWay/CORBA. For detailed information about CTM GateWay/CORBA, including how to enable username and password encryption, set the heartbeat event, and create OSS clients, refer to the Cisco Transport Manager GateWay/CORBA User Guide and Programmer Manual.
The Common Object Request Broker Architecture (CORBA) is a middleware platform defined by the Object Management Group (OMG). The CTM GateWay/CORBA option is a CORBA-based interface that provides higher-layer management systems with fault, inventory, performance, configuration, Layer 1 circuit provisioning, and Layer 2 VLAN management information for NEs. The CTM GateWay/CORBA option is based on the TeleManagement Forum (TMF) standards for the NMS-to-EMS interface.
Because it is CORBA-based, CTM GateWay/CORBA is independent of the hardware that the integrated OSS is running. This independence allows service providers to easily add CTM as a building block of their management environment.
Note Table 2-3 on page 2-4 shows the NEs that support CTM GateWay/CORBA.
Figure 12-3 shows the CTM GateWay/CORBA communications architecture within a service provider's OSS environment.
Figure 12-3 CTM GateWay/CORBA Communications Architecture
CTM GateWay/CORBA is based on the following TMF standards:
•TMF513 v2.0 (October 2001): Multi-Technology Network Management Business Agreement
•TMF608 v2.0 (October 2001): Multi-Technology Network Management Information Agreement
•TMF814 v2.0 (October 2001): Multi-Technology Network Management Solution Set
12.2.3.1 Configuring the CORBA Timeout
The CORBA timeout determines the number of seconds that the CTM server has to process a CORBA call and return it to the CTM client. If the CTM server does not return a response in time, CORBA automatically times out.
Step 1 Open the ems-client.cfg file.
By default, the ems-client.cfg file is located in the C:\Cisco\TransportManagerClient\config directory for Windows platforms and in the /opt/CiscoTransportManagerClient/config directory for Sun Solaris platforms.
Step 2 Set the CORBA_Call_Timeout_Seconds parameter to the desired value. The default timeout is 120 seconds; the recommended range is 120 to 300 seconds.
Note If the NE is busy or if the CTM server is processing many requests, you might need to increase the CORBA timeout parameter accordingly.
Step 3 Save and close the ems-client.cfg file.
12.2.3.2 Viewing the CTM GateWay/CORBA Service Pane
Use the GateWay/CORBA Service pane to stop, start, or configure CTM GateWay/CORBA service parameters. The pane has two tabs, Global and OSS Clients.
•Global—Use this tab to start and stop the CTM GateWay/CORBA service.
•OSS Clients—Use this tab to view current OSS client configuration information or add a new OSS client. The OSS Clients tab is not displayed if the Service Status is Not Installed.
Table 12-33 describes the fields in the GateWay/CORBA Service pane.
Table 12-33 Field Descriptions for GateWay/CORBA Service Pane
Field
|
Description
|
Global Tab
|
Service Status
|
Displays the current status of the service: Active, Not Active, or Not Installed.
|
Service Action
|
Allows you to stop or start a process. Notice that the Service Action button toggles between Stop and Start, and the Service Status field changes accordingly. This field is not available if the Service Status is Not Installed.
|
Enable Encryption for Username and Password
|
When checked, usernames and passwords are transmitted between the EMS server and the OSS in encrypted format. The maximum encryption length is 53 bytes. If this check box is unchecked, CTM GateWay/CORBA usernames and passwords are transmitted without encryption. By default, encryption is disabled at installation.
|
Heartbeat for Notification Channel
|
Notifies the OSS if a failure in the notification service has occurred. The heartbeat is measured in minutes; the range is 0 to 999 minutes. A zero value implies that the heartbeat is disabled.
|
Maximum Number of Simultaneous Sessions
|
Specifies the number of CTM GateWay/CORBA sessions that can be active at the same time. The range is 4 to 25; the default is 4.
|
Maximum Events per Consumer
|
Sets the MaxEventsPerConsumer administrative QoS parameter on the notification channel. The notification server uses this property to bound the maximum number of events in a given channel allowed to queue at any one time. The default value is 0, meaning that the notification server does not limit 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, because the server must keep all events in memory until they are consumed by all registered consumers.
Caution Any change to this value should be done with extreme caution. If you set the value too low, the NMS cannot receive all notifications. If you set the value too high, the CTM notification server runs out of memory. The current value can handle alarm bursts of 10,000 events per minute.
|
Notification Service Name
|
Defines the service name used by the resolve_initial_reference function to get a reference to the notification service.
The CTM GateWay/CORBA installation installs the notification service. However, if you want to use your own notification service, you can modify this parameter.
Note You do not need to modify this parameter if you plan to use the notification service that is bundled with CTM GateWay/CORBA.
|
Notification Service Naming Context
|
Defines the naming context of the notification service. This property is used when the resolve_initial_reference function fails to resolve the notification service. 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.
Note You do not need to modify this parameter if you plan to use the notification service that is bundled with CTM GateWay/CORBA.
|
Notification Service Factory IOR Filename
|
Enter the notification service factory Information Object Repository (IOR) filename located in the /opt/CiscoTransportManagerServer/openfusion/domains/OpenFusion/localhost/NotificationService/NotificationSingleton/NotificationService.ior directory.
The FactoryIORFile property defines the path to a text file that contains the IOR of the notification service. This property is used only after the resolve_initial_reference function and the naming service both fail. CTM GateWay/CORBA opens the file as defined by the URL format in this property and retrieves the IOR. This parameter allows you to run your notification service on a different host to improve performance.
Note You do not need to modify this parameter if you plan to use the notification service that is bundled with CTM GateWay/CORBA.
|
Notification Service Listening Port Number
|
Sets the port number 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 are set properly. If set to 0 (the default), the port number is allocated by the operating system.
|
Session Port Number
|
Configures the IIOP listening port. The CTM GateWay/CORBA service listens to CORBA requests on this port. If set to 0 (the default), the session port number is allocated by the operating system.
|
Name Service Server List
|
Defines where the name servers are running. Accepts a comma-separated list of hostnames.
|
Name Service Root IOR
|
Defines the path to find the naming service's IOR on each host defined in the server list. The complete path is constructed as <http://<item>_of_ServerList><RootIORLoc>.
|
Error Level
|
Defines the error level of messages to log. Error levels are:
•Critical
•Major
•Minor
•Informational
•Debug
•Trace
This property can be configured by modifying the corbagw.properties configuration file located in <CTM_server_installation_directory>/cfg. The property is:
corbagw.CTP.getLayeredParameters=false
By default, this property is disabled. If the NMS requires that CTP-related transmission parameters be included as part of any object reporting a TerminationPoint_T structure, this property should be set to true. However, the ManagedElementMgr_I.getTP interface is independent of this property setting and always returns transmission parameters as part of the TerminationPoint_T structure.
|
OSS Clients Tab
|
OSS Profile Name
|
The name of the OSS profile.
|
Password
|
The password that the OSS client uses to log into the CTM server. If you are adding a new OSS client, the password must contain 1 to 53 characters, including one special character (, . ; % & ! + #), at least two letters (A-Z, a-z), and at least one number (0-9).
|
Confirm Password
|
The reconfirmed password.
|
Delete button
|
Deletes an OSS profile from the CTM database. If a profile is deleted, the OSS using this profile cannot connect to CTM. If the OSS is connected to CTM when the profile is deleted, CTM does not terminate the OSS session.
|
12.2.3.3 Viewing the CTM GateWay/CORBA Client Configuration Table
The CTM GateWay/CORBA Client Configuration table displays information about OSS CORBA client properties.
Step 1 In the Domain Explorer window, choose Administration > Control Panel.
Step 2 In the Control Panel window, choose Administration > GW/CORBA Client Configuration Table. Table 12-34 provides descriptions.
Table 12-34 Field Descriptions for the CTM GateWay/CORBA Client Configuration Table
Column Name
|
Description
|
OSS Name
|
Displays the name of the selected OSS client.
|
IP Address
|
Displays the IP address of the OSS client.
|
