This documentation is archived and is not being maintained.

MSFT_SIPMediaRelaySetting

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 settings for a Media Relay on an Audio/Video Edge Server.

The properties in the MSFT_SIPMediaRelaySetting 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_SIPMediaRelaySetting
{
  uint8[] BankCertIssuer;
  uint8[] BankCertSN;
  uint32 EventLoggingLevel;
  string ExternalFQDN;
  [key] string InstanceID;
  uint32 MaxBandwidthPerAllocatedPort;
  uint32 MaxBandwidthPerUser;
  uint32 MaximumTokenLifetime;
  boolean ResolveExternalFQDN;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPMediaRelaySetting class has the following properties.

BankCertIssuer

Data type: uint8[]

Access type: Read/Write

Required. A byte array representing the certificate authority that issued the user authentication certificate.

BankCertSN

Data type: uint8[]

Access type: Read/Write

Required. A byte array representing the serial number of the user authentication certificate.

EventLoggingLevel

Data type: uint32

Access type: Read/Write

Required. Specifies the level of logging for a Media Relay on an Audio/Video Edge Server. Each successive level is inclusive of preceding levels.

Value

Description

1

Log fatal errors

2

Log errors

3

Log warnings

4

Log information

5

Verbose logging

6

Log all

ExternalFQDN

Data type: string

Access type: Read/Write

Required. Specifies the fully qualified domain name (FQDN) of the public interface.

The value must be an FQDN. An IP address is not allowed.

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}".

MaxBandwidthPerAllocatedPort

Data type: uint32

Access type: Read/Write

Required. Specifies the maximum allowed bandwidth for each port used by a media relay in kilobits per second (Kbps).

The default value for this property is 3000.

The minimum value for this property is 1024 and the maximum value is 102400.

The default value is 1536.

MaxBandwidthPerUser

Data type: uint32

Access type: Read/Write

Required. Specifies the maximum allowed bandwidth per user for a media relay in kilobits per second (Kbps).

The default value for this property is 10000.

The minimum value for this property is 1024 and the maximum value is 102400.

The default value is 7680.

MaximumTokenLifetime

Data type: uint32

Access type: Read/Write

Required. The maximum lifetime in minutes for the credentials issued by the Authentication Service.

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

The default value is 480.

ResolveExternalFQDN

Data type: boolean

Access type: Read/Write

Internal use only. Do not modify.

Remarks

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

Only one instance of this class can be present.

Except for BankCertSN and BankCertIssuer, 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 flags:

    • WBEM_FLAG_CREATE_ONLY

    • WBEM_FLAG_UPDATE_ONLY

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

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

Namespace: Defined in \root\cimv2.

Show: