.. _arbitrator-archive-management: Archive Management ----------------------- .. _SP23|New config screen added to allow customer ndx file retention times. Default is 6 months.: .. _SP23|New PRI and SIP Trunk probes for Cisco Voice Gateways. Please reference Arbitrator Cisco PRI and SIP Probe Configuration for instructions.: .. _SP25|Webex API support added (Requires Dashboard SP66 Release for visualization).: .. _22.1|VOSS-934: .. _22.1|EKB-12298: .. _22.2|EKB-13343: .. _23.1|EKB-13157: .. _23.1|EKB-15145: .. _23.1|VOSS-986: .. _23.1|VOSS-1153: .. _23.2|EKB-14142: .. _23.2|EKB-16510: .. _23.3|EKB-17216: .. _23.3|VOSS-1213: .. _23.3|EKB-18181: .. _23.3|EKB-18103: .. _24.1|EKB-18816: .. _24.2|EKB-21117: .. _24.2|EKB-20657: .. _25.1.1|EKB-23808: .. _25.1.1|EKB-23573: .. _25.4|EKB-26997: .. _25.4|EKB-27018: Overview ........... :bdg-info-line:`admin-users-only` The Arbitrator **Archive Management** page provides options for backing up and configuring the Arbitrator correlation platform. You can select the following tabs on this page: * :ref:`arb-archive-management-configuration-management` * :ref:`arbitrator-log-management` .. note:: Archive Management is only accessible to admin users. .. image:: /src/images/arb-archive-management.png .. _arb-archive-management-configuration-management: Configuration Management Tab .................................. You can select the following tabs on the Archive Management > Configuration Management tab: * :ref:`api-config-tab` * :ref:`arbitrator-archive` * :ref:`automate-datasource` * Cisco SDL Tab * :ref:`collect-tab` * Data User Tab * :ref:`arb-import-tab` * :ref:`ldap-tab` * :ref:`license-tab` * Probe Tab * :ref:`proxy-config` .. _api-config-tab: API Config Tab '''''''''''''' This tab allows you to set up a number of API configurations to enable monitoring, for example, of Webex or MS Teams. .. rubric:: Webex Config The Webex Config option allows the configuration of Webex monitoring. A dashboard is available to visualize the data. .. image:: /src/images/SP25-Webex-config.png .. note:: For Webex API support, your network should be configured to access: ``https://webexapis.com/v1``, port 443. (Admin menu > Network Configuration, **DNS Settings** may need to be configured to reach the external site.) To configure Webex API: 1. From the Arbitrator main user interface, click the toolbar **Wrench** icon (System Configuration), to open the Arbitrator **Configuration** GUI. 2. Click the toolbar **Cabinet** icon to open **Archive Management**. 3. On the **Configuration Management** tab, select the **API Config** tab. 4. On the **API Config** tab, select **Webex Config**, then fill out details to enable and configure Webex monitoring: a. Click **Create Access Token**. On the new screen that displays, click **Get Access Tokens** to start the Webex authorization, then fill out your Webex account credentials. b. Copy the JSON string that performs OAuth handshake with Webex. c. Paste the JSON string into the **AccessToken** field. The JSON format is as follows (line breaks here not in string): :: {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxx", "expires_in":nnnnnnn, "refresh_token":"xxxxxxxxxxxxxxxxxxxxxxxxx", "refresh_token_expires_in":nnnnnnn, "token_type":"Bearer"} d. At the **Enabled** drop-down, select ``enabled``. e. At **CUSTOMER**, fill out the customer name (if multi-tenancy is required). f. Click **Verify Access Token**, wait for the operation to complete, then inspect the output in **View Output**. .. image:: /src/images/insights-arbitrator-api-config-webex-config.png g. Click **Save Access Token**, which will create a new Customer-specific "Webex Config - " entry. under the **API Config** list. (You need to click away and return to **Configuration Management** to reload with the new entry.) .. image:: /src/images/arb-config-management-webex-config.png Created configurations can be deleted or modified. This will be needed for Access Tokens, as these contain an ``expires_in`` value. .. rubric:: MS Teams Config **MS Teams Config** settings configure MS Teams monitoring for Insights. The MS Teams API configuration requires an initial application registration on Microsoft Azure. .. raw:: html To set up Microsoft Teams integration and monitoring for Insights and to see the check of the connection and correct permissions that are set to Microsoft Graph API endpoints, see Microsoft Teams Integration Guide for Insights. .. raw:: latex To set up Microsoft Teams integration and monitoring for Insights and to see the check of the connection and correct permissions that are set to Microsoft Graph API endpoints, see *Microsoft Teams Integration Guide for Insights*. .. rubric:: Zoom Config An access token is required for the configuration of Zoom monitoring. | .. image:: /src/images/arb-zoom-config-create-token.png | Click the **Create Access Token** button to be redirected to get an access token. 1. If Zoom statistics are to be captured, select **enabled** from the **Enabled** drop-down. 2. Enter a **Customer** name for the associated customer. 3. Enter the received access token in the **AccessToken** input box. 4. Enter a refresh token in the **RefreshToken** input box. 5. Click the **Verify Access Token** button to test the entered access token. .. _arbitrator-archive: Archive Tab '''''''''''''''' The Archive tab provides a number of options based on the specific functions you wish to backup. .. note:: From release 24.2, new configuration options are available for the archive of: * Cisco SNMP SQL * Network Observability SQL * VMWARE SQL .. rubric:: Setup The system does a backup daily. For the most part, there is nothing for the user to configure. All data and configurations that exists on the system are archived automatically on a daily basis. Archived data are logically grouped together and by default stored into separate archived files locally on the box. There is a separate page for each Archive group. More detailed information about each Archive group can be found on the individual Archive group pages. The user also has the option to mount an NFS drive to the system. All archived files will then get archived to the NFS mounted drive. Note: removing the NFS mount will NOT copy the NFS contents back to local storage. Only NFS v3 mounts are currently supported today. | .. image:: /src/images/assurance-correlation-image76.png | .. rubric:: Arbitrator Backup This page contains the settings for the backup of the Arbitrator. There is nothing to edit here. The settings are simply displayed for informational purposes only. This Archive group contains the following data: Arbitrator Configuration settings (Database: Assets, Alerts, Policies, Rules, Probe Groups, Response Procedures, Controls), User Permissions settings (ldap), NDX files, Avaya data, Pexip data, and all other data currently being collected in the Arbitrator database. The backup excludes data from the CALL table, Cisco Tables, and raw Cisco CDR/CMR files. Data in the CALL table can be very large and is expendable. Cisco Tables and raw Cisco CDR/CMR files are part of a separate Archive group. | .. image:: /src/images/assurance-correlation-image73.png | .. rubric:: Cisco Files Archival for Cisco files. This Archive group will back up all Cisco CDR and Cisco CMR raw files. These are the files that are SFTP'd to the system by the Cisco Call Manager. The settings here are for informational purposes only. However, the user may disable the storage of raw Cisco CDR and Cisco CMR raw files on the system. This option could be used to conserve disk space. | .. image:: /src/images/assurance-correlation-image74.png | .. rubric:: Cisco SQL Archival for Cisco SQL data. This Archive group will back up all Cisco data in the database tables. This is the data that has already been processed by the system. There is nothing to edit here. The settings here are for information purposes only. The data here is grouped together by the Cisco Call Manager IP Address. This allows for more granular control on which Call Manager data to import. | .. image:: /src/images/assurance-correlation-image71.png | .. rubric:: Ndx This Archive group will manage Ndx files on the system. Default **monthsKept** is 6 months. | .. image:: /src/images/VAA-config-ndx-file-retention-times.png | .. rubric:: Pexip Files Archival for Pexip files. The system can be used to collect PEXIP data. The raw PEXIP data files are kept, by default, for historical purposes. However, in order to conserve disk space, the user may choose to disable the local storage of the raw PEXIP files. | .. image:: /src/images/assurance-correlation-image72.png | .. rubric:: Remote Storage If standard / local storage is chosen in the Archive Setup page, then this screen allows the user to configure remote archival of the Arbitrator backup files. Each Archive group produces one or many archive files. The system can be configured to SCP these archive files to a backup location or to another Arbitrator. The archives can be sent to a separate backup location (NFS, SFTP-server, SCP, or remote synced to another Arbitrator). .. image:: /src/images/assurance-correlation-image69.png The table describes the settings for remote storage: .. tabularcolumns:: |p{5cm}|p{10cm}| +------------------------------------------+-------------------------------------------------------------+ | Setting | Description | +==========================================+=============================================================+ | **archive_interval** | This can be configured on a schedule of: | | | | | | * Daily | | | * Weekly | | | * Monthly | +------------------------------------------+-------------------------------------------------------------+ | **Select an option** | Method, either of the following: | | | | | | * **disabled**: System will reset storage options, for | | | example, archives locations are reset to the local | | | system if these were previously on a remote host. | | | * **nfs**: System will mount the filesystem as a local | | | drive. The system ``drop/lxt_archive`` directory is | | | linked with a symbolic link to ``/mnt/nfsshare`` on a | | | host, thereby saving space on the system. | | | Selecting this option enables additional controls: | | | | | | .. image:: /src/images/arb-remote-nfs.png | | | | | | * **Check NFS Host**: Click and use the **View Output** | | | button to see verification output. | | | * **Check NFS Mount**: Check the **destination** | | | location (entered below) *after* saving the | | | configuration. **View Output** shows disk usage on the | | | destination of the NFS host. | | | | | | * **rsync**: System syncs the archive directory to a | | | remote system, which must have rsync | | | installed for this to work. | | | * **rsyncToArb**: System syncs the archives directory to a | | | remote Arbitrator, using the rsync protocol (so that both | | | Arbitrators will always be in sync. | | | * **scp**: System copies archives to a remote location. | | | SCP is not a sync. To reduce load on system and network, | | | system only copies new/changed archives over to the | | | SCP location. | | | * **sftp**: System copies archives to a remote | | | location. SFTP is not a sync. To reduce load on system | | | and network, system only copies new/changed archives | | | to the SFTP location. | +------------------------------------------+-------------------------------------------------------------+ | **IP location** | The IP address of the remote storage location. | +------------------------------------------+-------------------------------------------------------------+ | **username** / **password**: | The username and password for the remote storage location. | | | | | | If the remote storage location is a Windows environment, | | | Insights supports Microsoft domain names for | | | the username, that is `domain/userid` (including a | | | backslash). | +------------------------------------------+-------------------------------------------------------------+ | **destination** | The path on the remote server to the folder where backups | | | are to be stored. | +------------------------------------------+-------------------------------------------------------------+ .. rubric:: Related topics * :ref:`backup-restore-arbitrator` .. _automate-datasource: Automate Datasource Tab '''''''''''''''''''''''''' Arbitrator can be set up to query Automate and extract CDR data for specific Cisco UCMs and phones, based on the Cisco UCM IP and device name, and display this data on Insights dashboards. This tab configures an Automate datasource to securely store and manage Automate credentials. Here you can enable or disable the collection of data from a specified Automate database, specify the IP address, port, database name, and port of the Automate datasource, and the username and password to access the datasource. You can also enable or disable SSL for connecting to the Automate datasource, and test the connection to the datasource. .. image:: /src/images/arb-config-archive-automate-datasource.png Key Automate data for the Cisco UCM phone, line, and user is collected in regular Automate syncs to enrich the the Cisco CDR data for both originating and destination devices. This data displays on Insights dashboards, for example, to include customer and site location details for multiple customers and sites, as well as information about the lines. A data sync for the collection of data can also be forced from Automate on Arbitrator via the CLI **Administration** menu. .. image:: /src/images/cli-admin-automate-run-sync.png .. rubric:: Prerequisites * Automate, Arbitrator, Cisco UCM * A Cisco UCM configured via Automate * Cisco UCM configured to send its CDRs to Automate .. rubric:: Fields available on the arbitrator_ciscocdr resource Dashboards displaying enriched CDR data from Automate use these fields: * orig_voss_phone_customer * orig_voss_phone_site * orig_voss_phone_description * orig_voss_phone_line_pattern * orig_voss_phone_line_description * dest_voss_phone_customer * dest_voss_phone_site * dest_voss_phone_description * dest_voss_phone_line_pattern * dest_voss_phone_line_description .. rubric:: View data CDR data enriched with Automate data can be viewed on the following Insights reference dashboards: * CUCM Route Pattern Analysis * Call Analysis-All * Cisco Call Detail - Cause Code Analysis * Microsoft PSTN Calls * Microsoft Teams - Call Debug Compact * Microsoft Teams - Call Debug Details * Microsoft Teams - Call List * Microsoft Teams - Calls with Issues * Microsoft Teams - Calls with over 10 Participants * Microsoft Teams User Experience Detail * Phone Inventory .. rubric:: Related topics * .. raw:: latex Insights reference dashboards in the Dashboard Administration Guide .. raw:: html Insights Reference Dashboards .. _collect-tab: Collect Tab '''''''''''''' The Collect tab defines configuration options for the collection of CDRs. .. rubric:: Control This panel enables and disables the processing of various file types. When a file type is disabled, files of this type are added to a backlog, and are processed when processing is re-enabled. The table lists the control options you can enable and disable: ====================== ================================================================== DEM Enables/disables Digital Experience Monitoring (DEM) collection on the Arbitrator. DEM provides the ability to test connectivity to web-based systems, such as Microsoft Teams, and to deliver metrics for the following: * Overall round-trip times to the application * The number of hops taken * Best and worst latency * The connection path, displayed hop-by-hop DEM agents on the Arbitrator provide connectivity and performance statistics to various MS Teams internet endpoints, including Microsoft Graph. When enabled, the job runs every 5 minutes, and policies (rules) imported to Arbitrator fire incident alerts when any of the DEM-collected metrics are out of the permitted thresholds. To verify that the Arbitrator policies are firing alerts and to view the logs, you can search in Arbitrator for either "dem_connectivity" or "dem_web_performance". Cisco UCM Oracle SBC Pexip NGIN Enables/disables NGIN-XML processing Palladion NMR Infovista GSIP Infovista IPSLA ====================== ================================================================== .. image:: /src/images/arb-archive-config-collect-control-tab.png .. rubric:: Cisco Remote Copy This panel defines the storage location of collected Cisco CDR/CMR files. The default location is "local", which is the local Arbitrator Correlation platform. Choose "remote arbitrator" and the processed Cisco CDR/CMR files will be stored to the database of a remote arbitrator. This is useful if the data of multiple arbitrators needs to be stored to a centralized arbitrator. The "remote_ip" needs to be filled in with the IP address of the "remote arbitrator", if configured. | .. image:: /src/images/assurance-correlation-image70.png | .. rubric:: Oracle Microsoft Operator Connect If customer CDR folders for Oracle Call Manager were set up during Arbitrator setup, then parsing CDRs and using API calls to create the call record in the MS Tenant via the Operator Connect API is configured from the setup up on the **Oracle Microsoft Operator Connect** screen. | .. image:: /src/images/insights-arb-archive-oracle-ms-operator-connect.png | .. raw:: html For CDR folder setup, see Add Customer CDR Folders .. raw:: latex For CDR folder setup, see the "Add Customer CDR Folders" topic in the Arbitrator Install Guide. .. rubric:: Ping Probe This page configures ping probes to define the location to store the collection of ping probe results. By default, the storage location is "local", and all ping probe results are processed and stored on a local arbitrator. You can configure the ping probe to store results remotely. This is useful if the data of multiple arbitrators should be stored in a central location. 1. At **method**, select *remote arbitrator*. 2. Fill out the remote IP address of the arbitrator. 3. Save your changes. .. note:: Even if configuring the results of the ping probe to be stored to a remote arbitrator, results are stored both to the remote location as well as to the local storage location (the default). .. image:: /src/images/arb-archive-collect-ping-probe.png .. _arb-import-tab: Import Tab '''''''''''' This tab allows you to import configuration data to a server from a ``csv`` file. .. note:: Only ``csv`` file imports are supported. .. _ldap-tab: LDAP Tab '''''''''''' The system uses a local LDAP server to store user information. The system also supports authenticating with an external Microsoft Active Directory server. If an external Microsoft AD is used, the system will automatically sync all users locally. Local user accounts are necessary to set specific system privileges. Note that Microsoft AD passwords are never stored locally. Authentication always occurs with external Microsoft AD. Once authenticated, the system allows a user access based on their local system privileges. In order to properly configure these settings, the customer administrator requires an in-depth knowledge of the customer's Microsoft AD architecture. Improper configuration may cause too little or too many users in the system. | .. image:: /src/images/assurance-correlation-image67.png .. _license-tab: License Tab ''''''''''''''' This tab registers your system for integration with the VOSS Cloud License service for user license count auditing, and allows the licensed user counts files to be sent to VOSS automatically. You can also view and download license files on this tab, and upload license files to VOSS. .. image:: /src/images/arb-config-archive-license.png .. rubric:: Related Topics * :ref:`license-audit` .. _proxy-config: Proxy Tab '''''''''' To allow for cloud services access, proxy configuration (both authenticated and unauthenticated) is supported. You can configure the Proxy on the Arbitrator **Settings** menu from **ARCHIVE MANAGEMENT > Configuration Management > Proxy**. | .. image:: /src/images/arb-proxy-config.png | 1. Fill out the required **Proxy Config** values: **ipAddress**, **proxyPort**, **userName** **password**. 2. Click **Save**. 3. To enable the saved values, click **Set Proxy**. .. important:: The proxy is used only by services that use APIs for their data, and are set up in **Archive Management > Configuration Management > API Config**: Webex, Teams and Zoom. If it is necessary to remove the proxy configuration, click **Remove Proxy**. This will reset the configuration to empty settings from the system. In order to clear the configuration screen, you will then need to click **Delete** at the top of the form. This will remove any confusion as to the proxy settings in the future. .. _arbitrator-log-management: Log Management Tab ...................... The **Log Management** tab (in **Archive Management**) allows you to customize the archival of the index data store. It can be performed based on Size, Time or a combination of both. Set the archival process '''''''''''''''''''''''''' This procedure sets up the archival process. .. SP19 1. Click on the Log Management tab. 2. Select the file size at which to start the archive. 3. Select the time interval at which to start the archive. 4. Add the location to where the archive file will be sent. 5. Set the **IP Address**, Choose the **Method** of transport (e.g. SFTP), give it a **Path** and input any **Credentials** required. | .. image:: /src/images/assurance-correlation-image61-method.png | .. image:: /src/images/assurance-correlation-image61.png