Contents

1   Description

This instruction describes how to install an Ericsson License Manager (ELIM) formatted license key file on the Managed Element (ME).

Once received from the Ericsson software supply organization, a license key file must be installed on the ME to enable the corresponding license key.

License Management (LM) supports the installation of license key files using the File protocol or the SSH File Transfer Protocol (SFTP). The File protocol is used to install a license key file stored in a local directory. SFTP is used to install a license key file from a remote server.

2   Procedure

2.1   Install License Key File Using the File Protocol

Prerequisites

• No documents are required.
• No tools are required.
• The following conditions must apply:
  • The licensed application is running on the ME and registered as a client of LM.
  • The filename and directory location of the ELIM formatted license key file are known.
  • The external host and user credentials (username and password) of the remote SFTP server are known. If a password is not provided, the server must support password-less logon.
  • An Ericsson Command-Line Interface (ECLI) session in Exec mode is in progress.

Steps

1. Is it necessary to transfer the ELIM formatted license key file from an external host to the ME?

   Yes: Continue with the next step.

   No: Proceed with Step 6.

2. Log on the ME to access a Linux® shell, for example:

   ssh <user>@<hostname> -p <port>

3. Choose a proper directory to download the license file on the ME, or create a new one. For example:

   cd /cluster/licenses

4. Transfer the license key file to the ME:

   sftp -P <port> <user>@<hostname>:/<directory>/<filename>

   For example:

   sftp -P 2222 hostuser1@host1:/home/hostuser1/new_licenses.xml

5. Exit the shell:

   exit

6. In ECLI, navigate to the KeyFileManagement Managed Object (MO), for example:

   >ManagedElement=NODE06ST,SystemFunctions=1,Lm=1,KeyFileManagement=1

7. Install the license key file, for example:

   (KeyFileManagement=1)>installKeyFile --uri "file:///cluster/licenses/new_licenses.xml" --password

   Note:  

   Adding a white space after --password causes the ECLI to prompt for the password interactively. A password is mandatory. If the file location is not password protected, enter a blank password. After entering the password, ECLI echoes the full command. Press Enter to execute.

   
   

   The system returns true if the operation is successful.

8. Verify that the license key file installation completed successfully:

   (KeyFileManagement=1)>show reportProgress, result

   The system returns result=SUCCESS if the license key file was installed successfully.

2.2   Install License Key File Using the SFTP Protocol

Prerequisites

• No documents are required.
• No tools are required.
• The following conditions must apply:
  • The licensed application must be running on the ME and registered as a client of LM.
  • The filename and directory location of the ELIM formatted license key file are known.
  • The external host and user credentials (username and password) of the remote SFTP server are known. If a password is not provided, the server must support password-less logon.
  • The SSH algorithms used for license key file installation over SFTP are configured in the ME. For more information on SSH algorithms, refer to the security documentation.
  • An ECLI session in Exec mode is in progress.

Steps

1. In ECLI, navigate to the KeyFileManagement MO, for example:

   >ManagedElement=NODE06ST,SystemFunctions=1,Lm=1,KeyFileManagement=1

2. Install the license key file, for example:

   (KeyFileManagement=1)>installKeyFile --uri "sftp://hostuser1@host1:2222/home/hostuser1/new_licenses.xml" --password

   Note:  

   Adding a white space after --password causes the ECLI to prompt for the password interactively. A password is mandatory. If the file location is not password protected, enter a blank password. After entering the password, ECLI echoes the full command. Press Enter to execute.

   
   

   The system returns true if the operation is successful.

3. Verify that the license key file installation completed successfully:

   (KeyFileManagement=1)>show reportProgress, result

   The system returns result=SUCCESS if the license key file was installed successfully.