.. _arbitrator-probe-configuration:
Probe Configuration
-------------------------
.. _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:
.. _25.3|EKB-24063:
Overview
.......................
On the **Probe Configuration** screen you can assign a group of scripts to an asset that can run on a
set interval. The scripts allow data collection from many device types. The protocols can be API, SNMP, or
custom CLI scripts. SNMP v3 is also supported.
The return data from the probes can then be injected into the system for correlation or can be stored in the
database to allow for analysis on the Dashboard/Reporting server.
For PRI and SIP Trunk probes for Cisco Voice Gateways, reference:
.. raw:: latex
Arbitrator Cisco PRI and SIP Probe Configuration
.. raw:: html
Arbitrator Cisco PRI and SIP Probe Configuration
for instructions.
Add a probe group
......................
1. Click the toolbar **Probe** icon to open **Probe Configuration**.
2. Click the Plus icon (+) below the **Groups** pane.
3. Fill out a name for the probe group.
4. Click **Save**.
.. image:: /src/images/assurance-correlation-image17.png
Clone a probe group
.....................
To clone an existing Probe Group:
1. Click the Probe icon from the Menu bar.
2. Select a Probe group to clone from.
3. Click the "C" icon within the Groups pane in the bottom left
corner.
4. The cloned "Group" name shows: * clone*. Modify this name
to the required name.
5. Click the "Save" icon to save the added Probe.
6. The probes contained in this new group can also be modified. Refer
to the steps to add, clone and modify probes.
.. image:: /src/images/insights-arb-probes-clone.png
Create a probe
..................
To create a new probe:
1. Click the group in which you wish to create a new probe.
2. Click the Plus icon (+) within the **Probes** panel.
3. Enter the name and description of the probe.
4. Clear (uncheck) the **Custom** field. This field is
utilized when putting a custom probe in place versus utilizing the
ones within the system.
5. Select the probe category from the drop-down list to populate the scripts available in the selected
category within the **Select Script** drop-down.
6. Select a script from the script drop-down list.
7. Enter any additional information required by the selected script, such
as the hostname, IP, etc.
8. Click the check mark icon to close the probe in the far right of the
Probe panel.
9. Click **Save** to add the new probe.
.. image:: /src/images/assurance-correlation-image18.png
Clone a probe
.................
Since devices such as Cisco UCM and Unity Connection require dedicated
probes, it is useful to clone (create a copy) and modify an existing probe for this purpose.
To clone a probe:
1. Click the probe from which you wish to clone.
.. note::
Insights also provides a list of templates that can be cloned for the specific purpose.
2. Click the **Clone probe** icon (C) at the bottom of the **Probes** panel.
3. The clone is created, displaying with naming format, * clone*. Modify this name
to the required name, and update any other required properties.
.. note::
For a Cisco UCM probe, this typically includes **Cucm Ip Address**.
4. Click the **Done** icon (blue check mark to the right of the clone's properties panel).
5. Click **Save** to add the new probe created from the clone.
Create a custom probe
........................
To create a new probe:
1. Click the group in which you wish to create a new probe.
2. Click the Plus icon (+) in the **Probes** panel.
3. Enter the name and description of the probe.
4. Select and click the check icon from the field titled "Custom". This
field is utilized when putting a custom probe in place versus
utilizing the ones within the system.
5. Enter the path and script that you wish to run.
6. Click the "Check" icon to close the probe in the far right of the
Probe panel.
7. Click **Save** to save the new probe.
.. image:: /src/images/assurance-correlation-image15.png
Delete a probe group
........................
To delete a probe group:
1. Click the check box next to the group name you wish to delete.
2. Click the Minus icon within the Probe Group panel in the bottom left.
3. Click **Save** to save the changes.
.. image:: /src/images/assurance-correlation-image16.png
Delete a probe
..................
To delete a probe:
1. Click the check box next to the Probe name you wish to delete.
2. Click the Minus icon within the Probe panel in the bottom right.
3. Click the "Save" icon to save the changes.
.. image:: /src/images/assurance-correlation-image14.png
Export and import a profile
............................
.. important::
This import/export is special. Since we do not have a Profile main screen,
the import/export profiles are in Probe Configuration; the same as the legacy
push button (right next import/export buttons).
Within the **PROBE CONFIGURATION** section, you can export and
import the profiles that you exported from another system.
A new system log table ``insights_system_log`` has also been added
to log user actions and a user can create a dashboard to view these actions.
.. rubric:: Related topics
*
.. raw:: html
Log Search
.. raw:: latex
Log Search Section in the Dashboard and Reporting Administration Guide.
Export a profile
''''''''''''''''''''
1. Click the down arrow below the **PROBE CONFIGURATION** panel.
Since this is a probe configuration, we cannot select individual profiles,
so it will export all profiles in the system.
2. In the **Export CSV** dialog, fill out a **CSV file name** (You do
not have to add the ``.csv`` file extension), then click **Export**.
3. The **Export finished** dialog shows when the export file has been created.
4. Click **Download** to save the CSV file to your selected download location.
Import a profile
''''''''''''''''''
1. Click the up arrow at the bottom of the **PROBE CONFIGURATION** panel.
2. On the pop-up that displays, select the file.
3. Click **Choose file**, and select the exported CSV file that you
have saved to your computer.
4. Click **Import**.
Profile CSV format
''''''''''''''''''''
The following columns are in an exported CSV file:
::
"Row Action","Asset Name","IP Address","Customer Name",
"Site Name","Probe Group Name","Credential 1 Name",
"Credential 2 Name","Frequency (s)",Enable
.. note::
* The ``"Row Action"`` column is used when importing and if it contains "delete",
then the row will be deleted upon import.
* "Probe Group Name" must be unique.
* Combination: "IP Address","Customer Name","Site Name" must to be unique.
* "Asset Name" is used as a reference of the asset.
* When importing and if an asset and a probe group are found, then a profile
will be updated/inserted. If not, nothing to import.
.. image:: /src/images/arbitrator-import-probe.png
Assign a probe to an asset
'''''''''''''''''''''''''''''
A probe group assigned to an asset can be modified using a profile CSV file import by specifying
the related "Asset Name" and "Probe Group Name" in the CSV file.
For example, consider an asset "Local System" that has 3 profiles:
.. image:: /src/images/Insights-asset-local-system-3-profiles.png
We can assign probe "Cisco CUCM Version" to asset "Local System"
as a CSV file import:
.. image:: /src/images/Insights-CSV-row-add-profile-to-asset.png
After importing, the profile is added to the probe group.
.. image:: /src/images/Insights-asset-local-system-4-profiles.png