Members
precedence :String
The precedence of operations (i.e. 'DenyOverAllow' or 'AllowOverDeny').
Type:
- String
Methods
add(action, hostopt, useropt) → {IPFilterRule}
Adds an IP filter rule.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
action |
String | The action of the rule (i.e. 'Deny', 'Allow' or 'AllowAlways'). |
||
host |
String |
<optional> |
All | The mask of the rule. Rules with no mask defined apply to al IP addresses. |
user |
String | User |
<optional> |
none | Name or a User object of the user that the rule applies to. Rules with no user defined apply to all users. |
Returns:
- Type
- IPFilterRule
get(id) → {IPFilterRule}
Returns an IPFilterRule object for the given ID.
Parameters:
Name | Type | Description |
---|---|---|
id |
String | ID of the IP filter rule. |
Returns:
- Type
- IPFilterRule
remove(id)
Deletes the given IP filter rule.
Parameters:
Name | Type | Description |
---|---|---|
id |
String | IPFilterRule | ID or an IPFilterRule object of the rule to be deleted. |
toArray() → {Array.<IPFilterRule>}
Returns an array of IPFilterRule objects representing all existing IP filter rules.
Returns:
- Type
- Array.<IPFilterRule>