This documentation is archived and is not being maintained.

MSFT_SIPMediaRelayNetworkInterfaceData

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

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

The properties in the MSFT_SIPMediaRelayNetworkInterfaceData class do not map directly to the Office Communications Server 2007 R2 Administration Tool.

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.

Syntax


class MSFT_SIPMediaRelayNetworkInterfaceData
{
  string AllocateAddress;
  string[] AlternateTURNServers;
  boolean AuthenticateRequests;
  uint32 BandwidthCapacity;
  uint32 DefaultBandwidth;
  [key] string InstanceID;
  string InterfaceType;
  uint32 MaxConnectionsPerSession;
  uint32 PerUserPortAllocationLimit;
  uint32 SessionIdleTimeout;
  uint32 SessionLifetimeTimeout;
};

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

Optional. The IP address of the network interface that the Audio/Video Edge Server uses to allocate ports for media streaming.

The value must be a valid IPv4 address represented in the following format: "nnn.nnn.nnn.nnn". A fully qualified domain name (FQDN) is not allowed.

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

Required. Specifies whether to force authentication of all Turn sessions arriving on the network interface.

The default value for this property is True.

Internal use only. Do not modify.

BandwidthCapacity

Data type: uint32

Access type: Read/Write

Required. Specifies the maximum bandwidth in kilobits per second (Kbps) for each Turn connection.

The default value is 1500.

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

DefaultBandwidth

Data type: uint32

Access type: Read/Write

Required. Specifies the default bandwidth in kilobits per second (Kbps) assigned to a Turn connection that does not request a specific bandwidth amount.

The default value is 750.

The minimum value for this property is 0 and the maximum value is 3000.

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.

MaxConnectionsPerSession

Data type: uint32

Access type: Read/Write

Internal use only. Do not modify.

PerUserPortAllocationLimit

Data type: uint32

Access type: Read/Write

Required. The maximum number of ports allotted to each client.

The default when InterfaceType is set to Public is 40. The default when InterfaceType is set to Private is 50.

The minimum value is 2 and the maximum value is 65536.

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.

Remarks

This class gets and sets information at the following level: 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:

    • WBEM_FLAG_UPDATE_ONLY

Requirements

Server: Installed on computers serving the following role: Audio/Video Edge Server.

Namespace: Defined in \root\cimv2.

Show: