Professional Documents
Culture Documents
Licensing Guide
iDX 2.x
May 28, 2010
Copyright 2010 VT iDirect, Inc. All rights reserved. Reproduction in whole or in part without permission is
prohibited. Information contained herein is subject to change without notice. The specifications and information
regarding the products in this document are subject to change without notice. All statements, information, and
recommendations in this document are believed to be accurate, but are presented without warranty of any kind,
express, or implied. Users must take full responsibility for their application of any products. Trademarks, brand
names and products mentioned in this document are the property of their respective owners. All such references
are used strictly in an editorial fashion with no intent to convey any affiliation with the name or the product's
rightful owner.
ii
Revision History
The following table shows all revisions for this document. Refer to this information to verify
that you have the latest version. If you do not have the latest version or you are unsure, you
can access the TAC web page at http://tac.idirect.net and click on the Software Releases
link. You can then scroll down to the iDS/iDX release that is applicable to you and download
the latest version of this document.
Revision
Date Released
Who Updated?
TJenkins
Updated procedures.
TJenkins
Oct. 2, 2009
Updated procedures.
TJenkins
SMurphy
Updated for iDX 2.1; added
section on how to install Link
Encryption license on PP. Added
reference to iBuilder Users Guide
for sharing chassis in multi-NMS
configurations.
iii
iv
Contents
1.
2.
3.
4.
5.
3 Feature Licensing
3.1 What Features Are Available? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.2 How Do I Get a Feature License? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Step 1. Fill Out a Purchase Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Step 2. Create a License Request File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
vi
List of Figures
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
Figure
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
vii
viii
Purpose
The purpose of this guide is to introduce you to iDirects licensing features, and also to
explain how to acquire and apply these licenses to your iDirect network.
Intended Audience
This guide is written for network operators using the iDirect iDX iBuilder/iMonitor software
suite, network architects, and any other personnel who operate or monitor an iDirect
network. A basic knowledge of TCP/IP concepts, satellite communications, Linux and MS
Windows operating systems and tools (including WinSCP and PuTTY) is assumed. Prior
experience with the operation and monitoring of an iDirect network is desirable but not
required.
Document Conventions
This section illustrates and describes the conventions used throughout the manual. Take a
look now, before you begin using this manual, so that youll know how to interpret the
information presented.
Convention Description
Blue
Courier
bold
Example
[SWITCH_PORT_n]
vid = vlan_id
ix
Document Conventions
Convention Description
Example
Courier
font
Bold
Trebuchet
font
Bold italic
Trebuchet
font
Used to emphasize
information for the user,
such as in notes.
Note:
Red italic
Trebuchet
font
(or see
table
below)
Symbol
Warning type
CAUTION
Definition
Related Documents
Symbol
Warning type
WARNING
Definition
Related Documents
The following iDirect documents are available at http://tac.idirect.net and may also contain
information relevant to this release. Please refer to these documents as needed or indicated
within this guide. It is recommended that you download this guide, in addition to the iDX 2.1
iBuilder User Guide, as these two documents are used throughout the licensing procedures.
Note:
Release Notes
Getting Help
The iDirect Technical Assistance Center (TAC) is available to help you 24x7x365. iDX Software
users guides, installation procedures, FAQ pages, and other documentation that supports our
products are available on the TAC webpage. Please access our TAC webpage at:
http://tac.idirect.net.
If you are unable to find the answers or information that you need, you can contact the TAC at
(703) 648-8151.
iDirect strives to produce documentation that is technically accurate, easy to use, and helpful
to our customers. Your feedback is welcomed! Send your comments to techpubs@idirect.net.
xi
Getting Help
xii
iDirect offers several different types of licenses, depending on the iDX release you are using,
the features you want to use on your network(s), and the specific hardware you are using in
your network(s).
Each license is described in detail in the following sections.
NMS Server License As introduced in iDS 7.0, an NMS license is required in order to operate
the iDirect NMS server. This license is obtained from the iDirect Technical Assistance Center
(TAC) and installed on your NMS server when you initially install or upgrade the iDirect
software. Included in the NMS license are specific features you may request, including:
Geographic Map
Global NMS
SkyMonitor
Instructions for installing the NMS Server license are provided in the Network Upgrade
Procedure Guide for the specific release you are installing, which can be downloaded from
the TAC Web Page (tac.idirect.net).
Hub Timing Group License Introduced in iDX Release 2.0, Hub Timing Group licenses are
required to enable chassis slots on both the 4-slot and 20-slot hub chassis. For new 5IF hub
owners, this method offers a way to pay as you grow such that you can activate one, some,
or all five timing groups as your networks grow. These licenses are obtained from the TAC,
based on specific information you provide, and are imported using the iBuilder License
Toolbar.
Note:
Protocol Processor Blade Feature License Introduced in iDX Release 2.1 (applies only to all
releases that were delivered AFTER this release). Currently, the software feature license that
applies to all iDirect modems controlled by a Protocol Processor Blade server is Link
Encryption. To enable this, a valid license file must be copied to a specific directory on your
PP blade server.
Note:
The terms Chassis License and Hub Timing Group License are used
synonymously in this guide.
Introduced in iDX Release 2.0, Hub Timing Group licenses are required to enable chassis slots
on both the 4-slot and 20-slot hub chassis. For new 5IF hub owners, this method offers a way
to pay as you grow such that you can activate one, some, or all five timing groups as your
networks grow. These licenses are obtained from the TAC, based on specific information you
provide, and are imported using the iBuilder License Toolbar.
All users who are installing or upgrading to iDX 2.x releases are required to obtain a Hub
Timing Group license. Otherwise, the chassis will be disabled following the upgrade. This
includes the 4-slot chassis and 20-slot expansion chassis, daisy-chained chassis, and SCPC
concentrator chassis. Hub Timing Group licenses are controlled by a service in the NMS called
the Chassis Manager (cmsvr).
Note:
Hub Timing Group licenses are NOT required for private hubs or mini-hubs.
Anyone who is installing or upgrading to an iDX 2.x release is required to complete the iDX 2.x
Upgrade/Installation Survey (available at http://tac.idirect.net) and asked to provide
specific information about their chassis in order to generate the license.
2.1
In a shared Chassis environment (when multiple NMS servers share the same Chassis), the
NMS that controls the Chassis MUST be upgraded to an iDX 2.x release before any of the
other NMS servers are upgraded.
For HNO/VNO configurations, this means the HNO NMS must be upgraded before any
of the VNO NMS systems.
When multiple NMS servers are running an iDX 2.x release and the Chassis is shared, all
NMS systems must have IP connectivity to the server that is running Chassis Manager.
Each Hub line card in an iDX 2.x network must be assigned a Chassis slot. The Chassis
Manager is the tool that is used to assign slots on a Chassis. Chassis Manager requires IP
connectivity to successfully perform this task.
You may use ACLs, firewalls, or other security measures to allow shared access to the
Chassis Manager from multiple NMS servers, while at the same time preventing these NMS
servers from accessing each other.
Note:
2.2
In a non-VNO environment, if the current chassis controller NMS is not the one to be
upgraded first, control of the chassis may be transferred to the first iDX 2.x NMS
Server.
These conditions apply in all iDX 2.x implementations, not just those with
Pay-As-You-Grow 5-IF chassis and/or VNOs.
To communicate with Chassis Manager, use TCP port 15261 for inter-process
communication and 15262 for console sessions.
Note:
Note:
For more information about changing the chassis IP address, refer to the
iBuilder Users Guide for iDX 2.1.x, Section 8.6, Changing a Chassis IP
Address.
STEP 1. REQUESTING
1. Go to the TAC website (http://tac.idirect.net), download and fill out the iDX 2.x
Upgrade/Installation Survey.
2. To receive the correct Hub Timing Group license (also referred to as a chassis license),
you must supply the following information on the Upgrade/Installation Survey:
Type of hub chassis (20-slot or 4-slot)
Hub chassis IP address
NMS Eth0 MAC addresses for both the primary and backup NMS
Whether the hub chassis is daisy-chained
If all timing groups on the 5IF hub are not active, indicate which slots are active.
When you submit your request, keep in mind that the Chassis license must be requested at
least 24 hours prior to when you are need to use the license for an install/upgrade, and the
projected install/upgrade date must also be included in the request. Once you supply this
information to iDirect and it is verified, you receive your Hub Timing Group license key file.
The file is provided in tar.gz format. Once you receive the license file, you are ready to
continue to Step 2. Enabling Download Permissions on Chassis Manager
ON
CHASSIS MANAGER
Before you can import the license file in iBuilder, you must enable download permissions to
the Chassis Manager server process (cmsvr).
Perform the following:
Make sure you have completed Step 1. Requesting a Hub Timing Group License before you
begin this step!
1. Open a terminal window on your PC and ssh to the NMS server.
2. Confirm that cmsvr is running on this server by entering the following command:
service idirect_nms status cmsvr
Where: <ip address> is the IP address of the server running the NMS Chassis Manager
process.
4. At the Username prompt, logon to the Chassis Manager account as admin.
5. Enter the default password: iDirect
6. Optionally, iDirect recommends that you change the default password after inital login.
Use the passwd command at the cmsvrs > prompt.
7. Enable the download permissions by entering the following command:
download on
8. Make sure you keep telnet session open, as you are required to use this tool in the next
step.
Chassis license downloading permission is now enabled.
Now that the downloading permissions is enabled on the Chassis Manager NMS server, you are
ready to perform Step 3. Importing the Hub Timing Group License File using iBuilder to import
the license file.
STEP 3. IMPORTING
THE
Now that you have acquired the license, and have enabled the download permissions, you are
ready to import the license file.
Import
Export
6. Click OK.
7. Update the Chassis Manager by entering the following command using the telnet session
you have open with the cmsvr:
update
TO
SLOTS
In order for a line card to become operational in iDX 2.x releases, it must be assigned to a
chassis slot.
Make sure you have completed Step 4. Validating the Chassis Serial Number before you
begin this step!
1. In iBuilder, right-click the Chassis in the Network Tree, and select ModifyItem.
2. In the Modify Configuration Object Dialog (Figure 6), select the hub line card from the
Hub Assignment column drop-down list.
3. Repeat Step 2 for each hub line card.
4. When done, click OK.
Figure 6. Modify Configuration Object Dialog: Assigning Hub Line Cards to Slots
In the iBuilder tree, the message, Changes Pending displays.
10
5. Click the
11
12
3 Feature Licensing
For all iDX 2.x releases, software features such as Link Encryption and Spread Spectrum are
available for licensing on specific remotes and hub line cards. In this way, you pay for licensed
features only on the equipment on which they are actually used, which provides a simple,
scalable upgrade path to new features.
Note:
Introduced in iDX Release 2.1, the Link Encryption feature also requires a
license to be installed on the Protocol Processor blade. See Chapter4, Protocol
Processor Blade Feature Licensing for instructions.
This method is implemented through iBuilder, which helps you to avoid costly site visits.
3.1
Remote
Server
Link Encryption
Evolution X3
N/A
All PP Blades
Evolution X5
Spread Spectrum
* Separate licensing Purchase Order is not required for Spread Spectrum on the XLC-11.
3.2
Note:
If you are unable to access iDX 2.x, you will need to create the license request
file manually. See Option B. Creating a License File Manually on page 17.
13
PURCHASE ORDER
Contact your iDirect salesperson and fill out a Purchase Order to send to iDirect. In the
Purchase Order, please specify the feature you are requesting. Once your Purchase Order is
processed through iDirect, you will be contacted and asked for a license request file. You can
create this file using iDX 2.x iBuilder, or you can create one manually if you do not have
access to an iDX 2.x network.
STEP 2. CREATE
There are two options that are available to you for creating a license request file. Procedures
for these options are included in this section.
These are:
Option A: Creating a License File in iBuilder, which explains how to easily request a
feature license for your specific hardware and to import the license keys to your iDX 2.x
network.
Option B. Creating a License File Manually, which explains how to manually request a
feature license in cases where you may not have access to the iDX 2.x iBuilder client
software.
Serial Number
Derived ID (DID)
Perform the following to export data for licensing information from iBuilder:
1. View the License Toolbar in iBuilder by selecting select ViewLicense Toolbar from the
View Menu (Figure 8).
14
The Import Button: Used to import the resulting license files from iDirect.
Import
Export
15
4. Select all units for which you want to request licenses by clicking in the check box next to
your selections (Figure 12).
16
7. Click Save.
Your license request file contains the DID, serial number, and model type for each unit for
which you want to license a feature. Figure 14 shows the license request file opened in
Excel.
17
Import
Export
18
6. Click OK.
The message, Changes Pending displays on the remote and/or hub line card you applied
the license features.
19
7. Click the
STEP 3. ACTIVATE
THE
LICENSED FEATURE
Now that the feature is enabled, you must configure it on your network.
1. To implement the new feature, right-click the remote (or hub line card) from the iBuilder
Network Tree and select Modify Item.
The Modify Configuration Object Dialog (Figure 20) displays, showing that Link
Encryption is now enabled on the selected remote.
Note:
20
To fully enable Link Encryption, you also need to update your database.
Contact the TAC (703-648-8151) for details.
21
22
The Link Encryption feature license for the X3 and X5 remotes is enabled via
iBuilder. See Chapter3, Feature Licensing for details.
STEP 1. REQUEST
Go to the TAC website (http://tac.idirect.net), download and fill out the iDX 2.x
Upgrade/Installation Survey. To receive the correct PP blade license, you must supply the
MAC address of each PP blade requiring a license by completing and submitting the iDX 2.x
Upgrade/Installation Survey.
<filename> /etc/idirect/pp
23
Where: <filename> is the name of the license file as defined by iDirect (convention is
YYYY_MM_DD_PP_LINK_ENCRYPTION.tar.gz)
7. Change to the /etc/idirect/pp directory by entering the following commands:
cd /etc/idirect/pp
ll
The following output displays:
-rw-r--r-- 1 root root 976 May 12 22:41
2010_05_28_PP_LINK_ENCRYPTION.tar.gz
8. Uncompress the license file by entering the following command:
tar zxvf <filename>
Where: is the name of the license file as defined by iDirect (convention is
YYYY_MM_DD_PP_LINK_ENCRYPTION.tar.gz)
The following output displays:
00:10:18:1C:BE:41_license.lic
9. Copy the file and rename with license.lic by entering the following commands
cp 00:10:18:1C:BE:41_license.lic license.lic
ll
The following output displays:
total 40
-rw-r--r-- 1 root root 1173 May 12 22:06
00:10:18:1C:BE:41_license.lic
-rw-r--r-- 1 root root 976 May 12 22:41
2010_05_28_PP_LINK_ENCRYPTION.tar.gz
-rw-r--r-- 1 root root 1173 May 12 22:51 license.lic
10. Restart the PP services by entering the following command:
service idirect_hpb restart
ON THE
NMS SERVER
1. Logon to the NMS Server as root via console connection by entering the following
command:
su You are prompted to enter a password.
2. Enter the root password.
3. Check to ensure that encyption is allowed on the NMS Server by entering the following
commands:
mysql nms;
select * from ServerConfiguration;
The following output displays.
| ENCRYPTION
24
| encryption_allowed
| 0
In the above display, if the last column contains a zero (0), this indicates that encryption is
NOT allowed, so you must continue with Step 4. If the last column contains a one (1)
encryption IS allowed, and you can discontinue this procedure.
4. Change the encryption_allowed value from 0 to 1 by entering the following command:
update ServerConfiguration set Value="1" where
Field="encryption_allowed";
The following output displays.
Query OK, 1 row affected (0.00 sec)
Rows matched: 1
Changed: 1
Warnings: 0
5. Confirm that this change was successful by entering the following command:
select * from ServerConfiguration;
The following output displays, confirming that you have successfully changed the value to
1.
| ENCRYPTION
| encryption_allowed
| 1
OK
OK
#
Your PP blade encryption license is now enabled.
25
26