Config2_IPFilterRule

Represents an IP filter rule.

Instances of this class are obtained from Config2_IPFilterManager (via Config2_Site.ipFilter):

Properties

PropertyTypeDescription
action String

The action of this IP filter rule ('Deny', 'Allow' or 'AllowAlways').

host String

The mask of this IP filter rule that specifies which IP addresses the rule pertains to.

id String

The ID of this IP filter rule.

userName String

The name of the user that this IP filter rule applies to.

Methods

MethodReturnsDescription
remove() void

Deletes this IP filter rule.

Property Details

action :String

Description:
  • The action of this IP filter rule ('Deny', 'Allow' or 'AllowAlways').

    'Deny' will block access from clients whose IP addresses are included in the mask. 'Allow' will permit access, unless the auto-banning system has detected too many failed login-attempts. 'AllowAlways' is like allow except that auto-banning is disabled.

The action of this IP filter rule ('Deny', 'Allow' or 'AllowAlways').

'Deny' will block access from clients whose IP addresses are included in the mask. 'Allow' will permit access, unless the auto-banning system has detected too many failed login-attempts. 'AllowAlways' is like allow except that auto-banning is disabled.

Type:
  • String

host :String

Description:
  • The mask of this IP filter rule that specifies which IP addresses the rule pertains to. The mask may be (a) a specific IP address, such as 123.123.123.123, (b) the first one, two or three parts of an IP address, such as 192.168, which specifies all the IP addresses that begin with those parts, (c) a specific numeric range of IP addresses, such as 192.168.2.100-150, (d) an Internet host-name, or (e) a LAN network name.

The mask of this IP filter rule that specifies which IP addresses the rule pertains to. The mask may be (a) a specific IP address, such as 123.123.123.123, (b) the first one, two or three parts of an IP address, such as 192.168, which specifies all the IP addresses that begin with those parts, (c) a specific numeric range of IP addresses, such as 192.168.2.100-150, (d) an Internet host-name, or (e) a LAN network name.

Type:
  • String

(readonly) id :String

Description:
  • The ID of this IP filter rule.

The ID of this IP filter rule.

Type:
  • String

userName :String

Description:
  • The name of the user that this IP filter rule applies to.

The name of the user that this IP filter rule applies to.

Type:
  • String

Method Details

remove()

Description:
  • Deletes this IP filter rule.