Activating Features
  • 03 Oct 2024
  • 3 Minutes to read
  • Contributors
  • PDF

Activating Features

  • PDF

Article summary

Legacy orchestrator uses feature activation keys to enable licensed functionality. Each key activates a separate feature set.

Activation keys are binary files that must be imported in the Legacy orchestrator web user interface in order to activate certain menu options. You can obtain the activation keys for your installation of Legacy orchestrator from Accedian Technical Support.

Features are activated in the Feature Activation page. This page is only visible to users with ROLE_ADMIN privileges. For more information about user privileges, see "Managing User Accounts".


Note: From release 23.04, all activation keys are preinstalled by default on Legacy orchestrator. Skip this section if using Legacy orchestrator 23.04.

Feature Activation page (Admin ▶ Feature Activation)
activating features.png

The following activation keys are available:

  • Commissioning: Enables the Discovery Trigger (see "Discovering Elements") and Configuration Jobs (see "Managing Configuration Jobs").
  • Inventory & Configuration Management: Enables firmware management and backup and restore functionality. Enables viewing of the Legacy orchestrator inventory of devices and managed objects.
  • Metrics Collection: Enables the Legacy orchestrator functionality related to collecting performance monitoring data. This includes the ability to configure the metrics collection agents on devices, to collect performance monitoring statistics and to push the statistics to Provider Connectivity Assurance or a 3rd-party system. See "Metrics Collection".
  • Web Services API: Enables Legacy orchestrator's northbound web services REST API. See "Programming Interfaces" for more information.
  • Service Performance: Enables the Legacy orchestrator functionality related to Service Activation Testing (SAT). This includes the ability to configure and launch Y.1564 and RFC 2544 tests from Legacy orchestrator. See "Service Performance".
  • SNMP API: Enables Legacy orchestrator's northbound SNMP interface, which is used to forward alarms from devices to third-party systems. See "Configuring Alarm Handling via SNMP".
  • Session: Enables the Legacy orchestrator functionality for creating and managing performance sessions. The supported session types are: TWAMP, Ethernet OAM, Echo and 2xOneWay. See "Performance Sessions".
  • Internal License Server: Enables the Legacy orchestrator functionality for creating and managing performance sessions without using a license server (SDLS).

In the Feature Activation page, administrators can:

  • View the list of features that are currently active and available in Legacy orchestrator
  • Activate features by importing keys
  • Deactivate features by removing keys.

The following table explains the information that is displayed for each feature in the list.

Feature Activation Management - Information Displayed

Column NameDescription
Product NameThe product and module enabled by this key.
VersionThe product version valid for this key​.

To import a feature activation key

  1. Obtain the appropriate key file from Accedian Technical Support.
  2. Save the key file on the local file system (for example, on the desktop) and extract this file.
  3. Access the Admin ▶ Feature Activation page.
  4. Click the Choose File button.
  5. Select the key file on your local file system from the file selector dialog.
  6. Click the Import button.

Here are some important points to note about keys:

  • Keys are in service as soon as they are imported. Users should either refresh their pages or log out and log in to the application to see the changes.
  • A specific key can only be imported once. Importing it a second time will cause an error message.
  • Keys are validated for format and content. Improperly formatted keys will result in an “ERROR_READING_FILE” message.
  • Keys are in service as soon as they are imported. However, to see the changes, the user must either refresh the page or log out of the application (next step) and log back in (next procedure).
  • An activation key with a name as "Legacy-orchestrator - Internal License server" will be used to inform Legacy orchestrator to not use a license server (SDLS) but still make its functions available as if there was a license server.
    • There will be no notification of expiration or violation of rights to use sessions. Once this key is imported, Legacy orchestrator will need to be restarted for this key to take effect.

To remove a feature activation key

  1. Access the Admin ▶ Feature Activation page.
  2. Select the key that you want to remove in the list.
  3. Click the Button_Remove_Generic.png button (above the list) to remove the feature.
  4. Click the Ok button to confirm.


Notes:

Keys are out of service as soon as they are removed from the list. Users should either refresh their pages or log out of Legacy orchestrator and log in again to see the changes.

An activation key with a name as "skylight-orchestrator - Internal License server" is removed. Legacy orchestrator will need to be restarted for this to take effect.


© 2024 Cisco and/or its affiliates. All rights reserved.
 
For more information about trademarks, please visit: Cisco trademarks
For more information about legal terms, please visit: Cisco legal terms

For legal information about Accedian Skylight products, please visit: Accedian legal terms and tradmarks



Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.