OcNOS License Server UG

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 24

OcNOS®

Open Compute
Network Operating System
for Service Providers
Version 4.0

License Server
User Guide
January 2021

IP Infusion Inc. Proprietary


© 2021 IP Infusion Inc. All Rights Reserved.

This documentation is subject to change without notice. The software described in this document and this documentation
are furnished under a license agreement or nondisclosure agreement. The software and documentation may be used or
copied only in accordance with the terms of the applicable agreement. No part of this publication may be reproduced, stored
in a retrieval system, or transmitted in any form or any means electronic or mechanical, including photocopying and
recording for any purpose other than the purchaser's internal use without the written permission of IP Infusion Inc.

IP Infusion Inc.
3965 Freedom Circle, Suite 200
Santa Clara, CA 95054
+1 408-400-1900
http://www.ipinfusion.com/

For support, questions, or comments via E-mail, contact:


support@ipinfusion.com

Trademarks:
IP Infusion, OcNOS, VirNOS, ZebM, and ZebOS-XP are trademarks or registered trademarks of IP Infusion. All other
trademarks, service marks, registered trademarks, or registered service marks are the property of their respective owners.

Use of certain software included in this equipment is subject to the IP Infusion, Inc. End User License Agreement at http://
www.ipinfusion.com/license. By using the equipment, you accept the terms of the End User License Agreement.

ii IP Infusion Inc. Proprietary


Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

CHAPTER 1 Setting up a License Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7


Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Java Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Install License Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

CHAPTER 2 Setting up a Floating License on License Server . . . . . . . . . . . . . . . . 9


Create a Floating License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Activate the Floating License on License Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

CHAPTER 3 Installing a Floating License on a Switch . . . . . . . . . . . . . . . . . . . . . 13


Manually Install a License on a Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Automatically Install a License on a Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

CHAPTER 4 License Server Command Reference . . . . . . . . . . . . . . . . . . . . . . . . . 7


license get pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
license pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
license refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
license release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

CHAPTER 5 License Server Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

© 2021 IP Infusion Inc. Proprietary iii


Contents

iv © 2021 IP Infusion Inc. Proprietary


Preface

This document is a user guide for OcNOS License Server which enables your organization to use floating licenses for
your network switches:
• With node-locked licensing, a product license is tied to a switch.
• With a floating license, product licenses are shared among multiple switches. Each switch must be connected to a
License Server that your organization sets up. Floating licenses require you to activate the licenses on the License
Server. The number of licenses and SKUs registered and installed on the License Server limits the number of
concurrent users.

Audience
This guide is intended for network administrators and other engineering professionals who configure and manage
OcNOS License Sever.

Conventions
Table P-1 shows the conventions used in this guide.

Table P-1: Conventions

Convention Description

Italics Emphasized terms; titles of books

Note: Special instructions, suggestions, or warnings

monospaced type Code elements such as XML tags, commands, parameters, files, and directories

Support
For support-related questions, contact support@ipinfusion.com.

Comments
If you have comments, or need to report a problem with the content, contact techpubs@ipinfusion.com.

© 2021 IP Infusion Inc. Proprietary v


Preface

vi © 2021 IP Infusion Inc. Proprietary


CHAPTER 1 Setting up a License Server

This chapter explains the License Server requirements and steps to install a FlexNet License Server on Linux.

Hardware Requirements
The following are the minimum hardware requirements for the license server:
• Disk-100 MB
• RAM-4 GB
• CPU-1 GHz

Supported Platforms
The FlexNet embedded local License Server is supported on the following platforms.
Table 1-1: License Server platforms

Operating System CPU Architecture Tested with Operating System Versions

Linux x86/x86-64 CentOS 6.0


CentOS 7.0
Red Hat Enterprise Linux 6.x
Red Hat Enterprise Linux 7.x

Java Prerequisites
The following are the Java prerequisites for the machine where the FlexNet embedded local License Server is
installed:
• Oracle JRE 1.8 or OpenJDK 1.8
• A 64-bit JRE for a 64-bit License Server or a 32-bit JRE for a 32-bit License Server (not adhering to this
requirement can cause the License Server to fail to start)
• The JAVA_HOME (or JRE_HOME) environment variable on your system set to the path for your default JDK (or
JRE) installation
Note: The License Server requires only the JRE component. If JRE is your default Java installation, set the
JRE_HOME environment variable; if JDK is your default installation, set JAVA_HOME.

Install License Server


The steps below install and starts the License Server as a service on Linux.

1. Download and extract the FlexNet License Server package provided by IP Infusion Inc.

© 2021 IP Infusion Inc. Proprietary 7


Setting up a License Server

