Model: device/spark/License

Webex License Inventory

Tip

Use the Action search to navigate Automate

Overview

Webex App license usage counts are automatically updated in Automate after licenses are assigned (that is, after assigning a subscriber with Webex App services). A sync with the Webex Control Hub maintains the status of Webex App user licenses.

Webex App license syncs

Webex App user license syncs may be executed manually:

Admin Portal

To sync Webex App users for the customer, click the Services menu, then on the Customer Access form, click Action > Sync Webex App Roles Licenses

Go to (default menu) Administration Tools > Data Sync and run the SyncSparkRolesLicenses<customer_name> instance.

Important

Webex App Licenses need to be synced after upgrading to release 21.1:

Execute the following data sync: SyncSparkRolesLicenses<CUSTOMER_NAME>
If the Webex App organization associated with the Customer hierarchy has multiple subscriptions, a default subscription must be configured under the Webex App Customer Access.

See: Create Webex App Service.
If the Webex App organization associated with the Customer hierarchy has multiple Site URLs, a default Site URL must be configured under the Webex App Customer Access.

See: Create Webex App Service.

Only licenses synced and managed by Automate will be assignable to a Webex user. This means that licenses from subscriptions and sites other than the default configured above will not be retained on a user.

Note

This process only collects data at customer and site levels.

Model Details: device/spark/License

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title															Description																				Details
License Id																																			Field Name: id Type: String
Unique Name																																			Field Name: unique_name Type: String
Name																																			Field Name: name Type: String
Consumed Units																																			Field Name: consumedUnits Type: Integer
Total Units																																			Field Name: totalUnits Type: Integer
Licenses Used %																																			Field Name: LicensesUsedPercentage Type: Number
Site URL																																			Field Name: siteUrl Type: String
Site Type																																			Field Name: siteType Type: String
Subscription ID																																			Field Name: subscriptionId Type: String