Users with both Automate and Insights deployed can enable monitoring of UC applications via the Automate Admin Portal, from an Insights Arbitrator server integrated with Automate.

Once the integration is set up, you onboard customer server clusters, comprising one or more Cisco Unified Communication Manager (UCM) CallManager servers and/or Cisco Unity Connection (CUC) servers, to an Arbitrator server for monitoring, from within the Automate Admin Portal.

The onboarding process triggers a workflow that finds all the servers in the cluster, then provisions all required monitoring elements (which differ depending on whether the server is UCM or CUC, Publisher or Subscriber, or CUCM server type VOICE_VIDEO, or IM_P).

The table describes the onboarding provisioning that occurs for the server types supported for Arbitrator monitoring:

The table describes the probe groups and profiles that are added to the Insights Arbitrator server when assets are onboarded, and removed when assets are off-boarded.

Should you wish to disable monitoring and remove data from the Arbitrator server, you can offboard these assets (and their related configuration) from the Arbitrator server. For details see Offboard VOSS Assurance Assets

Insights Assurance Arbitrators

This procedure provides connection details to the Arbitrator server to integrate Automate with the Arbitrator server.

Server in the cluster	Onboarding Provisioning
CUCM VOICE Publisher (PUB)	Provisioning on Arbitrator: Creates the asset on Arbitrator. Adds the asset into an asset group on Arbitrator (or updates the asset group if it already exists) Creates a credential for the server. Creates a server-specific probe and probe group combination. Creates five Arbitrator monitoring profiles, which define the schedule for the probe to run on the asset (for example, every 5 minutes, or once a day): A server-specific PERFMON CUCM group profile that associates the probe and probe group combination with the asset and the credential. Four profiles that associate static probes (which are always on the Arbitrator) with the asset: RIS, PING Monitor, Version, RTMT The static probes must exist on the Arbitrator for Arbitrator monitoring to work. The static probes are associated with new assets, using the profiles. Provisioning on the CallManager: Creates the application user. When onboarding multiple servers, you can ignore a fail status at this step `Create Cucm App User`, since duplicate user creation is ignored. Updates service parameters
CUCM VOICE Subscriber (SUB)	Provisioning on Arbitrator: Creates the asset on Arbitrator. Adds the asset into an asset group on Arbitrator (or updates the asset group if it already exists) Creates a credential for the server. Creates one Arbitrator monitoring profile (ping test only).
CUCM IM_P Publisher (PUB)	Provisioning on Arbitrator: Creates the asset on Arbitrator. Adds the asset into an asset group on Arbitrator (or updates the asset group if it already exists) Creates a credential for the server. Creates a server-specific probe and probe group combination. Creates two Arbitrator monitoring profiles, which define the schedule for the probe to run on the asset (for example, every 5 minutes, or once a day): A server-specific PERFMON CUCM group profile that associates the probe and probe group combination with the asset and the credential. A PING Monitor profile

Server in the cluster	Onboarding Provisioning
CUCM IM_P Subscriber (SUB)	Provisioning on Arbitrator: Creates the asset on Arbitrator. Adds the asset into an asset group on Arbitrator (or updates the asset group if it already exists) Creates a credential for the server. Creates one Arbitrator monitoring profile (ping test only).
CUC Publisher (PUB)	View the transaction and sub-transaction log for details.
CUC Subscriber (SUB)	View the transaction and sub-transaction log for details.

PERFMON CUCM Group Profile
Probe name	`axlGetPerfmonCounters_CUCM_INTF (<CUCM Cluster name>)`
Probe Group Name	`<customer_name>-CUCM Perfmon AXL (<CUCM Cluster name>)`
Frequency	600 sec (10 min)
For Publisher Server	Yes
For Subscriber Server	No

PERFMON CUC Group Profile
Probe name	`axlgetperfmon (<CUCxn Cluster name>)`
Probe Group Name	`<customer_name>-Cisco Unity AXL (<CUCxn Cluster name>)`
Frequency	300 sec (5 min)
For Publisher Server	Yes
For Subscriber Server	No

RIS Group Profile
Probe Group Name	`1-Cisco CUCM RIS CmDevice_creds`
Frequency	300 sec (5 min)
For Publisher Server	Yes
For Subscriber Server	No

PINGMON Group Profile
Probe Group Name	`1b-PING Monitor`
Frequency	300 sec (5 min)
For Publisher Server	Yes
For Subscriber Server	Yes

VERSION Group Profile
Probe Group Name	`4-Cisco CUCM Version`
Frequency	86400 sec (24 hr)
For Publisher Server	Yes
For Subscriber Server	No

RTMT Group Profile
Probe Group Name	`5-Cisco RTMT`
Frequency	1800 sec (30 min)
For Publisher Server	Yes
For Subscriber Server	No

Note

Once the integration is complete:

The Arbitrator is available to onboard and offboard assets that are added or are available in VOSS.

For example, if a MS Tenant is managed in VOSS (Microsoft tenant setup), the corresponding MS tenant is shown and managed on the associated Arbitrator. The image shows an example where a tenant displays on the Arbitrator (API Config tab):

Also verify that the MS Tenant configuration includes a secret set up - see Microsoft tenant setup.
If Assurance is selected as Data Source to manage dashboard widgets, options are available to choose it as a Data Source Instance, since multiple instances can be configured. See: Chart Widgets and Table Widgets.

Note

The Arbitrator default database password for VOSS can be managed from the Arbitrator on the Change Passwords CLI menu on the Arbitrator. For details on the Arbitrator command line menus, refer to the Arbitrator Install Guide and Dashboard and Arbitrator Maintenance and Upgrade Guide.

To carry out this task, choose: Change Automate Public Database Password from the menu.
If Global Settings, Enabled Services shows Enable Microsoft as true, then Microsoft Tenant hierarchies can be synced in to the Arbitrator hierarchy via the Sync in Microsoft Tenants menu. Such a sync would then also allow for Digital Experience Monitoring (DEM) from the Microsoft Insights menu / dashboard. This sync should be repeated for any new Microsoft Tenants added under the hierarchy. For details, refer to Digital Experience Monitoring (DEM) in Microsoft Insights.

This procedure pushes VOSS's user hierarchy paths into Arbitrator's call records from the Microsoft tenant on VOSS to update the Arbitrator.

Pushing VOSS's user hierarchy paths into Arbitrator, particularly when new sites are added, allows new calls to be stamped with the correct hierarchy, enabling segmentation of Microsoft Teams call data, role based access control (RBAC), and filtering in Insights dashboards.

Microsoft Teams call data (collected by Arbitrator) is segmented to match the user hierarchies defined in Automate so that admins can view this data in the correct business context. This allows the Microsoft Insights dashboards in VOSS to display accurate call details at selected hierarchies, at a particular customer or site for example.

Existing call records are excluded. New calls (after the update) will have their hierarchy stamped - based on their user principal name (UPN) in the call record, matched to the correct hierarchy - as they're brought into VOSS from Microsoft.

Note

The Microsoft tenant pushes its configuration data (including hierarchy information) to the Arbitrator so that you won't need to add these details for the tenant on the Arbitrator. The call records on Arbitrator can then be stamped with hierarchy details from the tenant.

You will need to perform this procedure whenever you're adding a new tenant at the Provider level so that the Arbitrator is updated with data from all Microsoft tenants.

This procedure removes an Arbitrator server from the list of Arbitrator servers configured for integration with VOSS.

This relation implements the workflows to manage Assurance Arbitrator Server connection parameters and enabled services.

Model Details: relation/AssuranceArbitratorServer

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
Server Details		Group Assigned by FDP	Field Name: Server Details Type: Object
	Server Name *	Name of the Assurance Arbitrator Server. The name must be alpha-numeric and allows spaces, dashes and underscores e.g. 'ARB-US-001'.	Field Name: Server Details.name Type: String MaxLength: 50 Pattern: ^[a-zA-Z0-9]([\w -]*[a-zA-Z0-9])?$
	Description	Provide a brief description of this Assurance Arbitrator server e.g. Responsible for CDR collection.	Field Name: Server Details.description Type: String MaxLength: 255
	Host Name *	Host Name or IP Address of this Assurance Arbitrator server.	Field Name: Server Details.host Type: String MaxLength: 1024
	API Username *	Username of a valid API administrator user on the Assurance Arbitrator server.	Field Name: Server Details.username Type: String MaxLength: 1024
	API Password	Password of a valid API administrator user on the Assurance Arbitrator server.	Field Name: Server Details.password Type: String Is Password: True MaxLength: 1024
	Database Password	Database Password of the Assurance Arbitrator server.	Field Name: Server Details.db_password Type: String Is Password: True MaxLength: 1024
	Data Center	The name of the data center where the Assurance Arbitrator server is deployed.	Field Name: Server Details.data_center Type: String MaxLength: 50
	Sync on Create/Update	Sync server on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Assurance server	Field Name: Server Details.sync Type: Boolean

Server Name	Name of the Arbitrator server in VOSS. Alphanumeric characters, allows spaces, dashes, underscores (for example, ARB-US-001).
Description	Optional. Provide a description.
Host Name	Host name or IP address of this Arbitrator server, which is used to connect to the Arbitrator.
API Username	Username for a valid admin account; an admin user allowed to log in to the Arbitrator server.
API Password	Password credential of a valid admin account; an admin user allowed to log in to the Arbitrator server.
Database Password	The Arbitrator database password (this password can be changed from the default on the Arbitrator CLI -
Data Center	The name of the data center where the Arbitrator server is deployed. Used as the location when Arbitrator assets are created.
Sync on Create/Update	When enabled (selected) Arbitrator server (based on Host Name) data is synced in to VOSS (pull sync).

Model: relation/AssuranceArbitratorServer

Assurance

Docutils System Messages

Insights Assurance Arbitrators

Model Details: relation/AssuranceArbitratorServer