2. Set the JAVA_HOME or JRE_HOME environment variable on your system to the path for your default JDK or JRE
installation. For example:
set path "export JAVA_HOME=/usr/lib/jvm/jdk1.8.0_211"
3. Copy the producer-settings.xml file into the FlexNet License Server, under the path flexnetls-
i86_linux-2017.02.0/server.
The producer-settings.xml file is provided by IP Infusion Inc. as part of License Server.

4. For systemd, run the scripts below to install the License Server,
./install-systemd.sh
5. Check the License Server status:
systemctl status flexnetls-IPICO.service
For example:
root@instance1:/flexnetls-i86_linux-2017.02.0/enterprise# systemctl status flexnetls-
IPICO.service -l
flexnetls-IPICO.service - FlexnetLS Local License Server for IPICO.
Loaded: loaded (/etc/systemd/system/flexnetls-IPICO.service; enabled)
Drop-In: /etc/systemd/system/flexnetls-IPICO.service.d
flexnetls.conf
Active: active (running) since Thu 2019-08-01 09:16:01 UTC; 1 day 1h ago
Main PID: 30510 (java)
CGroup: /system.slice/flexnetls-IPICO.service
30510 /usr/bin/java -server -Xms2g -Xmx2g -XX:MaxMetaspaceSize=256m -
XX:+DisableExplicitGC -XX:+UseConcMarkSweepGC -XX:+CMSParallelRemarkEnabled -
XX:CMSInitiatingOccupancyFraction=75 -XX:+ScavengeBeforeFullGC -
XX:+CMSScavengeBeforeRemark -Dbase.dir=/var/opt/flexnetls/IPICO -jar flexnetls.jar --
service --systemd-logging
6. Check the status of License Server:
./flexnetlsadmin.sh -server http://127.0.0.1:7070/api/1.0/instances/~ -status
For example:
root@instance1:/flexnetls-i86_linux-2017.02.0/enterprise# ls
5254004A8B61_1.bin backofficeofflinesynctool flexnetlsadmin.sh
5254004A8B61.bin flexnetlsadmin.jar serverofflinesynctool
root@instance1:/flexnetls-i86_linux-2017.02.0/enterprise# ./flexnetlsadmin.sh -server
http://127.0.0.1:7070/api/1.0/instances/~ -status
Copyright (c) 2015-2016 Flexera Software LLC. All Rights Reserved.
(version) Version : 2017.02
(buildVersion) Build Version : 198983
The server is in active state.
Server: http://127.0.0.1:7070/ active
Backup Server: Not configured
BackOffice Server:
RecordsPendingSync : 0
Time elapsed since last sync: Sync to the back-office pending

8 © 2021 IP Infusion Inc. Proprietary


CHAPTER 2 Setting up a Floating License on License Server

This chapter shows how to create and activate a floating license on License Server.

Create a Floating License


The steps below create and download a floating license.

1. Log on to https://ipinfusion.flexnetoperations.com/.

2. Click “Search Servers”, and then enter the MAC address of the License Server in the field “License Server ID”.
Specify the MAC address of the server computer which is its first available Ethernet address.
The MAC address must in upper case characters. In this example, the license is generated for the MAC address
“525400B18CC3”.

Figure 2-1: Search Servers

3. If the License Server entry does not already exist, click “Create Server” and provide the MAC address as shown
below and click “Create”.

© 2021 IP Infusion Inc. Proprietary 9


Setting up a Floating License on License Server

Figure 2-2: Create Server

4. Click Map License to map the SKU and the units.

Figure 2-3: View Server

5. The server entry is displayed under search results. Click the same to view the details.

Figure 2-4: View Server details

6. Click “Map license” to change the quantities or SKUs mapped. In the example below, 50 ENT_IPBASE SKUs are
added to the license file.

10 © 2021 IP Infusion Inc. Proprietary


Setting up a Floating License on License Server

Figure 2-5: Increasing the number of licenses


Note: Follow the same steps to increase quantities and add SKUs. Newly mapped quantities and SKUs are
added into the new license file along with the previously mapped SKUs and quantities.

7. Click “Generate License”. The license file will be downloaded.

Activate the Floating License on License Server


1. Copy the downloaded License “525400B18CC3.bin” to the License Server.
#/root/license_server_installtion/flexnetls-x64_linux-2017.02.0/enterprise/# ls
525400B18CC3.bin backofficeofflinesynctool current flexnetlsadmin.jar
flexnetlsadmin.sh serverofflinesynctool.
2. Activate the new license file on License Server.
./flexnetlsadmin.sh -server http://10.12.65.99:7070/api/1.0/instances/~ -activate -load
/root/license_server_installtion/flexnetls-x64_linux-2017.02.0/enterprise/
525400B18CC3.bin
3. Check the License Server status
#/root/license_server_installtion/flexnetls-x64_linux-2017.02.0/enterprise/# ./
flexnetlsadmin.sh -server http://127.0.0.1:7070/api/1.0/instances/~ -status
Copyright (c) 2015-2016 Flexera Software LLC. All Rights Reserved.

