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

Gateway Name Example

An example of the name of the CUCM Gateway Type

Field Name: GatewayNameExample
Type: String

Gateway Name Prefix

The prefix for the name of the CUCM Gateway Type

Field Name: GatewayNamePrefix
Type: String

Protocol and Templates

Available options for this CUCM gateway type

Field Name: ProtocolTemplates.[n]
Type: Array

Protocol

One of the protocols available for this CUCM gateway type

Field Name: ProtocolTemplates.[n].Protocol
Type: String

Gateway Layout

Field Name: Layout.[n]
Type: Array

Allowed Units

Field Name: AllowedUnits.[n]
Type: Array

Allowed Subunits

Field Name: AllowedSubunits.[n]
Type: Array

Allowed Endpoints

Field Name: AllowedEndpoints.[n]
Type: Array

Endpoint Name

Field Name: ProtocolTemplates.[n].Layout.[n].AllowedUnits.[n].AllowedSubunits.[n].AllowedEndpoints.[n].EndpointName
Type: String

Starting Port

Field Name: ProtocolTemplates.[n].Layout.[n].AllowedUnits.[n].AllowedSubunits.[n].AllowedEndpoints.[n].StartPort
Type: Integer

Subunit Name

Field Name: ProtocolTemplates.[n].Layout.[n].AllowedUnits.[n].AllowedSubunits.[n].SubunitName
Type: String

Number of Allowed Ports

Field Name: ProtocolTemplates.[n].Layout.[n].AllowedUnits.[n].AllowedSubunits.[n].NumAllowedPorts
Type: Integer

Number of Allowed Subunits

Field Name: ProtocolTemplates.[n].Layout.[n].AllowedUnits.[n].NumAllowedSubunits
Type: Integer

Unit Name

Field Name: ProtocolTemplates.[n].Layout.[n].AllowedUnits.[n].UnitName
Type: String

Unit Position

Position of unit on this CUCM gateway type & protocol

Field Name: ProtocolTemplates.[n].Layout.[n].UnitPosition
Type: Integer

Vendor Config

JSON string - Available vendor config for this CUCM gateway type & protocol

Field Name: ProtocolTemplates.[n].VendorConfig
Type: ["String"]

Gateway Type Name

The CUCM Gateway Type name

Field Name: GatewayType
Type: String

Gateway Name Format

The format for the name of CUCM Gateway Type

Field Name: GatewayNameFormat
Type: String

Model: device/cucm/GatewayType

Model Details