Export (0) Print
Expand All
Expand Minimize

MSFT_SIPIIMFilterUrlFilterSetting

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.

Manages the way in which hyperlinks are handled during an instant messaging (IM) conversation.

The property values for the MSFT_SIPIIMFilterUrlFilterSetting class map to the settings found on the URL Filter tab of the Intelligent IM Filter dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking the name of a Standard Edition server or Enterprise Edition pool, pointing to Filtering Tools, and then clicking Intelligent Instant Message Filter. In the Intelligent IM Filter dialog box, click the URL Filter tab. Note that these settings apply only to the specified pool or server.

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

The AllowMessage property maps to the Enter the notice you want to insert at the beginning of each instance message containing hyperlinks text box in the Intelligent IM Filter dialog box.

Backend

Data type: [key] string

Access type: Read-only

Required: When accessing data from any role that belongs to a pool. This property must be empty when accessing data from the Edge Server or Proxy Server role.

This property identifies the instance of SQL Server that manages the back-end database for Office Communications Server.

The value for this property depends on the topology of Office Communications Server.

Topology

Value

Standard Edition

(local)\rtc

Enterprise Edition

(consolidated or expanded configuration)

computername\instancename

or

computername

For Enterprise Edition, computername identifies either the FQDN or the NetBIOS name of the host computer for SQL Server and instancename identifies a named instance of SQL Server on the host computer. The value computername by itself specifies the default instance of SQL Server on the host computer.

The Backend property does not map to the Intelligent IM Filter dialog box.

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.

The BlockFileExtensions property maps to the Block all hyperlinks, both intranet and Internet, that contain any of the file extensions defined on the File Transfer Filter tab checkbox in the Intelligent IM Filter dialog box.

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 this class. If False, all hyperlinks contained in IM messages are passed through the server.

The default value is True.

The Enabled property maps to the Enable URL filtering checkbox in the Intelligent IM Filter dialog box.

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 are ignored. If False, the filtering process is applied to all hyperlinks. The default value is True.

NoteNote

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

The IgnoreLocal property maps to the Allow local intranet URLs checkbox in the Intelligent IM Filter dialog box.

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

The InstanceID property does not map to the Intelligent IM Filter dialog box.

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 blocks 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:".

Important noteImportant

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

The value of this property is not case-sensitive.

The Schemes property maps to the Enter the prefixes, separated by a space, that you want the URL filter to block text box in the Intelligent IM Filter dialog box.

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.

The WarnMessage property maps to the Enter the warning you want to insert at the beginning of each instant message containing hyperlinks text box in the Intelligent IM Filter dialog box.

Remarks

This class gets and sets information at the following levels: WMI and 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 flags:

    • WBEM_FLAG_CREATE_ONLY

    • WBEM_FLAG_UPDATE_ONLY

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Access Edge Server, and Front End Server.

Namespace: Defined in \root\cimv2.

Show:
© 2015 Microsoft