Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

appfwpolicylabel_policybinding_binding

August 17, 2023
Contributed by: 
C

Binding object showing the policybinding that can be bound to appfwpolicylabel.

Properties

(click to see Operations )

Name Data Type Permissions Description
priority Read-write Positive integer specifying the priority of the policy. A lower number specifies a higher priority. Must be unique within a group of policies that are bound to the same bind point or label. Policies are evaluated in the order of their priority numbers.
policyname Read-write Name of the application firewall policy to bind to the policy label.
labelname Read-write Name of the application firewall policy label.
invoke_labelname Read-write Name of the policy label to invoke if the current policy evaluates to TRUE, the invoke parameter is set, and Label Type is set to Policy Label.
gotopriorityexpression Read-write Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
invoke Read-write If the current policy evaluates to TRUE, terminate evaluation of policies bound to the current policy label, and then forward the request to the specified virtual server or evaluate the specified policy label.
labeltype Read-write Type of policy label to invoke if the current policy evaluates to TRUE and the invoke parameter is set. Available settings function as follows
  • reqvserver. Invoke the unnamed policy label associated with the specified request virtual server.
  • policylabel. Invoke the specified user-defined policy label. Possible values = reqvserver, policylabel
    		•
    __count Read-write count parameter

    Operations

    (click to see Properties )

    • GET
    • GET (ALL)
    • COUNT

    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

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwpolicylabel_policybinding_binding/ labelname_value<String>

    Query-parameters:

    filter

    http:// <netscaler-ip-address> /nitro/v1/config/appfwpolicylabel_policybinding_binding/ labelname_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

    Use this query-parameter to get the filtered set of appfwpolicylabel_policybinding_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

    pagination

    http:// <netscaler-ip-address> /nitro/v1/config/appfwpolicylabel_policybinding_binding/ labelname_value<String> ? pagesize=#no;pageno=#no

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

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response:

    HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    
{  "appfwpolicylabel_policybinding_binding": [ {
      "priority":<Double_value>,
      "policyname":<String_value>,
      "labelname":<String_value>,
      "invoke_labelname":<String_value>,
      "gotopriorityexpression":<String_value>,
      "invoke":<Boolean_value>,
      "labeltype":<String_value>
}]}

<!--NeedCopy-->

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwpolicylabel_policybinding_binding

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Query-parameters:

    bulkbindings

    http:// <netscaler-ip-address> /nitro/v1/config/appfwpolicylabel_policybinding_binding? bulkbindings=yes

    NITRO allows you to fetch bindings in bulk.

    Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

    Response:

    HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    
{  "appfwpolicylabel_policybinding_binding": [ {
      "priority":<Double_value>,
      "policyname":<String_value>,
      "labelname":<String_value>,
      "invoke_labelname":<String_value>,
      "gotopriorityexpression":<String_value>,
      "invoke":<Boolean_value>,
      "labeltype":<String_value>
}]}

<!--NeedCopy-->

    count

    URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwpolicylabel_policybinding_binding/ labelname_value<String> ? count=yes

    HTTP Method: GET

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Accept:application/json

    Response:

    HTTP Status Code on Success: 200 OK

    HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    
{"appfwpolicylabel_policybinding_binding": [ { "__count": "#no"} ] }

<!--NeedCopy-->
    appfwpolicylabel_policybinding_binding
    August 17, 2023
    Contributed by: 
    C
    August 17, 2023
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.