plcm-call-server-v3.xsd Documentation

Imported Namespaces

Target Namespace

Elements

plcm-call-server-v3  PlcmCallServerV3

Access to Call Server configuration.


Complex Types

PlcmCallServerV3 Fields

NameTypeDescriptionAttributes
atomLinkList List of linkSee Definition of link
allow-calls-to-inactive-endpointsxs:boolean Include inactive endpoints when resolving the dial rules Mandatory
allow-calls-from-non-rogue-endpointsxs:boolean Allow/deny calls from unregistered out of territory endpoints (non-rogue). Value is ignored if rogue-call-policy enum value is specified.
allow-unregistered-endpoint-callsxs:boolean Allow/deny calls from unregistered in territory endpoints (rogue). Value is ignored if rogue-call-policy enum value is specified.
rogue-call-policyRogueCallPolicy Policy for allowing calls to and from unregistered endpoints in and out of territory.
available-bandwidth-limitxs:int Available bandwidth limit allocated to a single call (%) Mandatory
territory-delayxs:int The value in seconds of refresh territory's primary node's status Mandatory
forward-no-answer-timeoutxs:int The number of seconds to wait for a callee no answer before the call is forwarded to an alternate endpoint Mandatory
registration-refresh-intervalxs:int 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
sip-gateway-calls-lrq-with-email-not-e164xs:boolean For SIP calls gatewayed to an external gatekeeper, use the H323 email ID as the destination
enable-message-sharingxs:boolean If messages are shared with an destination DMA or not.
message-sharing-hostxs:string IP or FQDN of the host to share information with.
message-sharing-portxs:int Port of the host to share information with.
message-sharing-usernamexs:string Username used for message sharing if the destination DMA being shared to requires credentials.
message-sharing-userpassxs:string Password for user used for message sharing if the destination DMA being shared to requires credentials.
poly-evo-registration-sharing-peer-idxs:string The UUID of the Poly EVO peer to use for registration sharing.
enable-message-sharing-additional-listening-NICxs:boolean If the local DMA should listen on another NIC for share messages.
message-sharing-listening-NICMessageSharingListeningNic The extra NIC to listen to for share messages.
message-sharing-listening-portxs:int The Port to use when listening for DMA messages on the above defined message-sharing-listeining-NIC interface.
message-sharing-sending-NICMessageSharingSendingNic The local DMA NIC to send DMA share messages.
reg-sharing-inactive-registration-days-to-deletexs:int 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. A 0 or empty configuration will turn this feature off. 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.
minimum-registration-expiresxs:int Sip Registration minimum expiration time (second) Mandatory
proxy-time-outxs:int The value in seconds of a SIP peer call to time out. Mandatory
max-breadthxs:int The maximum allowable SIP max breadth value for incoming requests. Mandatory
options-ping-intervalOptionsPingInterval SIP OPTIONS ping timer (seconds)
options-ping-failure-codesList of OptionsPingFailureCodes SIP OPTIONS ping failure status codes
proxy-failure-codesList of ProxyFailureCodes Nonresponsive SIP peer status codes
next-ext-proxy-timeoutNextExtProxyTimeout Try next SIP peer timeout (seconds)
sip-outbound-keep-alive-intervalSipOutboundKeepAliveInterval Keep-alive interval as defined in RFC-5626
enable-no-ep-crlf-keep-alivexs:boolean 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)
no-ep-crlf-keep-alive-intervalxs:int 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.
routed-call-modexs:boolean 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
only-accept-neighbor-lrqxs:boolean 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
derive-h323-email-ids-for-other-aliasesxs:boolean 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
associate-email-id-to-endpointxs:boolean 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
lrq-hop-countxs:int The initial hop count used when the Janus system sends an LRQ to a neighbor Mandatory
lrq-time-outxs:int The value in seconds to wait for a response from any neighbor Mandatory
irq-intervalxs:int The interval at which the call server should send IRQ messages to H.323 endpoints in a call Mandatory
enable-irq-call-terminationxs:boolean Allows the termination calls due to failure or negative response to an IRQ message from the DMA requesting active call information. Mandatory
endpoints-belong-to-each-domain-for-sipxs:boolean 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
endpoints-belong-to-each-domain-for-h323xs:boolean 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
belong-to-local-domain-for-conferencexs:boolean Specifies whether or not to ignore the domain part of the dial string when the conference ID rule is used Mandatory
domain-namesList of xs: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.
allow-siteless-registrationxs:boolean 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
entity-tagEntityTag 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.
lync-conference-id-query-timeoutxs:int 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
bandwidth-conversion-factorBandwidthConversionFactor Conversion from bit rate to estimated bi-directional bandwidth used by a call. Range is from 1.000 to 5.000
blacklist-enabledxs:boolean Dynamically blacklist signaling from hyperactive endpoints
grq-quarantinexs:boolean Quarantine blacklisted endpoints. They remain in Quarantined or Quarantined (Inactive) status (unable to make or receive calls) until manually removed from quarantine.
grq-ignore-vbpxs:boolean Don't exempt video border proxy (VBP) traffic from blacklisting.
rrq-quarantinexs:boolean Quarantine blacklisted endpoints. They remain in Quarantined or Quarantined (Inactive) status (unable to make or receive calls) until manually removed from quarantine.
rrq-ignore-vbpxs:boolean Don't exempt video border proxy (VBP) traffic from blacklisting.
cleaner-task-interval-minutesCleanerTaskIntervalMinutes Remove non-hyperactive endpoints from blacklist after specified interval (minutes)
grq-duplicate-countGrqDuplicateCount GRQ threshold
grq-duplicate-interval-msGrqDuplicateIntervalMs GRQ interval (msec)
rrq-duplicate-countRrqDuplicateCount RRQ threshold
rrq-duplicate-interval-msRrqDuplicateIntervalMs RRQ interval (msec)
lync-edge-server-discovery-timeoutLyncEdgeServerDiscoveryTimeout 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.
allow-send-offerless-invitexs:boolean Allow/deny sending offer-less invite to EP.
lrq-ping-intervalLrqPingInterval H.323 LRQ ping timer (seconds)

