MSFT_SIPListeningAddressData class

MSFT_SIPListeningAddressData

The MSFT_SIPListeningAddressData class defines a listening address on the Live Communications Server.

The following syntax is simplified from MOF code and includes all inherited properties.

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

Methods

This class does not define any methods.

Properties

The MSFT_SIPListeningAddressData class has the following properties.

• DropRouteHeaders
  Data type: boolean

  Drop all Route headers from messages arriving at this listening address.

  Value	Description
  false	Do not drop Route headers.
  true	Drop Route headers.

  The value cannot be NULL. This property is required on creation and can be updated.

• Enabled
  Data type: boolean

  If true, the server will use this listening address. If false, it will not. This property cannot be NULL.

  This property is required on creation and can be updated.

• InstanceID
  Data type: [key] string

  A GUID value that uniquely identifies this listening address. The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

  This property is optional on creation and cannot be updated.

• IPAddress
  Data type: string

  The IP address to listen on. This property must be represented in "xxx.xxx.xxx.xxx" format and contain a valid IPv4 address. To listen to all available addresses that pass through the server, use "*".

  This property is required on creation and can be updated.

• Port
  Data type: uint32

  A valid port for the listening address.

  Valid values for this property are between 1 and 65535. The value cannot be NULL.

  This property is required on creation and can be updated.

• TLSCertIssuer
  Data type: uint8[]

  The certificate authority that issued the certificate as a byte array.

  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.

  This property is optional on creation and can be updated.

• TLSCertSN
  Data type: uint8[]

  The serial number of the certificate as a byte array.

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

  This property is optional on creation and can be updated.

• TransportType
  Data type: string

  The transport type of packets associated with the listening address as a string value. The value cannot be NULL.

  This property is required on creation and can be updated.

  Value	Description
  "TCP"	The transport protocol is TCP.
  "TLS"	The transport protocol is TLS.
  "MTLS"	The transport protocol is Mutually authenticated Transport Layer Security (MTLS).

• TreatAllConnectionsAsServer
  Data type: boolean

  Treat all connections on this listening address as originating from a server.

  Value	Description
  false	Do not treat all connections as server connections.
  true	Treat all connections as server connections.

  The value cannot be NULL. This property is required on creation and can be updated.

• TreatAllConnetionsAsTrusted
  Data type: boolean

  Treat all connections as trusted connections.

  Value	Description
  false	Do not treat all connections as trusted.
  true	Treat all connections as trusted.

  The value cannot be NULL. This property is required on creation and can be updated.

Remarks

Listening addresses are IP address/port pairs whose presence in a packet of the specified transport type will be noticed and examined.

Available actions for an instance of this class:

• Creation: The administrator can create instances of this class.
• Updates: The administrator can update instances of this class.
• Deletion: The administrator can delete instances of this class.

Requirements

Server: Installed on Windows Server 2003 with Live Communications Server 2005 with SP1.
Namespace: Defined in \root\cimv2.

See Also

Live Communications Server WMI Reference