MSFT_SIPFederationExternalEdgeSetting class

MSFT_SIPFederationExternalEdgeSetting

The MSFT_SIPFederationExternalEdgeSetting class exposes properties for configuring the external edge of an access proxy.

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

class MSFT_SIPFederationExternalEdgeSetting
{
   ;
  boolean AcceptAnyDestinationDomain;
  boolean AllowAllDomainsForAutoFederation;
  boolean AllowAutomaticFederation;
  boolean AllowOutsideUsers;
  string DefaultRoute;
  Boolean DefaultRouteIsPublicNetworkProvider;
  string DefaultRouteUserVerificationLevel;
  uint32 DNSCacheTableSize;
  boolean EnableArchivingNotification;
  boolean EnableFederation;
  string [] FilterVerbs;
  boolean FlushDNSCache;
  uint32 IncomingTLSCountForAutomaticFederationRoute;
  uint32 IncomingTLSCountForDefaultRoute;
  [key] string InstanceID;
  boolean IsClearinghouse;
  boolean KeepCRLsUpToDateForPeers;
  boolean MarkSourceVerifiableOnOutgoingMessages;
  uint32 OutgoingTLSCountForAutomaticFederationRoute;
  uint32 OutgoingTLSCountForDefaultRoute;
  boolean StorePeerCertificates;
  boolean UseDefaultRoute;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPFederationExternalEdgeSetting class has the following properties.

-

• AcceptAnyDestinationDomain
  Data type: boolean

  For a clearing house, indicates that the Access Proxy will accept any “to” internal domain in messages coming from its direct partners. In this case, the destination domain validation for incoming messages on the external edge against the internal domain list is relaxed. This is useful if the list of internally supported domains is large.

  Value	Description
  False	Do not accept clearing house traffic from any destination domain.
  True	Accept clearing house traffic from any destination domain.

  The default is false. The value cannot be NULL.

• AllowAllDomainsForAutoFederation
  Data type: boolean

  Specifies whether Access Proxy supports unrestricted enhanced federation. The default is FALSE. This property cannot be NULL. The value can be updated.

• AllowAutomaticFederation
  Data type: boolean

  Specifies whether this Access Proxy allows enhanced federation. The default value is FALSE. This value annot be null.

• AllowOutsideUsers
  Data type: boolean

  Indicates whether outside users can connect to this Access Proxy.

  Value	Description
  False	Outside users cannot connect to this Access Proxy.
  True	Outside users can connect to this Access Proxy.

  This value should be set to false if IsClearinghouse is set to True.

• DefaultRoute
  Data type: string

  The FQDN (fully qualified domain name) of the Access Proxy for the domain to which requests are sent if they are not recognized by the Access Proxy. The FQDN can contain a wild card character in the form of an asterisk (*) but cannot wholly consist of an asterisk. The default value is NULL, but this property cannot be NULL if UseDefaultRoute is set to true.

  This property is optional and can be updated.

• DefaultRouteIsPublicNetworkProvider
  Data type: Boolean

  Specifies whether DefaultRoute points to a public IM service provider. This value cannot be NULL. The default value is FALSE.

• DefaultRouteUserVerificationLevel
  Data type: string

  Indicates the verification level for requests arriving on the default route from a clearing house as a control for spam.

  Value	Description
  AlwaysVerifiable	All request received on the default route from the clearing house will be considered verifiable. If a header is not present, it will be added
  AlwaysUnverifiable	Requests are only allowed to pass if the user being requested has an allow ACE for the subscriber.
  UseSourceVerification	Use the domain's asserted verification level, which is passed by headers on the requests. If unmarked, the messages are marked as unverified.

  Default value is UseSourceVerification. This property cannot be NULL.

• DNSCacheTableSize
  Data type: uint32

  The number of DNS SRV records that can be stored in the in-memory cache. The valid range of values is between 300 and 30,000. The default value is 3000.

• EnableArchivingNotification
  Data type: boolean

  Indicates whether the Access Proxy will send an "archiving notification" header to federated and clearing-house partners such that clients at those partners can display these notifications as a disclaimer in the conversation window.

