Skip to content
Was this article helpful?

ns_waf_relaxation

Configuration for Reference object to pass for relaxing a WAF Learning engine learnt rule resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
field_type <String> Read-write Field type to be relaxed.

Maximum length = 512
status <Boolean> Read-write Status is true when the rule is enabled and false when the rule is disabled.
mode <Integer> Read-write mode to be deployed as open/closed.
violation_location <Integer> Read-write Violation Location.
violation_id <Integer> Read-write Violation Category.
field_name <String> Read-write Field name to be relaxed.

Maximum length = 512
resourceid <String> Read-write Resourceid generated for each relaxation rule..

Maximum length = 128
max_value <Integer> Read-write Maximum length of the filed to be relaxed.
value_type <String> Read-write Value type to be relaxed.

Maximum length = 512
http_req_url <String> Read-write HTTP Request URL to be relaxed.

Maximum length = 2000
value_expr <String> Read-write Value expression to be relaxed.

Maximum length = 512
si_device_ip_address <String> Read-write Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
min_value <Integer> Read-write minimum length of the field to be relaxed.
comment <String> Read-write Comment to be sent as payload in relaxation rule nitro.

Maximum length = 255
profile_name <String> Read-write profile_name.

Minimum length = 1

Maximum length = 32
adm_learn_profile_name <String> Read-write adm_learn_profile_name.

Minimum length = 1

Maximum length = 32

Operations

(click to see Properties )

  • GET (ALL)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ns_waf_relaxation

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/ns_waf_relaxation ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of ns_waf_relaxation resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ns_waf_relaxation ?pagesize=#no;pageno=#no

Use this query-parameter to get the ns_waf_relaxation resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ns_waf_relaxation ?count=yes

Use this query-parameter to get the count of ns_waf_relaxation resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_waf_relaxation":[{
      "field_type":<String_value>,
      "status":<Boolean_value>,
      "mode":<Integer_value>,
      "violation_location":<Integer_value>,
      "violation_id":<Integer_value>,
      "field_name":<String_value>,
      "resourceid":<String_value>,
      "max_value":<Integer_value>,
      "value_type":<String_value>,
      "http_req_url":<String_value>,
      "value_expr":<String_value>,
      "si_device_ip_address":<String_value>,
      "min_value":<Integer_value>,
      "comment":<String_value>,
      "profile_name":<String_value>,
      "adm_learn_profile_name":<String_value>}]}
Was this article helpful?