License Reports
For supported software information, click here.
This article discusses licensing reports that you can generate on Versa Director. You can export reports to a local server, or you can email them.
Entitlement Summary Report
The entitlement summary report provides information about the number of CPEs and devices in a solution tier. An entitlement summary report includes the appliance name and the solution tiers associated with the appliance, and the number of licenses in each license state.
To view the entitlement summary report:
- Log in to Versa Director.
- Select the Administration tab in the top menu bar.
- Select Entitlement Manager
> Summary
in the left menu bar. - Click the
Export icon.
- Enter the directory location and filename in which to save the report. After the report is downloaded, the message Report Exported Successfully displays.
The following is an example of a summary report for Releases 21.1.1 and later. The table describes the subscription report fields.
| Field | Description |
|---|---|
| Solution Tier (Column B) | Solution tier for the organization and for each VOS device in the organization. |
| Total (Columns C and E) | Total number of VOS devices associated with the solution tier, for active licenses (Column C) and terminated licenses (Column E). |
| Bandwidth (Columns D and H) | Bandwidth tier associated with the VOS device, in Mbps, for active licenses (Column C) and terminated licenses (Column E). |
The following is an example of a summary report for Releases 21.1.0 and earlier. The table describes the subscription report fields.
| Field | Description |
|---|---|
| Solution Tier (Column B) | Solution tier for the organization and for each VOS device in the organization. |
| Total (Columns C and E) | Total number of VOS devices associated with the solution tier, for trial licenses (Column C), active licenses (Column D), suspended licenses (Column E), and terminated licenses (Column F). |
| Bandwidth (Columns D and H) | Bandwidth tier associated with the VOS device, in Mbps. |
Query Report
The query report shows each subscription event that has occurred for CPEs and devices. Each single report traces the life of a subscription.
A query report provides the following information:
- Organization ID, organization name, and solution tier associated with a device
- Device subscription information, including license state and the time that the license state changed
To view the query report:
- Log in to Versa Director.
- Select the Administration tab in the top menu bar.
- Select Entitlement Manager > Query
in the left menu bar. - Click the Export icon.
- Enter the directory location and filename in which to save the report. After the report is downloaded, the message Report Exported Successfully displays.
The following is an example of a query report for Releases 21.1.1 and later. The table describes the subscription report fields.
| Field | Description |
|---|---|
| Versa Director License | License information about the Versa Director on which the report was generated. |
| Licensed CPE | Maximum number of VOS devices (excluding Controller nodes) that can be onboarded by the Director node based on its license. |
| Active CPE |
Actual number of VOS devices (excluding Controller) Nodes already onboarded by the Director node. |
| SUID | Subscription user ID assigned by Versa Director, which is a combination of the VOS device UUID and the organization UUID. |
| Appliance UUID | Unique ID generated by Versa Director for the VOS device. |
| Name | Name of the VOS device. |
| Location | Location of the VOS device. |
| Organization UUID | Unique identifier of the organization. |
| Organization Name | Name of the organization to which the VOS device belongs |
| Solution Tier | Solution tier for the VOS device. |
| Provisioned Bandwidth |
For SD-WAN or vCPE device, bandwidth assigned to the VOS device. For SASE, number of users licenses assigned to the organization. |
| Used Bandwidth | Bandwidth used by the VOS device, in Kbps. |
| Start Date | Subscription start date, which is when the VOS device was activated. |
| End Date | Date and time when the subscription was deactivated. If you do not renew the description manually after the end date, it is renewed automatically. |
| License Period | Time period, in years, for which the license is valid. |
| Changed At | Date and time when any modification were made in subscription fields. |
| Event | Events that occurred on VOS device during the subscription period. |
The following is an example of a query report for Releases 21.1.0 and earlier. The table describes the subscription report fields.
| Field | Description |
|---|---|
| Versa Director License | License information about the Versa Director on which the report was generated. |
| Licensed CPE | Maximum number of VOS devices (excluding Controller nodes) that can be onboarded by the Director node based on its license. |
| Active CPE |
Actual number of VOS devices (excluding Controller) Nodes already onboarded by the Director node. |
| SUID | Subscription user ID assigned by Versa Director, which is a combination of the VOS device UUID and the organization UUID. |
| Appliance UUID | Unique ID generated by Versa Director for the VOS device. |
| Name | Name of the VOS device. |
| Location | Location of the VOS device. |
| Is Primary |
Whether the device is the primary device:
|
| Organization UUID | Unique identifier of the organization. |
| Organization Name | Name of the organization to which the VOS device belongs |
| Solution Tier | Solution tier for the VOS device. |
| Bandwidth | Bandwidth used by the VOS device, in Kbps. |
| Analytics Enabled |
Whether Versa Analytics is enabled:
|
| Changed At | Date and time when any modification were made in subscription fields. |
| Changed State | Actions that occurred on VOS device during the subscription period. |
| Appliance Type |
Type of the VOS device:
|
| Appliance Owner | Whether the organization is the VOS device owner. |
Entitlement Subscription Report
The entitlement subscription report, which identifies chargeable events, is generated every month. You can use it to generate invoices.
To view the entitlement subscription report:
- Log in to Versa Director.
- Select the Administration tab in the top menu bar
- Select Entitlement Manager> Subscription Report
in the left menu bar. - Click the
Download icon in the Entitlement Report column.
- Enter the location and filename in which to save the report. After the report is downloaded, the message "Report Exported Successfully" displays.
The following is an example of an entitlement subscription report for Releases 21.1.1 and later. The table describes the subscription report fields.
| Field | Description |
|---|---|
| Versa Director License | License information of the Versa Director on which the report was generated. |
| Licensed CPE | Maximum number of VOS devices (excluding controller) that can be onboarded in Director as per license procured. |
| Active CPE |
Actual number of VOS devices (excluding controller) already onboarded in Director. |
| Month | Month and two-digit year for which the report was generated. |
| Unique Identifier |
Unique ID generated by Versa Director for the VOS device. |
| Appliance Name | Name of the VOS device. |
| Organization ID | Unique identifier of the organization. |
| Organization Name | Name of the organization to which the VOS device belongs. |
| Event Time |
Time of subscription event that occurred on the VOS device when a subscription was generated or updated. |
| Event Type |
Type of subscription event, such as automatically activated, manually activated, modified, or expiring. |
| Current Solution Tier and Bandwidth | Current VOS device solution tier and bandwidth when the report was generated, in Mbps per user. |
| Old Solution Tier and Bandwidth | Previous VOS device solution tier and bandwidth when the report was generated, in Mbps per user. |
| Current Status | Current status of the subscription license. |
| Days Since Activated on the Day of Event | How long the device remained in the active state after a subscription event occurred. You can use this number to calculate adjustments to the license fee when the solution tier for a license changes. |
| Multiple Events |
Whether multiple events for the same CPE occurred during the period:
|
| License Period | Time period for which the license is valid, in years. |
| User | Users who triggered the subscription actions for the VOS device. |
The following is an example of an entitlement subscription report for Releases 21.1.0 and earlier. The table describes the subscription report fields.
| Field | Description |
|---|---|
| Versa Director License Key | License key of the Versa Director on which the report was generated. |
| Month | Month and two-digit year for which the report was generated. |
| Unique Identifier |
Unique ID generated by Versa Director for the VOS device, in the format VOS-device-name organization-name or VOS-device-UUID organization-UUID. |
| Tenant Name | Name of the tenant (organization). |
| Organization ID | Unique identifier of the organization. |
| Organization Name | Name of the organization to which the VOS device belongs. |
| Event Time |
Time of subscription event that occurred on the VOS device when a subscription was generated or updated. |
| Event Type |
Type of subscription event, such as automatically activated, manually activated, modified, or expiring. |
| Current Solution Tier and Bandwidth | Current VOS device solution tier and bandwidth when the report was generated, in Mbps per user. |
| Old Solution Tier and Bandwidth | Previous VOS device solution tier and bandwidth when the report was generated, in Mbps per user. |
| Current Status | Current status of the subscription license. |
| Is Primary |
Whether the device is the primary device:
|
| Days Since Activated on the Day of Event | How long the device remained in the active state after a subscription event occurred. You can use this number to calculate adjustments to the license fee when the solution tier for a license changes. |
| Is Analytics |
Whether Versa Analytics is enabled:
|
| Multiple Events |
Whether multiple events for the same CPE occurred during the period:
|
| User | Users who triggered the subscription actions for the VOS device. |
Entitlement Usage Report
The entitlement usage report lists information about all services deployed, the solution tier for each Versa Operating SystemTM (VOSTM) device in an organization, and the provisioned and used bandwidth. This report provides proof of entitlement, and Versa uses the report to check compliance.
The entitlement usage report provides the following information:
- Services deployed
- Solution tier for each VOS device in an organization
- Provisioned and used bandwidth
- Out of compliance—Whether the bandwidth usage was more than the assigned bandwidth
- Month and year for which this report was generated
To view the usage report:
- Log in to Versa Director.
- Select the Administration tab in the top menu bar.
- Select Entitlement Manager> Subscription Reportin the left menu bar.
- In the Usage Report column, click the
Download icon.
- Enter the location and filename in which to save the report. After the report is downloaded, the message "Report Exported Successfully" displays.
The following is an example of an entitlement usage report. The table describes the subscription report fields.
| Field | Description |
|---|---|
| Month | Month and two-digit year for which the report was generated. |
| Appliance Name | Name of the VOS device. |
| Appliance UUID | Unique ID generated by Versa Director for the VOS device. |
| Tenant Name | Name of the tenant (organization). |
| Provisioned Bandwidth | Bandwidth used by the VOS device, in Mbps. |
| Peak Usage |
Highest amount of bandwidth used by the VOS device. If the Director license year is earlier than 2018 and if the VOS release is Release 20.2 or earlier, the used bandwidth of the VOS device is calculated in Kbps as the peak usage. |
| Tx Peak Usage | Highest transmitted amount of bandwidth used by the VOS device. If the Director license year is 2018 or earlier and if the VOS release is Release 20.2 or earlier, the VOS device bandwidth is calculated in Kbps as the peak transmit usage. |
| Rx Peak Usage | Highest received amount of bandwidth used by the VOS device. If the Director license year is 2018 or earlier and if the VOS release is Release 20.2 or earlier, the VOS device bandwidth is calculated in Kbps as the peak transmit usage. |
| Out of Compliance |
Whether the bandwidth usage is more than the assigned bandwidth:
|
Email Subscription Reports
Subscription reports are generated on the first three days of each month. After the reports are generated, you can email them.
To email reports:
- Log in to Versa Director.
- Select the Administration tab in the top menu bar.
- Select Entitlement Manager > Subscription Email
in the left menu bar.
- Click the
Add icon. - In the Add Subscription Email popup window, enter the email address.
- Click OK.
Supported Software Information
Releases 20.2 and later support all content described in this article, except:
- For Releases 21.1.1 and later, Is primary and analytics details are not supported in Query and Entitlement Usage reports and the entitlement subscription report displays the license period.