Model: device/cucm/Location

• 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

Between Locations

Field Name: betweenLocations Type: ["Object", "Null"] Cardinality: [1..1]

Between Location

Field Name: betweenLocation.[n] Type: Array Cardinality: [1..n]

Location *

Enter the name of the new location that you are creating. Three system locations are predefined: Hub_None— Hub_None is an example location that typically serves as a hub linking two or more locations. It is configured by default with unlimited intra-location bandwidth allocations for audio, video, and immersive bandwidth, but you can specify bandwidth allocations for each of these. By default, devices not assigned to other locations are assigned to Hub_None. Note    The location that is configured in a device pool takes precedence over the location configured in the device when the location in the device is set to Hub_None. If the device location is set to any other user-defined location, standard rules apply and the device parameter takes priority. Phantom—Phantom location specifies unlimited audio bandwidth, unlimited video bandwidth, and unlimited immersive video bandwidth.. Specify this location to allow successful call admission control for calls across inter-cluster trunks that use the H.323 protocol or SIP trunks to certain destinations that support the earlier Location CAC feature. Note    Both Hub_None and Phantom locations do allow configuration of the associated RSVP policy setting(s). Shadow—Shadow is a system location created for inter-cluster Enhanced Location CAC. In order to pass location information across clusters, the SIP ICT must be assigned to the system location Shadow.

Field Name: betweenLocations.betweenLocation.[n].locationName Type: String Target: device/cucm/Location Target attr: name Cardinality: [1..1] Format: uri

Immersive Bandwidth *

Enter the maximum amount of immersive video bandwidth (in kb/s) that is available for all immersive video calls on the link within this location. For video calls, the immersive video bandwidth does not include overhead. Choose among the following options: None—The system does not allow immersive video calls between this location and other locations. Immersive video calls can, however, take place within this location. Specified bandwidth—Specify an immersive video bandwidth by clicking the radio button next to the kb/s box and entering a specified immersive video bandwidth. The default value specifies 384 kb/s. Unlimited bandwidth—Click the Unlimited radio button. Default: 384

Field Name: betweenLocations.betweenLocation.[n].immersiveBandwidth Type: Integer Cardinality: [1..1] Default: 384 Choices: ["None", "Unlimited"]

Weight *

Enter the relative priority of this link in forming the Effective Path between any pair of Locations. The Effective Path has the least cumulative Weight of all possible paths. Valid values are 0-100. Default: 50

Field Name: betweenLocations.betweenLocation.[n].weight Type: Integer Cardinality: [1..1] Default: 50

Video Bandwidth (kbps) *

Enter the maximum amount of video bandwidth (in kb/s) that is available for all video calls on the link between this location and other locations. For video calls, the video bandwidth does not include overhead. Choose among the following options: None—The system does not allow video calls between this location and other locations. Specified bandwidth—Specify a video bandwidth by clicking the radio button next to the kb/s box and entering a specified video bandwidth. The default value specifies 384 kb/s. Unlimited bandwidth—Click the Unlimited radio button. Default: 384

Field Name: betweenLocations.betweenLocation.[n].videoBandwidth Type: Integer Cardinality: [1..1] Default: 384 Choices: ["None", "Unlimited"]

blank *

Enter the maximum amount of audio bandwidth (in kb/s) that is available for all audio calls on the link between this location and other locations. For audio calls, the audio bandwidth includes overhead. Choose between the following options: Unlimited bandwidth—Click the Unlimited radio button. Specified bandwidth—Specify a bandwidth by clicking the radio button next to the kb/s box and entering a specified bandwidth. Valid values are 1 to 2147483647. For purposes of location bandwidth calculations only, assume that each call stream consumes the following amount of bandwidth: G.711 call uses 80 kb/s. G.722 call uses 80 kb/s. G.723 call uses 24 kb/s. G.728 call uses 16 kb/s. G.729 call uses 24 kb/s. GSM call uses 29 kb/s. Wideband call uses 272 kb/s. Note    To improve audio quality, lower the bandwidth setting, so fewer active calls are allowed on this link.

Field Name: betweenLocations.betweenLocation.[n].audioBandwidth Type: Integer Cardinality: [1..1] Choices: ["Unlimited"]

Name *

