Model: relation/HcsRegionREL

Regions

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

This procedure adds, edits, and deletes a region.

Note

Regions can only be added at a Customer or Site hierarchy level.
Regions added directly on Cisco Unified Communications Manager (CUCM) are synced in at the hierarchy level the CUCM is configured at in VOSS Automate.
Regions can be modified or deleted at any hierarchy level. When deleting a region, related regions can't be removed from a region. They exist until either region is deleted.

Perform these steps:

Log in as Provider, Reseller or Customer administrator.
Go to (default menus) Apps Management > CUCM > Regions.
Choose the hierarchy (Customer or Site).
Choose an option:
- To delete a region, click on the name of the relevant region, then click Delete. Click Yes to confirm.
- To edit an existing region, click on the name of the relevant region. Go to step 5.
- To add a new region, click Add. Go to step 5.
At CUCM drop-down menu, choose or modify the CUCM (network device) for the region.
At the Name field, for a new region, enter a unique name for the region, or to edit the region, update the name, if required.

Note

If region is for a CUCM group, use AR_ RSMSimPhone as the region name.

At Related Regions, add or update the following details, as required:

Option	Description
Region Name	Drop-down menu with list of available regions. This field is mandatory.
Audio Codec Preference List	This is a drop-down containing available Audio Codec Preference Lists. The default codec is G.711.
Audio Bandwidth	Maximum Audio Bit Rate (kbps). This field is mandatory. If region is for a CUCM group, choose 64 kbps (G.711)
Video Bandwidth	Maximum Session Bit Rate for Video Calls (kbps). This field is mandatory.
Immersive Video Bandwidth	Maximum Session Bit Rate for Immersive Video Calls (kbps). This field is mandatory.

Click Save.

This relation wraps the default CUCM Region element to allow for targeted network device addition.

Model Details: relation/HcsRegionREL

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
Default Codec															Not valid for get and list Default: G.711																				Field Name: defaultCodec Type: String Cardinality: [0..1] Default: G.711
Name *															Enter a unique name for this region. This name can comprise up to 30 characters. Valid characters include letters, numbers, dashes, dots (periods), blanks, and underscores. Note Cisco recommends that you reset devices after changing a region name.																				Field Name: name Type: String Cardinality: [1..1] MaxLength: 50
Related Regions																																			Field Name: relatedRegions Type: ["Object", "Null"] Cardinality: [0..1]
		Related Region																																	Field Name: relatedRegion.[n] Type: Array Cardinality: [1..n]
			Lossy Network																																Field Name: relatedRegions.relatedRegion.[n].lossyNetwork Type: String Cardinality: [0..1] Choices: ["Keep Current Setting", "Use System Default", "Low Loss", "Lossy"]
			Immersive Video Bandwidth *												The entries in this column specify the maximum immersive video bit rate (including audio) between the region that you are configuring and the region that displays in the corresponding row. Default: 2147483647																				Field Name: relatedRegions.relatedRegion.[n].immersiveVideoBandwidth Type: Integer Cardinality: [1..1] Default: 2147483647 Choices: ["Use System Default", "Not Allowed"]
			Bandwidth *												The entries in this column specify the maximum audio bit rate between the region that you are configuring and the region that displays in the corresponding row. Default: 64																				Field Name: relatedRegions.relatedRegion.[n].bandwidth Type: String Cardinality: [1..1] Default: 64 Choices: ["Use System Default", "7 kbps (GSM-HR, G.723.1)", "8 kbps (G.729)", "13 kbps (GSM-FR, AMR)", "16 kbps (iLBC, G.728)", "24 kbps (AMR-WB)", "32 kbps (iSAC, G.722.1)", "64 kbps (G.711, G.722)", "128 kbps (AAC-LD [LATM])", "256 kbps (L16, AAC-LD)"]
			Video Bandwidth (kbps) *												The entries in this column specify the maximum video bit rate (including audio) between the region that you are configuring and the region that displays in the corresponding row. Default: 384																				Field Name: relatedRegions.relatedRegion.[n].videoBandwidth Type: Integer Cardinality: [1..1] Default: 384 Choices: ["Use System Default", "Not Allowed"]
			Codec Preference												The entries in this column specify the audio codec preference relationship between the region that you are configuring and the region that displays in the corresponding row.																				Field Name: relatedRegions.relatedRegion.[n].codecPreference Type: ["String", "Null"] Cardinality: [0..1]
			Regions *												The entries in this window pane specify all existing regions, including the Default region, the region that you are configuring, and all other regions. Choose a region in this pane prior to configuring the relationships between the region that you are configuring and the chosen region.																				Field Name: relatedRegions.relatedRegion.[n].regionName Type: String Target: /api/device/cucm/Region/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24EgO3BKpFkLrq2V9T%246uJrGwaMLlSpqC9trNgGZa1yOENi3dbXi41dZm9i/wjTtH2HqxYjJg9WDTbFXPTEy9lEKTLMLBC2GIfkLSZYIBOnykGdcaXFdeen24GEXU3V2noAfuHAFk3fmAv5TCK93t0CNtc1qr4DcttP3XO8Yds07KmUuB24XcxYl3Fbi8pvbvsK28mnKyXbENsWD3/t%2B0IsMCaPv5D22APTRCZJH6ZRCOqsUQlj6%2BUcNIpfVv%2BF1JFGyfNKiiwRZsTvTZS5YtcR4gCJUeIvf%2BEawt%2BD1zSKONlnFk8KgmG%2BERcBMC03unK/h6/2/1IO1gbpEPVqxbDbqVAVE%2BOaVUtkSg0NC1QjU9rSScZrunPd%2BwZOp/Idj5EYqs%2Bv2/rtwqhZ%24%3D%3D Target attr: name Target Model Type: device/cucm/Region Cardinality: [1..1] Format: uri Choices: []
Network Device																																			Field Name: networkDevice Type: Object
	Network Device														Select the network device for which you would like to add this element.																				Field Name: networkDevice.nd Type: String Choices: [" "]