.. _license-audit: License Auditing ----------------- .. _23.3|VOSS-1213: Overview ......... Insights integrates with the VOSS Cloud Licensing service to provide license auditing capabilities that allows you to view and inform VOSS of your license usage counts across various services and devices, including Cisco Unified Communications Manager (CUCM), Webex, Zoom, and Microsoft Teams. A backend service on the Arbitrator detects probes already configured for CUCM, UCCE, UNITY, Webex, and MS Teams devices, and automatically retrieves the user accounts for the respective services. Insights ships with resource files for the following views, which allow you to create dashboards that display user license counts for your system: * data_user_view * standalone_count_view * meeting_room_count_view .. image:: /src/images/license-counts.png The license auditing service generates a file that can be automatically sent to the VOSS Cloud Licensing service for processing. .. note:: If you prefer to opt out of the automated license delivery mechanism, you will need to manually upload the license user count details to VOSS. See :ref:`alternative-to-registration-with-voss-cloud-license-service` .. rubric:: Related topics * :ref:`license-tab` .. _register-with-cloud-license-service-and-upload: Register with the VOSS Cloud Licensing Service and Upload License File .......................................................................... This procedure registers your organization for syncing with the VOSS Cloud Licensing service, and optionally, allows for the license file to be automatically uploaded to the VOSS Customer Portal. Alternatively, once you've registered, you can manually upload the license file. Registering allows licensed user counts to be added to a file that is generated on Insights Arbitrator. These files are generated daily. .. rubric:: Before you start * Open the following ports to communicate with the VOSS Customer Portal at `voss.portalshape.com/` * Default HTTP: port 80 * Default HTTPS: port 443 * Add the host name to an allowlist for trusted servers: `platform.voss-solutions.com` .. note:: If your system is unable to reach external sites on the internet, you can use a proxy server that you set up on the Arbitrator (via **Configuration > Archive Management > Configuration Management > Proxy tab**) .. rubric:: Register and upload license file 1. Log in to Arbitrator as administrator, then click the toolbar **Wrench** icon (System Configuration) to open the **Configuration** GUI. 2. Click **Archive Management**, then on the **Archive Management** page, select the **License** tab. 3. Fill out your organization ID, your environment type (for example, staging, trial, or lab), and optionally, a device description. .. note:: You can obtain your organization ID from the VOSS Customer Portal. Registration and file upload fails if the organization ID is incorrect. 4. To allow automatic upload of generated license file to the VOSS Customer Portal, set the value of the **enabled** drop-down to ``true``. .. note:: If you wish to opt out of automatic file uploads, set the value to ``false`` (default). 5. Click **Save** to generate the license file for the organization ID you provided. 6. (Optional) On the **License** tab, click **Fetch License File**. .. note:: Clicking **Fetch License File** before saving triggers an error as the license file won't have been generated yet. To view the content of the license file you can click **View Output**. .. image:: /src/images/arb-config-archive-license.png .. _alternative-to-registration-with-voss-cloud-license-service: Alternative to registering with the VOSS Cloud Licensing Service .................................................................. If you're unable to register with the VOSS Cloud Licensing service for usage reporting, you'll need to provide the license audit files to VOSS. This procedure allows you to retrieve the required files, which you can then provide regularly as agreed with your VOSS account team and commercial agreement. .. note:: The registration method is preferred since it automates this process. .. rubric:: Download the file and submit it to VOSS: 1. Copy the last part of the path that appears below the **Fetch License File** button (``license/latest.csv``). See :ref:`register-with-cloud-license-service-and-upload` 2. Append the copied text to your system IP address in a URL (in a new tab). 3. The license file downloads as a `.csv` file. 4. Provide the file to the destination provided by your VOSS account team (typically email alias). .. rubric:: Related Topics * .. raw:: latex Archive Management (Proxy) in the Insights Arbitrator Administration Guide. .. raw:: html Archive Management - Proxy Tab