The External Gatekeeper object is created to configure the information needed to connect and communicate with a primary External H.323 Gatekeeper. Content-Type: application/vnd.plcm.plcm-ext-gatekeeper+xml. All attributes are used in ETag calculation except for entity-tag and atom-link.
| Name | Type | Description | Attributes |
|---|---|---|---|
| plcmExtGatekeeperAuthentication | PlcmExtGatekeeperAuthentication | See Definition of PlcmExtGatekeeperAuthentication | |
| atomLinkList | Array of Link | See Definition of Link | |
| extGatekeeperIdentifier | string | Internal identifier. Provided to protect against a name update. | |
| enabled | boolean | This check box allows to stop using an external gatekeeper without deleting it. | Mandatory |
| gatekeeperName | GatekeeperName | A meaningful name for the external gatekeeper. This field is mandatory. Max size 128 characters. | Mandatory |
| gatekeeperDescription | GatekeeperDescription | A brief description of the External Gatekeeper. Max size 128 characters. | |
| address | Address | Fully qualified domain name (FQDN), host name, or IP address of the external gatekeeper. If you specify a domain/host name, the system routes calls to this gatekeeper by using DNS to resolve the address. The DNS server that the system uses must contain the required records (NAPTR, SRV, and/or A/AAAA). Max size 128 characters. | Mandatory |
| rasPort | int | The RAS (Registration, Admission and Status) channel port number. Leave set to 1719 unless you know the gatekeeper is using a non-standard port number. | Mandatory |
| prefixRange | PrefixRange | The dial string prefix or prefix range for which the external gatekeeper is responsible. Enter a single prefix (44), a range of prefixes (44-47), multiple prefixes separated by commas (44,46), or a combination (41, 44-47, 49). If your dial plan uses the Dial services by prefix dial rule (in the default dial plan) to route calls to services, all dial strings beginning with an assigned prefix are forwarded to this gatekeeper for resolution. If your dial plan instead uses a rule that you create to apply the Resolve to external gatekeeper action, there is no need to specify a prefix. Max size 128 characters. | |
| stripPrefix | boolean | If selected, the system strips the prefix when a call that includes a prefix is routed to this gatekeeper. | |
| preferRouted | boolean | If selected (the default), the system forces all calls to this gatekeeper to routed mode. This setting must be enabled to avoid interoperability issues with Polycom CMA and Avaya gatekeepers, and possibly others as well. | |
| lrqPing | boolean | If true, the system sends LRQ ping messages to the H.323 gatekeeper to determine ts responsiveness. | |
| entityTag | EntityTag | The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance. | |
| authentication | boolean | Enable the gatekeeper authentication by configure the system to send its H.235 credentials when it sends address resolution requests to that gatekeeper. | |
| postliminaryEnabled | boolean | Flag indicating that the dial rule preliminary is enabled. | |
| script | string | A Javascript executable script that defines filtering and/or transformation actions applied to a dial string. | |
| gatekeeperType | GatekeeperType | For a DMA Gatekeeper that is responsible for counting call call licenses, select DMA_Licensed. For a DMA Gatekeeper that relies on a DMA_Licensed peer to count call licenses, select DMA_Subordinate. Otherwise, select Other. |
| Name | Type | Restrictions |
|---|---|---|
| GatekeeperType | string | Value must be one of:
|
| EntityTag | string | Length of value must be >=1 Length of value must be <=64 |
| PrefixRange | string | Length of value must be >=0 Length of value must be <=128 |
| Address | string | Length of value must be >=1 Length of value must be <=128 |
| GatekeeperDescription | string | Length of value must be >=0 Length of value must be <=128 |
| GatekeeperName | string | Length of value must be >=1 Length of value must be <=128 |