NetBorder Session Controller

Description

Rules

REST Name

rules

Methods

list: List
create: Create
retrieve: Retrieve
update: Update
delete: Delete

Properties

Name	Data	Possible Values	Description
`failed_attempts`	Type integer Default None	Rules integer greater_or_equal[0]	Failed Attempts If value is greater than 0 then it will represent the number of failed registrations attempts with authorization header needed to match the rule. If value is 0, then the rule will match on first matching registration attempt without authorization header.
`src_ip_whitelist_filter_expr`	Type string Default None	Rules src_ip_whitelist_filter_rule	Source IP White List Filter White list source IP filter - Requests with source IP in this list will be excepted from SIP Firewall Rules Below is the syntax that must be used for the source IP white list filter: 1) Empty = No source IP white list exception 2) IPv4 IP Address (10.10.0.1) 3) IPv4 Network Address (172.16.0.0/16) 4) Comma seperated list of IPv4 addresses or networks (10.10.0.1, 172.16.0.0/16)
`time_frame`	Type integer Default None	Rules integer greater_than[0]	Interval Number of minutes to wait before resetting the counter for failed attempts.
`comments`	Type string Default None		Comments
`request_name`	Type Enumeration Default REGISTER	Rules required Values REGISTER - REGISTER OPTIONS - OPTIONS INVITE - INVITE	SIP Request Method Select SIP Request Method.
`sip_response_code_filter_expr`	Type string Default 403	Rules validate_sip_response_code_filter	SIP Response Code Filter Apply rule to failed INVITE with the response code specified. Syntax: 1) Empty string is not accepted. 2) Comma-separated list of codes to match, ie "403,424,436".
`user_agent_filter_expr`	Type string Default None	Rules validate_user_agent_filter	User Agent Filter Whether to filter registration attempts based on user agent. Below is the syntax that must be used for the user agent filter: 1) Empty = No user agent filtering will be perfomed. 2) Any string (this will be an exact match of the string with the user agent) 3) A regular expression matching the desired user agent in format: regex="the regular expression"
`profile_filter`	Type Enumeration Default __none__	Rules required Values __none__ - ( None )	SIP Profile Filter Whether to filter attempts based on SIP profile.
`action_param`	Type string Default None	Rules required[action_expr,in,block_ip] integer greater_or_equal[0] less_than[1440]	Action Parameter Defines parameter of the selected action: Block IP - Number of minutes the IP will remain blocked, from [0 to 1439]. 0 means block this IP forever, until admin manually unblocks it.
`action_expr`	Type Enumeration Default false	Rules required Values block_ip - Block IP false - Log	Action Action to perform when the rule matches
`src_ip_filter_expr`	Type string Default None	Rules src_ip_filter_rule	Source IP Filter Source IP filter - Requests with source IP in this list will be accounted. If empty, all source IPs will be acounted Below is the syntax that must be used for the source IP filter: 1) Empty = All src IPs will be accounted 2) IPv4 IP Address (10.10.0.1) 3) IPv4 Network Address (172.16.0.0/16) 4) Comma seperated list of IPv4 addresses or networks (10.10.0.1, 172.16.0.0/16)
`account_filter_expr`	Type string Default None	Rules validate_account_filter	Account Registration Filter Whether to filter registration attempts based on account. Below is the syntax that must be used for the Account Registration filter: 1) Empty = No account filtering will be perfomed. 2) Unknown = The string "unknown" matches any accounts that are not known to the registrar (ie, trying to register joe@domain.com where the domain.com registrar does not know about any joe user). This option only works when SIP thru registration is disabled for the profile receiving the REGISTER request. 3) Comma-separated list of accounts to match, ie "bob@company.com, alice@company.com". 4) A regular expression matching the desired accounts in format: regex="the regular expression"