MSFT_SIPListeningAddressData

  • Article

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 a listening address for a Front End Server.

The property values for the MSFT_SIPIListeningAddressData class map to the settings found on the General tab of the Front End Server Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking the name of a front end server, pointing to Properties, and then clicking Front End Properties. (For an Enterprise Edition server, click Properties rather than Front End Properties.) In the Front End Server Properties dialog box, click the General tab. Note that these settings apply only to the specified server.

MSFT_SIPListeningAddressData

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 uses this listening address.

    When this value is True, the server uses this listening address. When this value is False, the server does not use this listening address.

    The Enabled property maps to the checkbox found in the Front End Server Properties dialog box.

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

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

  • 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.

    The IPAddress property maps to the Address setting in the Front End Server Properties dialog box.

  • 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.

    The Port property maps to the Port setting in the Front End Server Properties dialog box.

  • 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.

    The TLSCertIssuer property does not map to the Front End Server Properties dialog box. To view the name of the entity that issued the certificate for the Front End Server click the Certificate tab.

  • 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.

    The TLSCertSN property does not map to the Front End Server Properties dialog box. To view the serial number of the certificate click the Certificate tab, click the Select Certificate button, right-click the name of the certificate, and then click Properties. The serial number will be listed on the Details tab.

  • 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.

    The TransportType property maps to the Transport setting in the Front End Server Properties dialog box.

Remarks

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

Instances of this class support the following interface methods:

  • Provider::DeleteInstance();

  • 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 roles: Front End Server and Proxy Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference