Manage Licenses

This section contains the following topics:

Smart Licensing in Crosswork Network Controller

Cisco Smart Licensing is the licensing model that Crosswork Network Controller uses to register product usage, reserve licenses, and report license compliance through Cisco Smart Software Manager (CSSM).

Crosswork Network Controller supports two licensing paths:

  • Online licensing: Crosswork connects to CSSM, CSSM On-Prem, or CSSM through an HTTP/HTTPS gateway.

  • Offline reservation: Crosswork uses Specific License Reservation (SLR) when the deployment cannot connect to CSSM regularly.

Licensing lifecycle

The Crosswork licensing lifecycle includes these states:

  • Evaluation mode: Crosswork starts a 90-day evaluation period when the Smart Licensing service becomes active and licensing is not yet registered or reserved.

  • Initial registration or reservation: Register online or complete offline reservation before the evaluation period ends.

  • Licensed operation: Crosswork reports license usage and displays the registration and authorization status on the Smart Licenses page.

  • Out-of-compliance status: Crosswork reports out-of-compliance status when the associated Smart Account or Virtual Account does not include enough licenses, the correct license tier, or the required license type for current usage.


Note

Evaluation Expired is the licensing state that blocks access to Crosswork features. After registration or reservation is complete, out-of-compliance status does not block users from using Crosswork Network Controller.

License usage reporting

Crosswork Network Controller reports the licenses that the deployment uses. CSSM compares the reported usage with the licenses that are available in the associated Smart Account or Virtual Account.

Current Crosswork Network Controller consumption-based licensing is based on device Right-to-Manage (RTM) license counts.

External licensing resources

Use these resources for licensing information that is outside the Crosswork Network Controller user interface:

Lab system licenses

Use this information when you need licenses for a lab deployment.

Lab licenses follow the same product behavior as production licenses in Crosswork Network Controller.

  • Engineering does not implement lab licenses differently in the product.

  • Use the Cisco account team or Cisco partner process to obtain lab licenses.

  • Deposit lab licenses in a separate Virtual Account from production licenses.

  • Do not treat lab licensing as an extension of the 90-day evaluation period.

Crosswork Change Automation and Health Insights license guidance

Use this information if your deployment includes Crosswork Change Automation and Health Insights licenses from an earlier purchase.

New Crosswork Change Automation and Health Insights licenses cannot be purchased. Existing Crosswork Change Automation and Health Insights customers must work with the Cisco account team and Cisco Customer Experience if they need to renew, replace, or change an existing Crosswork Change Automation and Health Insights license.

Plan Crosswork licenses

Use this task before you register or reserve Crosswork licenses. Planning helps align the licenses in Cisco Smart Software Manager (CSSM) with the package tier, functions, and devices that the deployment uses or plans to use.

Online registration reports current usage to CSSM. Offline reservation requires you to select the licenses that the deployment needs before you generate and install the authorization code.

Procedure

Step 1

Identify the Crosswork Network Controller tier that is installed.

Crosswork Network Controller is available in Essentials, Advantage, and Premier tiers. Use the Cisco Crosswork Network Controller data sheet as the source of truth for the functions in each tier.

If the deployment uses a function that requires a higher tier than the licenses available in the Smart Account or Virtual Account, Crosswork reports out-of-compliance status for the required tier.

Note

 

Do not mix license tiers across device subsets. Use device licenses that align with the installed Crosswork Network Controller tier.

Step 2

Identify the required Right-to-Use (RTU) licenses.

Every deployment needs one Crosswork Network Controller RTU license. If the deployment uses geo redundancy, it also needs the geo redundancy license.

Step 3

Identify the required device Right-to-Manage (RTM) licenses.

RTM licenses are consumption-based licenses for managed devices. Plan RTM licenses by device count, device type, and license tier.

Device categories include Type A, Type B, and Type C. These categories are based on device characteristics such as the number of ports and card slots.

Plan Cisco device RTM licenses and third-party device RTM licenses separately.

Note

 