(version) Version : 2017.02


(buildVersion) Build Version : 198983

The server is in active state.

Server: http://127.0.0.1:7070/ active


Backup Server: Not configured
BackOffice Server:

RecordsPendingSync : 716

© 2021 IP Infusion Inc. Proprietary 11


Setting up a Floating License on License Server

Time elapsed since last sync: Sync to the back-office pending


4. Check the quantity mapped.
#/root/license_server_installtion/flexnetls-x64_linux-2017.02.0/enterprise/# ./
flexnetlsadmin.sh -server http://10.12.65.99:7070/api/1.0/instances/~ -licenses -
verbose
==================================================================
Feature ID Feature Name Feature Version Feature Count Used/Available
==================================================================
1 OCNOS-SP-MPLS 1.0 0/2
2 OCNOS-DC-IPBASE 1.3 1/11
3 OCNOS-ENT-IPBASE 1.3 2/0
4 OCNOS-OTN-IPBASE 1.3 0/1
33 OCNOS-ENT-IPBASE 1.3 0/50
==================================================================

Device Information:

-------------------------------------------------------------
Device Name Feature Registered(Used Count)
-------------------------------------------------------------
IPI-B86A9728A5C0 OCNOS-ENT-IPBASE(1)

IPI-80A235D258B5 OCNOS-DC-IPBASE(1)

IPI-20GSG02 OCNOS-ENT-IPBASE(1)

==================================================================

Total feature count : 67


Total feature count used : 3
Total uncounted features : 0
==================================================================

12 © 2021 IP Infusion Inc. Proprietary


CHAPTER 3 Installing a Floating License on a Switch

This chapter shows how to install the license on OcNOS using License Server. License Server is basically having pool
of floating licenses.
You can install license using License Server using following methods:
• Manual License Installation using License Server (command line)
• Automatic License Installation using License Server (ZTP/DHCP server)

Manually Install a License on a Switch


This process of license installation using License Server is fully based on commands.

1. Configure a License Server as described in Chapter 1, Setting up a License Server, and verify it is running on the
network where the switch is connected.

2. Make sure that the License server is reachable to all switches.

3. Uninstall the current license on the switch. An existing license on the switch must be released manually. Otherwise,
a new floating license cannot be installed. For example:
#license release
4. Give the license get pool command to download and install the license on the device:
license get pool http://<License server IP>fne/bin/capability vrf management
For example:
#license get pool http://10.12.65.99:7070/fne/bin/capability vrf management
Note: See the troubleshooting section in the installation guide.

5. Verify the license installation status using the show license command. This command also prints any errors that
occurred during license installation. For example:
#show license
License Type: Lease, Full edition
Remaining lease : 3649 day(s)
Node Identifier: B86A9728A5C0
Device Software : OCNOS-ENT-IPBASE
Note: “Lease, Full edition” means a permanent license that is automatically renewed.

6. To configure the license pool information for the switch, give the license pool command. For example:
(config)#license pool http://10.12.65.99:7070/fne/bin/capability vrf management

Automatically Install a License on a Switch


This process can be a fully automated installation of license to the device using License Server.
OcNOS gets the required License Server URL from the DHCP server. The License Server information is used to fetch
the license from License Server and the same is installed on the switch automatically.

© 2021 IP Infusion Inc. Proprietary 13


Installing a Floating License on a Switch

Note: The ability to get the License Server URL is not supported on Edgecore AS4610-54T switches.
Automatic license installation is only supported for versions of OcNOS that are provisioned to configure and fetch the
License Server details from a dhcpd.conf file.

1. Configure a License Server as described in Chapter 1, Setting up a License Server, and verify it is running on the
network where the switch is connected.

2. Configure a DHCP server with the License Server information in dhcpd.conf and verify it is running on the
network where the switch is connected as described in the OcNOS Installation guide.

3. Uninstall the current license on the switch. An existing license on the switch must be released manually. Otherwise,
a new floating license cannot be installed. For example:
>license release
Note: This step is not required for new installations.