Enter the name of the new location that you are creating. Three system locations are predefined: Hub_None— Hub_None is an example location that typically serves as a hub linking two or more locations. It is configured by default with unlimited intra-location bandwidth allocations for audio, video, and immersive bandwidth, but you can specify bandwidth allocations for each of these. By default, devices not assigned to other locations are assigned to Hub_None. Note    The location that is configured in a device pool takes precedence over the location configured in the device when the location in the device is set to Hub_None. If the device location is set to any other user-defined location, standard rules apply and the device parameter takes priority. Phantom—Phantom location specifies unlimited audio bandwidth, unlimited video bandwidth, and unlimited immersive video bandwidth.. Specify this location to allow successful call admission control for calls across inter-cluster trunks that use the H.323 protocol or SIP trunks to certain destinations that support the earlier Location CAC feature. Note    Both Hub_None and Phantom locations do allow configuration of the associated RSVP policy setting(s). Shadow—Shadow is a system location created for inter-cluster Enhanced Location CAC. In order to pass location information across clusters, the SIP ICT must be assigned to the system location Shadow.

Field Name: name Type: String Cardinality: [1..1] MaxLength: 50

Related Locations

Field Name: relatedLocations Type: ["Object", "Null"] Cardinality: [0..1]

Related Location

Field Name: relatedLocation.[n] Type: Array Cardinality: [1..n]

Location Name *

To change the RSVP policy setting between the current location and a location that displays in this pane, choose a location in this pane.

Field Name: relatedLocations.relatedLocation.[n].locationName Type: String Target: device/cucm/Location Target attr: name Cardinality: [1..1] Format: uri

Rsvp Setting *

To choose an RSVP policy setting between the current location and the location that is chosen in the Location pane at left, choose an RSVP setting from the drop-down list box. Choose from the following available settings: Use System Default—The RSVP policy for the location pair matches the clusterwide RSVP policy. No Reservation—No RSVP reservations can get made between any two locations. Optional (Video Desired)—A call can proceed as a best-effort audio-only call if failure to obtain reservations for both audio and video streams occurs. RSVP Agent continues to attempt RSVP reservation and informs Cisco Unified Communications Manager if reservation succeeds. Mandatory— Cisco Unified Communications Manager does not ring the terminating device until RSVP reservation succeeds for the audio stream and, if the call is a video call, for the video stream as well. Mandatory (Video Desired)—A video call can proceed as an audio-only call if a reservation for the video stream cannot be reserved.

Field Name: relatedLocations.relatedLocation.[n].rsvpSetting Type: String Cardinality: [1..1] Choices: ["Use System Default", "No Reservation", "Optional(Video Desired)", "Mandatory", "Mandatory(Video Desired)", "Allow Subscription", "Disallow Subscription"]

blank *

Enter the maximum amount of immersive video bandwidth (in kb/s) that is available for all immersive video calls on the link within this location. For video calls, the immersive video bandwidth does not include overhead. Choose among the following options: None—The system does not allow immersive video calls between this location and other locations. Immersive video calls can, however, take place within this location. Specified bandwidth—Specify an immersive video bandwidth by clicking the radio button next to the kb/s box and entering a specified immersive video bandwidth. The default value specifies 384 kb/s. Unlimited bandwidth—Click the Unlimited radio button.

Field Name: withinImmersiveKbits Type: Integer Cardinality: [1..1]

blank *

Enter the maximum amount of audio bandwidth (in kb/s) that is available for all audio calls on the link between this location and other locations. For audio calls, the audio bandwidth includes overhead. Choose between the following options: Unlimited bandwidth—Click the Unlimited radio button. Specified bandwidth—Specify a bandwidth by clicking the radio button next to the kb/s box and entering a specified bandwidth. Valid values are 1 to 2147483647. For purposes of location bandwidth calculations only, assume that each call stream consumes the following amount of bandwidth: G.711 call uses 80 kb/s. G.722 call uses 80 kb/s. G.723 call uses 24 kb/s. G.728 call uses 16 kb/s. G.729 call uses 24 kb/s. GSM call uses 29 kb/s. Wideband call uses 272 kb/s. Note    To improve audio quality, lower the bandwidth setting, so fewer active calls are allowed on this link.

Field Name: withinAudioBandwidth Type: Integer Cardinality: [1..1]

blank *

Enter the maximum amount of video bandwidth (in kb/s) that is available for all video calls on the link between this location and other locations. For video calls, the video bandwidth does not include overhead. Choose among the following options: None—The system does not allow video calls between this location and other locations. Specified bandwidth—Specify a video bandwidth by clicking the radio button next to the kb/s box and entering a specified video bandwidth. The default value specifies 384 kb/s. Unlimited bandwidth—Click the Unlimited radio button.

Field Name: withinVideoBandwidth Type: Integer Cardinality: [1..1]