Model: data/CucmGroupSelection

CUCM Group Selection

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

Provider level administrators can manage the Default CUCM Group setting in a customer's Site Defaults:

The least utilized Group can be calculated, in other words the group with the least number of phones can automatically be determined.

In this case, the administrator can set the Default CUCM Group in the customer's Site Defaults to automatically be the least utilized group so that CUCM Groups are optimally assigned whenever a site is created.

The current device utilization of customer CUCM Groups can be inspected. Device utilization is calculated by inspection of the Device Pools that belong to a CUCM Group of a CUCM cluster and the number of Phones in these Device Pools.

The administrator can therefore inspect the CUCM Group counts and then choose a Default CUCM Group to be the Default CUCM Group in the customer's Site Defaults.

High level administrators carry out these tasks from the Customer Management > Advanced > CUCM Group Selection and CUCM Group Counts menus.

Select a CUCM Group

The list of existing CUCM Group Selection configurations at the Provider hierarchy are listed.

Click Add to create a configuration. A hierarchy pop-up will show to choose the customer hierarchy at which the configuration should apply.

Choose a Name for the configuration. The default name is the hierarchy name.

Choose an Algorithm to apply to the CUCM Group Selection:

If Use Default is selected, the Site Defaults doc is updated if necessary so that the Default CUCM Group is applied.

Note: The CUCM Group called Default is always used when adding a Site unless the "Least utilized" algorithm has been selected. Default will also be the fallback CUCM Group in the event that all CUCM Groups have been excluded from the selection.
If Least utilized CUCM Group is selected from the Algorithm drop-down, options are available to include and exclude specific CUCM groups from the algorithm.
- If no groups are included or excluded, all groups available at the customer hierarchy are considered by the algorithm.
- If groups are added to the CUCM Groups to Include, only these groups are considered by the algorithm.
- If groups are added to the CUCM Groups to Exclude, these groups are not considered by the algorithm, unless they have also been added to the Groups to Include.
The table below summarizes the options and outcomes:

Group Selection	Algorithm	Include List	Exclude List	Result	Comment
No	Use Default	N/A	N/A	Default	Falls back to Default always
Yes	Use Default	None	None	Default
Yes	Least utilized	None	None	Least utilized
Yes	Least utilized	Yes	None	Least utilized	From the groups in the included list.
Yes	Least utilized	None	Yes	Least utilized	Least utilized from all groups except in the exclude list.
Yes	Least utilized	Yes	Yes	Least utilized	From the groups in the included list. Note that the exclude list will be ignored in this case.

Group Selection

Algorithm

Include List

Exclude List

Result

Comment

Use Default

N/A

Default

Falls back to Default always

Yes

Use Default

None

Default

Yes

Least utilized

None

Least utilized

Yes

Least utilized

Yes

None

Least utilized

From the groups in the included list.

Yes

Least utilized

None

Yes

Least utilized

Least utilized from all groups except in the exclude list.

Yes

Least utilized

Yes

Least utilized

From the groups in the included list. Note that the exclude list will be ignored in this case.

Click Save to save the configuration for the customer hierarchy. When a new site is created, the Default CUCM Group in the Site Defaults Doc is updated to reflect the configuration, so that any sites that are now created under this customer hierarchy will apply the calculated CUCM Group.

Note that an administrator can override this calculated CUCM Group by manually updating the Site Defaults Doc.

Data model to control if the CUCM Group should be available for use. This is to allow for load balancing devices between CUCM Groups. Only one instance may exist at Customer level.

Model Details: data/CucmGroupSelection

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
Cucm Group Selection			Group Assigned by FDP	Field Name: Cucm Group Selection Type: Object
	Name		Name of the CUCM Group Selection	Field Name: Cucm Group Selection.name Type: String
	Algorithm		Algorithm to use when selecting the CUCM Group Default: Use Default	Field Name: Cucm Group Selection.algorithm Type: String Default: Use Default Choices: ["Use Default", "Least utilized CUCM Group"]
		CUCM Groups to Include	CUCM Group Include list. Only groups in this list will be used for load balancing.	Field Name: include_list.[n] Type: Array
		CUCM Groups to Exclude	CUCM Group Exclude list. Groups in this list will be excluded for load balancing.	Field Name: exclude_list.[n] Type: Array
	Notes		Notes describing the feature. Default: CUCM Group Selection is used to select the lowest utilized group in CUCM. The VOSS Automate system will find the CUCM Group with the lowest amount of Phones and save that group to the Site Default Doc. This value is stored when the Site is created and can be changed afterwards. When using algorithm "Least utilized CUCM Group", include and exclude lists will be available to further limit the selection process. Please note that the include list will override the exclude list.	Field Name: Cucm Group Selection.notes Type: String Default: CUCM Group Selection is used to select the lowest utilized group in CUCM. The VOSS Automate system will find the CUCM Group with the lowest amount of Phones and save that group to the Site Default Doc. This value is stored when the Site is created and can be changed afterwards. When using algorithm "Least utilized CUCM Group", include and exclude lists will be available to further limit the selection process. Please note that the include list will override the exclude list.