AOS Feature Licensing Instructions

Version 22

    The following topics are provided to guide you through licensing additional AOS features on an existing AOS unit.

    The prerequisites listed in Pre-Licensing Requirements must be met before you can successfully complete this process.

    Complete and detailed instructions are provided in the Licensing AOS Features Quick Start Guide.

     

    Process Overview:

     

    Pre-Licensing Requirements

    To complete the licensing process on an AOS unit, you must meet the following requirements:

    • Have installed AOS firmware R11.8.0 or later.
    • Be a registered user at ADTRAN.com.
    • Have access to the AOS unit (via CLI or GUI) on which the new feature is being activated.
    • Have access to the AOS Licensing Portal located at www.adtran.com/AOSlicensing.
    • Have purchased an AOS license for the new feature.
    • Have received a confirmation email, which includes the Activation key(s).

     

    The following topics are provided to guide you through licensing additional AOS features on an existing AOS unit.

    Complete and detailed instructions are provided in the Licensing AOS Features Quick Start Guide.


    Step 1: Generate a License Request Key

    This step requires: Access to AOS unit (either CLI or GUI)

     

    IMPORTANTThe AOS unit must remain powered on through the duration of the licensing process. If the unit is rebooted or power cycled after the License Request key is generated, the key will no longer be valid and you will have to start the process from the beginning.

     

    The License Request key is a unique key generated by AOS which contains information about the unit that validates it for one-time use only. Once a license key has been installed, the License Request key is cleared and no longer valid.

     

    1.  To generate a License Request key, use either the CLI or the GUI instructions below. (For more detailed instructions on accessing the CLI or GUI of your device, refer to the Quick Start Guide that shipped with your unit.)


    Using the CLI

    a. Log into the AOS unit using Telnet or SSH.

    b. From the Enable Mode prompt, enter the command: license request key generate


    Using the GUI

    a.  Log into the GUI of the AOS unit.

    b.  Navigate to System > Licensing.

    c.  Select Generate from the License Request Key section of the menu.

     

    You will use the resulting License Request key to generate a license file from the AOS License Portal.

     

    2.  Using either the CLI or GUI, copy the License Request key by selecting the entire key and using the copy function (either through the browser or your terminal session with the AOS unit). Be sure to select the entire License Request key, including all dashes and text in the beginning and ending delimiters which identify the start of the license request key and the end. The following is an example License Request key:

     

    -----BEGIN LICENSE REQUEST KEY-----

    Q29uZ3Jlc3Mgc2hhbGwgbWFrZSBubyBsYXcgcmVzcGVjdGluZyBhbiBlc3RhYmxpc2htZW50IG9

    mIHJlbGlnaW9uLCBvciBwcm9oaWJpdGluZyB0aGUgZnJlZSBleGVyY2lzZSB0aGVyZW9mOyBvci

    BhYnJpZGdpbmcgdGhlIGZyZWVkb20gb2Ygc3BlZWNoLCBvciBvZiB0aGUgcHJlc3M7IG9yIHRoZ

    SByaWdodCBvZiB0aGUgcGVvcGxlIHBlYWNlYWJseSB0byBhc3NlbWJsZSwgYW5kIHRvIHBldGl0

    aW9uIHRoZSBHb3Zlcm5tZW50IGZvciBhIHJlZHJlc3Mgb2YgZ3JpZXZhbmNlcy4=

    -----END LICENSE REQUEST KEY-----

     

    3.  As soon as possible, proceed to Step 2: Log into the AOS Licensing Portal.

     

    IMPORTANTIt is important to use the License Request key as soon as possible to generate a license file from the

    AOS License Portal and complete the licensing process. Otherwise, the request key could be overwritten by

    generating a new License Request key on the AOS unit.

     

    Step 2: Log into the AOS Licensing Portal

    This step requires: Internet browser

     

    1.  Navigate to www.adtran.com/AOSlicensing.

     

    2.  Log in as a registered user. This can be a common user for your company or an individual account. The user you log in as will receive the email with the license file attached or you can download the license file from the AOS Licensing Portal. Ensure that you have either access to the email account or will be able to copy the contents of the downloaded license file to your AOS unit.

     

    3.  Select Add a New License Feature to Your AOS Device from the action list.

     

    Step 3: Generate a License File

    This step requires: Internet browser and Confirmation email

     

    1.  Paste the License Request key (from the AOS unit) into the appropriate field in the AOS Licensing Portal.

     

    2.  Copy the Activation key(s) from the confirmation email you received after purchasing your licensed AOS feature.

     

    IMPORTANTBe sure to use only the Activation key(s) for the feature(s) you intend to apply to the specific AOS unit from which the License Request key was generated. Your email confirmation may include more than one feature Activation key. Once the Activation key(s) is applied to a License Request key to generate a license file, it cannot be undone.

     

    3.  Paste the Activation key(s) into the appropriate field in the AOS Licensing Portal.

     

    4.  Select the Preview your License button. A summary screen is presented to allow you an opportunity to verify the features you are currently activating for the device from which the License Request key was generated. You should review this information to make sure it is correct before continuing.

     

    5.  Select the Generate your AOS License button. Once the license file is generated, it is emailed to the registered user and is available for immediate download. The license file is a text file and is named using the serial number of the AOS unit for which it was generated.

     

    6.  Retrieve the license file from the confirmation email or save the license file. You will need the contents of this file in the next step.

     

    Step 4: Install the License File

    This step requires: Access to AOS unit and the newly generated license file

     

    IMPORTANTThe AOS unit must remain powered on through the duration of the licensing process. If the unit is rebooted or power cycled after the License Request key is generated, the key will no longer be valid and you will have to start the process from the beginning.

     

    To complete the licensing process, you must install the license file on the AOS unit using either the CLI or the GUI instructions below.

     

    Using the CLI

    1.  From the AOS unit’s CLI, enter the following command and follow the prompts:

    >enable

    #license key install

    Enter the entire license key.  End with two consecutive

    carriage returns or the word "quit" on a line by itself:

     

    2.  Copy the contents of the license file by opening the license file in a text editor of your choice. Be sure to select all of the license file contents, including all dashes and text in the beginning and ending delimiters which identify the start of the license key and the end. For example:

     

    -----BEGIN LICENSE KEY-----

    License Serial Num:  12345678

    License Part Num:    1962SBCF50

    Device Serial Num:  LBADTN0000000

    -----BEGIN BODY-----

    RGV2aWNlU2VyaWFsTnVtPUxCQURUTjAwMDAwMDANCkxpY2Vuc2VWZXJzaW9uPWRvY3VtZW50YXRp

    b25fZGVtbw0KRW52ZWxvcGU9V2UgaG9sZCB0aGVzZSB0cnV0aHMgdG8gYmUgc2VsZi1ldmlkZW50

    LCB0aGF0IGFsbCBtZW4gYXJlIGNyZWF0ZWQgZXF1YWwsIHRoYXQgdGhleSBhcmUgZW5kb3dlZCBi

    eSB0aGVpciBDcmVhdG9yIHdpdGggY2VydGFpbiB1bmFsaWVuYWJsZSBSaWdodHMsIHRoYXQgYW1v

    bmcgdGhlc2UgYXJlIExpZmUsIExpYmVydHkgYW5kIHRoZSBwdXJzdWl0IG9mIEhhcHBpbmVzcy4=

    -----END BODY-----

    -----BEGIN AUTHENTICATION-----

    Rm91ciBzY29yZSBhbmQgc2V2ZW4geWVhcnMgYWdvIG91ciBmYXRoZXJzIGJyb3VnaHQgZm9ydGgg

    b24gdGhpcyBjb250aW5lbnQsIGEgbmV3IG5hdGlvbiwgY29uY2VpdmVkIGluIExpYmVydHksIGFu

    ZCBkZWRpY2F0ZWQgdG8gdGhlIHByb3Bvc2l0aW9uIHRoYXQgYWxsIG1lbiBhcmUgY3JlYXRlZCBl

    cXVhbC4=

    -----END AUTHENTICATION-----

    -----END LICENSE KEY-----

     

    IMPORTANTIf you are installing more than one license file on the same AOS unit, you must install them at the same time. Each license begins with -----BEGIN LICENSE KEY----- for easy identification.

     

    3.  Once the license file contents are pasted into the CLI, type quit or press the Enter key twice.

     

    Using the GUI

    If you plan to use the GUI to install the license file, you can upload the file that was generated in the previous step, or copy the contents of the file and paste it into the GUI.

     

    1.  To begin, navigate to System > Licensing.

     

    2.  Select either Option 1 or Option 2 as described below:

     

    Option 1: Upload the license file.

    a.  To upload the file, select Choose File from the Upload License File section of the menu.

    b.  Select Upload.

     

    Option 2: Copy the text from the license file and paste it into the GUI.

    a.  Open the license file in a text editor and copy the license text.

    b.  Return to the GUI and paste the text in the Upload License Text field provided.

    c.  Select Upload.

     

    3.  You will see a confirmation that the upload was successful.

     

    NOTE:  Once the license file is applied, some features may require the device be rebooted before they will take effect.


    Troubleshooting

    When generating and applying new features through the AOS Licensing process, there are errors that could occur on the Web Portal or on the AOS unit. The following tables identify some of the errors you may encounter and provide suggested actions to correct them.

     

    AOS License Portal Error Messages

    Error MessageCorrective Action
    Invalid Activation KeyVerify your activation key is correct. Compare the confirmation email received and the activation key used in the AOS Licensing Portal to confirm that they match.
    Invalid Request Key

    Verify your request key is correct. Verify the License Request key was generated from the correct AOS unit. License Request keys include information that link them to a specific AOS unit.

     

    Beginning and ending delimiters may have been omitted from the License Request key. Check the entry to make sure to include all dashes and text in the delimiters. Refer to the example in Step 1: Generate a License Request Key.

    This Activation Key has already been used on another device.

    Review existing activation keys on the AOS Licensing Portal. If the activation key has already been used to generate a License Request key on another device, you will not be able to use it again.

     

    To view your registered products and activation keys, go to View My Products & Licenses on the ADTRAN website and select Activation Keys.

     

    AOS Unit Error Messages

    Error Message Possible Causes and/or Corrective Action
    % Invalid license sentinelsCould result because some characters are missing in the entered or pasted text. Attempt to copy and paste the text a second time.
    % Translator: validateBase64Text FailureCould result because some characters are missing in the entered or pasted text. Attempt to copy and paste the text a second time.
    % License Verification Failure: License key does not match License Request keyLicense Request key of the unit does not match the one for which the license was generated. Generate a new License Request key and use it to generate a new license file on the AOS Licensing Portal.
    % Decryption Failure: failed to decrypt license payload

    Results from attempting to install a license on a different unit than the one for which it was generated. Verify you are installing the license on the correct AOS unit. If the unit is correct, generate a new License Request key and use it to generate a new license file on the AOS Licensing Portal.