[Index]

Model: relation/HcsRegionREL

Regions

Full HTML Help

Overview

Regions can only be added at a Customer or Site hierarchy level. Regions added directly on 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.

Add or Manage Regions

This procedure adds, edits, and deletes regions.

  1. Log in as Provider, Reseller or Customer administrator.

  2. Go to (default menus) Apps Management > CUCM > Regions.

  3. Choose the hierarchy (Customer or Site).

  4. Choose an option:

  5. At CUCM drop-down menu, choose or modify the CUCM (network device) for the region.

  6. 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.

  7. 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.

  8. Click Save.

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

Model Details: relation/HcsRegionREL

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%24NtTgTLSIbaR5WbsY%24RCz%2BMYEImqhhSADBR8mntdkkFP%2B1Q12bcPInTM2Cgikrl4Lu0D2mHWHMYb7DIp5WJnZE8DD1EzRqMSIgBQ%2BdfJuBMCKTHOFa6SgDHL6olox9GXVne4VRaAoTz0GfRP0b/MRBhQ83rqGNmD9crSFvOXdOH2fbXlHIzP7MVfFmUOAKDP6WHY9GSlzTML7eBDIDfYSkYaE/P92603pk%2BEbC48ilfR2e4gsOS2Pg9Fl9tYP7nXYRd9l09qUbTJD/6/HH9IQwE8XRG2O/w50Xj1tvEjR4GK3FjwxuEnMROzBpC%2Bw9ZOuxtGjAVqdBBCtfGuqX%2B/w7o%2Br197KTDNvCeoDj96qo0iNz4muOFGYx9wsiXYR4WKewS11ycAmu6Un9YhNVk9D3CajOLWVdyITF6pwjD30KvrkuBJix/vyfVfd3lb2oIPTbAfTBvQ8zzpueKcKB8JZFNcOYINwInawuKALpRl4p28yxwN%2BFKX8yM34/Nzk%2BQYfcwVsPcmjfB9Q%3D%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: [" "]