MSFT_SIPMediaRelayNetworkInterfaceData class

MSFT_SIPMediaRelayNetworkInterfaceData

Exposes the networking settings for a Media Relay on an Audio/Video Edge Server.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

class MSFT_SIPMediaRelayNetworkInterfaceData
{
  string AllocateAddress;
  uint32 AllocateEndPort;
  uint32 AllocateStartPort;
  string[] AlternateTURNServers;
  boolean AuthenticateRequests;
  uint32 BandwidthCapacity;
  [key] string InstanceID;
  string InterfaceType;
  string IPAddress;
  uint32 MaxConnectionsPerSession;
  uint32 MaximumConnections;
  uint32 SessionCredentialsTimeout;
  uint32 SessionIdleTimeout;
  uint32 SessionLifetimeTimeout;
  boolean SSRedirects;
  uint32 TCPPort;
  uint32 UDPPort;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPMediaRelayNetworkInterfaceData class has the following properties.

• AllocateAddress
  Data type: string

  Access type: Read/Write

  Internal use only. Do not modify.

• AllocateEndPort
  Data type: uint32

  Access type: Read/Write

  Internal use only. Do not modify.

• AllocateStartPort
  Data type: uint32

  Access type: Read/Write

  Internal use only. Do not modify.

• AlternateTURNServers
  Data type: string[]

  Access type: Read/Write

  Optional. A list of alternate Turn Servers that is sent in the redirect response to the client when the relay is overloaded.

  The value of this property is not case-sensitive.

• AuthenticateRequests
  Data type: boolean

  Access type: Read/Write

  Internal use only. Do not modify.

• BandwidthCapacity
  Data type: uint32

  Access type: Read/Write

  Required. Specifies the available bandwidth capacity in kilobits per second (Kbps) per Turn Connection.

  The minimum value for this property is 1 and the maximum value is 10800.

  The default value is 1500.

• InstanceID
  Data type: [key] string

  Access type: Read-only

  Required. A GUID value that uniquely identifies an instance of this class.

  The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

• InterfaceType
  Data type: string

  Access type: Read/Write

  Required. Indicates whether the interface is public or private.

  The value of this property is not case-sensitive.

  Value	Description
  "Public"	The interface is public.
  "Private"	The interface is private.

• IPAddress
  Data type: string

  Access type: Read/Write

  Internal use only. Do not modify.

• MaxConnectionsPerSession
  Data type: uint32

  Access type: Read/Write

  Internal use only. Do not modify.

• MaximumConnections
  Data type: uint32

  Access type: Read/Write

  Internal use only. Do not modify.

• SessionCredentialsTimeout
  Data type: uint32

  Access type: Read/Write

  Internal use only. Do not modify.

• SessionIdleTimeout
  Data type: uint32

  Access type: Read/Write

  Required. Specifies in seconds the duration that a relayed media session can remain idle before it times out.

  The minimum value for this property is 1 and the maximum value is 600.

  The default value is 60.

• SessionLifetimeTimeout
  Data type: uint32

  Access type: Read/Write

  Required. Specifies in minutes the maximum duration of a relayed media session.

  The minimum value for this property is 1 and the maximum value is 10800.

  The default value is 1440.

• SSRedirects
  Data type: boolean

  Access type: Read/Write

  Internal use only. Do not modify.

• TCPPort
  Data type: uint32

  Access type: Read/Write

  Internal use only. Do not modify.

• UDPPort
  Data type: uint32

  Access type: Read/Write

  Internal use only. Do not modify.

Remarks

This class gets and sets information at the following level(s): WMI.

A change in the value of any property in this class requires a restart of the A/V Authentication Service.

Instances of this class support the following interface methods:

• Provider::EnumerateInstances();

• Provider::GetObject();

• Provider::PutInstance();

  Where PutInstance() supports the following flag(s):

  • WBEM_FLAG_UPDATE_ONLY

Requirements

Server: Installed on computers serving the following role(s): Audio/Video Edge Server.
Namespace: Defined in \root\cimv2.

See Also

Communications Server WMI Reference