Model: device/spark/License

Webex Teams Licenses

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Webex Teams Feature Reference

This provides a condensed view of the Webex Teams Licenses consumed and available at the selected hierarchy level.

Click Webex Teams > Licenses to open the Webex Teams Licenses list view. The list view provides the following information:

Name (of the license)
Total Units (total number of licenses available)
Consumed Units (the number of licenses still available)
Location (where the licenses are available and used)

Webex Teams license usage counts are't automatically updated in VOSS-4-UC after licenses are assigned (that is, after assigning a subscriber with Webex Teams services). For this reason, it is recommended that you create a schedule to periodically sync Webex Teams user licenses.

Webex Teams user license syncs may be actioned manually:

Admin Portal

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

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

Business Admin Portal On the Webex Teams Quick Actions card at the customer hierarchy, select Sync Licenses.

Important

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

Execute the Data Sync named SyncSparkRolesLicenses<CUSTOMER_NAME>.
If the Webex Teams organization associated with the Customer hierarchy has multiple Subscriptions, a default Subscription must be configured under the Webex Teams Customer Access.

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

See: Create Webex Teams Service.

Only licenses synced and managed by VOSS-4-UC 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.

Webex App Licenses

Full HTML Help

Webex App license usage counts are automatically updated in VOSS 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 actioned 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 Data Sync named 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 VOSS 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.

View Webex App Licenses

This procedure provides a condensed view of the Webex App licenses consumed and available at the selected hierarchy level.

Go to (default menus) Cisco Webex App > Licenses.
View Webex App license details in the License list view:
- Name (of the license)
- Site URL (webex hub)
- Site Type (for example: Control Hub managed site)
- Subscription ID (ID - useful to distinguish licenses with similar names)
- Total Units (total number of licenses available)
- Consumed Units (the number of licenses still available)
- Location (where the licenses are available and used)

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
Site URL																																			Field Name: siteUrl Type: String
Site Type																																			Field Name: siteType Type: String
Subscription ID																																			Field Name: subscriptionId Type: String