  Value	Description
  False	Archiving notifications are not displayed.
  True	Archiving notifications are displayed.

  The default value is true. This property cannot be NULL.

• EnableFederation
  Data type: boolean

  Indicates whether federation is enabled for this Access Proxy.

  Value	Description
  False	Federation is not enabled on this Access Proxy.
  True	Federation is enabled on this Access Proxy.

  The default value is false. This property cannot be NULL.

• FilterVerbs
  Data type: string []

  Specifies whether to block certain incoming SIP messages (REGISTER and SERVICE requests) originating from outside the corporate network. REGISTER requests could affect your User Services databases. SERVICE requests could enable federated users to make unauthorized searches.

  Value	Description
  NULL	No messages will be blocked.
  REGISTER	REGISTER requests are blocked.
  SERVICE	SERVICE requests are blocked

  The default value is NULL, meaning that no messages will be blocked.

• FlushDNSCache
  Data type: boolean

  Specifies whether to flush the in-memory cache of DNS SRV records. This property is a toggle. Changing it from TRUE to FALSE or from FALSE to TRUE will flush the DNS SRV cache.

• IncomingTLSCountForAutomaticFederationRoute
  Data type: uint32

  The maximum number of incoming TLS connections allowed on the server for enhanced federation. The valid range of values is between 1 and 256. The default value is 40. This value cannot be NULL.

  This property is required on creation and can be updated.

• IncomingTLSCountForDefaultRoute
  Data type: uint32

  The maximum number of incoming TLS connections allowed on the server for a default route. The valid range of values is between 1 and 256. The default value is 80. This value cannot be NULL.

  This property is required on creation and can be updated.

• InstanceID
  Data type: [key] string

  A GUID value that uniquely identifies the external edge setting of the Access Proxy. The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

  This property cannot be updated.

• IsClearinghouse
  Data type: boolean

  Indicates whether the Access proxy functions as a clearing house or is used in a typical deployment.

  Value	Description
  False	The Access Proxy is used in a typical deployment.
  True	The Access Proxy functions as a clearing-house deployment.

  The default value is false. If UseDefaultRoute or AllowOutsideUsers properties are set to true, the value for the IsClearingHouse property must be false. This property cannot be NULL.

• KeepCRLsUpToDateForPeers
  Data type: boolean

  Indicates whether this Access Proxy will check certificate revocation lists for certificates it has stored for federated partners. This setting has meaning only if StorePeerCertificates is true. The default value is true. This property cannot be NULL.

• MarkSourceVerifiableOnOutgoingMessages
  Data type: boolean

  Indicates whether to mark asserted verification level using a header on outgoing messages. If true, federating partners can use the header to determine the verification level of these messages for spam control.

  Value	Description
  False	Do not mark outgoing messages as verifiable
  True	Mark outgoing messages as verifiable.

  The default is true The value cannot be NULL.

• OutgoingTLSCountForAutomaticFederationRoute
  Data type: uint32

  The number of outgoing TLS connections that the server will initiate for each enhanced federation partner. The valid range of values is between 1 and 256. The default value is 4. This value cannot be NULL.

  This property is required on creation and can be updated.

• OutgoingTLSCountForDefaultRoute
  Data type: uint32

  The number of outgoing TLS connections that the server will initiate to the default route. The valid range of values is between 1 and 256. The default value is 8. This value cannot be NULL.

  This property is required on creation and can be updated.

• StorePeerCertificates
  Data type: boolean

  Indicates whether the server certificates for federated partners are stored locally.

  Value	Description
  False	The certificates for federated partners are not stored locally.
  True	The certificates for federated partners are stored locally.

  The default value is true. This property cannot be NULL.

• UseDefaultRoute
  Data type: boolean

  Indicates whether the network route specified in the DefaultRoute property is to be used.

  Value	Description
  False	The default network route (specified in DefaultRoute) is not to be used.
  True	The default network route (specified in DefaultRoute) is to be used.

  The default value is false. If IsClearingHouse is set to true, UseDefaultRoute must be false. If UseDefaultRoute is set to true, then DefaultRoute cannot be empty. This property cannot be NULL.

Remarks

There cannot be more than one instance of this class. The only operation supported is update.

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