NSX-T Data Center REST API

ALBWafPSMRule (type)

{
  "additionalProperties": false, 
  "description": "Advanced load balancer WafPSMRule object", 
  "id": "ALBWafPSMRule", 
  "module_id": "PolicyAdvancedLoadBalancer", 
  "properties": {
    "description": {
      "description": "Free-text comment about this rule.", 
      "required": false, 
      "title": "Description", 
      "type": "string"
    }, 
    "enable": {
      "default": true, 
      "description": "Enable or disable this rule. Default value when not specified in API or module is interpreted by ALB Controller as true.", 
      "required": false, 
      "title": "Enable", 
      "type": "boolean"
    }, 
    "index": {
      "description": "Rule index, this is used to determine the order of the rules.", 
      "required": true, 
      "title": "Index", 
      "type": "integer"
    }, 
    "match_case": {
      "$ref": "ALBMatchCase, 
      "default": "INSENSITIVE", 
      "description": "The field match_value_pattern regular expression is case sensitive. Enum options - SENSITIVE, INSENSITIVE. Default value when not specified in API or module is interpreted by ALB Controller as INSENSITIVE.", 
      "required": false, 
      "title": "Match case"
    }, 
    "match_elements": {
      "description": "The match elements, for example ARGS id or ARGS|!ARGS password. Maximum of 64 items allowed.", 
      "items": {
        "$ref": "ALBWafPSMMatchElement
      }, 
      "required": false, 
      "title": "Match elements", 
      "type": "array"
    }, 
    "match_value_max_length": {
      "description": "The maximum allowed length of the match_value. If this is not set, the length will not be checked.", 
      "required": false, 
      "title": "Match value max length", 
      "type": "integer"
    }, 
    "match_value_pattern": {
      "description": "A regular expression which describes the expected value.", 
      "required": false, 
      "title": "Match value pattern", 
      "type": "string"
    }, 
    "mode": {
      "$ref": "ALBWafMode, 
      "description": "WAF Rule mode. This can be detection or enforcement. If this is not set, the Policy mode is used. This only takes effect if the policy allows delegation. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT.", 
      "required": false, 
      "title": "Mode"
    }, 
    "name": {
      "description": "Name of the rule.", 
      "required": true, 
      "title": "Name", 
      "type": "string"
    }, 
    "paranoia_level": {
      "$ref": "ALBWafParanoiaLevel, 
      "default": "WAF_PARANOIA_LEVEL_LOW", 
      "description": "WAF Ruleset paranoia mode. This is used to select Rules based on the paranoia-level. Enum options - WAF_PARANOIA_LEVEL_LOW, WAF_PARANOIA_LEVEL_MEDIUM, WAF_PARANOIA_LEVEL_HIGH, WAF_PARANOIA_LEVEL_EXTREME. Default value when not specified in API or module is interpreted by ALB Controller as WAF_PARANOIA_LEVEL_LOW.", 
      "required": false, 
      "title": "Paranoia level"
    }, 
    "rule_id": {
      "description": "Id field which is used for log and metric generation. This id must be unique for all rules in this group.", 
      "required": true, 
      "title": "Rule id", 
      "type": "string"
    }
  }, 
  "title": "WafPSMRule", 
  "type": "object"
}