[Index]

Model: relation/HcsRegionREL

Regions

Regions can only be added at the customer or site hierarchy level but can be modified at any hierarchy level. Regions added directly on Cisco Unified Communications Manager are synced in at the hierarchy level the Cisco Unified Communications Manager is configured at in VOSS-4-UC.

Procedure

  1. Log in as provider, reseller or customer administrator.

  2. Choose Device Management > CUCM > Regions.

  3. Perform one of the following:

  4. From the CUCM drop-down menu, choose or modify the Cisco Unified Communications Manager that corresponds to the Region.

  5. Enter a unique name for the new Region in the Name field, or modify the existing Name if desired.

  6. In the + Related Regions section, configure the following options:

    Option Description
    Region Name Drop-down menu with list of available regions. This field is mandatory.
    Audio Codec Preference Lidst 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.
    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.

  7. To save a new or updated group, click Save.

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

Model Details

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: device/cucm/Region
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
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: [" "]
API reference for relation/HcsRegionREL