Export (0) Print
Expand All
Expand Minimize

MSFT_SIPTrustedServiceSetting

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.

Represents an entry for a trusted Globally Routable User Agent URI (GRUU) service type.

The properties in the MSFT_SIPTrustedServiceSetting class do not map directly to the Office Communications Server 2007 R2 Administration Tool. However, some of these property values can be viewed using the Active Directory Sites and Services snap-in. To view values for the MSFT_SIPTrustedServiceSetting class open Active Directory Sites and Services, expand Services, expand RTC Service, and then click Trusted Services. Right-click one of the entries and then click Properties. In the Properties dialog box, click the Attribute Editor tab.

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_SIPTrustedServiceSetting
{
  string FQDN;
  string GRUU;
  string GruuID;
  [key] string InstanceID;
  uint32 Port;
  boolean Routable;
  string[] ServerReference;
  string TlsTarget;
  string TrustedServiceDN;
  string Type;
  uint32 Version;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPTrustedServiceSetting class has the following properties.

FQDN

Data type: string

Access type: Read-only

Required. The fully qualified domain name (FQDN) of the computer running Office Communications Server on which the trusted service is located.

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

The FQDN property maps to the msRTCSIP-TrustedServerFQDN attribute in the Properties dialog box.

GRUU

Data type: string

Access type: Read-only

Optional. Specifies the Globally Routable User Agent URI (GRUU) that can be used to route SIP packets to this server.

The GRUU property does not map to the Properties dialog box.

GruuID

Data type: string

Access type: Read-only

Optional. Reserved. Specifies the GRUU ID for this server.

The GRuuID property does not map to the Properties dialog box.

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

The InstanceID property does not map to the Properties dialog box.

Port

Data type: uint32

Access type: Read-only

Required. The port number used to connect to this GRUU service.

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

The Port property maps to the msRTCSIP-TrustedServicePort attribute in the Properties dialog box.

Routable

Data type: boolean

Access type: Read-only

Required. Specifies whether Office Communications Server is authorized to route to this service using its GRUU address.

If this value is set to True, Office Communications Server is authorized to route to this service. If this value is set to False, Office Communications Server is not authorized to route to this service.

The Routable property maps to the msRTCSIP-Routable attribute in the Properties dialog box.

ServerReference

Data type: string[]

Access type: Read-only

Optional. A list of the servers that refer to this trusted server.

For example, the QoSM and MRAS services can be referred to by a Mediation Server.

The ServerReference property does not map to the Properties dialog box.

TlsTarget

Data type: string

Access type: Read/Write

Optional. Contains the FQDN of the certificate for the trusted service on the computer. If this property is set to NULL, the value of the FDQN property is used. Different values for this property and the FQDN property indicate that a load balancer is being used.

Available pools can be retrieved from MSFT_SIPPoolSetting.PoolFQDN.

The value must be a FQDN (fully qualified domain name). An IP address is not allowed.

The TlsTarget property maps to the msRTCSIP-ExtensionData attribute in the Properties dialog box.

TrustedServiceDN

Data type: string

Access type: Read-only

Required. The distinguished name of the trusted service.

The TrustedServiceDN property does not map to the Properties dialog box.

Type

Data type: string

Access type: Read-only

Required. A string value that defines the type of GRUU service represented by an instance of the class.

The valid GRUU service types are as follows.

Value

Description

CWA

Communicator Web Access Server

Gateway

Gateway Server

Mediation Server

Mediation Server

MRAS

Media Relay Authentication Service

QoSM

Quality of Service Manager

The value of this property is not case-sensitive. The maximum length of the string is 16 characters.

The Type property maps to the msRTCSUIP-TrustedServiceType attribute in the Properties dialog box.

Version

Data type: uint32

Access type: Read-only

Optional. The version number of the service.

The Version property maps to the msRTCSUIP-TrustedServerVersion attribute in the Properties dialog box.

Remarks

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

Instances of this class support the following interface methods:

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Audio/Video Conferencing Server, Front End Server, and Mediation Server.

Namespace: Defined in \root\cimv2.

Show:
© 2015 Microsoft