For exact device type categorization and ordering guidance, use the ordering guide or work with your Cisco account team or Cisco partner.

Step 4

Identify other licensed functions used by the deployment.

If the deployment forwards telemetry or alarms to an external collection point or external consumer, include the external application endpoint license in the license plan.

Step 5

For offline reservation, select licenses based on planned usage.

The Smart Licenses page shows current usage. If the deployment has not yet added all planned devices, reserve the licenses that match the planned deployment, not only the licenses currently shown as used.

For example, if the page shows one RTU license and eight RTM licenses in use, reserve at least those licenses. If the deployment currently uses eight RTM licenses but will manage 50 devices, reserve the RTM licenses required for 50 devices.

Step 6

After licensing is complete, review compliance when usage changes.

Review license compliance after you add devices, enable licensed functions, change package tiers, or complete an upgrade.

Crosswork Network Controller does not warn users before the deployment reaches the entitlement limit in CSSM. Users may first learn about a shortage when Crosswork reports out-of-compliance status.

If multiple Crosswork Network Controller deployments use the same Smart Account or Virtual Account, CSSM tracks the aggregate license consumption for that account. Make sure that the total license consumption across the deployments does not exceed the licenses available in the account.

View license usage and device license types

Use this task to understand the license usage that Crosswork reports and to find the Type A, Type B, or Type C license type for an onboarded device.

The Smart Licenses page shows current Crosswork license usage. It does not show every entitlement in the Smart Account or Virtual Account.


Note

Some entitlements, such as Segment Routing Path Computation Element (SR-PCE) licenses, are visible in Cisco Smart Software Manager (CSSM) but are not reported in the Crosswork Smart Licenses page.

Procedure

Step 1

Choose Administration > Smart Licenses.

Step 2

Review the registration status and license authorization status.

Use these fields to determine whether Crosswork is in evaluation mode, registered, reserved, authorized, out of compliance, or evaluation expired.

Step 3

Review the license usage table.

Right-to-Use (RTU) rows show function-level or application-level license usage. Right-to-Manage (RTM) rows show managed-device license usage by tier and device type.

Step 4

Open Device Lifecycle Management and view the details for an onboarded device.

The device details include the license type that Crosswork uses for the device. Use this value to understand whether the device is counted as Type A, Type B, or Type C.

Step 5

Open CSSM to view all entitlements in the Smart Account or Virtual Account.

Use CSSM when you need to see account-level entitlements, remaining quantities, or licenses that are not shown in the Crosswork user interface.

Prepare license entitlements for an upgrade

Use this task before you upgrade from Crosswork Network Controller 6.0 or an earlier release to Release 7.0 or a later release.

License entitlements can change between releases. A deployment can become out of compliance after upgrade if the Smart Account or Virtual Account contains older entitlements but the upgraded product reports target-release license usage.

Procedure

Step 1

Before the upgrade, identify the Crosswork Network Controller release that you are upgrading from and the release that you are upgrading to.

Step 2

Confirm that the Smart Account or Virtual Account includes entitlements for the target release.

For example, older release-specific Right-to-Manage (RTM) entitlements might not satisfy Advantage RTM usage reported by a later release.

Step 3

If the required target-release entitlements are missing, work with your Cisco account team, Cisco partner, or Cisco Technical Assistance Center (TAC) before you complete the upgrade.

Step 4

After the upgrade, register or re-register Crosswork licensing as required by the upgrade workflow.

License tags are not automatically registered as part of the upgrade operation. Register them manually after the upgrade.

What to do next

Review the Smart Licenses page after the upgrade to confirm the registration and authorization status.

Configure Smart Licensing transport settings

Use this task only for online or connected licensing. Offline reservation does not use transport settings.

Before you begin

Make sure that Crosswork Network Controller is not in the Registered state. You must de-register before you can modify transport settings.

Procedure

Step 1

Choose Administration > Smart Licenses.

Step 2

In Transport settings, click View/Edit.

Step 3

Select the transport mode.

Cisco Smart Software Manager (CSSM) receives online license usage from Crosswork Network Controller.

Table 1. Transport modes

Mode

Description

Direct

Crosswork Network Controller connects directly to CSSM.

On-prem Smart Software Manager

Crosswork Network Controller communicates through CSSM On-Prem.

HTTP/HTTPS gateway

Crosswork Network Controller communicates with CSSM through an intermediate proxy server.

Step 4

Enter the required information for the selected transport mode.

Step 5

Click Save.

What to do next

Register Crosswork Network Controller with CSSM by using the online registration task.

Register Crosswork online

Use this task when Crosswork Network Controller can communicate with Cisco Smart Software Manager (CSSM), CSSM On-Prem, or CSSM through an HTTP/HTTPS gateway.

Before you begin

  • Create or identify the Smart Account and Virtual Account that contain the required Crosswork licenses.

  • Generate a product instance registration token in CSSM.

  • Configure Smart Licensing transport settings in Crosswork.

Procedure

Step 1

Choose Administration > Smart Licenses.

Step 2

In the Smart Software Licensing information box, click Register.

Step 3

In the Smart Software Licensing Product Registration dialog box, select Register via token.

Step 4

In Product instance registration token, enter the registration token from CSSM.

Make sure that the token ID is accurate and within its validity period.

Step 5

If you are re-registering an existing product registration, select Re-register this product registration if it is already registered.

Use this option after backup restore, disaster recovery, data migration, or upgrade when the Crosswork virtual machine was already registered when the backup was taken or when licensing must be re-associated after the operation.

Note

 

Do not select this option for a new installation.

Step 6

Click Register.

When registration completes, the registration status changes to Registered and the license authorization status changes to Authorized.

Crosswork Network Controller is registered with CSSM and can report license usage through the configured transport path.

Manage online license registration and authorization

Use this task after online registration when registration or authorization renewal requires manual action, or when you must de-register the product.

These actions apply to online or connected licensing. They are not part of the normal first-time registration workflow.

Before you begin

Make sure that the product is in the Registered state.

Procedure

Step 1

Choose Administration > Smart Licenses.

Step 2

Click Actions and select the required action.

Table 2. Online licensing actions

Action

Use case

Renew Authorization

Use this action when automatic authorization renewal fails.

Renew Registration

Use this action when automatic registration renewal fails.

Re-register

Use this action after backup restore, disaster recovery, data migration, upgrade, or token expiration when the product must be registered again.

De-register

Use this action before you change transport settings or disconnect the product from the current registration.

After de-registration, Crosswork returns to evaluation mode if evaluation time remains. If the evaluation period has expired, Crosswork enters Evaluation Expired mode.

Reserve Crosswork licenses offline

Use this task for disconnected or highly secure environments. Offline reservation uses a Reservation Request Code from Crosswork and an Authorization Code from Cisco Smart Software Manager (CSSM).

Before you begin

  • Create or identify the Smart Account and Virtual Account that contain the required Crosswork licenses.

  • Plan the Right-to-Use (RTU) and Right-to-Manage (RTM) licenses that the deployment needs.

Procedure

Step 1

Choose Administration > Smart Licenses.

Step 2

In the Smart Software Licensing information box, click Register.

Step 3

In the Smart Software Licensing Product Registration dialog box, select Register via Reserved License.

Step 4

Under Reservation code, click Generate, and then copy the Reservation Request Code.

Step 5

In CSSM, generate the Authorization Code.

  1. Log in to CSSM and select the appropriate Virtual Account.

  2. Choose Licenses > License Reservation.

  3. Paste the Reservation Request Code and click Next.

  4. On the Select Licenses page, select the RTU licenses and RTM licenses that the deployment uses or plans to use.

  5. On the Review and Confirm page, click Generate Authorization Code, and then copy the code.

Note

 

If the current Crosswork Smart Licenses page shows one RTU license and eight RTM licenses in use, select at least those licenses. If you plan to manage more devices than are currently onboarded, select the planned RTM count.

Step 6

