Share via


MSFT_SIPEdgeServerListeningAddressSetting

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.

Specifies the IP addresses and ports associated with Edge Server services.

MSFT_SIPEdgeServerListeningAddressSetting

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_SIPEdgeServerListeningAddressSetting
{
  uint32 APExternalFederationPort;
  string APExternalIPAddress;
  uint32 APExternalRemoteAccessPort;
  uint32 APInternalPort;
  string DPExternalIPAddress;
  uint32 DPExternalPort;
  uint32 DPInternalPort;
  [key] string InstanceID;
  string InternalIPAddress;
  uint32 MRASInternalPort;
  string MRExternalIPAddress;
  uint32 MRExternalPortRangeFrom;
  uint32 MRExternalPortRangeTo;
  uint32 MRExternalTCPPort;
  uint32 MRExternalUDPPort;
  uint32 MRInternalTCPPort;
  uint32 MRInternalUDPPort;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPEdgeServerListeningAddressSetting class has the following properties.

  • APExternalFederationPort
    Data type: uint32

    Access type: Read/Write

    Optional. The listening port for federation connections at the external edge of Access Edge Server.

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

    The default value is 5061.

  • APExternalIPAddress
    Data type: string

    Access type: Read/Write

    Optional. The external IP address of Access Edge Server.

    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.

  • APExternalRemoteAccessPort
    Data type: uint32

    Access type: Read/Write

    Optional. The listening port for remote client connections at the external edge of Access Edge Server.

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

    The default value is 443.

  • APInternalPort
    Data type: uint32

    Access type: Read/Write

    Optional. The internal listening port number of Access Edge Server.

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

    The default value is 5061.

  • DPExternalIPAddress
    Data type: string

    Access type: Read/Write

    Optional. The IP address of the external edge of Web Conferencing Edge Server.

    The value must be a valid IPv4 address represented in the following format: "nnn.nnn.nnn.nnn". An FQDN is not allowed.

  • DPExternalPort
    Data type: uint32

    Access type: Read/Write

    Optional. The listening port for the external edge of Web Conferencing Edge Server.

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

    The default value is 443.

  • DPInternalPort
    Data type: uint32

    Access type: Read/Write

    Optional. The internal listening port number of Web Conferencing Edge Server.

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

    The default value is 8057.

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

  • InternalIPAddress
    Data type: string

    Access type: Read/Write

    Required. The IP address of the internal edge.

    The value must be a valid IPv4 address represented in the following format: "nnn.nnn.nnn.nnn". An FQDN is not allowed.

  • MRASInternalPort
    Data type: uint32

    Access type: Read/Write

    Optional. The Audio/Video Edge Server Authentication Service (MRAS) SIP listening port.

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

    The default value is 5062.

  • MRExternalIPAddress
    Data type: string

    Access type: Read/Write

    Optional. The IP Address of the public interface of the relay.

    The value must be a valid IPv4 address represented in the following format: "nnn.nnn.nnn.nnn". An FQDN is not allowed.

  • MRExternalPortRangeFrom
    Data type: uint32

    Access type: Read/Write

    Optional. The Audio/Video Edge Server port range "from" port number.

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

    The default value is 50000.

  • MRExternalPortRangeTo
    Data type: uint32

    Access type: Read/Write

    Optional. The Audio/Video Edge Server port range "to" port number.

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

    The default value is 59999.

  • MRExternalTCPPort
    Data type: uint32

    Access type: Read/Write

    Optional. The external TCP port number of Audio/Video Edge Server.

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

    The default value is 443.

  • MRExternalUDPPort
    Data type: uint32

    Access type: Read/Write

    Optional. The external UDP port number of Audio/Video Edge Server.

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

    The default value is 3478.

  • MRInternalTCPPort
    Data type: uint32

    Access type: Read/Write

    Optional. The internal TCP port number of Audio/Video Edge Server.

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

    The default value is 443.

  • MRInternalUDPPort
    Data type: uint32

    Access type: Read/Write

    Optional. The internal UDP port number of Audio/Video Edge Server.

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

    The default value is 3478.

Remarks

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

Only one instance of this class can be present.

A change in the value of any property in this class requires a restart of the A/V Authentication Service.

Instances of this class support the following interface methods:

  • 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: all types of Edge Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference