PlcmCallServerV2

PlcmCallServerV2

Access to Call Server configuration.


PlcmCallServerV2 Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
allowCallsToInactiveEndpointsboolean Include inactive endpoints when resolving the dial rules Mandatory
allowCallsFromNonRogueEndpointsboolean Allow/deny calls from unregistered out of territory endpoints (non-rogue). Value is ignored if rogue-call-policy enum value is specified.
allowUnregisteredEndpointCallsboolean Allow/deny calls from unregistered in territory endpoints (rogue). Value is ignored if rogue-call-policy enum value is specified.
rogueCallPolicyRogueCallPolicy Policy for allowing calls to and from unregistered endpoints in and out of territory.
availableBandwidthLimitint Available bandwidth limit allocated to a single call (%) Mandatory
territoryDelayint The value in seconds of refresh territory's primary node's status Mandatory
forwardNoAnswerTimeoutint The number of seconds to wait for a callee no answer before the call is forwarded to an alternate endpoint Mandatory
registrationRefreshIntervalint For H.323 endpoints, this specifies how often registered endpoints send 'keep alive' messages to the Call Server. For SIP endpoints, this specifies the refresh interval used if the endpoint did not specify an interval or specified on greater than this value. Mandatory
sipGatewayCallsLrqWithEmailNotE164boolean For SIP calls gatewayed to an external gatekeeper, use the H323 email ID as the destination Mandatory
enableRegistrationSharingboolean If registrations are shared with an external server or not.
regSharingHoststring IP or FQDN of the host to share registration information with.
regSharingPortint Port of the host to share registration information with.
regSharingUsernamestring Username used for registration sharing if the host being shared to requires credentials.
regSharingUserpassstring Password for user used for registration sharing if the host being shared to requires credentials.
regSharingDeleteInactiveEndpointsboolean Select to specify that shared registrations whose status is Inactive (that is, their registrations have expired) are deleted from the system after the specified number of days. Some dial rule actions, such as Resolve to registered endpoint, can route calls to endpoints with an inactive registration. Deleting the registration record is the only way to prevent resolution to an inactive endpoint.
enableRegistrationSharingAdditionalListeningNICboolean If the receiver of the registrations API additions can listen on another NIC
regSharingListeningNICRegSharingListeningNic The extra NIC to listen to added registrations API
regSharingListeningPortint Alternative Port to listen to API calls the host to share registration information with.
regSharingSendingNICRegSharingSendingNic The NIC to send on API requests to add registrations
regSharingInactiveRegistrationDaysToDeleteint Select to specify that shared registrations whose status is Inactive (that is, their registrations have expired) are deleted from the system after the specified number of days. Some dial rule actions, such as Resolve to registered endpoint, can route calls to endpoints with an inactive registration. Deleting the registration record is the only way to prevent resolution to an inactive endpoint.
minimumRegistrationExpiresint Sip Registration minimum expiration time (second) Mandatory
proxyTimeOutint The value in seconds of a SIP peer call to time out. Mandatory
maxBreadthint The maximum allowable SIP max breadth value for incoming requests. Mandatory
optionsPingIntervalOptionsPingInterval SIP OPTIONS ping timer (seconds)
optionsPingFailureCodesArray of OptionsPingFailureCodes SIP OPTIONS ping failure status codes
proxyFailureCodesArray of ProxyFailureCodes Nonresponsive SIP peer status codes
nextExtProxyTimeoutNextExtProxyTimeout Try next SIP peer timeout (seconds)
sipOutboundKeepAliveIntervalSipOutboundKeepAliveInterval Keep-alive interval as defined in RFC-5626
enableNoEpCrlfKeepAliveboolean This setting specifies whether or not the SIP Proxy should send CRLF keep-alive messages to endpoints that do not support RFC-5626. Default is enabled (true)
noEpCrlfKeepAliveIntervalint Keep-alive interval for endpoints that do not support RFC-5626. Keep-alive interval range is between 60 and 9999 seconds and defaults to 120 seconds.
routedCallModeboolean This setting specifies whether the H.323 gatekeeper is operating in routed mode (true) or direct mode (false). In routed mode the gatekeeper proxies all H.323 signaling messages. In direct mode only H.225.0 RAS call control messages are proxied through the gatekeeper; all other call signaling and media control messages are exchanged directly between endpoints. Mandatory
onlyAcceptNeighborLrqboolean Specifies whether or not Janus will only accept and respond to LRQ messages from external Gatekeepers that are in its neighbor list or if it will attempt to service any LRQ sent to it per H.225 protocol specifications Mandatory
deriveH323EmailIdsForOtherAliasesboolean Resolve email ID dial strings to another local alias by using the user part of the email address. For example, the dial string 1234@company.com would resolve to the endpoint registered as 1234 Mandatory
associateEmailIdToEndpointboolean If this option is enabled and the system is integrated with Active Directory, an endpoint associated with an enterprise user is assigned the user's email address as an H.323 email ID Mandatory
lrqHopCountint The initial hop count used when the Janus system sends an LRQ to a neighbor Mandatory
lrqTimeOutint The value in seconds to wait for a response from any neighbor Mandatory
irqIntervalint The interval at which the call server should send IRQ messages to H.323 endpoints in a call Mandatory
enableIrqCallTerminationboolean Allows the termination calls due to failure or negative response to an IRQ message from the DMA requesting active call information. Mandatory
endpointsBelongToEachDomainForSipboolean Specifies that call requests for locally registered SIP endpoints do not have to match the domain. If not enabled, call requests must exactly match the URI of the registered endpoint Mandatory
endpointsBelongToEachDomainForH323boolean Specifies that call requests for registered H.323 endpoints' email IDs do not have to match the domain. If not enabled, call requests must exactly match the URI of the registered endpoint Mandatory
belongToLocalDomainForConferenceboolean Specifies whether or not to ignore the domain part of the dial string when the conference ID rule is used Mandatory
domainNamesArray of string The list of domains from which registrations are accepted by the system. If the list is empty, all domains are considered local, and the system accepts endpoint registrations from any domain. When updating the call server configuration, the following conventions will be followed: 1) If the sip-domains list is not supplied then the currently configured domains will be preserved. 2) If the sip-domains list is supplied but only contains empty domain-name elements then the list of domains in the current configuration will be cleared. 3) If the sip-domains list is supplied and contains any non-empty domain-name elements then the current configuration will be replaced with the new list.
allowSitelessRegistrationboolean Allows endpoints to register when their IP Addresses do not correspond to any subnet configured in the site topology. As of DMA 10.0 this field is no longer used. It has been replaced by RegistrationPolicy.getAllowSitelessRegistration
entityTagEntityTag 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.
lyncConferenceIdQueryTimeoutint The number of seconds that we will query a lync server before timing out that query. This value must be between 1 and 20 seconds. Mandatory
bandwidthConversionFactorBandwidthConversionFactor Conversion from bit rate to estimated bi-directional bandwidth used by a call. Range is from 1.000 to 5.000
blacklistEnabledboolean Dynamically blacklist signaling from hyperactive endpoints
grqQuarantineboolean Quarantine blacklisted endpoints. They remain in Quarantined or Quarantined (Inactive) status (unable to make or receive calls) until manually removed from quarantine.
grqIgnoreVbpboolean Don't exempt video border proxy (VBP) traffic from blacklisting.
rrqQuarantineboolean Quarantine blacklisted endpoints. They remain in Quarantined or Quarantined (Inactive) status (unable to make or receive calls) until manually removed from quarantine.
rrqIgnoreVbpboolean Don't exempt video border proxy (VBP) traffic from blacklisting.
cleanerTaskIntervalMinutesCleanerTaskIntervalMinutes Remove non-hyperactive endpoints from blacklist after specified interval (minutes)
grqDuplicateCountGrqDuplicateCount GRQ threshold
grqDuplicateIntervalMsGrqDuplicateIntervalMs GRQ interval (msec)
rrqDuplicateCountRrqDuplicateCount RRQ threshold
rrqDuplicateIntervalMsRrqDuplicateIntervalMs RRQ interval (msec)
lyncEdgeServerDiscoveryTimeoutLyncEdgeServerDiscoveryTimeout The number of seconds before timing out a query to a Lync edge server for MCU assignment rules. This value defaults to 10 seconds and must be between 1 and 20 seconds.
allowSendOfferlessInviteboolean Allow/deny sending offer-less invite to EP.
lrqPingIntervalLrqPingInterval H.323 LRQ ping timer (seconds)

ProxyFailureCodes Fields

NameTypeDescriptionAttributes
failureCodeFailureCodeMandatory

OptionsPingFailureCodes Fields

NameTypeDescriptionAttributes
pingFailureCodePingFailureCodeMandatory


Nested Types/Restrictions


NameTypeRestrictions
LrqPingIntervalint
LyncEdgeServerDiscoveryTimeoutint
RrqDuplicateIntervalMsint
RrqDuplicateCountint
GrqDuplicateIntervalMsint
GrqDuplicateCountint
CleanerTaskIntervalMinutesint
BandwidthConversionFactorstring
Length of value must be >=1
Length of value must be <=5
EntityTagstring
Length of value must be >=1
Length of value must be <=64
SipOutboundKeepAliveIntervalint
NextExtProxyTimeoutint
FailureCodeint
PingFailureCodeint
OptionsPingIntervalint
RegSharingSendingNicstring
Value must be one of:
  • MANAGEMENT
  • SIGNALING_LAN
  • SIGNALING_WAN
RegSharingListeningNicstring
Value must be one of:
  • MANAGEMENT
  • SIGNALING_LAN
  • SIGNALING_WAN
RogueCallPolicystring
Value must be one of:
  • ALLOW_REGISTERED_ONLY
  • ALLOW_UNREGISTERED_IN_TERRITORY
  • ALLOW_UNREGISTERED_NOT_IN_TERRITORY
  • ALLOW_REGISTERED_AND_UNREGISTERED