MSFT_SIPTrustedAddInServiceSetting (New)

Article
05/23/2014

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.

Defines third party applications (add-in services) to be trusted by Office Communications Servers.

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

MSFT_SIPTrustedAddInServiceSetting

Instances of this class can be created, updated and deleted.

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

Methods

This class does not define any methods.

Properties

The MSFT_SIPTrustedAddInServiceSetting class has the following properties.

FQDN
Data type: string

Access type: Read/Write

Required. The fully qualified domain name (FQDN) of the Office Communications Server to which SIP traffic to the application is routed. If the system is part of an array behind a load balancer, the FQDN is the address of the load balancer.

The value must be an FQDN. An IP address is not allowed.
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 add-in service.

The value of this property is not case-sensitive.
GruuID
Data type: string

Access type: Read/Write

Optional. Reserved.

The system uses this property to construct a GRUU identifier instead of using an Active Directory object GUID. Leave this property set to NULL.
InstanceID
Data type: [key] string

Access type: Read-only

Optional. 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}".
Port
Data type: uint32

Access type: Read/Write

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.
Routable
Data type: boolean

Access type: Read/Write

Required. Specifies whether Office Communications Server is authorized to route to this add-in 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 default value is True.
TlsTarget
Data type: string

Access type: Read/Write

Optional. Contains the FQDN of the certificate for the add-in service on the computer. If this property is set to NULL, then 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.
TrustedServiceDN
Data type: string

Access type: Read-only

Optional. The distinguished name of the trusted service.

The value of this property is not case-sensitive.
Type
Data type: string

Access type: Read/Write

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

The value of this property is not case-sensitive.

The maximum length of the string is 100 characters.
Version
Data type: uint32

Access type: Read/Write

Optional. The version number of the trusted add-in service.

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

Remarks

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

Instances of this class support the following interface methods:

Provider::DeleteInstance();
Provider::EnumerateInstances();
Provider::GetObject();
Provider::PutInstance();

Where PutInstance() supports the following flag:
- WBEM_FLAG_CREATE_ONLY
- WBEM_FLAG_UPDATE_ONLY
- WBEM_FLAG_CREATE_OR_UPDATE

Requirements

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

Namespace: Defined in \root\cimv2.

Share via