Model: view/OffboardAssuranceAssets

VOSS Assurance

Overview

CUCM and CUC server clusters that have been integrated with VOSS Insights Arbitrator servers can be offboarded in two ways:

Offboard the asset
Delete the UC app

Note

While an asset can be offboarded, the feature does not currently allow for the modification of any existing monitoring on UC Apps.

Related Topics:

VOSS Assurance Monitoring Overview
Voss Assurance Arbitrators
Onboard Voss Assurance Assets

Offboard Assets

This procedure allows a batch removal of the clusters associations by Arbitrator server.

In the VOSS Admin Portal, choose the relevant customer hierarchy.
Go to (default menus) Apps Management > VOSS Insights > Offboard Assets.
On the Offboard Assets page, choose relevant options:
- From the Arbitrator Server drop-down, choose the Arbitrator server where you wish to remove (offboard) an asset.
- In the Available field, select assets to remove (which are currently associated with the Arbitrator), and click the right-pointing arrows to move these items to the Selected field.
Click Save.
Note
- View the transaction log to ensure assets are off-boarded as required.
- VOSS Automate makes the following updates on the associated Arbitrator when a CUCM or CUC server (asset) is unassociated from a VOSS Insights Arbitrator:
  - Removes asset (the server)
  - Removes or refreshes asset group
  - Removes probe (performance monitoring)
  - Removes probe group (customer specific). See Probes, Group Names, Profiles and Timings
  - Removes relevant credentials on Arbitrator (by default the ADMIN user credentials set up on VOSS Automate)
  - Removes profiles in VOSS Insights Arbitrator (Probe Group > Templates/Profiles). See Probes, Group Names, Profiles and Timings
  - For CUCM, removes the application user, if this is a Publisher.
Note

Off-boarded CUCM and CUC servers in a cluster remain, and show Monitoring details with specific Assurance Arbitrator Server instances disabled.

The UC app server add/update page displays the unchecked (removed) Arbitrators. See the Monitoring section on the Publish page, via the Apps Management menu (for CUCM or CUC > Server).

Delete a UC App to Offboard the Asset

When a CUCM or CUCM server or cluster that was integrated with a VOSS Insights Arbitrator server is deleted, the asset, customer-specific probes, profiles, credentials, and related data are removed from the Arbitrator.

The VOSS Insights Arbitrator data syncs for the UC app are also removed.

Additional Offboard Tool for Single Servers

VOSS Automate provides a view that is not, by default, exposed in the default menus, but which has access profiles enabled for Provider and higher-level administrators. This view allows off-boarding of a single asset.

You can add this view to the menus, if required:

Offboard One Assurance Asset

This tool allows you to select the following on the page to perform off-boarding:

Assurance Arbitrator Server
Asset: Cisco UCM/CUC Server

Probes, Group Names, Profiles and Timings

When assets are onboarded, the probe groups and profiles as shown in the tables below are added to the VOSS Assurance and Analytics arbitrator.

Note

For Unified CM and Unity Connection servers, only the ping monitor profile is added.
When assets are offboarded, these are similarly removed from the arbitrator.

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

This tool offboards selected assets and related config off of a selected Assurance arbitrator server.

Model Details: view/OffboardAssuranceAssets

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
Assurance Arbitrator Server *		Select an Arbitrator server from which to remove an asset.	Field Name: arbitrator Type: String
Assurance Arbitrator PKID		Hidden field to store the selected arbitrator's PKID.	Field Name: arbitrator_pkid Type: String
	Assets	Select one or more assets to remove.	Field Name: assets.[n] Type: Array