ProxyFailureCodes Fields

NameTypeDescriptionAttributes
failure-codeFailureCodeMandatory

OptionsPingFailureCodes Fields

NameTypeDescriptionAttributes
ping-failure-codePingFailureCodeMandatory


Simple Types


NameTypeRestrictions
LrqPingIntervalxs:int
LyncEdgeServerDiscoveryTimeoutxs:int
RrqDuplicateIntervalMsxs:int
RrqDuplicateCountxs:int
GrqDuplicateIntervalMsxs:int
GrqDuplicateCountxs:int
CleanerTaskIntervalMinutesxs:int
BandwidthConversionFactorxs:string
Length of value must be >=1
Length of value must be <=5
EntityTagxs:string
Length of value must be >=1
Length of value must be <=64
SipOutboundKeepAliveIntervalxs:int
NextExtProxyTimeoutxs:int
FailureCodexs:int
PingFailureCodexs:int
OptionsPingIntervalxs:int
MessageSharingSendingNicxs:string
Value must be one of:
  • MANAGEMENT
  • SIGNALING_LAN
  • SIGNALING_WAN
MessageSharingListeningNicxs:string
Value must be one of:
  • MANAGEMENT
  • SIGNALING_LAN
  • SIGNALING_WAN
RogueCallPolicyxs:string
Value must be one of:
  • ALLOW_REGISTERED_ONLY
  • ALLOW_UNREGISTERED_IN_TERRITORY
  • ALLOW_UNREGISTERED_NOT_IN_TERRITORY
  • ALLOW_REGISTERED_AND_UNREGISTERED