Professional Documents
Culture Documents
Kairos HLR Configuration Volume 1 of 3
Kairos HLR Configuration Volume 1 of 3
PE/HLR/APP/027904
HLR
Replaces: NN10300-441v1
Kapsch CarrierCom AG
HLR
Release: HLR22
Document number: PE/HLR/APP/027904
Document release date: September 5, 2014 2:22 PM
The information contained in this document is the property of Kapsch CarrierCom (in the following referred to as
“Kapsch”). Except as specifically authorized in writing by Kapsch, the holder of this document shall keep the information
contained herein confidential and shall protect same in whole or in part from disclosure and dissemination to third parties
and use same for evaluation, operation and maintenance purposes only.
The content of this document is provided for information purposes only and is subject to modification. It does not
constitute any representation or warranty from Kapsch as to the content or accuracy of the information contained herein,
including but not limited to the suitability and performance of the product or its intended application.
Kapsch and the Kapsch logo are trademarks of Kapsch and/ or its licensors. All other trademarks are the property of
their owners.
Kapsch CarrierCom AG
Table of contents
2 Introduction ....................................................................................................................................... 8
2.1 Navigation ........................................................................................................................................... 8
10.2 Determining the need for an alternative external IP pool for SSG ..................................................118
10.3 Configuring an alternative external IP pool for SSG .......................................................................118
10.4 Adding an external SIP address ......................................................................................................119
10.5 Determining your SSG configuration ...............................................................................................120
10.6 Collecting and recording SSG data .................................................................................................133
10.7 Multihoming SSGs...........................................................................................................................150
10.8 Single-homing SSGs .......................................................................................................................151
10.9 Configuring network appearances ..................................................................................................152
10.10 Configuring routesets ......................................................................................................................153
10.11 Configuring a pathset between the set of SSGs and the MRF .......................................................154
10.12 Configuring paths between the SSGs and MRF .............................................................................155
10.13 Configuring pathsets between the set of SSGs and the HLR blade pairs ......................................156
10.14 Configuring paths between the SSGs and the HLR blades ............................................................156
10.15 Configuring pathsets between the MRF and the HLR blade pairs ..................................................158
10.16 Configuring paths between the MRF and the HLR blade pairs ......................................................158
10.17 Configuring pathset group ...............................................................................................................159
10.18 Configuring pathset group map .......................................................................................................160
10.19 Configuring adjacent node groups ..................................................................................................161
10.20 Prerequisites ...................................................................................................................................161
10.21 Configuring NA-based application servers ......................................................................................162
10.22 Configuring RS-based application servers ......................................................................................163
10.23 Configuring RSG-based application servers ...................................................................................164
10.24 Configuring routesets for RSG-based application servers ..............................................................165
10.25 Configuring ASPs or IPSPs .............................................................................................................166
10.26 Configuring ASPAs..........................................................................................................................169
10.27 Activating paths, ASPs, and routesets ............................................................................................170
10.28 Configuring SSG for SIP .................................................................................................................171
2 Introduction
This information supports configuration of the HLR Provisioning Proxy. This document describes the
Kapsch Advanced Integrated Reliable Operating System (KAIORS), SigTran Services Gateway (SSG)
and Call Agent (CA) configuration activities. This document does not describe upgrades.
2.1 Navigation
See the following chapters:
3.1.1 Overview
The HLR application in HLR22 is made up of multiple loosely-coupled HLR applications to make the
system truly scalable. Having a single proxy application handling all DS connections to a particular
KAIROS HLR node hides internal IP addresses and port numbers used by the different HLR applications
in the same node and means that the HLR will only have a single IP address published.
The HLR DS Proxy agent application is also able to take advantage of common services offered by the
KAIROS platform to integrate with KAIROS Availability Management Framework (AMF) and configuration
framework.
3.1.2 Description
The HLR Provisioning Proxy application performs the following:
• It handles the changed connection initiation procedure and enables TCP connection to be
established between DS and any HLR application instance in the KAIROS HLR cluster.
• It provides a public interface (IP address and port numbers) for the DS to connect to and
then establishes a connection to an HLR application using the HLR number (HLR E164
Address).
The proxy acts as a TCP server to the DS application and a TCP client to the HLR
application. The messaging protocols between the DS and HLR are proprietary.
• It runs on the KAIROS platform, which is based on the KAIROS standards with proprietary
enhancements to give even greater availability and robustness.
The operating system used is a carrier-grade version of Linux, which provides the
framework for implementing High Availability telecommunications-grade applications.
All commands use the VKAIROS CLI Man Machine Interface (MMI). All directories are accessible from
the KAIROS CLI. The KAIROS CLI is available on KAIROS System Controller at logon time.
Alternatively, to access the KAIROS CLI from the shell, enter cli<cr>
Use the preceding commands to begin running the proxy so that it will start accepting and provisioning
connections. The actions required, shown with their respective CLI commands/examples, include the
following:
Kapsch CarrierCom AG
Step Action
1. Add the service group:
cli> aim service-group add FoxyProxy HLR_DS_proxy_agent 9 0 0
ATTENTION
Make sure these are on the same blades as the Message Routing
Function (MRF) service units.
ATTENTION
Make sure you use the right external IP address and configure this IP
on the DS.
-End-
The following sections describe the commands and provide information about their usage to accomplish
these actions.
3.2.1.1 Description
This command has been extended to allow a service-group of type HLR_DS_proxy_agent to be
added. It extends the existing AIM Signaling Gateway (SG) add commands provided by the
application interface specification and availability management framework (AIS/AMF). Generic
semantic checking is provided by the CLI and existing command framework. See the base
documentation for more details.
In order to ensure the HLR DS Provisioning Proxy Agent entity is unique within the KAIROS
site, there is a restriction that only one SG of this type can be provisioned at any one time.
ATTENTION
Modification is not supported. The Signaling Gateway (SG) must be
deleted and re-added if, for example, the name is to be changed.
Example:
The SG name must be 3 - 31 characters (upper and lower case and "_" characters are allowed)
and must be unique within the KAIROS site. This is inherited from generic CLI/AIM behavior.
3.2.1.4 Response
If the command is successful, the CLI prompt will return and the new SG will be visible using the
aim service-group show command.
Example:
cli>aim service-group show FoxyProxy d
sg-name = FoxyProxy
sg-type = HLR_DS_proxy_agent
sg-max-num-of-sus = 2
sg-min-num-of-sus = 1
Kapsch CarrierCom AG
Delete the existing SG using the aim service-group delete command before adding in a
new SG. This is required to ensure that the HLR_DS_proxy_agent entity is unique within
the KAIROS site.
The user should check the health of the base platform and fix any base problems, then
retry the command. These return codes indicate that there has been an internal error
while trying to check current SG data and add the new SG to the application inventory.
3.2.2.1 Description
This command checks that the SG is not in use by an existing hlr-prov-proxy entity before
deleting the SG. The check is only performed on SG deletions where the application type is
HLR_DS_proxy_agent. This command extends the existing AIM SG add commands provided
by the AIS/AMF. Generic semantic checking is provided by the CLI and existing command
framework.
Example:
The SG name must be 3 - 31 characters (upper and lower case and "_" characters are allowed)
and must be unique within the KAIROS site. This is inherited from generic CLI/AIM behavior.
3.2.2.4 Response
If the command is successful, the CLI prompt returns and the specified SG is no longer visible
using the aim service-group show command.
See the following example, which shows how to verify that a specified SG no longer exists.
Example:
The error indicates that the service group cannot be deleted because it is being
used in the configuration of an hlr-prov-proxy entity. This is required to ensure that
data integrity of in-service HLR DS Provisioning Proxy Agent entity is always
preserved.
Check the health of the base platform and fix any base problems, then retry the command.
These return codes indicate that there has been an internal error while trying to check current
SG / hlr-prov-proxy data and delete the SG from the application inventory.
3.2.3.1 Description
At provisioning time it is the operator’s responsibility to ensure that the HLR DS Provisioning
Proxy Agent SUs are collocated with the MRF application SUs.
Kapsch CarrierCom AG
ATTENTION
It is mandatory in HLR22 for Provisioning Proxy to be collocated with
the MRF on blades 0 0 2 0 and 0 0 5 0.
This is required in order to permit correct functionality if the HLR DS Provisioning Proxy Agent
(including correct behavior when HLR application Switch of Activities (SWACTs)) and in order to
try to ensure that Central Processing Unit (CPU) utilization is balanced across all blades in the
system.
The code for running the aim service-unit add command has not been changed in any way at
the code level and there are no new restrictions on how it may be for by SUs of type HLR DS
Provisioning Proxy Agent.
This command does not change the existing AIM SU add command provided by the AIS/AMF
framework. Generic semantic checking etc. is provided by the CLI and existing command
framework. See base documentation for more details.
The MRF and HLR DS Provisioning Proxy Agent service-units are functionally entirely
independent and may Switch of Activity (SWACT) independently. It is therefore not necessary to
consider which MRF unit is standby when provisioning/loading/unlocking the HLR DS Proxy
SUs.
Example:
3.2.3.4 Responses
Responses provided by the AIM/AMF framework for aim service-unit add command are not
altered in any way.
3.2.4.1 Description
This command is used to add all the configuration data needed for the HLR DS Provisioning
Proxy Agent to the database on KAIROS System Controller for persistence and can be
accessed at runtime by the agent.
It extends the existing AIM SG add commands provided by the AIS / AMF framework. Generic
semantic checking etc. is provided by the CLI and existing command framework. Please see
base documentation for more details.
The command will reserve an external IP address for the HLR DS Proxy Agent which will be
associated with an SG name (the SG must be associated with HLR DS Proxy Agent application
type from the SG add command).
The current state of the dataoam pool can be checked using the networking ip show dataoam
command from the CLI to help find a free IP address which the proxy may use.
Default ports for DS and HLR side connections are also set up at this time (there are 2
connections supported, one for provisioning messages and one for System Data Caching on
the DS).
If the IP address cannot be reserved successfully the add command will fail.
WARNING
This feature does not provide any sort of security for ensuring
only trusted Data Server hosts may connect to the HLR DS
Proxy Agent entity. It is expected that this functionality will be
provided by the Network Gateway (NGW).
The NGW must be correctly configured to permit connections only from the IP address of the
Data Server to be allowed to connect to the HLR DS Proxy Agent and to block all other
addresses. Since the default NGW behavior is not to allow connections this means the Data
Server IP address must be added to the list of IPs which are allowed to send traffic to the
KAIROS platform.
Kapsch CarrierCom AG
This configuration is necessary to ensure that the DS can connect successfully while still
preventing unauthorized connections from untrusted sources (to prevent denial of service
attacks).
Example:
The SG name must be 3 - 31 characters (upper and lower case and "_" characters are allowed)
and must be unique within the KAIROS site - this is inherited from generic CLI / AIM behavior.
Additionally the SG must exist in AIM and have been configured with type
HLR_DS_proxy_agent at add time.
The IP address is checked from the KAIROS CLI to ensure that it has correct dotted character
string IPv4 address notation. Additionally the IP address must be configured to be part of the
dataoam pool and must be free (not used by any other applications) so that it can be reserved
for use by the HLR DS Provisioning Proxy Agent entity.
The current state of the dataoam pool can be checked using the networking ip show dataoam
command from the CLI to help find a free IP address which the proxy may use.
Example:
The last entry in the above example shows that HLR Provisioning Proxy successfully
provisioned the IP address.
If the IP address cannot be reserved successfully the add command will fail.
3.2.4.4 Response
The proxy entry is visible from the show command.
Example:
Check that the dataoam pool has been provisioned successfully because these return
codes indicate that there has been an internal error while trying to check current SG / hlr-
prov-proxy / IP data prior to allowing the hlr-prov-proxy add command to proceed.
Kapsch CarrierCom AG
Observe in particular that the pool name “dataoam” must be an exact match for the HLR
DS Proxy Agent to be able to reserve its external IP address successfully.
Delete any existing HLR DS Provisioning Proxy Agent entities using hlr-prov-proxy delete
command before trying to add another one. There can only be one at any one time
because this response indicates that an HLR DS Provisioning Proxy Agent entity already
exists in the database.
Check the currently configured service groups (using aim service-group show all
command from the KAIROS CI) and ensure that the SG name has been configured using
aim SG add command because this response indicates that the SG name provided does
not match an SG name that is configured with type HLR_DS_proxy_agent.
If you want to change the SG name for the SG of type HLR_DS_proxy_agent use aim
service-group delete command and then add it in again with the correct name.
Ensure that the SG name is typed correctly when using the hlr-prov-proxy add command.
This command is case-sensitive.
The user should check the health of the base platform and fix any base problems, then
retry the command because these return codes indicate that there has been an internal
error while trying to check current SG /hlr-prov-proxy data prior to allowing the load
command to complete.
The HLR22 OAM agents (delivered by HLR22 OAM features) will require another (different)
external IP address from the dataoam pool as well.
Example:
3.2.5.1 Description
This command has been extended to check that the hlr-prov-proxy entity has been configured
before the service unit can be loaded. This prevents the possibility of undefined behavior by the
HLR DS Provisioning Proxy Agent which could occur if the SU was loaded when hlr-prov-proxy
entity was not configured.
It extends the existing AIM SU load command provided by the AIS / AMF framework. Generic
semantic checking etc. is provided by the CLI and existing command framework. Please see
base documentation for more details.
Example:
3.2.5.4 Response
If the command is successful the CLI prompt will return and the specified SG will no longer be
visible using the aim service-group show command.
Configure an HLR DS Provisioning Proxy Agent entity using hlr-prov-proxy add command
and retry the SU load command because these return codes indicate that the service unit
cannot be loaded and that no hlr-prov-proxy entity is configured. The hlr-prov-proxy entity
must be configured first so that all data required by the service-unit to provide service is
available before it can be loaded.
The user should check the health of the base platform and fix any base problems, then
retry the command because these return codes indicate that there has been an internal
error while trying to check current SG /hlr-prov-proxy data prior to allowing the load
command to complete.
This command extends the existing AIM SG add commands provided by the AIS / AMF
framework. Generic semantic checking etc. is provided by the CLI and existing command
framework. Please see base documentation for more details.
3.2.6.1 Description
The HLR DS Proxy Agent makes use of the generic entity show command to display the
provisioned data.
There are no additional return codes beyond those provided by the generic framework.
Example:
3.2.7.1 Description
This command removes all data associated with the HLR DS Provisioning Proxy entity from the
database on KAIROS System Controller so that data is no longer persisted.
Example:
The IP address is removed from the dataoam pool (no entry for HlrProvProxyIp block name).
Example:
The SG name must be 3 - 31 characters (upper and lower case and "_" characters are allowed)
and must be unique within the KAIROS site - this is inherited from generic CLI / AIM behavior.
The user should check that an hlr-prov-proxy is provisioned using hlr-prov-proxy show
command and ensure that the SG specified in the delete command is an exact match.
The check is case sensitive.
The user should ensure all service-units are unloaded using aim service-unit lock and
unload commands then retry the hlr-prov-proxy delete command because these return
codes indicate that the hlr-prov-proxy entity cannot be deleted because there are service-
units provisioned which use that entity currently.
Deleting the configured data in that case could cause undefined behavior so is not
permitted.
The user should check the health of the base platform and fix any base problems, then
retry the command because these return codes indicate that there has been an internal
error while trying to check current SG /hlr-prov-proxy data prior to allowing the load
command to complete.
3.2.8.1 Description
This command changes the provisioning port pairs from their default value of 19999.
WARNING
This command is provided for flexibility and to make the design
future-proof but is not recommended for use.
If you use this command you will have to ensure config changes are
made on the DS side (so that client-side ports match on both DS and
HLR DS Provisioning Proxy Agent) and any changes to the server-
side ports will require HLR Switch Operating System (SOS) code
changes (new SOS load required).
Example:
3.2.8.4 Response
Possible error messages are listed below.
The user should check the health of the base platform and fix any base problems, then
retry the command because these return codes indicate that the hlr-prov-proxy entity has
not yet been provisioned.
These errors are generally expected to appear if there is a problem with the KAIROS
system e.g. internal DB is unavailable temporarily.
The user should check the health of the base platform and fix any base problems, then
retry the command because these return codes indicate that there has been an internal
error while trying to check current SG /hlr-prov-proxy data prior to allowing the command
to proceed.
These errors are generally expected to appear if there is a problem with the KAIROS
system e.g. internal DB is unavailable temporarily.
may be encountered.
3.2.9.1 Description
This command changes the port pair used for System Data Cache connection from their default
value of 20000.
WARNING
This command is provided for flexibility and to make the design
future-proof but is not recommended for use.
If you use this command you will have to ensure config changes are
made on the DS side (so that client-side ports match on both DS and
HLR DS Provisioning Proxy Agent) and any changes to the server-
side ports will require HLR SOS code changes (new SOS load
required).
Example:
3.2.9.4 Response
Possible error messages are listed below.
The user should check the health of the base platform and fix any base problems, then
retry the command because these return codes indicate that the hlr-prov-proxy entity has
not yet been provisioned.
These errors are generally expected to appear if there is a problem with the KAIROS
system e.g. internal DB is unavailable temporarily.
Kapsch CarrierCom AG
The user should check the health of the base platform and fix any base problems, then
retry the command because these return codes indicate that there has been an internal
error while trying to check current SG /hlr-prov-proxy data prior to allowing the command
to proceed.
These errors are generally expected to appear if there is a problem with the KAIROS
system e.g. internal DB is unavailable temporarily.
3.2.10.1 Description
This command is used to unlock the service unit and place the HLR Proxy into service.
Example:
Response
The following example shows how to check that the unlock has been
successful.
Example:
The fields enabled, in-service and standby in the example above show that both units have
been successfully unlocked and are now in service. Iff you unlock SU 0 first and then SU 1 then
the active / standby fields will be the other way round from in the example (SU 1 would be
standby and SU 0 would be active). The order is not important, as long as one is active and one
is standby which indicates that the command was successful.
Kapsch CarrierCom AG
4 KAIROS Configuration
This section covers configuration tasks for platform components.
4.1 Navigation
• “KAIROS configuration fundamentals” on page 28
• “KAIROS System Controller and KSX blade configuration” on page 34
• “Networking, addressing, and NGW configuration procedures” on page 69
• “SSG configuration fundamentals” on page 116
• “SSG configuration” on page 117
• “SSG Common procedures” on page 173
• “Call Agent configuration” on page 204
• “SOS file system commissioning” on page 232
• “Table synchronization configuration” on page 243
Kapsch CarrierCom AG
5.1 Navigation
• “Network services and IP addresses” on page 28
• “Network time protocol (NTP)” on page 28
• “Network Gateway (NGW) Management” on page 29
• “SOS file system configuration” on page 29
• “Table synchronization configuration” on page 29
• “Table synchronization configuration” on page 30
Internal IP addresses are used within KAIROS for private communication among platform elements.
Default internal IP address ranges are used, unless the operator has identified a conflict. In that case,
operator specified internal IP address ranges are defined during commissioning of the product. These
cannot be changed without a service outage once commissioning is complete.
5.2.1 IP pools
You can group KAIROS external IP addresses into pools to make it easier to assign external IP
addresses to applications. When you create an IP pool you enter a pool name followed by the gateway
address, subnet address, and subnet mask address to assign all of the addresses in that subnet to the IP
pool. If you want to define a subset of addresses within a subnet, you have the option to specify a start
and end IP address.
5.2.2 IP addresses
The KAIROS system allows you to activate, or assign, external IP addresses to applications or blades.
The show IP addresses procedure displays information associated with an IP address. You can activate
up to 255 external IP addresses in a block and define the number of addresses within a pool, including
the start IP address. External IP addresses that are no longer required by an application can be
deactivated or freed.
5.2.3 IP aliases
The system assigns a unique client ID to identify each KAIROS system IP address. The purpose of IP
aliases is to allow you to assign your own identifier for an IP address. For example, you may want to
name an IP address the same as the application that will use it. You can show, add, and delete IP
aliases.
The NTP protocol specifies that you provision a minimum of three servers. External redundancy requires
Kapsch CarrierCom AG
two servers; however, three servers allows the NTP protocol to detect that one server appears to be
incorrectly reporting the time. (The server incorrectly reporting the time may itself be out of sync.) In this
scenario, the system ignores the response from the erroneous server and relies on the data provided by
the remaining two. This fault tolerance and error detection algorithm is built into the NTP protocol itself.
An override time zone applies to a particular blade that may not share the same time zone as the system.
You can show, add, modify, and delete an override time zone.
• Layer 1 functions involve physical connections between the KSC blade and networks on
both sides: the external WAN and the internal KAIROS LAN.
• Layer 2 functions involve link aggregation (LAG) and multi-link trunking (MLT).
• Layer 3 functions involve static routing and the Virtual Router Redundancy protocol
(VRRP).
Other sections of this document describe these functions.
Configuring a NGW requires a well-developed network engineering plan that identifies the information,
such as
DMS table changes. Through the control mechanisms, slave blades become and remain synchronized
with the latest changes or roll back to a common synchronization point. System table changes to slaves
are not permitted, except through the distribution mechanism. A system table is a table or office
parameter that is registered for cluster syncing.
A Supercom allows control of the distributed table syncing functionality. To simplify coding, some CI
commands are only enabled on the master node.
A Supercom allows control of the distributed table syncing functionality. To simplify coding, some CI
commands are only enabled on the master node.
6 KAIROS configuration
Configure the KAIROS platform to change initial commissioning.
6.1 Prerequisites
• You have installed
– the frame and KAIROS shelf hardware
– the KAIROS platform software
– the KAIROS frame
– the power distribution units (PDU)
– the data servers
– the KAIROS shelf
– the Shelf Manager and Alarm Modules (SAM)
– all remaining blades
• You have installed and properly terminated all associated cabling.
• You have installed and commissioned the KSX, and KAIROS System Controller (KSC)
blades as well as the KXA and KPA blades.
• You have inserted all Power Entry Modules (PEM) and Fan Transition Modules (FTM).
Kapsch CarrierCom AG
6.4 Navigation
• “KAIROS System Controller and KSX blade configuration” on page 34
• Figure 3 NGW configuration task flow on page 70
Kapsch CarrierCom AG
• frame description
• frame location
Kapsch CarrierCom AG
• frame user-label
7.1.1 Prerequisites
• A KAIROS CLI session is open.
• Know the frame number.
OR
To modify a frame’s location attribute, enter
hardware frame modify <frame> location <location>
OR
To modify a frame’s user-label attribute, enter
hardware frame modify <frame> user-label <user-label>
-End-
Variable Value
<frame> physical frame location, range 0 to 15
<description> alphanumeric name associated with the blade; string of 1 to 64
characters in length
<location> alphanumeric name associated with the frame's location; string
of
1 to 64 characters in length
<user-label> a name you can assign to a frame; no operational impact; a
string of 1 to 64 characters in length
• shelf description
• shelf location
• shelf product engineering code (PEC)
• shelf user label
Kapsch CarrierCom AG
7.2.1 Prerequisites
• A KAIROS CLI session is open.
OR
To modify a shelf’s location attribute, enter
hardware shelf modify <frame> <shelf> location <location>
OR
To modify a shelf’s PEC attribute, enter
hardware shelf modify <frame> <shelf> pec <pec>
OR
To modify a shelf’s user-label attribute, enter
hardware shelf modify <frame> <shelf> user-label <user-label>
-End-
Variable Value
<description> alphanumeric name associated with the shelf; a string of 1 to
64 characters in length
<frame> physical frame location, range 0 to 15
<location> location of the shelf; alphanumeric name associated with the
shelf’s physical location; string of 1 to 64 characters in length
<pec> product engineering code associated with the shelf;
alphanumeric name associated with the shelf; string of 1 to 16
characters in length (example: NTRY10AA)
<shelf> physical shelf location, range 0 to 2
<user-label> a name you can assign to a shelf; no operational impact; a
string of 1 to 64 characters in length
7.3.1 Prerequisites
• CLI session is open.
Kapsch CarrierCom AG
-End-
Variable Value
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
7.4.1 Prerequisites
• CLI session is open.
• Shelf is provisioned.
The system returns attribute information for a specific shelf or several shelves within a
specific frame.
-End-
Variable Value
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
Kapsch CarrierCom AG
Example
command hardware shelf show all brief
System frame shelf user-label pec
response ------- ------ ------------- ----
0 0 default-user-label NTRY10AA
0 1 default-user-label NTRY10AA
7.5.1 Prerequisites
• A KAIROS CLI session is open.
• Know the location (frame, shelf, slot, and sub-slot) of the blade you are modifying.
ATTENTION
To modify a KAIROS System Controller blade logical-blade-type parameter, first
lock the blade.
OR
To modify a KAIROS System Controller blade’s logical blade type attribute, enter
hardware app-blade modify <frame> <shelf> <slot> <sub -slot>
logical-blade-type <logical-blade-type>
OR
To modify a blade’s user label attribute, enter
hardware app-blade modify <frame> <shelf> <slot> <sub -slot>
user-label <user-label>
Kapsch CarrierCom AG
-End-
Variable Value
<description> alphanumeric name associated with the blade; a string of 1
to
64 characters in length
<frame> physical frame location, range 0 to 15
<logical-blade-type> logical blade type; one of: typhoon-0, typhoon-1
(only for KAIROS System
Controller blades)
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 16
<sub-slot> physical sub-slot number, range of 0 to 4
<user-label> a name you can assign to a blade; no operational impact; a
string of 1 to 64 characters in length
7.6.1 Prerequisites
• A CLI session is open.
-End-
Variable Value
<frame> physical frame location, range 0 to 15
<sg-name> service group name, string, 1-255 characters in length
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 16
<su-number> service unit number in the service group, range 0 to 255
• disk description
• disk user-label
7.7.1 Prerequisites
• A KAIROS CLI session is open.
Kapsch CarrierCom AG
OR
To modify a disk’s user-label attribute, enter
hardware disk modify <frame> <shelf> <slot> <sub-slot > user-
label <user-label>
-End-
Variable Value
<description> alphanumeric name associated with the blade; string of 1 to 64
characters in length
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 16
<sub-slot> physical sub-slot number, range of 0 to 4
<user-label> a name you can assign to a disk; no operational impact; a
string of 1 to 64 characters in length
read-total-bytes = 13335076609536
read-errors-total-uncorrected =0
write-errors-corrected-slowly =0
write-total-redone =0
write-errors-total-corrected =0
write-errors-total-algorithm =0
write-total-bytes = 12214014650880
write-errors-total-uncorrected =0
non-medium-errors =7
disk-mirror-status = Good
7.8.1 Prerequisites
• A CLI session is open.
• Know the location of the disk.
Variable Value
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 16
<sub-slot> physical sub-slot number, range 0 to 4
Kapsch CarrierCom AG
7.9.1 Prerequisites
• A KAIROS CLI session is open.
• Know the location (frame, shelf, slot, sub-slot) of the FTM.
• Know how to show KAIROS alarms, should they occur during this procedure.
• Know where to find information on specific KAIROS alarms, should they occur during this
procedure.
Kapsch CarrierCom AG
OR
To modify the description of an FTM, enter
hardware ftm modify <frame> <shelf> <slot> <sub-slot>
description <description>
OR
To modify the user label for an FTM, enter
hardware ftm modify <frame> <shelf> <slot> <sub-slot>
user-label <user-label>
2. If you changed the PEC, verify that the PEC was modified (optional). Enter
hardware ftm show <frame> <shelf> <slot> <sub-slot>
[<output-form>]
Variable Value
<assigned-pec> assigned product engineering code for the FTM; a string of
characters from 1 to 16 in length
<description> description of the FTM; a string of characters from 1 to 64 in length
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 9
<sub-slot> physical sub-slot number, range 0 to 4
<user-label> a name you can assign to an FTM; no operational impact; a string
of characters from 1 to 64 in length
7.10.1 Prerequisites
• A CLI session is open.
Kapsch CarrierCom AG
• You know the frame, shelf, and slot of the FTM (optional). The FTM sub-slot number is always
0.
• Left to right, FTM 1, FTM 2 and FTM 3 are the upper Fan Tray Modules at the front of the
frame.
• Left to right, FTM 7, FTM 8 and FTM 9 are the lower Fan Tray Modules at the front of the
frame.
• Left to right, FTM 4, FTM 5 and FTM 6 are the lower Fan Tray Modules at the rear of the frame.
OR
To see information for a specific FTM, enter
hardware ftm show <frame> <shelf> <slot> 0
Variable Value
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 9
7.10.4 Example
supplier-name = Kapsch
supplier -part-number = 01-W2199F01A
supplier-serial-number = 0000001
hw-version = CHS1600 Fan Tray
Kapsch CarrierCom AG
7.11.1 Prerequisites
• A KAIROS CLI session is open.
• Know the location (frame, shelf, slot, sub-slot) of the PEM (if applicable).
• Know how to show KAIROS alarms, should they occur during this procedure.
• Know where to find information on specific KAIROS alarms should they occur during this
procedure.
OR
To modify the description of a PEM, enter
hardware pem modify <frame> <shelf> <slot> <sub-slot>
description <description>
OR
To modify the user label for a PEM, enter
hardware pem modify <frame> <shelf> <slot> <sub-slot> user-
label <user-label>
2. If you modified the PEC, verify that the PEC was modified (optional).
To view specific PEM information, enter
hardware pem show <frame> <shelf> <slot> <sub-slot> [<output-
form>]
Variable Value
<assigned-pec> assigned product engineering code for the PEM; a string of
characters from 1 to 16 in length
Kapsch CarrierCom AG
7.12.1 Prerequisites
• A CLI session is open.
• Know the location (frame, shelf, slot, sub-slot) of the PEM (if applicable).
• Know the location (frame, shelf, slot) of the PEM (if applicable).
OR
To view specific PEM information, enter
hardware pem show <frame> <shelf> <slot> <sub-slot>
Variable Value
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range a or b
<sub-slot> physical sub-slot number, range 0 to 4
Kapsch CarrierCom AG
supplier-name = Kapsch
supplier-part-number = 01-W2330F01C
supplier-serial-number = NNTMHL0002E6
hw-version = PEM1600
7.13.1 Prerequisites
ATTENTION
Do not force the RTM into the backplane slot.
ATTENTION
Do not force the RTM into the backplane slot.
4. Compress the handle and apply pressure to insert the RTM until it is securely seated.
5. Close the bottom latch to activate the RTM.
6. Wait for the blue H/S LED to switch off; this indicates that the RTM is active.
7. Secure the RTM by tightening the captive screws at both ends of the faceplate.
Kapsch CarrierCom AG
-End-
7.14.1 Prerequisites
ATTENTION
Observe esd precautions when handling the RTM. Use a grounded wrist strap,
static-dissipating work surface, and antistatic containers when handling and storing
components.
ATTENTION
In the situation where a blade record has an associated RTM provisioned
record, then that RTM is required. Check to see if the RTM is physically present.
If not, do not let the board boot and alarm the event for boot failure.
• Ensure that you have already provisioned the front board and that the front board is the
appropriate type.
• You can provision an RTM without it being physically present. Once you have provisioned
an RTM for a slot, then any RTM inserted into that slot will be checked against that
provisioned record.
ATTENTION
Make sure you do PEC checks for front-board compatibility.
Variable Value
<field to modify> This value can either be user-label or description. The modify
command is not used during the provisioning or removal of an RTM.
<frame> physical frame location, range 0 to 15
<location> The <location> is equivalent to <frame> <shelf> <slot>
<sub-slot>. (Location 0 0 1 0 is a valid location, but it is made up of
frame = 0 shelf = 0 slot = 1 sub-slot = 0)
<PEC> See the following job aid.
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 16
<sub-slot> physical sub-slot number, range 0
KCRY83AA KCRY82AA
7.15.1 Prerequisites
• A CLI session is open.
OR
hardware rtm modify <frame> <shelf> <slot> <sub-slot> user-
label <user-label>
-End-
Kapsch CarrierCom AG
Variable Value
<description> keyword, string of characters, 1-64 in length
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 16
<sub-slot> physical sub-slot number, range 0
<user-label> keyword, string of characters, 1-64 in length
ATTENTION
If you delete a blade record, the corresponding rtm record, if it exists, will be
deleted as well. Also if you pull the front blade, then the corresponding RTM
physical record will be deleted as well (just as if it were pulled).
7.16.1 Prerequisites
ATTENTION
Observe esd precautions when handling the RTM. Use a grounded wrist strap,
static-dissipating work surface, and antistatic containers when handling and storing
components.
CAUTION
Powering down or removing a blade before you have properly shut
down the operating system or other software running on the blade may
cause corruption of data or file systems.
7.17.1 Prerequisites
• A CLI session is open.
Variable Value
<frame> physical frame location, range 0 to 15
• SAM description
• SAM product engineering code (PEC)
• SAM user-label
7.18.1 Prerequisites
• A KAIROS CLI session is open.
• Know the SAM frame, shelf, slot, and sub-slot.
Kapsch CarrierCom AG
OR
To modify the description for a SAM, enter
hardware sam modify <frame> <shelf> <slot> <sub-slot>
description <description>
OR
To modify the user label field for a SAM, enter
hardware sam modify <frame> <shelf> <slot> <sub-slot> user-
label <user-label>
-End-
Variable Value
<assigned-pec> product engineering code of the SAM; alphanumeric string of 1 to 16
characters in length
<description> alphanumeric name associated with the blade; string of 1 to 64
characters in length
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, a or b
<sub-slot> physical subslot location, 0
<user-label> a name you can assign to a SAM; no operational impact; a string of
1 to 64 characters in length
7.19.1 Prerequisites
• A CLI session is open.
• Know the SAM frame, shelf, and slot to view a specific SAM.
OR
To view information for a specific SAM, enter
hardware sam show <frame> <shelf> <slot>
The system displays SAM information. After a short delay the cli> prompt returns.
-End-
Variable Value
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, a or b
7.20.1 Prerequisites
• A KAIROS CLI session is open.
• Know the IP pool name (if applicable).
Kapsch CarrierCom AG
Variable Value
<pool name> character string, the name assigned to an IP pool, up to 64
characters in length.
7.21.1 Prerequisites
• A KAIROS CLI session is open.
• Know the pool name (if applicable).
The system displays all activated IP addresses, pool names, blocks, client IDs, and IP
addresses.
OR
To show attribute information for one IP address or a subset of IP addresses, enter
networking ip show <pool-name> [<block>] [registeredservice
<registered-service>]
The system displays a list of activated IP addresses, blocks, client IDs, and IP
addresses for the specified pool name.
-End-
Kapsch CarrierCom AG
Variable Value
<block> block; alphanumeric name associated with a block; string of 1 to
72 characters in length
<pool-name> a name (up to 64 characters) you enter to identify the pool
<registered- the service that has registered the IP address; string of 1 to 72
service> characters, usually in the format of service group, service unit
(optionally, service instance)
7.22.1 Prerequisites
• A KAIROS CLI session is open.
• Know the client ID (if required).
The system displays a list of all aliases and their client IDs.
OR
To view a specific alias, enter
networking alias show <client-ID>
The system displays the single alias and its client ID or the list of all the aliases that
begin with that specific client ID. For example, you may have a series of client IDs
beginning with bob.
-End-
Variable Value
<client ID> system-assigned ID for an IP address
The network time protocol function provides the KAIROS platform with an off-system clock
synchronization. This is important to maintain accurate timekeeping for billing functions.
Kapsch CarrierCom AG
The NTP protocol specifies that you provision a minimum of three servers. You need two servers for
external redundancy; however, three servers allow the NTP protocol to detect that one server appears to
be incorrectly reporting the time. (The server incorrectly reporting the time may itself be out of sync.) In
this scenario, the system will ignore the response from the erroneous server and rely on the data
provided by the remaining two. This fault tolerance and error detection algorithm is built into the NTP
protocol itself.
7.23.1 Prerequisites
• A KAIROS CLI session is open.
• Know the NTP server location (optional).
OR
To view a specific NTP entry, enter
time ntp show <location>
-End-
Variable Value
<location> the server host name for the NTP entry
7.24.1 Prerequisites
• A KAIROS CLI session is open.
Kapsch CarrierCom AG
OR
To view all the ports and IP addresses for a specific registered service, enter
networking ipmgr-port-entry show registered-service <ip-
address> |<port>
OR
To view registered services for an IP address and/or port, enter
networking ipmgr-port-entry show <ip-address> | <port>
Variable Value
<ip-address> a system-defined IP address
<port> a port number; 0 to 65 535
Every system is commissioned with an appropriate overall time zone that corresponds to its geographic
location. You can add, modify, and show the time zone for your system.
7.25.1 Prerequisites
• A KAIROS CLI session is open.
7.26.1 Prerequisites
• A KAIROS CLI session is open.
The system displays a warning that modifying the overall system time zone changes
the time zone for many cards. You must confirm if you want to continue (y to confirm
and n to abort).
2. To confirm your action, enter
y
Variable Value
<first-level-time-zone-keyword> Use the? character to view a list of all first-level
time-zone parameters, for example, America or
Canada.
<second-level-time-zone-keyword> Use the? character to view a list of all second-level
time-zone parameters, for example, Kentucky or
Winnipeg.
7.27.1 Prerequisites
• A KAIROS CLI session is open.
7.28.1 Prerequisites
• A KAIROS CLI session is open.
• Know the override time zone you want to change.
The system displays a warning that modifying the blade’s override time zone changes
it from the overall system time zone. You must confirm if you want to continue (y to
confirm and n to abort).
2. To confirm the action of modifying an override time zone, enter
y
-End-
Variable Value
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 16
<sub-slot> subslot number; integer value; range of 0 to 4
<first-level-time-zone-keyword> Use the? character to view a list of all first-level
time-zone parameters, for example, America or
Canada.
<second-level-time-zone- Use the? character to view a list of all second-level
keyword> time-zone parameters, for example, Kentucky or
Winnipeg.
7.29.1 Prerequisites
• A KAIROS CLI session is open.
OR
To see a specific DHCP entry, enter
networking dhcp show <host>
Variable Value
• hardware address
• fixed address
• file name
• Network File System (NFS) location
• NFS server (optional)
7.30.1 Prerequisites
• A KAIROS CLI session is open.
• Know the host parameter of the DHCP entry you want to modify.
The information for the DHCP entry appears. Use this information to guide you in
entering your DHCP modifications.
2. Enter
networking dhcp modify <host> <hardware-address> <fixed-
address> <file-name> <nfs-location> [<nfs-server>]
To minimize input errors, you can add each variable, one at a time, followed by a?
character. The system prompts you for the next variable until you have entered all of
the variables.
-End-
Kapsch CarrierCom AG
Variable Value
<host> name of the host
<hardware-address> hardware address (MAC) of the blade
The MAC address must be unique.
<fixed-address> IP address of the card to boot
The fixed address must be unique.
<file name> software load location and name of load (boot image)
7.31.1 Prerequisites
• A KAIROS CLI session is open.
• Know the file system mount point.
OR
To change all file system block alarm thresholds, enter
storage file-system modify <mount-point> thresholds block all
<threshold-value> <threshold-value> <threshold-value>
OR
To change all G/U MSC-HLR Server alarm thresholds, enter
storage file-system modify <mount-point> threshold s inode
all <threshold-value> <threshold-value> <threshold-value>
Kapsch CarrierCom AG
OR
To change all freespace alarm thresholds, enter
storage file-system modify freespace threshold all
<freespace-threshold> <freespace-threshold> <freespace-
threshold>
-End-
Variable Value
<mount-point> mount point for the file system, for example /home
<threshold-value> type of G/U MSC-HLR Server or block usage percentage alarm;
all - Enter the keyword all followed by space-separated values for
minor, major, and critical thresholds. (See explanation for each level of
alarm below.)
minor - Minor alarm threshold (in percentage) must be greater than 0
and less than 100, or -1 for default value 50, or 100 for turning off the
alarm, for example, 65 or -1 or 100.
major - Major alarm threshold (in percentage) must be greater than 0
and less than 100, or -1 for default value 70, or 100 for turning off the
alarm, for example, 75 or -1 or 100.
critical - Critical alarm threshold (in percentage) must be greater than
0 and less than 100, or -1 for default value 90, or 100 for turning off
the alarm, for example, 85 or -1 or 100.
<freespace- integer 0 - maximum disk size in Mbs.
threshold> Enter the keyword all followed by space-separated values for minor,
major, and critical freespace alarm thresholds.
7.32.1 Prerequisites
• A CLI session is open.
• Know the file system mount point (optional).
The system responds with information about all file systems. The last line of the
display shows the free space available on the volume group.
Kapsch CarrierCom AG
OR
To view information for a specific file system (you must know the mount point of the
file system), enter
storage file-system show <mount-point>
2. Record the name (mount point) of the file system you want to expand and the current
size, percentage used, and free space available for re-sizing.
The file systems are synchronized when the opr-stat = enable and avail = available.
-End-
Variable Value
<mount-point> mount point location of the file system
ATTENTION
You can only increase the current size of a file system. You cannot decrease the
size of a file system.
7.33.1 Prerequisites
• A KAIROS CLI session is open.
• Know the name and current size of the file system.
• The /opt/swd/backups file system must be 25000 Mbs before you back up a system. Enter
the new total size of the file system required.
-End-
Kapsch CarrierCom AG
Variable Value
<mount-point> mount point for this file system, for example, /home.
<size> the total new size of the file system in megabytes (MB) This variable
must be preceded by the keyword sz.
-End-
-End-
Kapsch CarrierCom AG
8.1.1 Prerequisites
• You must have the following network information:
– a list of already-configured public and private IP address pools (pool name, gateway
address that defines a VRRP instance, subnet, subnet-mask, pool-start IP address,
and pool-end IP address)
– the peer IP address (next hop gateway)
– NGW WAN interface aggregation configuration
– NGW WAN interface IP addresses and masks
– VRRP identifier number, priority, interface mapping, and interface tracking to each
gateway address
– VRRP WAN advertisement interval and optional mac release time
– interval settings for ICMP echo monitoring (if required)
– the default master NGW for each VRRP instance, supporting a gateway address
– security policies for the supported traffic flows
– static routes toward the WAN for both NGWs
• Install the KSC blades in slots 3 and 7 of the KAIROS frame.
• Know if your WAN interfaces are aggregated. The default configuration is aggregated.
Contact your next level of support for assistance.
Kapsch CarrierCom AG
Use the following navigation list to see the procedures shown in the taskflow:
• “Determining if router identifiers have been assigned for the NGWs” on page 71
• “Provisioning router instances for the KSC blades” on page 72
• “Provisioning IP addresses for WAN interfaces” on page 71
• “Configuring internal VRRP LAN instances” on page 73
• “Configuring external WAN VRRP instances” on page 75
• “Provisioning static routes” on page 77
• “Configuring ICMP echo monitoring” on page 78
• “Provisioning security policies” on page 86
• “Unlocking the aggregate WAN interfaces” on page 92
• “Unlocking VRRPs” on page 93
Kapsch CarrierCom AG
8.2 Determining if router identifiers have been assigned for the NGWs
Perform this procedure to determine if router identifiers have been assigned for the KSC blades.
8.2.1 Prerequisites
• A KAIROS CLI session is open.
8.3.1 Prerequisites
• A KAIROS CLI session is open.
• You have enabled the NGW service unit for the KSC blade.
• You have added the related router.
Kapsch CarrierCom AG
-End-
Variable
<mask-length> subnet mask length; must be the same as the subnet mask
specified in the associated address mapping tables; integer
value; range of 0 to 32
8.4.1 Prerequisites
• A KAIROS CLI session is open.
• You have unlocked the KSC blade slots.
-End-
Variable Value
<frame> physical frame location, range 0 to 15
<router-frame> frame number of the NGW router, range of 0 to 15
<router-shelf> shelf number of the NGW router, one of 0 or 1
<shelf> physical shelf location, range 0 to 2
Typically, you will provision VRRP instances and tracking for every public gateway address that was
previously configured (before KAIROS installation and commissioning) when provisioning the address
pools.
ATTENTION
To support full redundancy on a VRRP router, define the same VRRP instances on
both KSC (NGW) blades.
ATTENTION
You can define tracking at both the physical (port) level and at the logical (link
aggregation) level.
8.5.1 Prerequisites
• A KAIROS CLI session is open.
Kapsch CarrierCom AG
• You have enabled the NGW service unit for the KSC blade.
• You have added the NGW router.
• You have configured address pools.
2. Repeat step 1 for each remaining VRRP instance required on the slot 3 KSC (NGW).
3. To provision the first VRRP instance on the slot 7 KSC (NGW), enter
routing ngw-vrrp-instance add 2 601 <vrrp-identifier>
<gateway-address> <mask-length> <default-priority>
4. Repeat step 3 for each remaining VRRP instance required on the slot 7 KSC (NGW).
5. To provision VRRP tracking for the first VRRP instance configured on the slot 3 KSC
(NGW), enter
routing ngw-vrrp-tracking add 1 601 <vrrp-identifier>
<interface-number> <group-identifier>
ATTENTION
The interface-number cannot be the same as the vrrp-interface-
number. That is, a VRRP instance cannot track itself.
6. Repeat step 5 for each remaining VRRP instance on the slot 3 KSC (NGW).
7. To provision VRRP tracking for the first VRRP instance configured on the slot 7
(NGW), enter
routing ngw-vrrp-tracking add 2 601 <vrrp-identifier>
<interface-number> <group-identifier>
8. Repeat step 7 for each remaining VRRP instance on the slot 7 KSC (NGW).
-End-
Variable Value
<default-priority> The NGW router uses this field to select a master for this
VRRP route. Integer value: 230 (backup) or 254 (master).
<gateway-address> VRRP IP address. This address must be configured as a gateway
address in the address mapping tables (xxx.xxx.xxx.xxx).
<group-identifier> VRRP group identifier; integer value; range of 1 to 255
<interface-number> NGW WAN interface identifier (physical port or LAG
logical port); integer value; range 602 to 605
<mask-length> Subnet mask length must be the same as the subnet mask
Kapsch CarrierCom AG
ATTENTION
To support full redundancy on a VRRP router, define the same peer VRRP
instances on both KSC (NGW) blades.
ATTENTION
You can define tracking at both the physical (port) level and at the logical (link
aggregation) level.
8.6.1 Prerequisites
• A KAIROS CLI ses sion is open.
• You have enabled the NGW service unit for the KSC blade.
• You have added the NGW router.
• You have configured address pools.
• You have configured the IP address on the NGW IPV4 interface in the same subnet as
the VRRP gateway address.
• You have engineering documentation that provides the IP addresses and interface
numbers.
4. Repeat step 3 for each remaining VRRP instance required on the slot 7 KSC (NGW).
5. To provision VRRP tracking for the first VRRP instance configured on the slot 3 KSC
(NGW), enter
routing ngw-vrrp-tracking add 1 <vrrp-interface-number>
<vrrp-identifier> <interface-number> <group-identifier>
ATTENTION
The interface-number cannot be the same as the vrrp-interface-
number. That is, a VRRP instance cannot track itself.
6. Repeat step 5 for each remaining VRRP instance on the slot 3 KSC (NGW).
7. To provision VRRP tracking for the first VRRP instance configured on the slot 7 KSC
(NGW), enter
routing ngw-vrrp-tracking add 2 <vrrp-identifier> <interface-
number> <group-identifier>
8. Repeat step 7 for each remaining VRRP instance on the slot 7 KSC (NGW).
-End-
Variable Value
<advertisement-interval> Advertisement interval in msecs for sending advertisement
messages when in master state; range 200 to 255 000
Default is 1 000 for WAN interface-number. When
vrrp-interface-number is set to 601, the advertisement interval
must be 200.
<default-priority> The NGW router uses this field to select a master for this
VRRP route. Integer value: 1 to 255
<gateway-address> VRRP IP address. Configure this address as a gateway address
in the address mapping tables. (xxx.xxx.xxx.xxx).
<group-identifier> VRRP group identifier; integer value; range of 1 to 255
<interface-number> NGW WAN interface identifier (physical port or LAG logical port);
integer value; one of 601, 208, or 212
<mac-release-time> time before traffic is discarded on the interface when VRRP
goes out from the VRRP master state; range 0 to 10 000
Default is 0 for WAN interface number. When vrrp-interface-nu
mber is set to 601, the mac-release-time must be 5 000.
<mask-length> Subnet mask length must be the same as the subnet mask
specified in the associated address mapping tables; integer
value; range of 0 to 32.
<vrrp-identifier> virtual router identifier; integer value; range of 1 to 255. (You can
choose eight values.)
<vrrp-interface-number> virtual router interface number; range of 602 to 605
Kapsch CarrierCom AG
ATTENTION
The number of static routes configured on both NGWs cannot exceed 1000.
ATTENTION
You must provision NGW routes carefully to ensure that redundancy exists
between KAIROS and the external WAN.
8.7.1 Prerequisites
ATTENTION
Do not enter values for the optional <metric> and <no-install-flag> variables.
Changing these variables may adversely affect your system configuration.
ATTENTION
Do not enter values for the optional <metric> and <no-install-flag>
variables.
-End-
Variable
<address-prefix> IP network route address prefix for a specific route; must be a logical
pairing with the subnet mask to form a proper network address
(xxx.xxx.xxx.xxx)
<gateway-address> IP address of a single gateway used as
a next hop for the associated static route
(xxx.xxx.xxx.xxx)
<interface-address> IP interface address that will be used to reach the next hop address
(gateway address) (xxx.xxx.xxx.xxx)
<mask-length> subnet mask length; integer value; range of 0 to
Kapsch CarrierCom AG
32 (0 is default route)
<preference> Preference value selects the best route when multiple routes exist for
the same destination. Integer value, range of 1 to 255. The lowest
numbered route is chosen first. The router having the lower
preference value is considered the master router for this route.
<router-identifier> router instance identifier; integer value, range of
1 to 2
ATTENTION
Do not enter values for the optional <metric> and <no-install-flag> variables.
8.8.1 Prerequisites
• A KAIROS CLI session is open.
• Know the router identifier.
2. To confirm, enter
y
%Warning: All routing instances should have the icmpecho-
monitoring updated to the same value as this one. Do you want
to continue?
3. To confirm, enter
y
The system warning that all routing instances should have the same icmp-echo-
monitoring value may also appear.
Kapsch CarrierCom AG
5. To confirm, enter
y
-End-
Variable Value
<icmp-echo-monitoring> time interval value in msecs; range of 200 to 3000
<router-identifier> router instance identifier; integer value; range of 1 to 2
• selectively allowing secure packet flows to bypass the firewall (based on a security
association [SA] negotiated and installed through the remote key management protocol
[KMP] interface)
ATTENTION
Policies added from the CLI must have an identifier in the range of 1 to 9999.
Policies added from the remote KMP application interface must have an identifier
in the range of 10000 to 65535. Any policy can be displayed or deleted from the
CLI interface while only policies added using the remote KMP interface can be
deleted through the remote KMP interface.
CAUTION
You must choose a policy-identifier value that is not already in use.
Adding a policy with a duplicate policy-identifier will result in an error.
If a conflict exists with an existing policy, the new policy would partially or entirely overlap an existing
policy. Prepare to set the priority field appropriately in order to dictate the order in which the policies will
be considered by the Packet Filtering Firewall (PFF) application on the NGW. Failure to properly assign
policy priorities in such a scenario would result in unexpected networking behavior.
8.9.1 Prerequisites
• A KAIROS CLI session is open.
• You have unlocked the KSC blades.
• You have noted any policies that exist in the same source and/or destination subnet of the
policy to be added.
Kapsch CarrierCom AG
4. Repeat steps 1 through 3 for each additional security policy you require.
-End-
Variable Value
<policy-identifier> This field uniquely identifies the policy in the table. Policies that a CLI user
manually adds must have a policy-id between 1 and
9999. Policies that are added by application programs at runtime (for
example, using the PFKEY API) will be added sequentially from 10000.
<policy-priority> The PFF uses the priority field to determine in which order to apply
conflicting policies when treating inbound or outbound flows. (For
example, when you configure two or more policies with identical source
and/or destination addresses, the policy with the highest priority is always
applied. Similarly, when you configure two or more policies with different,
but overlapping source and/or destination addresses, the policy with the
highest priority is always applied.)
<policy-direction> The direction field specifies whether the policy should be applied to flows
originating from the LAN (KAIROS Network), or WAN (Customer
Network). IP flows originating from the KAIROS Network (LAN) are said to
be outbound flows. IP flows originating from
the Customer Network (WAN) are said to be inbound flows.
<policy- This field specifies the source IP address of the policy.
srcnetworkaddress> The IP address must be specified according to the address mask
selected. (For example, 192.168.0.0/16 is valid while
192.168.2.1/16 is not.) To match all IP addresses, you can specify the
value of 0.0.0.0 with a mask length of 0.
<policy-srcmasklen> The address mask length specifies the number of bits in the IP address
that form the network portion of the address. The remaining bits are
considered the host bits. (For example, a mask length of 16 is equivalent
to a network address mask of
255.255.0.0, and a mask length of 24 is equivalent to a network
address mask of 255.255.255.0.) When specifying a source or
destination IP address, the host portion of the address must always be
zeros. A mask length of 0 bits is a special case that must only be used
when specifying an IP address of 0.0.0.0 that matches any IP address.
Kapsch CarrierCom AG
<policy-srcportstart> This field specifies the start value of the source port range to match. The
start value must be less than or equal to port range end value. (For
example, ranges of 0 to 0, 0 to 65535, or 200 to
300 are all valid while 200 to 100 is not valid.)
<policy-srcportend> This field specifies the end value of the source port range to match. The
start value must be less than or equal to port range end value. (For
example, ranges of 0 to 0, 0 to 65535, or 200 to
300 are all valid while 200 to 100 is not valid.)
<policy- This field specifies the destination IP address of the policy. The IP
destnetworkaddress> address must be specified according to the address mask selected. (For
example, 192.168.0.0/16 is valid while
192.168.2.1/16 is not.) To match all IP addresses, the value of
0.0.0.0 can be specified with a mask length of 0.
<policy-destmasklen> The address mask length specifies the number of bits in the IP address
that form the network portion of the address. The remaining bits are
considered the host bits. (For example, a mask length of 16 is equivalent
to a network address mask of
255.255.0.0, and a mask length of 24 is equivalent to a network address
mask of 255.255.255.0.) When specifying a source or destination IP
address, the host portion of the address must always be zeros. A mask
length of 0 bits is a special case that must only be used when specifying
an IP address of 0.0.0.0, which matches any IP address.
<policy-destportstart> This field specifies the start value of the destination port range to match.
The start value must be less than or equal to port range end value. (For
example, ranges of 0 to 0, 0 to 65535, or 200 to
300 are all valid while 200 to 100 is not valid.)
<policy-destportend> This field specifies the end value of the destination port range to match.
The start value must be less than or equal to port range end value. (For
example, ranges of 0 to 0, 0 to 65535, or 200 to
300 are all valid while 200 to 100 is not valid.)
<policy-protocol> The protocol field is used to specify the IP protocol to match when
examining flows. (For example, UDP is protocol 17, TCP is protocol 6,
and ICMPv4 is protocol 1.)
<policy-action> The action field is used to specify the PFF behavior when handling IP
flows that match this policy. The following behaviors appear for each field
value:
bypass: The PFF application allows any matching IP flows to enter or
leave the KAIROS network without requiring any IPSec configuration.
These flows are said to be cleartext flows.
discard: The PFF application drops (or discards) any matching IP flows
silently. The sender does not receive any indication that the packet has
been dropped.
protect: The PFF application requires that any matching IP flows be
protected by a corresponding IPSec SA. As well as matching the source
and destination address information, the Security Parameter Index (SPI)
of each IPSec packet must also match the SPI of the matching SA. If any
parameters do not match, the packet is dropped silently.
8.9.4 Example procedure for range policy blocking all communications between two subnets on TCP
ports 1023/1024
Step Action
1. To determine if the new policy conflicts with any existing policies and resolve conflicts
Kapsch CarrierCom AG
4. Repeat steps 1 through 3 for each additional security policy you require.
-End-
8.9.5 Example procedure for policy that permits ICMP traffic on ports 0 to 2048 (that is, ping from WAN
to LAN), for an exact IP address WAN to LAN
Step Action
1. To determine if the new policy conflicts with any existing policies and resolve conflicts
before continuing, at the cli> prompt, enter
netsec ngw-policy show all brief
4. Repeat steps 1 through 3 for each additional security policy you require.
-End-
8.9.6 Example procedure for range policy, allow all ports, protocols and addresses within two subnets
LAN to WAN
Step Action
1. To determine if the new policy conflicts with any existing policies and resolve conflicts
before continuing, at the cli> prompt, enter
netsec ngw-policy show all brief
4. Repeat steps 1 through 3 for each additional security policy you require.
-End-
8.9.7 Example procedure for policy to block ICMP Ping requests for a range of addresses from WAN to
LAN
Step Action
1. To determine if the new policy conflicts with any existing policies and resolve conflicts
before continuing, at the cli> prompt, enter
netsec ngw-policy show all brief
4. Repeat steps 1 through 3 for each additional security policy you require.
-End-
8.9.8 Example procedure for policy to allow ICMP Ping requests for a range of addresses from WAN to
LAN
Step Action
1. To determine if the new policy conflicts with any existing policies and resolve conflicts
before continuing, at the cli> prompt, enter
netsec ngw-policy show all brief
4. Repeat steps 1 through 3 for each additional security policy you require.
-End-
8.9.9 Example procedure for policy to allow all traffic on the 192.168.0.0/16 WAN subnet and then further
restrict the 192.168.2.0/24 WAN subnet to use IPSec
Step Action
1. To determine if the new policy conflicts with any existing policies and resolve conflicts
before continuing, at the cli> prompt, enter
netsec ngw-policy show all brief
4. Repeat steps 1 through 3 for each additional security policy you require.
-End-
8.9.10 Example procedure for policy to temporarily block traffic to/from a specific host
Step Action
1. To determine if the new policy conflicts with any existing policies and resolve conflicts
before continuing, at the cli> prompt, enter
netsec ngw-policy show all brief
4. Repeat steps 1 through 3 for each additional security policy you require.
-End-
Policies are typically installed to allow traffic in or out of the KAIROS Network in support of an application
running on the KAIROS platform. Removing a policy that is in use by an application could result in call
processing failures and potentially prolonged outages. Consult application documentation or Kapsch
application engineering information to ensure that removing the policy would not cause an outage.
8.10.1 Prerequisites
• A KAIROS CLI session is open.
• Know the policy-identifier you are deleting.
CAUTION
You must never remove an existing policy without knowing its purpose in the
network. Accidentally removing a policy could cause unintended network impact.
Kapsch CarrierCom AG
ATTENTION
You must examine the existing policies to determine if removing the intended
policy would cause another overlapped (or overridden) policy to become active.
Removing a higher priority policy will enable a lower priority policy if one exists. A
scenario such as this could result in unexpected network behavior.
ATTENTION
You must know if the existing policy is a protect policy. Removal of the policy will
cause all related Security Associations to be removed. The scenario such as this
could result in unexpected network behavior.
3. Verify that the network behavior has been modified as expected. If incorrect network
behavior has been found then re-add thedeleted policies and re-evaluate the effect of
removing the target policies.
-End-
Variable Value
<policy-identifier> This field uniquely identifies the policy in the table. Policies that a CLI
user manually adds must have a policy-id between 1 and 9999. Policies
that are added by application programs at runtime (for example, using
the PFKEY API) will be added sequentially from 10000).
8.11.1 Prerequisites
• A KAIROS CLI session is open.
• You are familiar with the KAIROS fault management CLI commands under the CLI
sublevel fm.
If there is a fault record for this application type, then a previously added, modified, or
deleted filter configuration may have caused the failure condition.
2. To identify the filter chains/rules associated with the faulted filter policy configuration
and to list the chains based on the policy-name, enter
filter policy show <policy-name>
The chains used by this policy are identified by the inbound-chain-name and
outbound-chain-name fields.
3. To review the recently issued configuration commands against the faulted policy, enter
fm seclog show application-type-id 1085 detailed
4. Using the chain names identified in the policy show output, review the previously
issued configuration commands. Remove the suspected configuration from the system
to see if that will clear the fault condition.
5. Repeat step 1 to determine if the fault condition has been cleared. If the problem
persists, contact your next level of support as instructed by the fault record.
-End-
Variable Value
<policy-name> string of characters from 1 to 31 in length
ATTENTION
You can only add or delete policies with identifiers ranging from 1 to 10 000
through the CLI. You can only add or delete policies with identifiers ranging from
10 001 to 20 000 through the remote KMP interface. All policies are visible
through the CLI.
8.12.1 Prerequisites
• A KAIROS CLI session is open.
• You have unlocked the KSC blades.
Variable
<policy-action> action a policy takes; one of: protect, discard or bypass
<policy-destinationportend> named constants for well-known protocol ports; integer value; range of 0
to 65535 (example: exact match start =
1024, exact match end = 1024, range start = 1024, range end = 2048,
wildcard start = 0, wildcard end = 65535)
<policy-destmasklen> destination mask length; integer value; exact match value of 32; range
of 1 to 31 (wildcard is 00)
<policy-destnetworkaddress> destination IP address. Wildcard is 0.0.0.0 (xxx.xxx.xxx.xxx) (example:
Exact match = 10.24.1.1 masklen 32 Range match = 10.24.1.0 masklen
24
Wildcard = 0.0.0.0 masklen 0
<policy-destportstart> named constants for well-known protocol ports; integer value; range of 0
to 65535 (example: exact match start =
1024, exact match end = 1024, range start = 1024, range
end = 2048, wildcard start = 0, wildcard end = 65535)
<policy-direction> Defines where policy is applied; WAN side is inbound, LAN side
outbound; one of inbound or outbound.
<policy-identifier> policy identifier; integer value; range of 1 to 20 000
<policy-priority> Defines precedence of policy; one of lowest, low, medium, high, or
highest.
Kapsch CarrierCom AG
8.12.4 Example procedure for exact match allowing only WAN to LAN TCP for specific ports and
addresses
Step Action
1. To provision the first required security policy, at the cli> prompt, enter
netsec ngw-policy add 100 low inbound 10.1.1.1 32 102 4 1024
172.24.68.10 32 1023 1023 6 bypass
8.12.5 Example procedure for range policy blocking all communications between two subnets on TCP
ports 1023/1024
Step Action
1. To provision the first required security policy, at the cli> prompt, enter
netsec ngw-policy add 101 high outbound 172.24.68.0 2 4 1023
1023 10.1.1.0 24 1024 1024 6 discard
netsec ngw-policy add 102 high inbound 10.1.1.0 24 10 24 1024
172.24.68.0 24 1023 1023 6 discard
8.12.6 Example procedure for policy that permits ICMP traffic on ports 0 to 2048 (that is, ping from WAN
to LAN), for an exact IP address WAN to LAN
Step Action
1. To provision the first required security policy, at the cli> prompt, enter
netsec ngw-policy add 103 medium inbound 10.1.1.1 32 0 2048
172.24.68.10 32 0 0 1 bypass
Kapsch CarrierCom AG
8.12.7 Example procedure for range policy, allow all ports, protocols and addresses within two subnets
WAN to LAN
Step Action
1. To provision the first required security policy, at the cli> prompt, enter
netsec ngw-policy add 105 medium outbound 172.24.68.0 24 0
65535 10.1.1.0 24 0 65535 255 bypass
netsec ngw-policy add 106 medium inbound 10.1.1.0 24 0 65535
172.24.68.0 24 0 65535 255 bypass
8.12.8 Example procedure for policy to block ICMP Ping requests for a range of addresses from WAN to
LAN
Step Action
1. To provision the first required security policy, at the cli> prompt, enter
netsec ngw-policy add 107 high inbound 10.1.1.0 24 20 48 2048
172.24.68.0 24 0 0 1 discard
The Y entries in the job aid, Supported autonegotiation parameters for SFPs, following these procedure
steps, mark the supported autonegotiation parameters for SFPs inserted in each SFP host blade. If the
inserted SFP module type (N entry in the table) cannot support the provisioned autonegotiation
parameters for an Ethernet interface, the Ethernet interface cannot provide service and an alarm is
raised.
8.13.1 Prerequisites
• A KAIROS CLI session is open.
• You know the frame, shelf, slot, sub-slot numbers.
See the job aid, Example of the interfaces eth-physical show command, for an
example of the modified autonegotiation parameter in context.
-End-
Variable Value
<duplexity value> full, half
Multiple values are allowed with the hyphen as follows:
<duplexity1>-<duplexity2>
Example:
duplexity full-half
<frame> physical frame location, range 0 to 15
<if-number> associated interface number; range of 0 to 999
<parameter value> yes or no
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 16
<speed-configured value> 1000, 100, 10
Multiple values are allowed with the hyphen as follows: <speed1>-
<speed2>-<speed3> Example:
speed-configured 1000-100-10
<sub-slot> physical sub-slot number, range 0
the Ethernet interface is prevented from providing service and an alarm is raised.
Table 18 Supported autonegotiation parameters for each SFP type/SFP host blade
far-end-shelf-number = not-available
far-end-slot-number =0
far-end-sub-slot-number =0
far-end-if-number =0
autorelease = no
mtc-allowed = yes
global-if-number = 154
global-if-name = 0-0-9-0-ewan4
flow-control-capable = no
flow-control = no
lag-capable = yes
lag-type = static
ae-if-number = 602
mtu = 1500
hardware-mac-address = 00:e0:48:24:04:90
duplexity-supported = full-half
speed-supported = 10-100-1000
autonegotiation-supported = yes
duplexity-configured = full-half
speed-configured = 100-1000
autonegotiation-configured = yes
duplexity-status = full
speed-status = 100
autonegotiation-status = yes
sfp-type = 1000BASE-T
sfp-ordercode-or-pec = NTTP61CA
8.14.1 Prerequisites
• A KAIROS CLI session is open.
• Know the aggregate Ethernet (AE) WAN interface number of the AE interface you will
test.
• You have unlocked and enabled the slot 3 and 7 KSC blades.
1. To display state information for the physical WAN Ethernet interfaces, at the cli>
prompt, enter
interfaces eth show all brief where if-number >= 204 and if-
number <= 207
The system returns attribute information for Ethernet interfaces 204 through 207 on
the KSC blades.
2. Match your system’s LAG interfaces in the LAG interfaces.
If there is at least one physical port enabled belonging to each aggregate interface
(according to the appropriate option), then you can create an aggregate link with this
aggregate WAN interface.
ATTENTION
If each aggregate interface does not have at least one physical interface
member enabled, do not proceed with this procedure. An aggregate link
whose physical member interfaces are disabled will not run traffic.
-End-
Variable Value
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
8.15.1 Prerequisites
• A KAIROS CLI session is open.
• You have enabled the NGW service unit for the KSC blade.
• You have added related VRRP tracking entries.
• You have unlocked and enabled all tracking WAN interfaces.
Variable Value
<router-identifier> router instance identifier; integer value; range of 1 to 2
<vrrp-interface- virtual router interface number; integer value; range 601 to 605
number>
<vrrp-identifier> virtual router identifier; integer value; range of 1 to 255
This procedure validates connectivity and redundancy between a node on the WAN and a node on the
KAIROS LAN.
8.16.1 Prerequisites
• A KAIROS CLI session is open.
• There is already at least one address pool associated with VRRP.
• Know which of your IP address pools use VRRP as a gateway.
• Know the IP address of a node on the WAN.
• An application on the KAIROS LAN is in service and assigned an IP address.
• Have a duplex KSX configuration in your KAIROS.
Kapsch CarrierCom AG
The system returns IP addresses for all blades in the KAIROS node.
5. In your copy of “Table 20 IP address and address pool datafill” on page 97, write down
the IP address of the application blade you will use to test connectivity and
redundancy.
6. At the cli> prompt, enter
hardware app-blade show all detailed where slot = 1 or slot =
2 or slot = 9 or slot = 16
The system returns attribute information for all KSX and KSC blades in the KAIROS
system.
7. In your copy of “Table 21 KSX and NGW attributes” on page 97, write down the frame,
shelf, slot, and sub-slot values for each KSX and KSC blade.
8. Pinging the KAIROS application from the WAN node
ATTENTION
Perform the following steps while keeping the previous step’s ping
going. If the ping fails without recovering at any time, then the only
enabled (unlocked) blade you have running at the time has failed the
test.
If your ping fails at this point, perform the next step immediately and contact your next
level of support.
11. To unlock the KSX in slot 6, enter
hardware app-blade unlock <frame> <shelf> 6 <sub-slot>
If your ping fails at this point, perform the next step immediately and contact your next
level of support.
14. To unlock the KSX in slot 9, enter
hardware app-blade unlock <frame> <shelf> 9 <subslot>
If your ping fails at this point, perform the next step immediately and contact your next
level of support.
17. To unlock the NGW in slot 3, enter
hardware app-blade unlock <frame> <shelf> 3 <sub-slot>
18. Enter the following command until the NGW in slot 2 shows unlocked and enabled:
hardware app-blade show all
19. Testing each WAN-side router for continuity and redundancy
ATTENTION
Perform the following steps while keeping the previous step’s ping
going. If the ping fails at any time then the only enabled WAN-side
router you have running at the time has failed the test.
Variable Value
<frame> physical frame location, range 0 to 15
<shelf> physical shelf location, range 0 to 2
<sub-slot> physical sub-slot location, range 0 to 4
Slot 6 KSX
Slot 9 KSX
Slot 3 KSC
Slot 7 KSC
8.17.1 Prerequisites
• A KAIROS CLI session is open.
-End-
Variable Value
<router-identifier> router instance identifier; integer value, range of 1 to 2
See “Table 24 IP address and address pool datafill” on page 100 to change interface attributes of
aggregated links.
The KAIROS data fabric uses a maximum transmission unit (MTU) of 1500. If you define a value higher
than this for an Ethernet interface, KAIROS performance is affected.
Users can modify the <user-label> variable for each interface. Users cannot modify the MTU size on the
LAN side. This attribute is set to 1500. Users should not modify the 1500 default MTU size on the WAN
NGW ports.
You can only change one of <user-label> or <mtu> in each cli command.
8.18.1 Prerequisites
• A KAIROS CLI session is open.
• You have enabled the KSC blade.
• To change the MTU, the WAN Ethernet interface is locked.
CAUTION
Possible system performance impact
The KAIROS data fabric uses an mtu of 1500. If you define a value
higher or lower than this for an Ethernet interface, you can impact
KAIROS performance.
-End-
Variable Value
<frame> physical frame location, range 0 to 15
<if-number> associated interface number; integer value; range of 0 to 999
<mtu> maximum transmission unit (maximum packet size); integer value; range of
64 to 9216, default is 1500. The recommended MTU for NGW interfaces is
1500 and it should not be changed to a lower value.
<shelf> physical shelf location, range 0 to 2
Kapsch CarrierCom AG
8.19.1 Prerequisites
• A KAIROS CLI session is open.
• You have enabled the KSC blade.
• KSC blades are located in slots 3 and 7. NGW sub-slot is 0.
The system returns attribute values for the specified Ethernet interface.
-End-
Kapsch CarrierCom AG
Variable Value
<frame> physical frame location, range 0-15
Example command interfaces eth show all detailed where slot = 16 and operational-
state starts-with e and if-number >= 426
System response frame =0
shelf =0
slot = 16
sub-slot =0
if-number = 426
if-name = eth426
if-type = eth
fabric = data-switch
connectivity = intra-shelf
admin-state = unlocked
operational-state = enabled
offline =n
far-end-frame-number =0
far-end-shelf-number =1
far-end-slot-number =1
far-end-sub-slot-number =0
far-end-if-number =0
flow-control-capable =n
flow-control =n
speed-capable = 10-100-1000-10000
lag-capable =y
lag-type =0
ad-if-number = none
duplexity = none
autonegotiation =n
mtu = 9000
WARNING
Risk of traffic interruption
Perform this procedure in a maintenance window. Performing this
procedure will result in a traffic interruption.
Kapsch CarrierCom AG
CAUTION
Possible system performance impact
The KAIROS data fabric uses an mtu of 1500. If you define a value higher
or lower than this for an aggregated Ethernet interface, you can impact
KAIROS performance.
ATTENTION
Only perform this procedure if you have aggregated links.
ATTENTION
You can only change one of <user-label> or <mtu> in each cli command.
8.20.1 Prerequisites
• A KAIROS CLI session is open.
• You have enabled the KSC blade.
• To change the maximum transmission unit (mtu), you must lock the WAN aggregated
Ethernet interface and all associated Ethernet interfaces.
-End-
Variable Value
<frame> physical frame location, range 0 to 15
<if-number> associated interface number; integer value; range of 0 to 999
<mtu> maximum transmission unit (maximum packet size); integer value;
range of 64-9000, default is 1500
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 16
<sub-slot> physical sub-slot number, range of 0 to 4
<user-label> a name you can assign to an aggregated Ethernet interface; no
operational impact; a string of 1 to 64 characters in length
Kapsch CarrierCom AG
You can only change one of <user-label> or <mtu> in each CLI command.
8.21.1 Prerequisites
• A KAIROS CLI session is open.
• You have provisioned the KSC blade.
The system returns attribute values for the specified aggregate interfaces.
-End-
Kapsch CarrierCom AG
Variable Value
<frame> physical frame location, range 0 to 15
<if-number> interface number, range 0 to 999
<shelf> physical shelf location, range 0 to 2
<slot> physical slot location, range 1 to 16
<sub-slot> physical sub-slot number, range 0 to 4
8.22.1 Prerequisites
• A KAIROS CLI session is open.
• You have enabled the NGW service unit for the KSC blade.
Kapsch CarrierCom AG
Variable Value
<interface-address> IP address of the local IP interface route (xxx.xxx.xxx.xxx)
<interface-number> associated interface number; integer value; range of 602-605
<router-identifier> router instance identifier; integer value; range of 1 to 2
8.23.1 Prerequisites
• A KAIROS CLI session is open.
• You have enabled the NGW service units for the KSC blade.
The system returns routing table information for the specified route.
-End-
Variable Value
<address-prefix> IP network route address prefix for a specific route; must be a logical
pairing with the subnet mask to form a proper network address
(xxx.xxx.xxx.xxx)
<mask-length> mask length; integer value; range of 0 to 32
<preference> preference; integer value; range of 1 to 255
<router-identifier> router instance identifier; integer value; range of 1 to 2
Kapsch CarrierCom AG
Example command routing ngw-ipv4-route-table show all detailed where mask-length > 16
and mask-length <25
System response router-identifier =2
address-prefix = 10.106.6.0
mask-length = 24
preference =5
metric =0
nexthop-address = 10.106.6.3
ribs-active = unicast
protocol = static
8.24.1 Prerequisites
• A KAIROS CLI session is open.
• You have enabled the NGW service units for the KSC blade.
ATTENTION
Do not enter values for the optional <metric> and <no-install-flag>
variables.
-End-
Kapsch CarrierCom AG
Variable Value
<address-prefix> IP network route address prefix for a specific route; must be a logical
pairing with the subnet mask to form a proper network address
(xxx.xxx.xxx.xxx)
<gateway-address> IP address of a single gateway used as a next hop for the associated
static route (xxx.xxx.xxx.xxx)
ATTENTION
Do not enter values for the optional <metric> and <no-install-flag> variables.
8.25.1 Prerequisites
• A KAIROS CLI session is open.
• You have enabled the NGW service units for the KSC blade.
The system returns attribute values for the specified static routes.
-End-
Kapsch CarrierCom AG
Variable Value
<address-prefix> IP network route address prefix for a specific route; must be a logical
pairing with the subnet mask to form a proper network address
(xxx.xxx.xxx.xxx)
<mask-length> mask length; integer value; range of 0 to 32
8.26.1 Prerequisites
• A KAIROS CLI session is open.
• A policy with protect action exists.
OR
To show policy attributes for a specific security policy, enter
netsec ngw-policy show <policy-identifier>
-End-
Variable Value
<policy-identifier> This field uniquely identifies the policy in the table. Policies that are
manually added by a CLI user must have a policy-id between 1 and 9999.
Policies that are added by application programs at runtime (for example,
using the PFKEY API) will be added sequentially from 10000.
System response ID =3
Priority = medium
Direction = inbound
SrcNetAddr = 10.102.15.0
Mask = 24
PortStart = 25
PortEnd = 25
DstNetAddr = 10.102.16.0
Mask = 24
PortStart =0
PortEnd = 65535
Proto = 225
Action = bypass
8.27.1 Prerequisites
• A CLI session is open.
• You have enabled the NGW service unit for the KSC blade.
The system returns attribute information for the specified VRRP instance.
OR
To show attribute information for a specific VRRP instance by specifying the VRRP
interface, enter
routing ngw-vrrp-instance show <router-identifier> <vrrp-
interface-number>
The system returns attribute information for the specified VRRP instance.
OR
To show attribute information for a specific VRRP instance by specifying the VRRP
interface and identifier, enter
routing ngw-vrrp-instance show <router-identifier> <vrrp-
interface-number> <vrrp-identifier>
The system returns attribute information for the specified VRRP instance.
OR
To show attribute information for a specific VRRP instance by specifying the gateway
address, enter
routing ngw-vrrp-instance show <router-identifier> <gateway-
address>
The system returns attribute information for the specified VRRP instance.
-End-
Kapsch CarrierCom AG
Variable Value
<vrrp-interface-number> virtual router interface number; integer value; range 601 to 605
1 0 0 2 0
2 0 0 9 0
Table 35 VRRP instance show all example command and system output
Table 36 VRRP instance show specific example command and system output
Example command routing ngw-vrrp-instance show all detailed where state ends-with p
and router-identifier = 2
System response router-identifier =2
vrrp-interface-number = 601
vrrp-identifier =1
gateway-address = 10.106.6.1
mask-length = 28
default-priority = 230
advertisement-interval = 200
mac-release-time = 5000
state = vrrp-backup
current-priority = 230
Kapsch CarrierCom AG
8.28.1 Prerequisites
• A KAIROS CLI session is open.
• You have enabled the NGW service unit for the KSC blade.
• You have locked the VRRP instance.
-End-
Variable Value
<advertisement-interval> Advertisement interval for sending advertisement messages when
in master state; range 200 to 255 000
Default is 1000 for WAN interface-number. When
vrrp-interface-number is set to 601 the advertisement interval must
be 200.
<default-priority> The NGW router uses this field to select a master for this VRRP
route. For an internal VRRP LAN instance, the value is 230 or
254. For an external VRRP WAN instance, the range is 1 to 254.
<mac-release-time> time before traffic is discarded on the interface when VRRP goes
out from the VRRP master state; range 0 to 10 000
Default is 0 for WAN interface number. When vrrp-interface-num
ber is set to 601, the mac-release-time must be 5000.
<router-identifier> router instance identifier; integer value; range of 1 to 2
8.29.1 Prerequisites
• A KAIROS CLI session is open.
• You have enabled the NGW service unit is enabled for the KSC blade.
Variable Value
<interface-number> associated interface number; integer value; range of 0 to 65 535
<router-identifier> router instance identifier; integer value; range of 1 to 2
<vrrp-identifier> VRRP router identifier number; integer value; range of 1 to 255
<vrrp-interface-number> virtual router interface number; integer value; range 601-605
2 601 3 30 604
2 601 4 40 605
10 SSG configuration
This chapter contains SigTran Services Gateway (SSG) configuration-related descriptive material,
configuration task flow, and procedures.
ATTENTION
Once you have completed “Collecting and recording SSG data” (page 133), use
the tables of that procedure as datafill for the remaining procedures of the task
flow.
10.1.1 Navigation
• “Determining the need for an alternative external IP pool for SSG” on page 118
• “Configuring an alternative external IP pool for SSG” on page 118
• “Determining your SSG configuration” on page 120
• “Collecting and recording SSG data” on page 133
• “Multihoming SSGs” on page 150
• “Single-homing SSGs” on page 151
• “Configuring network appearances” on page 152
• “Configuring routesets” on page 153
• “Configuring a pathset between the set of SSGs and the MRF” on page 154
• “Configuring paths between the SSGs and MRF” on page 155
• “Configuring pathsets between the set of SSGs and the HLR blade pairs” on page 156
• “Configuring paths between the SSGs and the HLR blades” on page 156
• “Configuring pathsets between the MRF and the HLR blade pairs” on page 158
• “Configuring paths between the MRF and the HLR blade pairs” on page 158
• “Configuring adjacent node groups” on page 161
• “Configuring NA-based application servers” on page 162
• “Configuring RS-based application servers” on page 163
• “Configuring RSG-based application servers” on page 164
• “Configuring routesets for RSG-based application servers” on page 165
• “Configuring ASPs or IPSPs” on page 166
• “Configuring ASPAs” on page 169
• “Activating paths, ASPs, and routesets” on page 170
• “Configuring SSG for SIP” on page 171
Kapsch CarrierCom AG
10.2 Determining the need for an alternative external IP pool for SSG
Perform this procedure to determine the need for an alternative external IP pool for SSG.
10.2.1 Prerequisites
• You have a requirement for a particular range of external IP addresses for your SSGs.
• A KAIROS CLI session is open.
ATTENTION
A private IP pool provides increased security as private IP addresses
are not routable across the Internet without the use of network address
translation masquerading.
CAUTION
If you configure the datacallp pool using a public IP
address range, you are exposing your KAIROS system to
the Internet. This is not a secure or recommended
practice.
-End-
10.3.1 Prerequisites
• A KAIROS CLI session is open.
-End-
Variable Value
<gateway> IP address of a gateway (xxx.xxx.xxx.xxx)
10.4.1 Prerequisites
• A KAIROS CLI session is open.
-End-
Kapsch CarrierCom AG
Variable Value
<external-sip-port-number> external port number for the SIP connection, range 1024 to 65535.
<ip-sip-addr-id> unique index into the SIP IP assignment table, range 0 -10.
<sg-name> name of the service group on which the SIP application resides,
length 1-32 characters.
Questions Configuration #
1 2 3 4 5 6 7 8 9 10
Is your node con nected x x x x x x x x
to SGs?
Is your node con nected x
to IPSPs?
Is your node con nected x
to MGWs for SS7?
Is your node con nected x
to MGWs for H.248?
How many SG nodes do 1 1 1 1 2 2 2 2 0 0
you connect to?
How many IPSP nodes 0 0 0 0 0 0 0 0 >1 0
do you connect to?
How many NAs will your 1-4 1-4 1-4 1-4 1-4 1-4 1-4 1-4 1-4 1-4
KAIROS have?
Does your AS connect x x x x x x x x
to an SG (N A-based)?
Does your AS connect x
to an IPSP (RS-based)?
Does your AS connect x
to an MGW (RSG-base
d)?
Does one ASP on each x x x
blade service one AS?
Does one ASP on each x x x x
blade service all ASs?
Does one ASP on each x
blade service some
ASs?
Does one IPSP on each x
blade service one IPSP?
Kapsch CarrierCom AG
Do 1-16 x
ASPs on each blade
service one RSG-based
AS?
Are your ASP-As mul ti- x x x x x
homed?
Are your ASP-As sin x x x x x
gle-homed?
Are your two SGs a n/a n/a n/a n/a x x x n/a n/a
mated pair?
Do your two SGs serve n/a n/a n/a n/a x n/a n/a
different networks?
Questions Configuration #
1 2 3 4 5 6 7 8 9 10
Is your node con x x x x x x x x
nected to SGs?
Is your node con x
nected to
IPSPs?
Is your node con x
nected to
MGWs?
How many SG 1 1 1 1 2 2 2 2 0 0
nodes do you
connect to?
How many IPSP 0 0 0 0 0 0 0 0 >1 0
nodes do you
connect to?
How many NAs 1-4 1-4 1-4 1-4 1-4 1-4 1-4 1-4 1-4 1-4
will your
KAIROS have?
Does your AS x x x x x x x x
connect to an
SG (N A-
based)?
Does your AS x
connect to an
IPSP (RS-
based)
?
Does your AS x
connect to an
MGW (RSG-
base d)?
Does one ASP x x x
on each blade
service one AS?
Kapsch CarrierCom AG
You can mix the following configurations to provide the complete description of your system.
configuration
• two KPA (MRF) blades in shelf 0, slots 2 and 5
• KPA (HLR) blade topology consists of the following:
– two KPA (HLR) blades in shelf 0, slots 8 and 12 (1 mated pair) in HLR
Min/typical configuration
– two KPA (HLR) blades in shelf 0, slots 8 and 12 (1 mated pair) plus
four KPA (HLR) blades in shelf 0, slots 10, 11, 13, and 14 (2 mated
pairs) in HLR max configuration
• There are between 1 and 4 network appearances.
• All ASs are NA-based.
• Multiple ASPs on each blade exist (one for each AS)
• One ASP-A exists for each ASP.
• The number of paths and pathsets for HLR Min/typical configuration is
as follows:
– one SSG/MRF pathset
– one SSG/HLR pathset (one pathset for each KPA (HLR) blade pair)
– one MRF/HLR pathset
– two SSG/MRF paths (one path for each SSG/MRF combination)
– two SSG/HLR paths (one path for each SSG to each KPA (HLR) blade
pair)
– one MRF/HLR path (one path for each MRF to each KPA (HLR) blade
pair)
pair)
– one MRF/HLR path (one path for each MRF to each KPA (HLR) blade
pair)
blade pair)
– three MRF/HLR paths (one path for each MRF to each KPA (HLR)
blade pair)
• Two ANGs exist (one for each SG). Each AS uses the two ANGs.
6 • KAIROS node is connected to a mated SG pair.
• SSG topology consists of the following:
– two KXA (SSG) blades in shelf 0, slots 1 and 4 in HLR min/typical/max
configuration
• two KPA (MRF) blades in shelf 0, slots 2 and 5
• KPA (HLR) blade topology:
– two KPA (HLR) blades in shelf 0, slots 8 and 12 (1 mated pair) in HLR
min/typical configuration
– two KPA (HLR) blades in shelf 0, slots 8 and 12 (1 mated pair) plus
four KPA (HLR) blades in shelf 0, slots 10, 11, 13, and 14 (2 mated
pairs) in HLR max configuration
• There are between 1 and 4 network appearances.
• All ASs are NA-based.
• Two ASPs exist on each blade (one ASP on each SG).
• ASP associations are multi-homed.
• One ASP-A exists for each ASP.
• The number of paths and pathsets for HLR Minimum/typical
configuration consists of the following:
– one SSG/MRF pathset
– one SSG/HLR pathset (one pathset for each KPA (HLR) blade pair)
– one MRF/HLR pathset
– two SSG/MRF paths (one path for each SSG/MRF combination)
– two SSG/HLR paths (one path for each SSG to each KPA (HLR) blade
pair)
– one MRF/HLR path (one path for each MRF to each KPA (HLR) blade
pair)
• The number of paths and pathsets for HLR Maximum configuration is
as follows:
– one SSG/MRF pathset
– three SSG/HLR pathsets (one pathset for each KPA (HLR) blade pair)
– one MRF/HLR pathset
– two SSG/MRF paths (one path for each SSG/MRF combination)
– twelve SSG/HLR paths (one path for each SSG to each KPA (HLR)
blade pair)
– three MRF/HLR paths (one path for each MRF to each KPA (HLR)
blade pair)
• Two ANGs exist (one for each SG). Each AS uses the two ANGs.
7 • KAIROS node is connected to two SGs serving different networks.
• SSG topology consists of the following:
– two KXA (SSG) blades in shelf 0, slots 1 and 4 in HLR min/typical/max
configuration
• two KPA (MRF) blades in shelf 0, slots 2 and 5
• KPA (HLR) blade topology:
Kapsch CarrierCom AG
– two KPA (HLR) blades in shelf 0, slots 8 and 12 (1 mated pair) in HLR
min/typical configuration
– two KPA (HLR) blades in shelf 0, slots 8 and 12 (1 mated pair) plus
four KPA (HLR) blades in shelf 0, slots 10, 11, 13, and 14 (2 mated
pairs) in HLR max configuration
• There are between 1 and 4 network appearances.
• All ASs are NA-based.
• Two ASPs exist on each blade (one ASP on each SG).
• ASP associations are multi-homed.
• One ASP-A exists for each ASP.
• The number of paths and pathsets for HLR Minimum/typical
configuration consists of the following:
– one SSG/MRF pathset
– one SSG/HLR pathset (one pathset for each KPA (HLR) blade pair)
– one MRF/HLR pathset
– two SSG/MRF paths (one path for each SSG/MRF combination)
– two SSG/HLR paths (one path for each SSG to each KPA (HLR) blade
pair)
– one MRF/HLR path (one path for each MRF to each KPA (HLR) blade
pair)
all ASs.
• ASP associations are multi-homed.
• One ASP-A exists for each ASP.
• The number of paths and pathsets for HLR Minimum/typical
configuration consists of the following:
– one SSG/MRF pathset
– one SSG/HLR pathset (one pathset for each KPA (HLR) blade pair)
ATTENTION
If you connect to IPSPs, all the connected IPSPs must have
the same <netapp-id> as the logical node on this KAIROS
platform that connects to those IPSPs.
– twelve SSG/HLR paths (one path for each SSG to each KPA (HLR)
blade pair)
– three MRF/HLR paths (one path for each MRF to each KPA (HLR)
blade pair)
• ASP operational mode is server if SSG IPSPs accept Loadshare or
Override as a receiving traffic mode.
• ASP operational mode is client if SSG IPSPs send Loadshare in the
initial ASP-active message.
10 • KAIROS node is connected to MGW.
• SSG topology consists of the following:
– two KXA (SSG) blades in shelf 0, slots 1 and 4 in HLR min/typical/max
configuration
• two KPA (MRF) blades in shelf 0, slots 2 and 5
• KPA (HLR) blade topology:
– two KPA (HLR) blades in shelf 0, slots 8 and 12 (1 mated pair) in HLR
min/typical configuration
– two KPA (HLR) blades in shelf 0, slots 8 and 12 (1 mated pair) plus
four KPA (HLR) blades in shelf 0, slots 10, 11, 13, and 14 (2 mated
pairs) in HLR max configuration
– There are between 1 and 4 network appearances.
– RSG-based ASs exist (one AS for each MGW).
– One to 16 ASPs exist on each blade for each ANG.
– One ANG exists for each MGW.
ATTENTION
Client/Server labeling
When configuring SSG, the MSC is always client.
When configuring SSG, remember the following:
• If MRF is communicating with SSG, MRF is the client.
• If MRF is communicating with HLR, MRF is the server.
ATTENTION
The acronym, SG, in the context of AIM data, refers to service group. In the
context of SigTran, SG refers to signaling gateway.
10.6.1 Prerequisites
• A KAIROS CLI session is open.
ATTENTION
If you intend to connect to one or more IPSPs, ensure all the IPSPs
have the same network appearance identifiers <netapp-id> as the
logical node on this KAIROS platform that connects to those IPSPs.
14. Fill in the missing data in your working copy of “Table 56 Pathset datafill” on page 146.
The configuring rules for pathset are as follows:
• You must configure one pathset between each HLR blade pair (as client) and
the MRF (as server). The application type is appmgr-app.
• You must configure one pathset between the MRF (as client) and the set of
SSGs (as server). The application type is appmgr-sig.
• You must configure one pathset between each HLR blade pair (as client) and
the set of SSGs (as server). For each of these pathsets, the application type is
app-sig.
15. Path datafill table
Determine the number of paths you require in your KAIROS node.
ATTENTION
For the MSC, you must configure one path to each SSG.
ATTENTION
For each HLR blade pair, you must configure one path to each SSG.
For the MRF, you must configure:
• one path to each SSG
• one path to each HLR blade pair
16. Fill in the missing data in your working copy of “Table 57 Path datafill” on page 146.
The configuring rules for path are as follows:
• For each path between an SSG and MSC, define a path in the table by filling in
that MSC’s pathset-id in one row of the table.
17. Fill in the missing data in your working copy of “Table 58 Path datafill” on page 147.
The configuring rules for path are as follows:
• For each path between one HLR blade pair and any SSG, define a path in the
table by filling in that HLR blade pair’s pathset-id in one row of the table.
• For each path between an SSG and MRF, define a path in the table by filling in
that MRF’s pathset-id in one row of the table.
• For each path between an MRF and each HLR blade pair, define a path in the
table by filling in the pathset-id that corresponds to this MRF-to-HLR blade pair
in one row of the table.
Example
If there are three HLR blade pairs and two SSGs, you must fill in two rows of the table
with the pathset-id of HLR1, two rows of the table with the pathset-id of HLR2, and two
rows of the table with the pathset-id of HLR3.
19. In your working copy of “Table 58 Path datafill” on page 147, for each path using the
pathset-id of a given HLR blade pair, fill in the SG name of one of the SSGs in the
Server SG Name column. Do this until you have exhausted every SSG/HLR blade pair
combination.
Use “Table 45 Hardware AIM data” on page 141 to reference AIM data.
Example
Kapsch CarrierCom AG
If there are two SSGs and two HLR blade pairs, fill in the SG name of each of the
SSGs in the rows of the table using the pathset-id of HLR1. Then fill in the SG names
of these same SSGs in the rows of the table using the pathset-id of HLR2.
21. In your working copy of “Table 58 Path datafill” on page 147, for each row of the table
with the pathset-id of a given HLR blade pair, fill in
• the SU number of the corresponding SSG in the Server SU Number column
• the SG name of the HLR blade pair in the Client SG Name column
• the SU number of the HLR blade pair in the Client SU Number column
22. In your working copy of “Table 57 Path datafill” on page 146, for each row of the table
with the pathset-id of the MSC, fill in
You need a minimum of one ANG for each adjacent SG, IPSP, or MGW.
ATTENTION
You can configure the <protocol-type> attribute with a value of h248
only if your <member-type> attribute is set to IPSP.
26. AS workup
Determine which and how many of your application servers (AS’s) are routeset-based,
network appearance-based, or routeset group-based using the following criteria:
• You will have one AS for each NA in your KAIROS.
• An AS should be NA-based if the RS has a route to each SG connected to the
KAIROS.
• An AS should be RS-based if the RS has a direct route to the destination.
• An AS must be RS-based for each H.248 ANG.
Kapsch CarrierCom AG
ATTENTION
Use this section for all NA-based ASs.
ATTENTION
If your KAIROS platform is connected to two SG nodes in a mated-pair
configuration, fill in an an-group-id-1 and an-group-id-2 corresponding
to the two mated-pair, adjacent SGs. See “Table 42 SSG configuration
mapping” on page 123.
ATTENTION
If your KAIROS platform is connected to two SG nodes in a mated-pair
configuration, fill in an an-group-id-1 and an-group-id-2 corresponding
to the two mated-pair, adjacent SGs. See “Table 43 SSG configuration
mapping” on page 126.
ATTENTION
If the ANG corresponding to <an-group-id-1> has a protocol type of
H.248, you cannot configure an <an-group-id-2>.
You cannot configure an <an-group-id-2> if the corresponding ANG
has a protocol type of H.248.
ATTENTION
Use this section for all RS-based ASs.
33. In the routeset-id column, fill in each of the routeset-id’s. You can find these routeset-
id’s in your working copy of “Table 54 Routeset datafill” on page 145.
34. Fill in the following in “Table 61 RS-based AS datafill” on page 148:
• a new as-name for each AS
• an an-group-id-1 corresponding to the adjacent IPSP
• the traffic mode for each AS
• traffic mode for H.248 has to be loadshare
ATTENTION
Use this section for all RSG-based ASs.
SSG2
SSG3
SSG4
SSG5
SSG6
MSC1
MSC2
Kapsch CarrierCom AG
SSG2
SSG3
SSG4
MRF1
MRF2
HLR1
HLR2
HLR3
HLR4
HLR5
HLR6
HLR7
Internal IP
address SG name of SU # of this Internal IP of
identifier this SSG SSG this SSG
CLI variable <ip-int-addr-id> <sgname> <sunumber> <internal-
ipaddress>
Example answer 0 SSG 0 10.103.13.154
SSG1
SSG2
SSG3
Kapsch CarrierCom AG
m3ua
intern Second Secondar
alIP SG na SU # Primary Primary ary y
addres me of of external external external external
sidenti this this pool IP pool IP
fier SSG SSG name address name address
CLI variable <ip-m3 <sg- <su- <primary- <primary- <second <seconda
ua-add- name numbe m3 ua- m3 ua-ip- ary- ry- m3ua-
id> > r pool- address> m3ua- ip-add
> name> pool-n ress>
ame>
Example 0 SSG 0 SsgExter datacallp SsgExter 10.103.13
answer nal nal .1
IP IP 55
SSG1
SSG2
SSG3
sip
internal Seco
IP SG Primary Primary ndary Second Extern Local
address nam e SU # external external extern ary ext al sip root Local
identifie of this of this poolnam IP al pool ernal IP port nu domain domain
r SSG SSG e address name address mber name name
CLI <ipsipad <sgna <sunu <primar y- <primar <secon <secondar <externa <local- <local-
varia dr-id> me> m ber> sip-pool- y-sip- dary-sip- y-sip-ip- l-sip- root- fqdn>
ble name> ipaddress pool- address> port- fqdn>
> name> number>
SSG 1
SSG 2
SSG 3
Kapsch CarrierCom AG
Example answer 0
SSG1
SSG2
SSG3
Remote
domain Remote Remote root
name domain Far end IP Far end port domain name
index name address number index
CLI <remote-fq <remote- <far-end-ip- <far-end-port-num <remote-root-
variable dn-index> fqd n> address> ber> fqdn- index>
SSG1
SSG2
SSG3
Remote
External do main
connection SG name SU # of name SCTP Operationa l
identifier of SSG SSG identifier identifier mode
CLI <connection <sg- <su- <remote- <sctp- <operationa l-
variable -index> name> number> fqd n- parm- mode>
index> index>
Example 0 SSG 0 20 0 client
answer
SSG1
SSG2
SSG3
Kapsch CarrierCom AG
Table 52 NA datafill
Alphan
umeric
CLLI as
sociated Protocol NA’s
netap with this standar NA’s point NA’s local network Service
p-id NA d for NA code variant point code indicator value
CLI var <neta <netapp <protoco <pointcode- <pointcode> <network <service-
iable pp-id> -clli> l- variant> - indicator > value>
standard
>
Exa 11 SG4_TT itu14 itu14-383 xxx-xxx-xxx national MSC
mple
answer
NA1 MSC
NA2 MSC
NA3 MSC
NA4 MSC
Table 53 NA datafill
Alphanum
eric CLLI NA’s
associate d Protocol NA’s point local NA’s
netap with this standard code varia point network Service
p-id NA for NA nt code indicator value
CLI vari <neta <netapp <protocol- <pointcode <pointcod <network- <service-
able pp-id> -clli> standard> - variant> e indicator> value>
>
NA1 HLR
NA2 HLR
NA3 HLR
NA4 HLR
Kapsch CarrierCom AG
RS1
RS2
RS3
RS4
...
Alphanumeric name
associated with this Type of application
pathset-id pathset end-point for this pathset
CLI variable <pathset-id> <pathset-name> <application-type>
Pathset1
Pathset2
Pathset3
Pathset4
Kapsch CarrierCom AG
Pathset1
Pathset2
Pathset3
Pathset4
Pathset5
Pathset6
Pathset7
Pathset8
Server Client SU
SG name Server SU # Client SG # of Port #
of this of service na me of service of
pathset server grou Port # of client group of client
-id of side p for server serv er side client’s side
path-i this of this side side of of this side of of this
d path path of this path this path path this path path
CLI <path- <pathset <server- <server <server- <client- <client-su <client-
variable id> -id> sg-name -su-num ber> port> sg-name> -number> port>
>
Example 2 1 SSG 0 2905 MSU 0 4698
answer
Path1
Path2
Path3
Path4
Path5
Path6
Path7
Path8
Path9
Path10
Path11
Kapsch CarrierCom AG
Path12
ANG1
ANG2
ANG3
ANG4
Kapsch CarrierCom AG
an-group-id-1
Alphanumer netapp-id of first ANG an-group-id-2 of
ic name of of NA of used by this second ANG
as-id this AS this AS AS used by this AS
CLI variable <as-id> <as-name> <netapp-id> <an-group-id- <an-group-id-2>
1>
Example 1 AS1 11 0 1
answer
AS1
AS2
AS3
AS4
Alpha-
numeric routeset-id of Type of
name asso RS traffic mode an-group-id-1 of
ciated with associated used on the first ANG used
as-id this AS with this AS ASPs by this AS
CLI varia <as-id> <as-name> <routeset-id> <traffic- <an-group-id-1>
ble mode>
Example 4 AS5 101 loadshare 2
answer
AS5
AS6
AS7
AS8
sg-
name of
service su-num What
an-gr group ber of is
Alpha- oup-id of to service Does opera
numeric ANG to which unit to this ASP tional
name whi ch this which this support Type mode
asp- of this this ASP ASP ASP routing of AS of this
id ASP belongs belongs belongs keys? P ASP?
CLI varia <asp-i <asp-na <an-gro <sg- <su- <rtg-keys- <asp-t <operat
ble d> me> up-id> name> number> supported ype> i onal-
- option> mo de>
Example 281 ASP3 1 SSG 1 false asp client
answer
ASP1
ASP2
ASP3
ASP4
ASP5
ASP6
ASP7
ASP8
ASP9
ASP10
ID reference
Far-end port # into the
asp-id of Primary far-end IP of # of this SCTP PARM
association-id the ASP this association association table
CLI variable <association-i <asp-id> <far-end-ip-address> <far-end- <sctp-parm
d> port> -index>
Example 281 15 10.102.13.202 2905 0
answer
ASP-A1
ASP-A2
ASP-A3
ASP-A4
ASP-A5
ASP-A6
Kapsch CarrierCom AG
ASP-A7
ASP-A8
ASP-A9
ASP-A10
ATTENTION
The internal IP address must come from the datacallp pool.
ATTENTION
Kapsch recommends that the far-end network element use the same SCTP
settings.
10.7.1 Prerequisites
• A KAIROS CLI session is open.
• For each SSG you multihome, the associated sg-name and su-number must be in the
OFFLINE su-admin-state.
-End-
Variable Value
<ip-m3ua-addr-id> unique index into the m3ua IP assignment table
<primary-m3ua-ip-address> primary m3ua IP address used for external service unit
communication, of the form (xxx.xxx.xxx.xxx)
<primary-m3ua-pool-name> alphanumeric name associated with the primary external IP
address pool
<secondary-m3ua-ip-address> secondary m3ua IP address used for external service unit
communication, of the form (xxx.xxx.xxx.xxx)
Kapsch CarrierCom AG
ATTENTION
The internal IP address must come from the datacallp pool.
ATTENTION
Kapsch recommends that the far-end network element use the same stream
control transmission protocol (SCTP) settings.
10.8.1 Prerequisites
• A KAIROS CLI session is open.
• For each SSG you single-home, the associated sg-name and su-number must be in the
offline su-admin-state.
-End-
Variable Value
<ip-m3ua-addr-id> unique index into the m3ua IP assignment table
<primary-m3ua-ip-address> primary m3ua IP address used for external service unit
communication, of the form (xxx.xxx.xxx.xxx)
<primary-m3ua-pool-name> alphanumeric name associated with the primary external IP
address pool
<sg-name> name of the service group on which the m3ua application
resides
Kapsch CarrierCom AG
<su-number> integer value of the service unit on which the m3ua application
resides
ATTENTION
If you connect to IP Signaling Points (IPSP), all the connected IPSPs must have
the same <netapp-id> as the logical node on this KAIROS platform that connects
to those IPSPs.
10.9.1 Prerequisites
• A KAIROS CLI session is open.
• You have the filled-in copy of “Table 52 NA datafill” on page 144.
• You have the filled-in copy of “Table 53 NA datafill” on page 144 .
• The MSC Call Agent is in service.
• The MRF Call Agent is in service.
2. Provision your first network appearance using data from the NA1 row of Table 53 NA
datafill (page 144). At the cli> prompt, enter
ssg network-appearance add <netapp-id> <netapp-clli>
<protocol-standard> <pointcode-variant> <pointcode> <network-
indicator>
3. Perform the previous step for each remaining network appearance using data from the
NA2, NA3, and NA4 rows.
-End-
Variable Value
<netapp-clli> alphanumeric CLLI associated with the network appearance; a string of 1
to 15 characters; must begin with an uppercase alphabetic letter; can
contain numbers and underscores
<netapp-id> unique index into the network-appearance table; range of 0 to 30
Kapsch CarrierCom AG
10.10.1 Prerequisites
• A KAIROS CLI session is open.
• A network appearance must exist before you configure an associated routeset.
• You have the filled-in copy of “Table 54 Routeset datafill” on page 145.
• The MSC Call Agent is in service.
• The MRF Call Agent is in service.
3. Perform step 2 for each remaining routeset not requiring an as-id using “Table 54
Routeset datafill” on page 145.
-End-
Variable Value
<as-id> unique index into the application server table for the routeset group;
range of 0 to 255
<destination-pointcode> destination pointcode of the routeset; a string of 1 to 11 characters
<netapp-id> network appearance for the routeset from the network-appearance
table; range of 0 to 30
<routeset-id> unique index into the routeset table; range of 0 to 3999
Kapsch CarrierCom AG
10.11 Configuring a pathset between the set of SSGs and the MRF
Perform this procedure to configure a pathset (PS) between the set of SSGs and the MRF.
PSs define logical groupings of internal connectivity paths between the SSGs and the KPA (MRF/HLR)
blades. Three types of PS exist:
• a PS between an KPA (HLR) blade pair as client and the set of SSG server blades
• a PS between the KPA (MRF) blade as client and the set of SSGs
• a PS between an KPA (HLR) blade pair as client and the MRF server blade
10.11.1 Prerequisites
• A CLI session is open.
• You have the filled-in copy of “Table 56 Pathset datafill” on page 146.
• The MRF Call Agent is in-service.
2. Repeat step 1 for each remaining pathset in “Table 56 Pathset datafill” on page 146
that has an application type of appmgr-sig.
CAUTION
Do not perform this procedure for any pathsets with an
application type of app-sig.
-End-
Variable Value
<pathset-id> unique index into the pathset table; range of 0 to 31127
<pathset-name> alphanumeric name associated with the pathset; a string of characters
from 1 to 15 in length; must begin with an uppercase alphabetic letter;
can contain numbers and underscores
Kapsch CarrierCom AG
Paths are internal connections between the KPA (MRF/HLR) blades and the SSGs. They are non-
standard connections using the m3ua protocol.
10.12.1 Prerequisites
• A CLI session is open.
• A pathset must already be configured.
• You have the filled-in copy of “Table 58 Path datafill” on page 147.
• The MRF is in-service.
3. Perform the previous step for each remaining path identified in step 1.
-End-
<server-su-number> service unit number of the service group for the server side of
the path; range of 0 to 7
10.13 Configuring pathsets between the set of SSGs and the HLR blade pairs
Perform this procedure to configure pathsets (PS) between the set of SSGs and each KPA (HLR) blade
pair.
PSs define logical groupings of internal connectivity paths between the SSGs and the KPA (MRF/HLR)
blades. Three types of PS exist:
• a PS between an KPA (HLR) blade pair as client and the set of all SSG server blades
• a PS between the KPA (MRF) blade as client and the set of SSGs
• a PS between an KPA (HLR) blade pair as client and the MRF server blade
10.13.1 Prerequisites
• A CLI session is open.
• You have the filled-in copy of “Table 59 ANG datafill” on page 147.
• The MRF is in-service.
3. Repeat step 2 for each remaining pathset from “Table 56 Pathset datafill” on page 146
with an application type of app-sig.
-End-
Variable Value
<pathset-id> unique index into the pathset table; range of 0 to 31127
<pathset-name> alphanumeric name associated with the pathset;a string of characters from
1 to 15 in length; The pathset name must begin with the HLR SG name
exactly as defined in Call Agent configuring.
The pathset name must begin with an uppercase alphabetic letter.
The pathset name can contain numbers and underscores.
10.14 Configuring paths between the SSGs and the HLR blades
Perform this procedure to configure all required paths between the SSGs and KPA (HLR) blades.
Kapsch CarrierCom AG
Paths are internal connections between the KPA (MRF/HLR) blades and the SSGs. They are non-
standard connections using the m3ua protocol.
10.14.1 Prerequisites
• A CLI session is open.
• A pathset must already be configured.
• You have the filled-in copy of Table 58 "Path datafill" (page 221).
• The MRF is in-service.
3. Perform the previous step for each remaining path identified in step 1.
-End-
Variable Value
<client-port> port for the client side of the path; integer value. The range is dependent
on the node you are connecting to. See “On-product help” content for
additional information.
<client-sg-name> service group name for the client side of the path; a string of characters
from 1 to 255 in length
<client-su-number> service unit number of the service group for the client side of the path;
range of 0 to 13
<path-id> first part of a unique index into the path table;
range of 0 to 11
<pathset-id> second part of a unique index into the path table that is a reference to an
entry in the pathset table; range of 0 to 31127
<server-sg-name> service group name for the server side of the path; a string of characters
from 1 to 255 in length
<server-port> port for the server side of the path. The range is dependent on the node
you are connecting to. See "On-product help" content for additional
information.
<server-su-number> service unit number of the service group for the server side of the path;
range of 0 to 7
Kapsch CarrierCom AG
10.15 Configuring pathsets between the MRF and the HLR blade pairs
Perform this procedure to configure all required pathsets (PS) between the MRF and each HLR blade
pair.
PSs define logical groupings of internal connectivity paths between the SSGs and the KPA (MRF/HLR)
blades. Three types of PS exist:
• a PS between an KPA (HLR) blade pair as client and the set of all SSG server blades
• a PS between the KPA (MRF) blade as client and the set of SSGs
• a PS between an KPA (HLR) blade pair as client and the MRF server blade
10.15.1 Prerequisites
• A CLI session is open.
• You have the filled-in copy of Table 56 "Pathset datafill" (page 219).
• The MRF and all the HLR blade pairs are in-service.
3. Repeat step 2 for each remaining pathset from “Table 56 Pathset datafill” on page 146
with an application type of appmgr-app.
-End-
Variable Value
<pathset-id> unique index into the pathset table; range of 0 to 31127
10.16 Configuring paths between the MRF and the HLR blade pairs
Perform this procedure to configure all required paths between the MRF and each of the HLR blade pairs.
10.16.1 Prerequisites
• A CLI session is open.
• A pathset must already be configured.
• You have the filled-in copy of Table 58 "Path datafill" (page 221).
• The MRF and each of the HLR blade pairs are in-service.
3. Perform the previous step for each remaining path identified in step 1.
-End-
Variable Value
<client-port> port for the client side of the path. The range is dependent on the
node you are connecting to. See "On-product help" content for
additional information.
<client-sg-name> service group name for the client side of the path; a string of
characters from 1 to 255 in length
<path-id> first part of a unique index into the path table;
range of 0 to 11
<pathset-id> second part of a unique index into the path table that is a reference
to an entry in the pathset table; range of 0 to 31127
<server-sg-name> service group name for the server side of the path; a string of
characters from 1 to 255 in length
<server-port> port for the server side of the path. The range is dependent on the
node you are connecting to. See “On-product help” content for
additional information.
10.17.1 Prerequisites
• A KAIROS CLI session is open.
-End-
Variable Value
<map-type> {PATHSET_MAP}
<pathset-group-id> unique index into the pathset-group table; range of 0 to 63
<pathset-group-name> maximum of 15 characters
ATTENTION
Do not configure pathsets on the same CA node twice in the same group.
10.18.1 Prerequisites
• A KAIROS CLI session is open.
-End-
Kapsch CarrierCom AG
Variable Value
<group-map-index> unique index into the group-map table; range of 0 to 31
<pathset-group-id> unique index into the pathset-group table; range of 0 to 63
<pathset-id> range of 0 to 127
ANGs are groupings of application server processes (ASPs) or IP signaling points (IPSPs) that simplify
and ensure full external connectivity to remote destinations. There should be either one group for each
external signaling gateway (SG) supporting all application servers (ASs) or one group for each external
SG-AS combination. Each group must have exactly one ASP or IPSP on each blade to provide full
connectivity to each destination.
ATTENTION
You must have exactly one ANG for each media gateway (MGW).
ATTENTION
You can configure a maximum of 256 adjacent node groups.
ATTENTION
In cases where there is an IPSP link, ensure the far end has the same network
appearance identifier <netapp-id> as your network appearance.
ATTENTION
You must have either
• one adjacent node group for each external SG supporting all application
servers
OR
• one group for each external SG-AS combination
ATTENTION
You must have exactly one adjacent node group for each external IPSP-based
destination.
10.20 Prerequisites
• A KAIROS CLI session is open.
• You have the filled-in copy of “Table 59 ANG datafill” on page 147.
• The MSC Call Agent is in service.
• The MRF Call Agent is in service.
Kapsch CarrierCom AG
Perform the previous step for each remaining ANG in “Table 59 ANG datafill” on page
147.
-End-
Variable Value
<an-group-id> unique index into the adjacent-node-group table; range of 0 to 255
<member-type> type of ASPs that belong to this adjacent node group; for protocol type
= ss7, value is asp or ipsp; for protocol type = h248, value
is ipsp
<protocol-type> messaging protocol to be used for this adjacent node group; one of:
ss7, h248
Each network appearance (NA) must correspond to a configured application server (AS). An AS is
required for each routeset accessible through a point-to-point IP signaling point (IPSP) connection.
ATTENTION
You can configure a maximum of 256 application servers.
10.21.1 Prerequisites
• A KAIROS CLI session is open.
• The NA and ANG must be configured.
• You have the filled-in copy of “Table 60 NA-based AS datafill” on page 148.
• The MSC Call Agent is in service.
Kapsch CarrierCom AG
2. Perform the previous step for each remaining NA-based AS using data from the AS2,
AS3, and AS4 rows of “Table 60 NA-based AS datafill” on page 148.
-End-
Variable Value
<an-group-id-1> ID reference to an entry in the adjacent-node-group table for the first
adjacent-node-group to be used by this application server; range of 0 to 255
Each network appearance (NA) must correspond to a configured application server (AS). An AS is
required for each routeset accessible through a point-to-point IP signaling point (IPSP) connection.
ATTENTION
You can configure a maximum of 256 application servers.
Kapsch CarrierCom AG
10.22.1 Prerequisites
• A KAIROS CLI session is open.
• The NA, RS, and ANG must be configured.
• You have the filled-in copy of “Table 61 RS-based AS datafill” on page 148.
• The MSC Call Agent is in service.
• The MRF Call Agent is in service.
2. Perform the previous step for each remaining RS-based AS using data from the AS2,
AS3, and AS4 rows of “Table 61 RS-based AS datafill” on page 148.
-End-
Variable Value
<an-group-id-1> ID reference to an entry in the adjacent-node-group table for the first adjacent-
node-group to be used by this application server; range of 0 to 255
Each network appearance (NA) must correspond to a configured application server (AS). An AS is
required for each routeset accessible through a point-to-point IP signaling point (IPSP) connection.
ATTENTION
You can configure a maximum of 256 application servers.
10.23.1 Prerequisites
• A KAIROS CLI session is open.
• The NA and ANG must be configured.
• You have the filled-in copy of “Table 62 RSG-based AS datafill” on page 148.
• The MSC Call Agent is in service.
• The MRF Call Agent is in service.
2. Perform the previous step for each remaining RSG-based AS using data from the
AS2, AS3, and AS4 rows of “Table 62 RSG-based AS datafill” on page 148.
-End-
Variable Value
<an-group-id-1> ID reference to an entry in the adjacent-node-group table for the first
adjacent-node-group to be used by this application server; range of
0 to 255
<as-id> unique index into the application-server table; range of 0 to 255
<as-name> alphanumeric name associated with the application-server; a string of
characters from 1 to 15 in length; must begin with an uppercase
alphabetic letter; can contain numbers and underscores
<netapp-id> ID reference to an entry in the network-appearance table; range of
0 to 30
10.24.1 Prerequisites
• A KAIROS CLI session is open.
• A network appearance must exist before you configure an associated routeset.
Kapsch CarrierCom AG
3. Perform step 2 for each remaining routeset for an RSG-based AS using data from
“Table 54 Routeset datafill” on page 145.
-End-
Variable Value
<as-id> unique index into the application server table for the routeset group;
range of 0 to 255
<destination-pointcode> destination pointcode of the routeset; a string of characters from 1 to
11 in length
<netapp-id> network appearance for the routeset from the network-appearance
table; range of 0 to 30
<routeset-clli> alphanumeric CLLI associated with the routeset;
a string of characters from 1 to 15 in length; must begin with an
uppercase alphabetic letter; can contain numbers and underscores
An SSG uses application servers (ASs), which are indirectly associated with an ASP or IPSP through an
adjacent node group (ANG). These ASPs or IPSPs are, in turn, associated with an ASP/IPSP stream
control transmission protocol (SCTP) assignment to connect to the external network. ASPs may be
associated with a single AS or multiple ASs.
Kapsch CarrierCom AG
ATTENTION
An AS is associated with one or two ANGs. An ASP/IPSP is associated with an
ANG. Therefore, if you have an AS with one ANG and an ASP with the same ANG,
then all routesets corresponding to that AS (either by NA, RS, or RSG) are served
by the ASP in that ANG.
ATTENTION
You can only have a maximum of 1024 application server processes (ASP) or IP
signaling points (IPSPs).
ATTENTION
You can only have a maximum of 16 ASPs on each SSG for each adjacent node
group (ANG).
ATTENTION
You can only have a maximum of 64 ASPs on each SSG.
ATTENTION
You can only have a maximum of 64 combined external-connections and ASP
connections on each SSG.
ATTENTION
You can only have a maximum of two IPSP for each H.248 adjacent node group
(ANG)
ATTENTION
Always configure the operational mode of an ASP as client. The operational mode
of ASP defaults to client. The operational mode of an IPSP can be either client or
server.
10.25.1 Prerequisites
• A KAIROS CLI session is open.
• The ANG is configured.
• You have the filled-in copy of Table 63 "ASP datafill" (page 223).
• The MSC Call Agent is in service.
• The MRF Call Agent is in service.
See “Job aid: example of advertised receive buffer rate equation” on page 169.
2. In “Table 63 ASP datafill” on page 149, identify the ASPs (rows) whose <asp-type> is
asp.
3. Using data from the first ASP typed as asp in step 1, configure the first ASP. At the
cli> prompt, enter
ssg application-server-process add <asp-id> <asp-name> <an-
group-id> <sg-name> <su-number> <rtg-keys-supported-option>
asp
4. Perform the previous step for each remaining ASP typed as asp, as identified in step
1.
5. In “Table 63 ASP datafill” on page 149, identify the ASPs (rows) whose <asp-type> is
ipsp.
6. Using data from the first ASP typed as ipsp in step 4, configure the first ASP. At the
cli> prompt, enter
ssg application-server-process add <asp-id> <asp-name> <an-
group-id> <sg-name> <su-number> <rtg-keys-supported-option>
ipsp <operational-mode>
7. Perform the previous step for each remaining ASP typed as ipsp, as identified in step
4.
-End-
Variable Value
<an-group-id> an-group-id from the adjacent-node-group table of which this application
server process is a member; range of 0 to 255
Using the equation for SSG-1, which was not experiencing the problem, you can see that the 14 Kbyte
buffer was large enough to accommodate the 5-msec rtt on that link:
Example
Using the equation for SSG-2 with a 60 msec rtt, the calculation is:
WindRiverS (WRS) recommends a value of at least twice that, at 150 KB (in other words, take the highest
value between SSG-1 and SSG-2 and multiply by 2.)
10.26.1 Prerequisites
• A KAIROS CLI session is open.
• The ASP must be configured.
• You have the filled-in copy of “Table 64 ASP-A datafill” on page 149.
• The MSC Call Agent is in service.
• The MRF Call Agent is in service.
Perform the previous step for each remaining ASPA in “Table 64 ASP-A datafill” on
page 149.
-End-
Variable Value
<asp-id> ID reference into the application-server-process table; range of 0 to
1023
<association-id> unique index into the asp-association table; range of 0 to 1023
<far-end-ip-address> far-end primary IP address of this association (xxx.xxx.xxx.xxx)
Kapsch CarrierCom AG
10.27.1 Prerequisites
• A KAIROS CLI session is open.
• The MSC Call Agent is in service.
• The MRF is in service
• All paths to the MSCCA are deactivated.
• All paths to the MRF and HLR are deactivated.
• All ASPs are deactivated.
• All RSs are deactivated.
• You have the filled in copies of
– “Table 57 Path datafill” on page 146
– “Table 58 Path datafill” on page 147
– “Table 54 Routeset datafill” on page 145
• The advertised receiver window of SCTP layer of STP that SSG is communicating with is
set proportionate to bit rate and RTT latency of the network.
5. Repeat the previous step for each path you identified as having a client SG name of
MSCCA.
Kapsch CarrierCom AG
6. Repeat the previous step for each path you identified as having a client SG name of
MRF.
8. In “Table 58 Path datafill” on page 147 identify the paths with HLR as a client SG
name.
10. To activate the first path with a client SG name of HLR, enter
ssg path activate <path-id> <pathset-id>
12. Repeat the previous step for each path you identified as having a client SG name of
HLR.
13. Activate the first ASP in “Table 63 ASP datafill” on page 149.
ssg application-server-process activate <asp-id>
16. Repeat the previous step for each remaining non-H.248 routeset.
-End-
Variable Value
<asp-id> unique index into the application-server-process table; range of 0 to 1023
<path-id> first part of a unique index into the path table; range of 0 to 11
<pathset-id> second part of a unique index into the path table that is a reference to an
entry in the pathset table; range of 0 to 127
10.28.1 Navigation
• Adding a remote root fqdn
• Adding a remote fqdn
• “Adding an external SIP address” on page 119
• Adding an external connection
• Activating an external connection
Kapsch CarrierCom AG
SSGs can be assigned to one internal IP address and up to two external IP addresses. This assignment
enables a multihomed stream control transmission protocol (SCTP) association.
11.1.1 Prerequisites
• A KAIROS CLI session is open.
Variable Value
<ip-address-id> unique index into the ip-address-assignment table; range of 0 to 31
<ip-int-address-id> unique index into the ip-int-address-assignment table; range of 0 to 31
11.2.1 Prerequisites
• A KAIROS CLI session is open.
Kapsch CarrierCom AG
• Know the IP address Id you are modifying; see “Showing an IP internal address
assignment” on page 174.
OR
To modify attributes for a secondary-m3ua IP address assignment, enter
ssg ip-m3ua-addr-assignment modify <ip-address-id> secondary-
m3ua <secondary-m3ua pool-name> <secondary-m3ua_ip_address>
OR
To modify attributes for a secondary-ip address assignment, enter
ssg ip-m3ua-addr-assignment modify <ip-address-id> secondary-
ip <default>
-End-
Variable description
<delete> include the <> when using this deletes the secondary IP, which allows you to change
command from multi-homing to single home
<ip-address-id> unique index into the ip-address-assignment table;
range of 0 to 31
<secondary-ip-address> secondary external IP address
(xxx.xxx.xxx.xxx)
<secondary-pool-name> alphanumeric name associated with the secondary
external IP address pool; a string of
1 to 255 characters
11.3.1 Prerequisites
• A KAIROS CLI session is open.
• Know the IP address id you are modifying; see “Showing an IP internal address
assignment” on page 174.
-End-
Variable description
<delete> include the <> when deletes the secondary IP, which allows you to change
using this command from multihoming to single home
<ip-address-id> unique index into the ip-address-assignment table; range
of 0 to 31
<secondary-ip-address> secondary external IP address (xxx.xxx.xxx.xxx)
11.4.1 Prerequisites
• A KAIROS CLI session is open.
Variable Value
<netapp-id> unique index into the network-appearance table; range of 0 to 30
Kapsch CarrierCom AG
ATTENTION
Kapsch recommends that the far-end network element use the same STCP
settings.
11.5.1 Prerequisites
• A KAIROS CLI session is open.
The system returns attribute information for the specified SCTP parameter.
-End-
Variable Value
<sctp-parameter-id> unique index into the sctp-parameters table; range of 0 to 15
Kapsch CarrierCom AG
11.6.1 Prerequisites
• A KAIROS CLI session is open.
Kapsch CarrierCom AG
Variable Value
<routeset-id> unique index into the routeset-pathset-map table, which is a
reference to an entry in the routeset table; range of 0 to 3999
11.7.1 Prerequisites
• A KAIROS CLI session is open.
-End-
Variable Value
<pathset-group-id> pathset-group-id index in the pathset-group table that this
routeset is associated with; range of 0 to 63
<routeset-id> unique index into the routeset-pathset-map table, which is a
reference to an entry in the routeset table; range of 0 to 3999
11.8.1 Prerequisites
• A KAIROS CLI session is open.
• Know the routeset pathset map you are deleting.
-End-
Variable Value
<routeset-id> unique index into the routeset table; range of 0 to 3999
11.9.1 Prerequisites
• A KAIROS CLI session is open.
1. To show attributes for all pathset groups, at the cli> prompt, enter
ssg pathset-group show all [<output-form>]
Variable Value
<pathset-group-id> unique index into the pathset-group table; range of 0 to 63
11.10.1 Perquisites
• You know the pathset group id you are deleting.
• You have deleted the pathset map group.
• A KAIROS CLI session is open.
Kapsch CarrierCom AG
-End-
Variable description
<pathset-group-id> unique index into the pathset-group table; range of 0 to 63
11.11.1 Prerequisites
• A KAIROS CLI session is open.
Variable Value
<path-id> first part of a unique index into the path table; range of 0 to 11
<pathset-id> second part of a unique index into the path table that is a reference to
an entry in the pathset table; range of 0 to 127
Kapsch CarrierCom AG
11.12.1 Prerequisites
• You have deactivated the path.
• A KAIROS CLI session is open.
OR
To modify a path’s server-port attribute, enter
ssg path modify <path-id> <pathset-id> server-port <server-
port>
-End-
Kapsch CarrierCom AG
Variable Value
<client-port> port for the client side of the path; the range is dependent on the
node you are connecting to.
<path-id> first part of a unique index into the path table; range of 0 to 11
<pathset-id> second part of a unique index into the path table that is a reference
to an entry in the pathset table; range of 0 to 127
<server-port> port for the server side of the path; the range is dependent on the
node you are connecting to. For more information, see your on-
product help.
11.13.1 Prerequisites
• A KAIROS CLI session is open.
• The path must be deactivated.
-End-
Variable Value
<path-id> first part of a unique index into the path table; range of 0 to 11
<pathset-id> second part of a unique index into the path table that is a reference to
an entry in the pathset table; range of 0 to 127
Paths are internal connections between the MSCCA and the SSGs. They are non-standard connections
Kapsch CarrierCom AG
Paths are internal connections between the KPA (MRF/HLR) blades and the SSGs. They are non-
standard connections using the m3ua protocol.
WARNING
Risk of service loss
If you deactivate the last active path in a pathset, you will lose service.
If you deactivate the path between the MSC Call Agent and an SSG, this
SSG will no longer provide service. A warning message appears in this
situation.
11.14.1 Prerequisites
• A KAIROS CLI session is open.
• The path must be activated.
2. If a warning message appears and you expect to deactivate the last active path in the
pathset, enter
y
-End-
Variable Value
<path-id> first part of a unique index into the path table; range of 0 to 11
<pathset-id> second part of a unique index into the path table that is a reference to an
entry in the pathset table; range of 0 to 127
11.15.1 Prerequisites
• A KAIROS CLI session is open.
1. To show attribute information for all routeset IDs, at the cli> prompt, enter
ssg routeset show all [<output-form>]
The system returns attribute information for the specified routeset ID.
-End-
Variable Value
<routeset-id> unique index into the routeset table; integer value, range of 0 to 3999
11.16.1 Prerequisites
• A KAIROS CLI session is open.
ATTENTION
To rename a routeset, you must first deactivate the routeset. Once the routeset is
deactivated, the renaming capability will be available.
OR
To modify a routeset’s name, enter
ssg routeset modify <routeset_id> routeset-clli
<routeset_name>
OR
To modify a routeset’s signaling gateway accessibility status, enter
ssg routeset modify <routeset-id> sg-accessible-option <sg-
accessible-option>
-End-
Variable Value
<as-id> unique index into the application server table for the
routeset group; range of 0 to 255
<routeset-id> unique index into the routeset table; range of 0 to 3999
<routeset_name> the routeset name
<sg-accessible-option> Is this routeset accessible from a signaling gateway?
boolean: true/false yes/no
11.17.1 Prerequisites
• A CLI session is open.
• The routeset must be deactivated.
-End-
Variable Description
<routeset-id> unique index into the routeset table; integer value; range
of 0 to 3999
WARNING
Loss of service
You can lose service to the destination you are deactivating.
11.18.1 Prerequisites
• A KAIROS CLI session is open.
• The routeset must be activated.
-End-
Kapsch CarrierCom AG
Variable Value
<routeset-id> unique index into the routeset table; range of 0 to 3999
ANGs are groupings of application server processes (ASPs) or IP signaling points (IPSPs) that simplify
and ensure full external connectivity to remote destinations. There should be either one group for each
external signaling gateway (SG) supporting all application servers (ASs) or one group for each external
SG-AS combination. Each group must have exactly one ASP or IPSP on each blade to provide full
connectivity to each destination.
11.19.1 Prerequisites
• A KAIROS CLI session is open.
The system returns attribute values for all adjacent node groups.
OR
To show attribute information for a specific adjacent node group, enter
ssg adjacent-node-group show <an-group-id> [<output-form>]
The system returns attribute values for the specified adjacent node group.
-End-
Variable Value
<an-group-id> unique index into the adjacent-node-group table; range of 0 to 255
Kapsch CarrierCom AG
ANGs are groupings of application server processes (ASPs) or IP signaling points (IPSPs) that simplify
and ensure full external connectivity to remote destinations. You should have either one group for each
external signaling gateway (SG) supporting all application servers (ASs) or one group for each external
SG-AS combination. Each group must have exactly one ASP or IPSP on each blade to provide full
connectivity to each destination.
The modifiable attribute for an adjacent node group is the adjacent node group name.
11.20.1 Prerequisites
• A KAIROS CLI session is open.
-End-
Variable Value
<an-group-id> unique index into the adjacent-node-group table;
range of 0 to 255
<an-group-name> alphanumeric name of the group of ASPs connected to the adjacent
node; a string of characters from 1 to 15 in length; must begin with
an uppercase alphabetic letter; can contain numbers and
underscores.
Each network appearance (NA) must correspond to a configured application server (AS). An AS is
required for each routeset accessible through a point-to-point IP signaling point (IPSP) connection.
11.21.1 Prerequisites
• A KAIROS CLI session is open.
The system returns attribute values for the specified application server.
-End-
Variable Value
<as-id> unique index into the application-server table; range of 0 to 255
Each network appearance (NA) must correspond to a configured application server (AS). An AS is
required for each routeset accessible through a point-to-point IP signaling point (IPSP) connection.
For modification of attributes of an AS whose ANGs are (or will be) of protocol type H.248, the following
conditions apply:
• To modify the <an-group-id-1> to a different ANG with a protocol type of H.248, the AS must
be routeset-based.
• If the <an-group-id-1> is of protocol type H.248, there can be no <an-group-id-2>.
• The protocol type of <an-group-id-2> cannot be modified to H.248.
• To modify the <an-group-id-1> to a different ANG with a protocol type of H.248, the ANG’s
traffic mode first must be set to loadshare.
• You can only have one AS for each ANG if the ANG has a protocol type of H.248.
WARNING
Risk of service outage
Modifying ANG1 or ANG2 could cause a service outage or service
interruption. This type of modification is usually only done in cutovers.
11.22.1 Prerequisites
• A KAIROS CLI session is open.
OR
To modify an application server’s adjacent node group ID 2 value, enter
ssg application-server modify <as-id> an-group-id-2 <an-
group-id-2>
ATTENTION
Modification of the second adjacent-node-group table is valid only for
network-appearance-based application servers.
OR
To modify an application server’s alphanumeric name, enter
ssg application-server modify <as-id> as-name <asname>
-End-
Variable Value
<an-group-id-1> ID reference to an entry in the adjacent-node-group
table for the first adjacent-node-group to be used by this application
server; range of 0 to 255
An SSG uses application servers (ASs) associated with an ASP or IP signaling point (IPSP). These ASPs
or IPSPs are, in turn, associated with an ASP/IPSP stream control transmission protocol (SCTP)
Kapsch CarrierCom AG
assignment to connect to the external network. ASPs may be associated with a single AS or multiple ASs.
11.23.1 Prerequisites
• A KAIROS CLI session is open.
The system returns attribute values for all application server processes.
OR
To show attribute information for a specific application server process, enter
ssg application-server-process show <asp-id> [<output-form>]
The system returns attribute values for the specified application server process.
-End-
Variable Value
<asp-id> unique index into the application-server-process table;
range of 0 to 1023
11.24.1 Prerequisites
• The application server process to be modified is deactivated.
• A KAIROS CLI session is open.
OR
To modify the ASP’s routing key support status, enter
ssg application-server-process modify <asp-id> rtg-keys-
supported-option <rtg-keys-supported-option>
-End-
Kapsch CarrierCom AG
Variable Value
<asp-id> unique index into the application-server-process table;
range of 0 to 1023
An SSG uses application servers (ASs) associated with an ASP or IP signaling point (IPSP). These ASPs
or IPSPs are, in turn, associated with an ASP/IPSP stream control transmission protocol (SCTP)
assignment to connect to the external network. ASPs may be associated with a single AS or multiple ASs.
11.25.1 Prerequisites
• A KAIROS CLI session is open.
• The ASP must be deactivated.
2. A warning message appears if only one ASP is configured for an H.248 ANG. If this is
the expected configuration, enter
y
-End-
Variable Value
<asp-id> unique index into the application-server-process table; range of
0 to 1023
of an ASP.
An SSG uses application servers (ASs) associated with an ASP or IP signaling point (IPSP). These ASPs
or IPSPs are, in turn, associated with an ASP/IPSP stream control transmission protocol (SCTP)
assignment to connect to the external network. ASPs may be associated with a single AS or multiple ASs.
WARNING
Risk of service loss
If you deactivate the last in-service ASP on a specific SSG, that SSG
will no longer provide service. A warning message appears in this
situation.
11.26.1 Prerequisites
• A KAIROS CLI session is open.
• The ASP must be activated.
-End-
Variable Value
<asp-id> unique index into the application-server-process table;
range of 0 to 1023
For each application server process (ASP) or IP signaling point (IPSP), define one ASP-A.
11.27.1 Prerequisites
• A KAIROS CLI session is open.
Kapsch CarrierCom AG
Variable Value
<association-id> unique index into the asp-association table; range of 0 to 1023
11.28.1 Prerequisites
• A KAIROS CLI session is open.
• The ASP must be deactivated.
OR
To modify an ASP association’s far-end port, enter
ssg asp-association modify <association-id> far-endport <far-
end-port>
OR
To modify the sctp-parm-id for an ASP association, enter
ssg asp-association modify <association-id> sctp-parm-index
<sctp-parm-index>
-End-
Variable Value
<association-id> unique index into the asp-association table; range of 0 to 1023
11.29.1 Prerequisites
• A KAIROS CLI session is open.
Variable Value
<connection-index> integer value that uniquely identifies the external connection
11.30.1 Prerequisites
• A KAIROS CLI session is open.
-End-
Variable Value
<connection-index> integer value that uniquely identifies the external
connection
11.31.1 Prerequisites
• A KAIROS CLI session is open.
• An external connection is defined.
WARNING
Risk of service loss
If you deactivate the external connection on a specific SSG, that SSG
will no longer provide service. A warning message appears in this
situation.
-End-
Variable Value
<connection-index> integer value that uniquely identifies the external
connection
11.32.1 Prerequisites
• A KAIROS CLI session is open.
• The associated trunk and SOS must be in the in-service busy (INB) state.
Variable Value
<connection-index> integer value that uniquely identifies the external
connection
Kapsch CarrierCom AG
KAIROS Call Agent consists of a software framework to run the Switch Operating System (SOS), hiding
the underlying hardware platform from DMS product line software. The MRF Call Agent runs its existing
Call Server software on KAIROS hardware with essentially no changes to its call processing software or
traditional MAP and CI interfaces.
• At the blade level, OAM of the Call Agent blades is provided through the KAIROS
Command Line Interface (CLI) consistent with all the blade types for KAIROS. Here you can
monitor the blade health as well as a high-level view of the application health. To access the
CLI environment you must log on to the KAIROS System Controller.
• At the application level, OAM continues to be provided through the traditional SOS MAP and
CI commands. Here you can monitor detailed application health. To access MAP or CI you
must log on to the KAIROS System Controller and from there log on to SOS.
Kapsch CarrierCom AG
• Message Routing Function (MRF), with two blades provisioned in a 1:1 (active/standby)
redundancy model
• Home Location Registry (HLR), with multiple pairs of two blades provisioned in a 1:1
(active/standby) redundancy model
The KAIROS uses the SigTran Services Gateway (SSG) application layer to provide an RFC standard
M3UA/SCTP interface for the KAIROS platform. SSGs perform a routing function for messages outbound
to the network and a distribution function for messages from the network to the appropriate MSC, HLR,
and MRF Call Agent blades.
SSG supports ISUP, TUP, BICC, and SCCP for KAIROS-based products.
SSG supports ISUP, TUP, BICC, SCCP, H.248, SIPI/SCTP, and SIPI/UDP for KAIROS-based products.
Up to three instances of SSG can be provisioned on a KXA processor blade, as required by the product.
For example, in an MSC solution, two MSCs and two SSGs are provisioned. The SSGs use the n + n (all
units active and load sharing) redundancy model. This means that all SSGs are active and normally share
the traffic, but in the event of a failure, the remaining blades are sufficient to carry all traffic.
12.2.1 Prerequisites
• There is an HLR SOS image already on your KAIROS System Controller in the
/opt/Kapsch/ca/data/NODATA directory.
• You have root access to a Linux secure shell (SSH) on the KAIROS System Controller
through your network connection (that is, you can drop into a root prompt).
• The KAIROS platform is fully configured, including KSX and KSC blades.
12.2.3 Navigation
• “Installing and provisioning KPA (MRF) blades” on page 209
• “Provisioning the datacallp subnet” on page 216
• “Provisioning MRF service group, service units, and application” on page 217
Kapsch CarrierCom AG
• “Creating a softlink pointer to the default SOS image on KAIROS System Controller” on
page 221
• “Loading, unlocking, and activating the MRF service units” on page 222
• “Showing Call Agent information” on page 226
Aside from configuration procedures the only modifiable variable for the MRF is the e164 global title an
SCCP protocol address used for routing signaling messages on the public switched telephone network
(PSTN).
12.2.5 Navigation
• “Determining the HLR configuration of your ” on page 211
• “Installing and provisioning HLR blades in a Minimum/Typical configuration” on page 212
• “Installing and provisioning HLR blades in a Maximum configuration” on page 214
• “Provisioning the HLR-1 pair” on page 218
• “Provisioning the HLR-2 and HLR-3 pairs” on page 219
• “Loading, unlocking, and activating the HLR service units for a Minimum/Typical
configuration” on page 222
• “Loading, unlocking, and activating the HLR service units for a Maximum configuration” on
page 223
Aside from configuration procedures the only modifiable variable for the HLR blade is the e164 global title
an SCCP protocol address used for routing signaling messages on the public switched telephone network
(PSTN).
CAUTION
Bent pins or loose components can cause damage to the blade, the
backplane, or other system components. Carefully inspect your blade and
the backplane for both pin and component integrity before installation.
WARNING
Observe electrostatic discharge (ESD) precautions when handling a
blade.
12.3.1 Prerequisites
• A CLI session is open.
• You are wearing grounded ESD bands.
• You have two KPA blades.
• Slots 2 and 5 of KAIROS shelf 0 are currently empty.
• KSX and KSC blades are already installed and commissioned.
CAUTION
Risk of pin breakage
Step Action
1. Align the edges of a KPA blade with the card-cage rail guides in shelf 0, slot 2.
2. Apply equal and steady pressure with your thumbs to carefully slide the blade into the
card-cage rail guides.
3. Compress the ejector levers and apply pressure to insert the blade. Continue to
gently push until the blade connectors engage with the backplane connector.
4. Press the ejector levers down.
Wait while the HS LED turns solid blue (self-testing mode), then flashes
(communicating with Shelf Manager), then goes out completely (self-test passes).
When the blue LED turns off the blade is active.
Kapsch CarrierCom AG
ATTENTION
If the blade is not latched properly the blue LED will not change from
solid. In this case the blade must be pulled and re-seated.
If the blade fails, the blue LED will go solid again. If this is the case,
pull the blade and try again. If this does not work, you must replace the
blade.
The system returns the administrative and operational state of the KPA (MRF) blade
in shelf 0, slot 2.
ATTENTION
If the administrative state of the shelf 0, slot 2 KPA (MRF) blade is still
locked, call your next level of support.
The system returns the administrative and operational state of the KPA (MRF) blade
in shelf 0, slot 5.
ATTENTION
If the administrative state of the shelf 0, slot 5 KPA (MRF) blade is still
locked, call your next level of support.
-End-
Variable Value
<frame> physical frame location, range 0-15
CAUTION
Bent pins or loose components can cause damage to the blade, the
backplane, or other system components. Carefully inspect your blade
and the backplane for both pin and component integrity before
installation.
WARNING
Observe electrostatic discharge (ESD) precautions when handling a
blade.
12.5.1 Prerequisites
• A CLI session is open.
• You are wearing grounded ESD bands.
• You have two KPA (HLR) blades.
• Shelf 0 slots 8 and 12 are currently empty.
• KSX and KSC blades are already installed and commissioned.
• Two KPA (MRF) blades are already installed and provisioned in shelf 0, slots 2 and 5.
CAUTION
Risk of pin breakage
Step Action
1. Align the edges of a KPA blade with the card-cage rail guides in shelf 0, slot 8.
2. Apply equal and steady pressure with your thumbs to carefully slide the blade into the
card-cage rail guides.
3. Compress the ejector levers and apply pressure to insert the blade. Continue to
gently push until the blade connectors engage with the backplane connector.
4. Press the ejector levers down.
Wait for the blue LED to illuminate solid. This indicates that the blade is in
communication with the shelf manager. When the blue LED turns off again the blade
is active.
5. Tighten screws at either end of the card.
6. Perform steps 1 through 5 for another KPA blade in shelf 0, slot 12.
7. Unlocking the KPA (HLR) blades
Unlock the KPA (HLR) blade in shelf 0, slot 8.
hardware app-blade unlock <frame> 0 8 0
The system returns the administrative and operational state of the KPA (HLR) blade
in shelf 0, slot 8.
ATTENTION
If the administrative state of the shelf 0, slot 8 KPA (HLR) blade is still
locked, call your next level of support.
The system returns the administrative and operational state of the KPA (HLR) blade
in shelf 0, slot 12.
ATTENTION
If the administrative state of the shelf 0, slot 12 KPA (HLR) blade is still
locked, call your next level of support.
-End-
Variable Value
<frame> physical frame location, range 0-15
Kapsch CarrierCom AG
CAUTION
Bent pins or loose components can cause damage to the blade,
the backplane, or other system components. Carefully inspect
your blade and the backplane for both pin and component
integrity before installation.
WARNING
Observe electrostatic discharge (ESD) precautions when handling a
blade.
12.6.1 Prerequisites
• A CLI session is open.
• You are wearing grounded ESD bands.
• You have six KPA blades.
• Slots 8 and 12 of KAIROS shelf 0 are currently empty.
• Slots 10, 11, 13, and 14 of KAIROS shelf 0 are currently empty.
• KSX and KSC blades are already installed and commissioned.
• Two KPA (MRF) blades are already installed and provisioned in shelf 0, slots 2 and 5
CAUTION
Risk of pin breakage
Step Action
1. Installing KPA blades for HLR pair 1
Align the edges of a KPA blade with the card-cage rail guides in shelf 0, slot 8.
2. Apply equal and steady pressure with your thumbs to carefully slide the blade into the
card-cage rail guides.
3. Compress the ejector levers and apply pressure to insert the blade. Continue to
gently push until the blade connectors engage with the backplane connector.
4. Press the ejector levers down.
Kapsch CarrierCom AG
Wait for the blue LED to illuminate solid. This indicates that the blade is in
communication with the shelf manager. When the blue LED turns off again the blade
is active.
5. Tighten screws at either end of the card.
6. Perform steps 1 through 5 for another KPA blade in shelf 0, slot 12.
7. Installing KPA blades for HLR pair 2
Perform steps 1 through 5 for another KPA blade in shelf 0, slot 10.
8. Perform steps 1 through 5 for another KPA blade in shelf 0, slot 13.
9. Installing KPA blades for HLR pair 3
Perform steps 1 through 5 for another KPA blade in shelf 0, slot 11.
10. Perform steps 1 through 5 for another KPA blade in shelf 0, slot 14.
11. Unlocking the KPA (HLR) blades
Unlock the KPA (HLR) blade in shelf 0, slot 8.
hardware app-blade unlock <frame> 0 8 0
The system returns the administrative and operational state of the KPA (HLR) blade
in shelf 0, slot 8.
ATTENTION
If the administrative state of the shelf 0, slot 8 KPA (HLR) blade is still
locked, call your next level of support.
18. Verify the KPA (HLR) blade installation in shelf 0, slot 12.
hardware app-blade show <frame> 0 12
The system returns the administrative and operational state of the KPA (HLR) blade
in shelf 0, slot 12.
ATTENTION
If the administrative state of the shelf 0, slot 12 KPA (HLR) blade is still
locked, call your next level of support.
19. Verify the KPA (HLR) blade installation in shelf 0, slot 10.
hardware app-blade show <frame> 0 10
The system returns the administrative and operational state of the KPA (HLR) blade
in shelf 0, slot 10.
ATTENTION
If the administrative state of the shelf 0, slot 10 KPA (HLR) blade is still
locked, call your next level of support.
Kapsch CarrierCom AG
20. Verify the KPA (HLR) blade installation in shelf 0, slot 13.
hardware app-blade show <frame> 0 13
The system returns the administrative and operational state of the KPA (HLR) blade
in shelf 0, slot 13.
ATTENTION
If the administrative state of the shelf 0, slot 13 KPA (HLR) blade is still
locked, call your next level of support.
21. Verify the KPA (HLR) blade installation in shelf 0, slot 11.
hardware app-blade show <frame> 0 11
The system returns the administrative and operational state of the KPA (HLR) blade
in shelf 0, slot 11.
ATTENTION
If the administrative state of the shelf 0, slot 11 KPA (HLR) blade is still
locked, call your next level of support.
22. Verify the KPA (HLR) blade installation in shelf 0, slot 14.
hardware app-blade show <frame> 0 14
The system returns the administrative and operational state of the KPA (HLR) blade
in shelf 0, slot 14.
ATTENTION
If the administrative state of the shelf 0, slot 14 KPA (HLR) blade is still
locked, call your next level of support.
-End-
12.7.1 Prerequisites
• A CLI session is open.
• A secure shell (SSH) Linux session on the KSC blade is open.
• You have the system engineering document.
-End-
• create an MRF service group for the KPA (MRF) blade pair in shelf 0, slots 6 and 13
• create an MRF application for the KPA (MRF) blade pair in shelf 0, slots 6 and 13
• create two MRF service units (one for each KPA (MRF) blade)
12.8.1 Prerequisites
• A CLI session is open.
• You know the mated pair HLR requirements for cluster node ID.
• You match mated pair (geographic) to
• You know what the schemas are (site-specific).
ATTENTION
Use the <sg-name> provisioned in the previous step for the <sg-
name> in this step.
3. Provision an MRF service unit for the KPA (MRF) blade in shelf 0, slot 6.
ATTENTION
Use the <sg-name> provisioned in step 1 for the <sg-name> in this
step.
4. Provision an MRF service unit for the KPA (MRF) blade in shelf 0, slot 13.
ATTENTION
Use the <sg-name> provisioned in step 1 for the <sg-name> in this
step.
-End-
Kapsch CarrierCom AG
Variable Value
<sg-name> alphanumeric name associated with the MRF service group; a
string of characters from 1 to 31 in length
12.9.1 Prerequisites
• A CLI session is open.
ATTENTION
Use the <sg-name> provisioned in the previous step for the <sg-
name> in this step.
3. Provision an HLR service unit for the KPA (HLR) blade in shelf 0, slot 7.
ATTENTION
Use the <sg-name> provisioned in step 1 for the <sg-name> in this
step.
4. Provision an HLR service unit for the KPA (HLR) blade in shelf 0, slot 14.
Kapsch CarrierCom AG
ATTENTION
Use the <sg-name> provisioned in step 1 for the <sg-name> in this
step.
-End-
Variable Value
<cluster-node-id> Unique identifier associated with the cluster node to which this
HLR belongs; integer value; range of 0 to 255.
The cluster node ID should follow a consistent pattern and be
consistent between the Geographic Mate Site (for example: 0
for MRF, 1 for first HLR, 2 for second HLR)
12.10.1 Prerequisites
• A CLI session is open.
ATTENTION
Use the <sg-name> provisioned in the previous step for the <sg-
name> in this step.
3. Provision an HLR service unit for the KPA (HLR) blade in shelf 0, slot 10.
ATTENTION
Use the <sg-name> provisioned in step 1 for the <sg-name> in this
step.
4. Provision an HLR service unit for the KPA (HLR) blade in shelf 0, slot 13.
ATTENTION
Use the <sg-name> provisioned in step 1 for the <sg-name> in this
step.
ATTENTION
Use the <sg-name> provisioned in the previous step for the <sg-
name> in this step.
7. Provision an HLR service unit for the KPA (HLR) blade in shelf 0, slot 11.
ATTENTION
Use the <sg-name> provisioned in step 1 for the <sg-name> in this
step.
8. Provision an HLR service unit for the KPA (HLR) blade in shelf 0, slot 14.
ATTENTION
Use the <sg-name> provisioned in step 1 for the <sg-name> in this
step.
-End-
Kapsch CarrierCom AG
Variable Value
<cluster-node-id> Unique identifier associated with the cluster node to which this
HLR belongs; integer value; range of 0 to 255.
The cluster node ID should follow a consistent pattern and be
consistent between the Geographic Mate Site (for example: 0 for
MRF, 1 for first HLR, 2 for second HLR).
12.11 Creating a softlink pointer to the default SOS image on KAIROS System Controller
Create a softlink pointer to a default SOS image on the KAIROS System Controller to facilitate
configuration.
12.11.1 Prerequisites
• You are logged on as root (Linux SSH session) on your KAIROS System Controller.
• You know the name of the SOS image on your KAIROS System Controller and it is in the
/opt/Kapsch/ca/data/NODATA directory.
-End-
Kapsch CarrierCom AG
Variable Value
<imageName> file name of the SOS image
12.12.1 Prerequisites
• A CLI session is open.
• There is an HLR SOS image already on your KAIROS System Controller in the
/opt/Kapsch/ca/data/NODATA/ directory.
2. Load the MRF service unit for shelf 0, slot 13 with the MRF/HLR application software.
sosagent mrf load <sg-name> 1
-End-
Variable Value
<sg-name> alphanumeric name associated with the MRF
service group; a string of characters from 1 to
10 in length
12.13 Loading, unlocking, and activating the HLR service units for a Minimum/Typical
configuration
Perform this procedure to load the HLR service units of HLR-1 with software, unlock them, and activate
the service group of HLR-1.
Kapsch CarrierCom AG
12.13.1 Prerequisites
• A CLI session is open.
• There is an HLR SOS image already on your KAIROS System Controller in the
/opt/Kapsch/ca/data/NODATA/ directory.
2. Load the HLR service unit for shelf 0, slot 14 with HLR application software.
sosagent hlr load <sg-name> 1
5. Activate the HLR service group for HLR-1 pair (shelf 0, slot 7 and 14).
sosagent hlr activate <sg-name>
-End-
Variable Value
<sg-name> alphanumeric name associated with the HLR service group;
naming restrictions:
• the whole name must be upper case
• the name must begin with an alphabetic letter (not numbers)
• the rest of the name (not the first character) may be alphanumeric
and underscores
• At the user’s discretion, the sg-name should be less than 16
characters because SSG pathset names for the KPA (HLR) blades
must begin with this name. The SSG pathset-name has a
• 16-character limitation.
12.14 Loading, unlocking, and activating the HLR service units for a Maximum configuration
Perform this procedure to
• load the HLR service units of HLR-1 through HLR-3 with software
• unlock the HLR service units of HLR-1 through HLR-3
• activate the service group of HLR-1 through HLR-3
12.14.1 Prerequisites
• A CLI session is open.
Kapsch CarrierCom AG
2. Load the HLR service unit for shelf 0, slot 14 with HLR application software.
sosagent hlr load <sg-name> 1
5. Activate the HLR service group for HLR-1 pair (shelf 0, slot 7 and 14).
sosagent hlr activate <sg-name>
7. Load the HLR service unit for shelf 0, slot 13 with HLR application software.
sosagent hlr load <sg-name> 1
10. Activate the HLR service group for HLR-2 pair (shelf 0, slot 10 and 13).
sosagent hlr activate <sg-name>
12. Load the HLR service unit for shelf 0, slot 14 with HLR application software.
sosagent hlr load <sg-name> 1
13. Unlock the HLR service unit for shelf 0, slot 11.
sosagent hlr unlock <sg-name> 0
14. Unlock the HLR service unit for shelf 0, slot 14.
sosagent hlr unlock <sg-name> 1
15. Activate the HLR service group for HLR-3 pair (shelf 0, slot 11 and 14).
Kapsch CarrierCom AG
-End-
Variable Value
<sg-name> alphanumeric name associated with the HLR service group; naming
restrictions:
• the whole name must be upper case
• the name must begin with an alphabetic letter (not numbers)
• the rest of the name (not the first character) may be alphanumeric
and underscores
• At the user’s discretion, the sg-name should be less than 16
characters because SSG pathset names for the KPA (HLR)
blades must begin with this name. The SSG pathset-name has a
16-character limitation.
12.15.1 Prerequisites
• A CLI session is open.
-End-
Variable Value
<e164-global-title> SCCP protocol address used for routing signaling messages
on the public switched telephone network (PSTN); a string of
characters up to 15 in length
The e164 global title is the only modifiable attribute on an HLR blade.
12.16.1 Prerequisites
• A CLI session is open.
-End-
Variable Value
<e164-global-title> Signaling Connection Control Part (SCCP) protocol address used
for routing signaling messages on the public switched telephone
network (PSTN); a string of characters up to 15 in length
12.17.1 Prerequisites
• A CLI session is open.
The system returns service unit information for the specified service group.
6. Record the value of the Call Agent service unit number.
7. To retrieve MSC Call Agent information, enter
sosagent mscca show <sg-name>
The system returns MSC Call Agent data for the specified service group.
8. To retrieve HLR information, enter
sosagent hlr show <sg-name>
The system returns configuration data for the specified service group.
10. To retrieve MRF information, enter
sosagent mrf show <sg-name>
The system returns configuration data for the specified service group.
-End-
Variable Value
<sg-name> alphanumeric name associated with the Call Agent service group;
a string of characters from 1 to 31 in length
<su-number> Call Agent service unit in the Call Agent service group; integer
value; one of 0 or 1
Kapsch CarrierCom AG
System SG Name Active IRM Sync State App Admin App Oper
response State State
System SG Name Active IRM Sync State App Admin App Oper
response State State
e164-global-title = 611237200200101
num-subscribers = 73001
app-state = INSV
geo-mating-state = standalone
provisioning-allowed = true
sccp-state = INSV
app-sig-alive = true
dump-in-progress = false
upgrade-in-progress = false
Kapsch CarrierCom AG
ATTENTION
Perform the procedures in this chapter only in the context of the Call Agent task
flow.
13.1.1 Prerequisites
You have a provisioned Call Agent.
13.2 Determining the need for SOS file system partition resizing
Perform this procedure to determine whether the existing SOS file system partitions are large enough to
accommodate the image and patch volumes.
13.2.1 Prerequisites
• You must know the total partition size (device size), patch volume size, and image volume
size requirements. Consult systems engineering documentation for your network.
• A KAIROS CLI session is open.
ATTENTION
Resize file system partitions with extreme caution.
You cannot resize a partition to a smaller size.
The system returns the disk partition size for device sd00.
6. Quit the partition administration.
quit
The system returns the disk partition size for device sd01.
8. Quit the partition administration.
quit
10. Compare the recommended partition sizes to the current, actual partition sizes
retrieved in step 3 and step 5.
If the current partition sizes are too small, you must resize the partitions.
-End-
Variable Value
<sg-name> alphanumeric name associated with the application service
group; a string of characters from 1 to 31 in length
13.3.1 Prerequisites
• You have completed “Determining the need for SOS file system partition resizing” on
page 234.
• A KAIROS CLI session is open.
The system returns information about all the HLR mated pairs.
4. Log on to the MSCCA SOS application using the <sg-name> retrieved in the last step.
sosagent mscca login <sg-name>
CAUTION
Resize file system partitions with extreme caution.
CAUTION
Resize file system partitions with extreme caution.
CAUTION
Resize file system partitions with extreme caution.
CAUTION
Resize file system partitions with extreme caution.
Variable Value
<sg-name> alphanumeric name associated with the application service
group; a string of characters from 1 to 31 in length
13.4.1 Prerequisites
• You have completed “Determining the need for SOS file system partition resizing” on
page 234.
• You know the required volume sizes for the applications.
• You know the required volume size for the MSC Call Agent.
• A KAIROS CLI session is open.
OR
To decline the backup, enter
N
logout
16. Log off from the SOS CI for the HLR-1 mated pair.
logout
Variable Value
<sg-name> alphanumeric name associated with the application service
group; a string of characters from 1 to 31 in length
13.5.1 Prerequisites
• You have completed “Provisioning image volumes” on page 237.
Kapsch CarrierCom AG
diskadm sd01
createvol patch <VOLUME SIZE>
OR
To decline the backup, enter
N
26. Create a volume on the sd01 device for patches on the first HLR based on the
recommended patch volume size.
diskadm sd01
cv patch <VOLUME SIZE>
The system asks if you want to back up the volume.
27. Accept the backup.
Y
Kapsch CarrierCom AG
30. Log off from the SOS CI for this HLR node.
logout
Variable Value
<sg-name> alphanumeric name associated with the application
service group; a string of characters from 1 to 31 in
length
14.1.1 Prerequisites
• A CLI session is open.
>TABSYNC
TABSYNC:
>HELP
TABSYNC is used to control the Cluster Syncing of registered DMS Tables, Office Parms
and SOC options. Available commands (M = Master node ONLY) are:
14.2.1 REGISTERED
The REGISTERED command allows the user to filter tables based on how they are registered with
Kapsch CarrierCom AG
TABSYNC.
14.2.1.1 Prerequisites
• A KAIROS CLI session is open
• You are logged on to SOS. See “Logging on to a SOS application” on page 243.
2 Enter
x REGISTERED
3 Enter
registered OTC
The requested data appears. See “Figure 9 System response - registered” on page
245.
4 Enter
registered CLLI
The requested data appears. See “Figure 9 System response - registered” on page
245.
5 To exit the session, enter
QUIT
-End-
Kapsch CarrierCom AG
14.2.2 STATUS
The STATUS command allows the user to query the status of the table sync system. This command is
used to identify the location of sync problems.
14.2.2.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to SOS. See “Logging on to a SOS application” on page 243.
2 Enter
x STATUS
3 Enter
Kapsch CarrierCom AG
STATUS
The requested data appears. See “Figure 10 System response - status” on page 246.
4 To exit the session, enter
QUIT
-End-
14.2.3.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to an SOS master node. See “Logging on to a SOS application”
on page 243.
2 Enter
x DBTRID
3 Enter
DBTRID
4 Enter
DBTRID 5
The requested data appears. See “Figure 11 System response -DBTRID” on page
247.
5 To exit the session, enter
QUIT
-End-
14.2.4 STOPSYNC
The STOPSYNC command instructs the TABSYNC mechanism to stop syncing cluster-synced tables.
The STOPSYNC command will result in writes to cluster-synced tables being disabled. Only use it during
conditions when table sync should not be operational (for example, during a manual upgrade procedure
on one of the nodes or before a ROLLBACK request.
Once you have run the STOPSYNC command, changes to cluster-synced tables on the master are not
allowed and outstanding slave transactions are stopped as well. This condition will be Siren alarmed. If a
slave node boots up during STOPSYNC, the node will detect that system sync is stopped and will not go
into Bulk Sync mode. A TABS104 log is produced, to record the action. To restore normal operation, use
the STARTSYNC command.
Kapsch CarrierCom AG
14.2.4.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to an SOS master node. See “Logging on to a SOS application”
on page 243.
2 Enter
x STOPSYNC
3 Enter
STOPSYNC
4 Enter
YES
-End-
14.2.5 STARTSYNC
The STARTSYNC command instructs DBMAN to begin a sync of cluster-synced tables to the slaves. Use
the STARTSYNC command when table sync has been disabled manually by the STOPSYNC command.
The following steps occur:
14.2.5.1 Prerequisites
• STOPSYNC is disabled.
• A KAIROS CLI session is running.
• You are logged on to an SOS master node. See “Logging on to a SOS application” on
page 243.
3 Enter
STARTSYNC
Table syncing has been ENABLED.
-End-
14.2.6 ROLLBACK
Use the rollback command to instruct DBMAN through TABSYNC to roll back transactions to the lowest
successfully applied TRID. Use the rollback command when an apply error has occurred on one or more
slaves. A TABS104 log is produced to record the action.
14.2.6.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to an SOS master node. See “Logging on to a SOS application”
on page 243.
2 Enter
x ROLLBACK
3 Enter
STOPSYNC; y
4 Enter
ROLLBACK
5 Enter
YES
Rollback initiated.
-End-
14.2.7 AUDIT
Use the AUDIT command to audit a table or office parameters for cluster sync. This command is allowed
on MASTER node only. AUDIT captures system table inconsistencies. Once complete, a TABS103 log
displays the results.
The TABS103 log displays only the first 16 failed instances. (All other inconsistencies are not captured as
part of the log-reporting mechanism.) The total number of inconsistencies count is truncated to 32. For
example if there are inconsistencies in 39 tables, then only 32 are reported as an overall count. You can
run the AUDIT command for each table (AUDIT TABNAME <table>) to see all system table
inconsistencies.
14.2.7.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to an SOS master node. See “Logging on to a SOS application” on
page 243.
-End-
Kapsch CarrierCom AG
>x audit
Audit a table or office parm for cluster sync. Allowed on MASTER node ONLY.
AUDIT cmds:
STATUS
– STATUS of audit.
STOP
– Disable AUTO audit. After table X completes, if
running.
START
– START (re-enable) AUTO audit NOW or NEXT
cycle.
TABNAME
– Audit <table>. First do STOP. Use START when
done.
PARMNAME
– Audit <table><parm>. First do STOP. Use START
when done.
TABLIST
– List TABLES to be audited.
PEERLIST
– List NODES to be audited.
PEERLIST
>TABSYNC
TABSYNC_DEBUG:
TABSYNC_DEBUG is used to debug the Cluster Syncing of registered DMS Tables, Office
Parms and SOC options. Available command (M = Master node ONLY) are:
14.3.1 SYNC
The SYNC command disables Tabsync only on the node where the command is typed. Use it only when
no other available option can resolve a Tabsync failure to sync. A TABS104 log is produced to record the
action.
14.3.1.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to SOS. See “Logging on to a SOS application” on page
243.
2 Enter
Kapsch CarrierCom AG
x SYNC
-End-
14.3.2 UNSYNC_CHG
The UNSYNC_CHG command allows the user to enable and disable changes to all UNSYNCED tables
on the slave. The master node is always allowed to change unsynced tables. A TABS104 log is produced
to record the action.
14.3.2.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to SOS. See “Logging on to a SOS application” on page 243.
2 Enter
x UNSYNC_CHG
-End-
14.3.3 DISPQS
The DISPQS command shows Tabsync Q counts and Q item basic contents.
14.3.3.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to SOS. See “Logging on to a SOS application” on page 243.
Kapsch CarrierCom AG
2 Enter
x DISPQS
3 Enter
DISPQS
Items on FREE_Q : Head: 476B3000 Count: 32
Addr: 476B9000 Link: 476BC000 Q: FREE_Q BufIdx: 4 Sen
dCnt: 0 TRID: NILTRID
...
Addr: 427BC000 Link: 476B0000 Q: FREE_Q BufIdx: 0 Sen
dCnt: 1 TRID: 4
Addr: 476B0000 Link: 476B3000 Q: FREE_Q BufIdx: 1 Sen
dCnt: 1 TRID: 5
Addr: 476B3000 Link: 476B6000 Q: FREE_Q BufIdx: 2 Sen
dCnt: 1 TRID: 6
Addr: 476B6000 Link: 476B9000 Q: FREE_Q BufIdx: 3 Sen
dCnt: 0 TRID: NILTRID
Items on WORK_Q : Head: FFFF0000 Count: 0
Items on ACK_Q : Head: FFFF0000 Count: 0
Items on PREOK_Q: Head: FFFF0000 Count: 0
-End-
14.3.4 COUNTQS
The COUNTQS command shows Tabsync Q counts (a subset of DISPQS output).
14.3.4.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to SOS. See “Logging on to a SOS application” on page 243.
2 Enter
x COUNTQS
3 Enter
COUNTQS
Items on FREE_Q : Head: 476B3000 Count: 32
Items on WORK_Q : Head: FFFF0000 Count: 0
Items on ACK_Q : Head: FFFF0000 Count: 0
Items on PREOK_Q: Head: FFFF0000 Count: 0
-End-
14.3.5 ORPHAN
The ORPHAN command scans or reclaims any orphaned Tabsync buffers. A buffer is considered
orphaned if its link field is NIL, and its state is NO_Q. For the sub-command ORPHAN RECLAIM, a
TABS104 log is produced, to record the action if any orphans are found.
14.3.5.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to SOS. “Logging on to a SOS application” on page 243.
2 Enter
x ORPHAN
3 Enter
ORPHAN SCAN
-End-
14.3.6 REBUILDQ
The REBUILDQ command nil initializes Tabsync Q items and re-engineers them on the FREE Q. A
Kapsch CarrierCom AG
command is required, since even a RELOAD intentionally does not re-initialize these DSUNPROT Q
items, so that no transactions are lost during any restart. A TABS104 log is produced to record the action.
14.3.6.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to SOS. See “Logging on to a SOS application” on page 243.
2 Enter
x REBUILDQ
3 Enter
REBUILDQ
4 Enter
y
-End-
14.3.7 MOVETOFREEQ
The MOVETOFREEQ command moves the item at the head of a selected Q to the FREE Q. A TABS104
log is produced to record the action.
14.3.7.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to SOS. See “Logging on to a SOS application” on page 243.
2 Enter
x MOVETOFREEQ
-End-
14.3.8 DISPTRID
The DISPTRID command displays decoded transaction information, given a TRID, buffer item idx, or
table name. Only items still contained within a transaction buffer are accessible. If REBUILDQ is used,
the buffer is re-initalized, so information is lost. DBTRID can be used for older/reset transactions. It reads
the information from the solid DB.
14.3.8.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to SOS. See “Logging on to a SOS application” on page 243.
2 Enter
x DISPTRID
3 Enter
STATUS BRIEF
4 Enter
Kapsch CarrierCom AG
DISPTRID BYTRID 7
-End-
14.3.9 TUPSIZES
The TUPSIZES command shows the logical tuple size of all DMS tables. It also shows the largest
external tuple size, for NTC tables. The output is sorted from lowest to highest byte count sum of 2*logical
+ 2*external byte count. With the COUNT option, the number of tuples in the table is also determined and
shown, with the output sorted from lowest to highest tuple count.
14.3.9.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to SOS. See “Logging on to a SOS application” on page 243.
2 Enter
x TUPSIZES
3 Enter
TUPSIZES
RLOGCLAS 1 0 0 n/a
RLOGTAB 1 0 0 n/a
RLOGDEV 1 0 0 n/a
...
OCCMAP 12 23 70 n/a
LATALRN 12 31 86 n/a
EASAC 40 3 86 n/a
PMEXCEPT 40 4 88 n/a
SNPANAME 40 7 94 n/a
MCCMNC 40 7 94 n/a
...
4 Enter
TUPSIZES COUNT
% Same output, but NumTuples column is populated, and sorted low to high.
-End-
14.3.10 SHRMEM
The SHRMEM command allows viewing the decoded content of the Linux, Sys V shared memory used by
Tabsync, since it is not accessible through DEBUG.
14.3.10.1 Prerequisites
• A KAIROS CLI session is open.
• You are logged on to SOS. See “Logging on to a SOS application” on page 243.
2 Enter
x SHRMEM
3 Enter
SHRMEM
The system returns Linux-shared memory content used by Tabsync for all node num
entries. See “Table 102 Linux shared memory content for all node num entries” on
page 261.
4 Enter
SHRMEM 3
The system returns Linux-shared memory content used by Tabsync for node num
entry 3. See “Table 103 Linux shared memory content for a specific node num entry”
on page 261.
-End-
Kapsch CarrierCom AG
F: failedRollingBack S: manuallyStopped
O: OnpInProgress K: KickedByCcgMan
C: dbConnected D: DumpInProgress
R: RollingBack P: nodePresent
Table 103 Linux shared memory content for a specific node num entry
F: failedRollingBack S: manuallyStopped
O: OnpInProgress K: KickedByCcgMan
C: dbConnected D: DumpInProgress
R: RollingBack P: nodePresent
14.3.11 HELP_DEBUG
The HELP_DEBUG command shows command available in the TABSYNC_DEBUG increment. See
“Table 101 TABSYNC_DEBUG available commands” on page 252.
Kapsch CarrierCom AG
The following table shows the list of terms you can use.
Table 105 Commands for managing software
You can enter any of the terms from the previous table as the second term of the software command. To
determine the possible third terms in a command, enter two terms followed by the question mark, for
example, “software upgrade?”. You can continue this process to determine all of the possible software
Kapsch CarrierCom AG
commands.
In Kapsch technical documentation, procedures support a specific task and provide only the specific
command required. The procedure identifies the values you need to enter for variables or tells you how to
determine these values.
Many CLI commands do not require a definition to the subslot level. However, you need to enter all
identifiers above the level required. For example, to specify a shelf, you only need to identify the frame
and shelf. But to specify a blade location, you must specify a value for frame, shelf, and slot.
The Variable definitions table, located after the procedure steps, provides the equipment identification
values required by the procedure. For example, a procedure that applies to NGW on KSC blade indicates
that the value for slot can be 3 or 7.
Kapsch CarrierCom AG
Example
For example:
The Variable definitions table associated with each procedure provides the appropriate values for
<attribute> and <value>.
< The attribute is numerically smaller than the value or the character
string has an ASCII value less than the value.
<= The attribute is numerically smaller than or equal to the value, or the
character string has an ASCII value less than the value or is identical.
> The attribute is numerically larger than the value or the character string
has an ASCII value greater than the value.
>= The attribute is numerically larger than or equal to the value, or the
character string has an ASCII value greater than the value or is
identical.
The attributes for many objects can be displayed in a small screen space, where you can easily
compare them.
This is the default output form. If the attributes displayed are sufficient to complete a procedure,
the procedure step does not include an output-form term in the CLI command.
Since each attribute requires one line on the screen, each object requires several lines. This
view is useful when showing a single entry.
If a procedure requires you to see an attribute that does not appear in the brief output form, the
procedure step includes the term detailed in the CLI command.
15.3.1 Prerequisites
• A CLI session is open. To stop or monitor bulk input you must have two CLI sessions open.
• The bulk input text file is located in the /scratch volume.
• You know the reference name and local file name (path) of the bulk input text file.
-End-
Variable Value
<ref-name> a reference name to use with the show and stop commands
<local-filename> the full path to the file that contains the CLI commands scratch/<file-
name>
<stop-on-error> stop bulk input for errors
Value: y or n
<line-number> number of the start line in the bulk input text file where command
execution should begin
Value: 0 - 65535 (0 is the start of the file).
15.4.1 Navigation
At the beginning of a chapter, any task that requires more than one procedure to complete includes a task
flowchart. Many task flowcharts may appear in the same chapter and they may use some of the same
procedures. The task flowchart tells you the specific order in which you are to perform the procedures.
Any decisions you need to make appear in the task flowchart to avoid decisions within the procedures.
If you can perform the procedures in a section in any order, the section does not contain a task flowchart.
Procedure names appear below the flowcharts, with links to the procedures. If you are reading the
documentation in PDF form, you can select the links and go directly to the procedures.
Kapsch CarrierCom AG
15.4.2.1 Title
The title identifies the objective of the procedure. KAIROS procedure titles are very specific, to
enable you to find the one you need.
15.4.2.3 Prerequisites
Prerequisites are conditions that you must satisfy before you perform the procedure. These may
be as simple as being logged on to the system with a CLI session open or knowing some
information that you need to enter in a procedure step. You may have completed some
prerequisites in previous procedures of a task flow. Prerequisites appear in a bulleted list.
15.4.2.4 Steps
Procedure steps have a step number, an action for you to take, and often a system response.
Actions and responses have different font types, as described in the conventions below.
Variable Value
<role> defines the permissions assigned to the user account;
possible values: Basic, Admin, SecAdmin
<account-state> If locked, the account cannot be used.
If unlocked (the default), the account can be used.
• Terms without any surrounding brackets are keywords and you must enter them as shown.
In the example, security, user-account, and add are keywords.
Kapsch CarrierCom AG
• Terms surrounded by < > are variables, which are described in the Variable definitions
table. In the example, user-id, role, and emergency-account are variables. You must enter a
value in place of these terms to create a valid command. In the example, the Variable
definitions table entry for role would give Basic, Admin, and SecAdmin as acceptable
values.
• Terms surrounded by [ ] are optional. In the example, <emergency-account> does not have
to be specified. A default value, specified in the Variable definitions table, is used when
optional terms are omitted.
Kapsch CarrierCom AG