This documentation is archived and is not being maintained.

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.

MSFT_SIPListeningAddressData

Defines a listening address on the Office Communications 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.

Syntax


class MSFT_SIPListeningAddressData
{
  boolean Enabled;
  [key] string InstanceID;
  string IPAddress;
  uint32 Port;
  uint8[] TLSCertIssuer;
  uint8[] TLSCertSN;
  string TransportType;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPListeningAddressData class has the following properties.

Enabled

Data type: boolean

Access type: Read/Write

Required. Controls whether the server will use this listening address.

If true, the server will use this listening address. If false, it will not.

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

IPAddress

Data type: string

Access type: Read/Write

Required. The IP address on which to listen.

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.

Port

Data type: uint32

Access type: Read/Write

Required. A valid port for the listening address.

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

The default value is 5061.

TLSCertIssuer

Data type: uint8[]

Access type: Read/Write

Optional. A byte array representing the TLS certificate authority that issued the certificate.

This value must be NULL for TCP connections, and can be not NULL for TLS connections. If MTLS is specified, this property must contain the fully qualified domain name of the certificate server.

TLSCertSN

Data type: uint8[]

Access type: Read/Write

Optional. A byte array representing the serial number of the TLS certificate.

This value must be NULL for TCP connections, and can be not NULL for TLS connections.

TransportType

Data type: string

Access type: Read/Write

Required. A string value indicating the transport type of the packets associated with the listening address.

The value of this property is not case-sensitive.

Value

Description

"TCP"

The transport type is TCP.

"TLS"

The transport type is TLS.

"MTLS"

The transport type is Mutually authenticated Transport Layer Security (MTLS).

The default value is MTLS.

Remarks

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

Instances of this class support the following interface methods:

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

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

WBEM_FLAG_CREATE_ONLY WBEM_FLAG_UPDATE_ONLY WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role(s): Front End Server, Proxy Server.Namespace: Defined in \root\cimv2.


Reference

[<LinkCreatedDuringXmlConversion>]

Concepts

Show: