[Index]

Model: relation/AssuranceArbitratorServer

VOSS Assurance

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Users with both VOSS Automate and VOSS Insights deployed, can easily enable monitoring of new UC applications from the VOSS Automate administration portal. The integration manages both onboarding and off-boarding of assets to VOSS Insights servers configured in VOSS Automate. The UC apps are monitored by VOSS Insights through the creation of assets, probes and profiles.

The purpose of the feature is to automate the setup of assets and related configuration for new and existing VOSS Automate Customers and UC applications on VOSS Insights.

With this feature, you can:

Note

VOSS Assurance

Full HTML Help

Overview

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

Note

For details around integrating VOSS Automate with the Insights Arbitrator server, see Voss Assurance Arbitrators

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

The following servers are supported:

Note

The image displays a customer with four CallManager servers that are part of the same cluster. The cluster is onboarded to the Arbitrator server for monitoring purposes.

This feature provides the following functionality in the Admin Portal:

Note

At the time of writing (VOSS Automate v21.3), modifying any existing monitoring setup on UC apps is not supported. However, deleting a UC app on VOSS Automate will remove the asset and related configuration from all corresponding VOSS Insights Arbitrator servers.

Onboarding Provisioning

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 CUCM or CUC, Publisher or Subscriber, or CUCM server type VOICE_VIDEO, or IM_P).

Note

You can view all workflow provisioning steps via the transaction log in the Admin Portal.

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

Server in the cluster Onboarding Provisioning
CUCM VOICE Publisher (PUB)

Provisioning on Arbitrator:

  1. Creates the asset on Arbitrator.

  2. Adds the asset into an asset group on Arbitrator (or updates the asset group if it already exists)

  3. Creates a credential for the server.

  4. Creates a server-specific probe and probe group combination.

  5. 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:

  1. Creates the asset on Arbitrator.
  2. Adds the asset into an asset group on Arbitrator (or updates the asset group if it already exists)
  3. Creates a credential for the server.
  4. Creates one Arbitrator monitoring profile (ping test only).
CUCM IM_P Publisher (PUB)

Provisioning on Arbitrator:

  1. Creates the asset on Arbitrator.
  2. Adds the asset into an asset group on Arbitrator (or updates the asset group if it already exists)
  3. Creates a credential for the server.
  4. Creates a server-specific probe and probe group combination.
  5. 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:

  1. Creates the asset on Arbitrator.
  2. Adds the asset into an asset group on Arbitrator (or updates the asset group if it already exists)
  3. Creates a credential for the server.
  4. 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.

For details, see Onboard Voss Assurance Assets

Note

All provisioned elements can be viewed on the Insights Arbitrator dashboard. For details, see the VOSS Insights documentation.

Probe Groups, Profiles, and Asset Onboarding

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

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

Offboarding Assets

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

VOSS Insights Arbitrators

Prerequisites

The management of arbitrators in VOSS Automate require:

Refer to the VOSS Insights documentation for arbitrator setup.

Adding an arbitrator to VOSS Automate

These steps integrate the arbitrator with VOSS Automate by entering its connection details. When integrated, the arbitrator is available to onboard and offboard assets that are added or are available in VOSS Automate.

  1. Choose the VOSS Assurance > Arbitrator menu. This sets the hierarchy at the provider level.

  2. Complete the form:

    If the Sync on Create/Update check box is selected, the arbitrator server (according to Host Name) data from the arbitrator is synced onto VOSS Automate (pull sync).

  3. Click Save.

Next Steps

Unified CM and Unity Connection servers can now be enabled or disabled for monitoring.

Related Topics

Removing an arbitrator

An arbitrator can be removed from the list of arbitrators under the VOSS Assurance menu.

Arbitrators

Full HTML Help

Overview

Managing VOSS Insights Arbitrators in VOSS Automate requires the following:

Note

See the VOSS Insights documentation for Arbitrator setup.

Add a Connection to the Arbitrator Server

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

Note

Once the integration is complete, the Arbitrator is available to onboard and offboard assets that are added or are available in VOSS Automate.

  1. In the VOSS Automate Admin Portal, go to (default menus) Apps Management > VOSS Insights > Arbitrator.

  2. Click the Plus icon (+) to add an Arbitrator.

  3. Fill out Arbitrator details:

    Server Name Name of the VOSS Insights Arbitrator server in VOSS Automate. Field tooltip provides naming convention.
    Description Optional. Provide a description.
    Host Name Host name or IP address of this Arbitrator server, which is used to connect to the Arbitrator.
    User Name Username for a valid admin account; an admin user allowed to log in to the Arbitrator server.
    Password / Repeat Password Password credential of a valid admin account; an admin user allowed to log in to the Arbitrator server.
    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 Automate (pull sync).

  4. Click Save.

Next Steps

CUCM and CUC servers can now be onboarded and enabled for monitoring. See Onboard Voss Assurance Assets

Related Topics

Remove an Arbitrator Server

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

  1. In the VOSS Automate Admin Portal, go to (default menus) Apps Management > VOSS Insights > Arbitrator.
  2. View the summary list of available Arbitrators set up for integration with VOSS Automate.
  3. Select the relevant Arbitrator, then click Delete.

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

Model Details: relation/AssuranceArbitratorServer

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
Username * Username of a valid administrator user on the Assurance Arbitrator server.
  • Field Name: Server Details.username
  • Type: String
Password Password of a valid administrator user on the Assurance Arbitrator server.
  • Field Name: Server Details.password
  • Type: String
  • Is Password: True
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