Citrix ADM NITRO API Reference

af_waf_deploy_rules_l2

Configuration for WAF Learning engine ready to deploy relaxation rules learnt for Level 2 resource.

Properties

(click to see Operations )

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

Maximum length = 512
lastpolltime <Double> Read-write Last Time polling was done to fetch hits.
status <Boolean> Read-write Status is true when the rule is enabled and false when the rule is disabled.
mode <Integer> Read-write Deployment mode would be OPEN(0) / CLOSE(1).
count_value <Integer> Read-write count for the number of times this rule has caused violation.
hits <Integer> Read-write Number of hits for the relaxation rule in this appfw profile..
failure_reason <String> Read-write Field used to help the user figure out point of failure for a rule.
ctnsappname <String> Read-write ctnsappname.

Maximum length = 255
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
is_system <Boolean> Read-write Set to true when system generated and false for user configured rule.
max_value <Integer> Read-write Maximum length of the filed to be relaxed.
rpt_sample_time <Double> Read-write Report Sample time..
user_name <String> Read-write Field used to maintain the name of User who take an action that lead to this transaction record.
learning_mode <Integer> Read-write Learning mode to differentate between a rule to be pruned (2) or deployed (0 or 1).
value_type <String> Read-write Value type to be relaxed.

Maximum length = 512
lasthittime <Double> Read-write Last hit for the relaxation rule in this appfw profile..
value_expr <String> Read-write Value expression to be relaxed.

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

Maximum length = 2000
is_deployed <Integer> Read-write Field refelecting status of rule i.e 0-ready to deploy,1-deployed,2-skipped,4-failed.
si_device_ip_address <String> Read-write Citrix ADC IP Address..

Minimum length = 1

Maximum length = 512
min_value <Integer> Read-write minimum length of the field to be relaxed.
profile_name <String> Read-write profile_name.

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

Minimum length = 1

Maximum length = 32
id <String> Read-only Id is system generated key..

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/af_waf_deploy_rules_l2 Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/af_waf_deploy_rules_l2 ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of af_waf_deploy_rules_l2 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/af_waf_deploy_rules_l2 ?pagesize=#no;pageno=#no Use this query-parameter to get the af_waf_deploy_rules_l2 resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/af_waf_deploy_rules_l2 ?count=yes Use this query-parameter to get the count of af_waf_deploy_rules_l2 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, "af_waf_deploy_rules_l2":[{
"field_type":<String_value>,
"lastpolltime":<Double_value>,
"status":<Boolean_value>,
"mode":<Integer_value>,
"count_value":<Integer_value>,
"hits":<Integer_value>,
"failure_reason":<String_value>,
"ctnsappname":<String_value>,
"violation_location":<Integer_value>,
"id":<String_value>,
"violation_id":<Integer_value>,
"field_name":<String_value>,
"resourceid":<String_value>,
"is_system":<Boolean_value>,
"max_value":<Integer_value>,
"rpt_sample_time":<Double_value>,
"user_name":<String_value>,
"learning_mode":<Integer_value>,
"value_type":<String_value>,
"lasthittime":<Double_value>,
"value_expr":<String_value>,
"http_req_url":<String_value>,
"is_deployed":<Integer_value>,
"si_device_ip_address":<String_value>,
"min_value":<Integer_value>,
"profile_name":<String_value>,
"adm_learn_profile_name":<String_value>}]}

<!--NeedCopy-->
af_waf_deploy_rules_l2