Return to the Smart Software Licensing Product Registration dialog box in Crosswork.

Step 7

Select Paste authorization code, paste the Authorization Code, and click Register.

When reservation completes, the registration status changes to Registered and the license authorization status changes to Authorized.

Update an offline license reservation

Use this task after growth, additional device onboarding, additional licensed functionality, or correction of an incomplete offline reservation.

Offline reservation has one main change operation: update the reservation. Update the reservation when the deployment needs more licenses than were reserved.

Procedure

Step 1

Choose Administration > Smart Licenses, and note the Product Instance Name.

Step 2

In Cisco Smart Software Manager (CSSM), open the required product instance and choose Actions > Update Reservation.

Step 3

On the Select Licenses page, select the updated license reservation.

Step 4

On the Review and Confirm page, click Generate Authorization Code, and then copy the code.

Step 5

Return to Crosswork and choose Actions > Update Reservation.

Step 6

Paste the Authorization Code and click Update.

Crosswork generates a Confirmation Code.

Step 7

Copy the Confirmation Code from Crosswork and enter it in CSSM.

In CSSM, open the product instance and choose Actions > Enter Confirmation Code.

The license count is updated on the Smart Licenses page in Crosswork.

Disable an offline license reservation

Use this task to release reserved licenses from the current Crosswork instance.

Disable offline reservation when you switch to online licensing, decommission or replace a cluster, move a deployment to a different data center, or complete a forklift migration to a new Crosswork release.


Note

After the licenses are released, Crosswork moves to evaluation mode if evaluation time remains. If the evaluation period has expired, Crosswork moves to Evaluation Expired mode.

Procedure

Step 1

Choose Administration > Smart Licenses, and note the Product Instance Name.

Step 2

Click Actions, and then click Disable License Reservation.

Step 3

In the confirmation dialog box, click Confirm.

Crosswork generates a Reservation Return Code.

Step 4

Copy the Reservation Return Code.

Step 5

In Cisco Smart Software Manager (CSSM), remove the reservation from the required product instance.

  1. Log in to CSSM and select the appropriate Virtual Account.

  2. Navigate to the required product instance and choose Actions > Remove.

  3. Paste the Reservation Return Code and click Remove Reservation.

Step 6

Return to the Smart Licenses page in Crosswork and confirm that the registration status is Unregistered.

License authorization status

Use these tables to interpret the licensing state on the Smart Licenses page.

Table 3. License authorization status

Registration status

Authorization status

Description

Unregistered

Evaluation mode

Crosswork is in the 90-day evaluation period.

Unregistered

Evaluation Expired

Crosswork was not registered or reserved before the evaluation period ended. Smart Licensing remains available so that users can register or complete reservation.

Registered

Authorized

Crosswork is authorized to use the reported licenses. Authorization renews automatically.

Registered

Reserved

Crosswork is in compliance in offline reservation mode.

Registered

Out of Compliance

The associated Smart Account or Virtual Account does not include enough licenses, the correct license tier, or the required license type for current usage.

Registered

Not Authorized

Crosswork is out of compliance in offline reservation mode.

Registered

Authorization Expired

Crosswork cannot communicate with Cisco Smart Software Manager (CSSM) for 90 days or more, and authorization has expired.
Table 4. Authorization status responses

Registration status

Authorization status

Response

Registered

Out of Compliance

No action is enforced. Users can continue to use Crosswork while they correct the license entitlement, allocation, or reservation issue. Verify that the Smart Account or Virtual Account contains the required licenses. For offline reservation, update the reservation if current or planned usage exceeds the reserved licenses. Work with your Cisco account team, Cisco partner, or Cisco Technical Assistance Center if the required entitlements are missing or incorrect.

Registered

Not Authorized

No action is enforced. In offline reservation mode, update the reservation or correct the associated entitlements so that the reserved licenses match the deployment usage.

Unregistered

Evaluation Expired

Crosswork displays only the Smart Licensing window. The user interface remains blocked until registration or reservation is complete.