4. Use the following options in the dhcpd.conf file for License Server:
option ocnos-license-server-info code 252 = text;
option ocnos-license-server-info <license-server-url>;
Example for IPv4:
option ocnos-license-server-info "http://10.12.65.89:7070/fne/bin/capability";
Example for IPv6:
option ocnos-license-server-info "http://[2001:db8:1f70::999:de8:7648:6e8]:7070/fne/
bin/capability";
5. Update the /etc/dhcp/dhcpd.conf file as below:
# DHCP Server Configuration file.
# see /usr/share/doc/dhcp*/dhcpd.conf.sample
# see 'man 5 dhcpd.conf'
#
option ocnos-license-server-info code 252 = text;
#For dell 3k boards
class "3K" {
match if substring (option vendor-class-identifier, 0, 29) = "onie_vendor:x86_64-
dell_s3000";
}
subnet 10.12.28.0 netmask 255.255.255.0 {
option routers 10.12.28.1;
# specify subnet-mask
option subnet-mask 255.255.255.0;
default-lease-time 5555;
max-lease-time 77777;
option ocnos-license-server-info "http://10.12.65.89:7070/fne/bin/capability";
pool {
allow members of "3K";
range 10.12.28.205 10.12.28.210;
option default-url = "ftp://10.12.16.15/pub/ocnos_image/DELL_S3048_ON-OcNOS-1.3.6.134a-
ENT_IPBASE-S0-P0-installer"; # location to pick up the build.
option ocnos-provision-url = "ftp://10.12.16.15/pub/ocnos_config/3K/ZebOS.conf"; #
location to pick up the conf file
}
}

14 © 2021 IP Infusion Inc. Proprietary


Installing a Floating License on a Switch

6. OcNOS automatically gets and installs the license from License Server at startup.

© 2021 IP Infusion Inc. Proprietary 15


Installing a Floating License on a Switch

16 © 2021 IP Infusion Inc. Proprietary


CHAPTER 4 License Server Command Reference

This chapter describes these commands:


• license get pool
• license pool
• license refresh
• license release

© 2021 IP Infusion Inc. Proprietary 7


License Server Command Reference

license get pool


Use this command to get the license for this device from a license server. This command generates the license for the
device using the device identifier.
Ensure that the IP address of the License Server is reachable from the device.
After running this command, you can immediately use the device without rebooting.
Note: If the device startup configuration is not restored, reboot the device after installing the license.
Note: This command downloads the license from the server first, and then attempts to install it. Now, License Server
decreases the available “license count” irrespective of its installation status as the device has consumed one
license. At this stage, the user shall use the “license release” command to release the acquired license, which
in turn increases the available license count at the license server side.

Command Syntax
license get pool URL (vrf management|)

Parameters
URL License server URL
vrf management Management VRF

Default
None

Command Mode
Exec mode

Applicability
This command was introduced in OcNOS-SP version 3.0.

Examples
>license get pool http://10.12.65.89:7070/fne/bin/capability vrf management

8 © 2021 IP Infusion Inc. Proprietary


License Server Command Reference

license pool
Use this command to configure the License Server URL. This setting is restored after a save and reboot.
Note: The license is automatically renewed after the lease period is over.
Use the no form of this command to remove a License Server URL.

Command Syntax
license pool URL (vrf management|)
no license pool

Parameters
URL License server URL
vrf management Management VRF

Default
None

Command Mode
Configure mode

Applicability
This command was introduced in OcNOS-SP version 3.0.

Examples
(config)#license pool http://10.12.65.89:7070/fne/bin/capability vrf management

© 2021 IP Infusion Inc. Proprietary 9


License Server Command Reference

license refresh
Use this command to refresh the device license from the pool of a license server. The device license is refreshed
immediately.
If the device does not have a license (license never installed or license previously released), this command causes an
error.

Command Syntax
license refresh

Parameters
None

Default
None

Command Mode
Exec mode

Applicability
This command was introduced in OcNOS-SP version 3.0.

Examples
For a node-locked license, you cannot “refresh” after a release.
#license release
#license refresh
%% license file (IPI-DEVICEID.bin) Not Found
#
If the license is configured using the license pool command and the license is released and then refreshed, the device
acquires the license again.
#license release
#license refresh
2020 Jan 29 10:37:00.320 : OcNOS : NSM : CRITI : [LICENSE_INFO_2]: license
acquired from URL http://10.12.17.139:7070/fne/bin/capability
#

10 © 2021 IP Infusion Inc. Proprietary


License Server Command Reference

license release
Use this command to release any type of license, node-locked or floating, on the device.
The device license is revoked immediately.

Command Syntax
license release

Parameters
None

Default
None

Command Mode
Exec mode

Applicability
This command was introduced in OcNOS-SP version 3.0.

Examples
>license release

© 2021 IP Infusion Inc. Proprietary 11


License Server Command Reference

12 © 2021 IP Infusion Inc. Proprietary


CHAPTER 5 License Server Troubleshooting

Table 5-1: License server troubleshooting

Symptom/ Error Solution

1) license server pool URL Failed to connect to license server Check if license server URL is reachable
2) license refresh (when license server is
configured)
3) license release

© 2021 IP Infusion Inc. Proprietary 13


License Server Troubleshooting

14 © 2021 IP Infusion Inc. Proprietary

You might also like