[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-4-UC and VOSS Assurance deployed, can easily
enable monitoring of new UC applications from the VOSS-4-UC
administration portal.
The integration manages both onboarding and off-boarding
of assets to VOSS Assurance Aribitrator servers configured in VOSS-4-UC.
The UC apps are monitored by VOSS Assurance 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-4-UC
Customers and UC applications on VOSS Assurance.
With this feature, you can:
- Voss Assurance Arbitrators: Set up VOSS Assurance arbitrators in VOSS-4-UC
- Onboard Voss Assurance Assets: Onboard Assets: enable monitoring of
Unified CM and Unity Connection clusters on one or more VOSS Assurance arbitrator servers.
- Offboard Voss Assurance Assets: Offboard Assets: disable monitoring
for Unified CM and Unity Connection clusters by removing assets and related configuration
from VOSS Assurance. This will remove data from the arbitrators.
- See existing integration(s):
- Configured VOSS Assurance arbitrator servers
- Unified CM server - see which arbitrator servers are monitoring the server
- Unity Connection server - see which arbitrator servers are monitoring the server
Note
- The Arbitrator Server should be at version SP23 or higher.
- The feature does not currently allow for the modification of any existing monitoring setup
on UC Apps. Deleting a UC app on VOSS-4-UC will however remove the asset
and related configuration from all corresponding VOSS Assurance arbitrator servers.
Voss Assurance Arbitrators
Prerequisites
The management of arbitrators in VOSS-4-UC require:
- the arbitrators to be set up
- the host connection details and credentials:
admin user and password from the arbitrator
Refer to the VAA documentation for arbitrator setup.
Adding an arbitrator to VOSS-4-UC
These steps integrate the arbitrator with VOSS-4-UC by entering its connection details.
When integrated, the arbitrator is available to onboard and offboard assets
that are added or are available in VOSS-4-UC.
Choose the VOSS Assurance > Arbitrator menu. This sets the hierarchy at the provider level.
Complete the form:
- Server Name: descriptive name of the arbitrator in VOSS-4-UC - note the naming convention restrictions
- Description: an optional description
- Host Name: used to connect to the arbitrator
- User Name: credentials to log in on the arbitrator host: the admin account
- Password: credentials to log in on the arbitrator host: the admin account
- Repeat Password: credentials to log in on the arbitrator host
- Data Center: a free text field used as the location address
when arbitrator assets are created.
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-4-UC (pull sync).
Click Save.
- A data sync instance is created: SyncAssuranceArbitrator__<arbitrator-name>
- A data sync instance is created: PurgeAssuranceArbitrator__<arbitrator-name>
- A test connection is automatically carried out when saving the
arbitrator details and it can also be used to manually verify input
details and connection to the arbitrator host by using the Action menu.
- The list of arbitrators are displayed on the Arbitrator menu list view.
Next Steps
Unified CM and Unity Connection servers can now be enabled or disabled
for monitoring.
Related Topics
- Onboard Voss Assurance Assets
- Offboard Voss Assurance Assets
Removing an arbitrator
An arbitrator can be removed from the list of arbitrators under the VOSS Assurance menu.
- Select the arbitrator and choose Delete.
- The arbitrator is removed from VOSS-4-UC.
- Integration is removed. The arbitrator is removed
from VOSS-4-UC app servers (Unified CM, Unity Connection)
- On the Monitoring group of the UC app server publisher form,
the Assurance Arbitrator check box is removed.
- Created pull/purge data syncs on VOSS-4-UC are removed.
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.
|
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
|