MSFT_SIPIIMFilterUrlFilterSetting class

MSFT_SIPIIMFilterUrlFilterSetting

Specifies the action to perform on IM messages that contain a URL.

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.

class MSFT_SIPIIMFilterUrlFilterSetting
{
  string Action;
  string AllowMessage;
  [key] string Backend;
  boolean BlockFileExtensions;
  boolean Enabled;
  boolean IgnoreLocal;
  [key] string InstanceID;
  string[] Schemes;
  string WarnMessage;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPIIMFilterUrlFilterSetting class has the following properties.

• Action
  Data type: string

  Access type: Read/Write

  Required. Specifies the action to perform on IM messages that contain a URL.

  The value of this property is not case-sensitive.

  Value	Description
  "Block"	Office Communications Server blocks delivery of messages containing active hyperlinks, and sends an error message to the sender.
  "Allow"	Office Communications Server prefixes hyperlinks with an underscore so that the links are no longer active, and optionally inserts a notification message at beginning of each instant message containing hyperlinks. Specify the notification message using the AllowMessage property.
  "Warn"	Office Communications Server passes messages containing active hyperlinks, and inserts a warning message at the beginning of those messages. Specify the warning message using the WarnMessage property.

  The default value is Allow.

• AllowMessage
  Data type: string

  Access type: Read/Write

  Optional. The message that is inserted at the beginning of each message containing hyperlinks when the value of the Action property is set to Allow.

  Use this message to state the potential dangers of clicking unknown links, or to refer to your organization's relevant policies and requirements. The maximum length of the string is 300 characters.

• Backend
  Data type: [key] string

  Access type: Read-only

  Must be empty when accessing data from Edge Server or Proxy Server roles. Required when accessing data from any role that belongs to a pool.

  The computer name (either the FQDN or NetBIOS name) and SQL Server instance name of the Office Communications Server 2007, back-end database (configuration data is stored in the same SQL instance as user data, but in a different database). Indicates where this class is stored, which varies depending on the server role.

  Server Role	Acceptable Values
  Enterprise Edition	SQL_Instance_Name
  Standard Edition	(local)\rtc
  Access Edge Server and Forwarding Proxy	Empty string

• BlockFileExtensions
  Data type: boolean

  Access type: Read/Write

  Required. Blocks any hyperlink that contains a file path with an extension specified by the Schemes property of the MSFT_SIPIMFilterFileFilterSetting class, and returns an error message to the sender.

  If false, no special check is made for file paths and extensions.

  The default value is true.

• Enabled
  Data type: boolean

  Access type: Read/Write

  Required. Controls whether IM filtering is performed on URLs passed in IM messages.

  If true, filtering is performed according to the parameters set by the additional properties of this class. If false, all hyperlinks contained in IM messages are passed through the server.

  The default value is true.

• IgnoreLocal
  Data type: boolean

  Access type: Read/Write

  Required. Controls whether IM filtering is performed on local Intranet URLs passed in IM messages.

  If true, any URL that is defined in the Intranet zone will be ignored. If false, the filtering process is applied to all hyperlinks. The default value is true.

  Note???? Each individual Office Communications Server that performs filtering can define an Intranet zone differently from other Office Communications Servers. For each server, this definition is determined by the settings on the security tab of Internet Explorer on that server.

• InstanceID
  Data type: [key] string

  Access type: Read-only 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}".

• Schemes
  Data type: string[]

  Access type: Read/Write

  Optional. Specifies the list of URL prefixes corresponding to the types of URLs that Office Communications Server will block when the value of the Enabled property is set to true.

  The default list includes the following scheme values: "href", "www*.", "ftp.", "http:", "https:", "ftp:", "gopher:", "nntp:", "news:", "file:", "mailto:", "sip:", "sips:", "tel:", "callto:", "ldap:", "telnet:".

  Note???? With the exception of href, www, and ftp, all scheme values end with a colon.

  The value of this property is not case-sensitive.

• WarnMessage
  Data type: string

  Access type: Read/Write

  Optional. The message that is inserted at the beginning of each message containing hyperlinks when the value of the Action property is set to Warn.

  Use this message to state the potential dangers of clicking unknown links, or to refer to your organization's relevant policies and requirements. The maximum length of the string is 300 characters.

Remarks

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

No localization process is performed on the notification or warning messages.

If this class is installed on a server whose role has "Pool" scope, the scope of this class is "Pool" and settings are stored in SQL. In this case, only one instance of this class can be present in the pool. For a list of server roles and their corresponding WMI class scopes, see WMI Class Management Scopes and Roles.

Instances of this class support the following interface methods:

• 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): Administrative Tools Server, Access Edge Server, Front End Server.
Namespace: Defined in \root\cimv2.

See Also

Communications Server WMI Reference