TURN / ICE Parameters

This section lists parameters that configure the following Microsoft network features:
  • Traversal Using Relays Around NAT (TURN)
  • Interactive Connectivity Establishment (ICE)
    Table 1. TURN / ICE Parameters

    Template

    Parameter

    Permitted Values

    Change Causes Restart or Reboot

    firewall-nat.cfg

    tcpIpApp.ice.ConnCheckInetvalPairs

    Time interval in milliseconds to serialize first attempt of connectivity check of identified ICE candidate pairs per call.

    25 (default)

    25 - 100

    No

    firewall-nat.cfg

    tcpIpApp.ice.ConnCheckInetvalRetries

    Time interval in milliseconds to serialize the retry attempts of connectivity check for identified pairs per call.

    100 (default)

    25 - 100

    No

    firewall-nat.cfg

    tcpIpApp.ice.MaxCandidateGatheringInParallel

    The number of ICE candidates gathering threads run in parallel in the maximum time span of 2 seconds for simultaneous incoming calls only.

    3 (default for VVX 201 business media phone)

    5 (default for all other VVX platforms)

    2 – 24

    No

    firewall-nat.cfg

    tcpIpApp.ice.MaxConnectivityChecksInParallel

    The number of ICE connectivity checks threads that run in parallel in the maximum time span of 30 seconds (connectivity checks will be complete in 1 sec after answering call in general) for simultaneous incoming calls only.

    The following table lists the default value set when using a particular VVX phone model.

    Table 2. Default Values for VVX phones
    VVX Phone Model Default Value
    VVX 150 1
    VVX 201, 300, 310, 400 1
    VVX 250, 350, 450 5
    VVX 301, 311, 401, 411, 500 5
    VVX 410 2
    VVX 501, 601 7
    VVX 600 3

    1 - 24

    No

    firewall-nat.cfg

    tcpIpApp.ice.MaxRetries

    The maximum number of retry attempts performed on each ICE connectivity check pair identified in case of a request timeout or failure.

    5 (default)

    2 - 25

    No

    firewall-nat.cfg

    tcpIpApp.ice.mode

    MSOCS (default)

    Disabled

    Standard

    No

    firewall-nat.cfg

    tcpIpApp.ice.NetworkMode

    The information about TCP and UDP ICE candidates.

    TCPUDP (default) – Gathers all the possible UDP and TCP ICE candidates.

    TCPOnly – Gathers all the TCP candidates along with UDP host candidates.

    UDPOnly - Gathers all the UDP candidates.

    No

    firewall-nat.cfg

    tcpIpApp.ice.password

    Enter the password to authenticate to the TURN server.

    NULL (default)

    No

    firewall-nat.cfg

    tcpIpApp.ice.policy

    Default (default)

    Default<VVXxxx>, where <xxx> is the VVX phone model number.

    For example, If you are using VVX 201 phone model, the value is set to DefaultVVX201 by default.

    Legacy - support the legacy behavior of ICE stack.

    Custom - tune the following ICE parameters according to network conditions:
    • tcpIpApp.ice.NetworkMode
    • tcpIpApp.ice.MaxCandidateGatheringInParallel
    • tcpIpApp.ice.MaxConnectivityChecksInParallel
    • tcpIpApp.ice.ConnCheckInetvalPairs
    • tcpIpApp.ice.ConnCheckInetvalRetries
    • tcpIpApp.ice.ReflexiveChecksRequired
    • tcpIpApp.ice.MaxRetries

    No

    firewall-nat.cfg

    tcpIpApp.ice.ReflexiveChecksRequired

    To determine whether reflexive candidates to be collected as part of ice candidates collection.

    1 (default) - TCP and UDP reflexive candidates will be collected in candidate gathering process.

    0 - TCP and UDP reflexive candidates will not be collected in candidate gathering process.

    No

    firewall-nat.cfg

    tcpIpApp.ice.stun.server

    Enter the IP address of the STUN server.

    NULL (default)

    No

    firewall-nat.cfg

    tcpIpApp.ice.stun.udpPort

    The UDP port number of the STUN server.

    3478 (default)

    1 - 65535

    No

    firewall-nat.cfg

    tcpIpApp.ice.tcp.enabled

    1 (default) - Enable TCP.

    0 - Disable TCP.

    No

    firewall-nat.cfg

    tcpIpApp.ice.turn.server

    Enter the IP address of the TURN server.

    NULL (default)

    No

    firewall-nat.cfg

    tcpIpApp.ice.turn.tcpPort

    443 (default)

    1 - 65535

    No

    firewall-nat.cfg

    tcpIpApp.ice.turn.udpPort

    The UDP port number of the TURN server.

    443 (default)

    65535

    No

    firewall-nat.cfg

    tcpIpApp.ice.username

    Enter the user name to authenticate to the TURN server.

    NULL (default)

    No