Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

cmpglobal_cmppolicy_binding

May 23, 2024
Contributed by: 
C

Binding object showing the cmppolicy that can be bound to cmpglobal.

Properties

(click to see Operations )

Name Data Type Permissions Description
priority Read-write Positive integer specifying the priority of the policy. The lower the number, the higher the priority. By default, polices within a label are evaluated in the order of their priority numbers. In the configuration utility, you can click the Priority field and edit the priority level or drag the entry to a new position in the list. If you drag the entry to a new position, the priority level is updated automatically.
globalbindtype Read-write .

Default value: SYSTEM_GLOBAL

Possible values = SYSTEM_GLOBAL, VPN_GLOBAL, RNAT_GLOBAL, APPFW_GLOBAL
gotopriorityexpression Read-write Expression or other value specifying the priority of the next policy, within the policy label, to evaluate if the current policy evaluates to TRUE. Specify one of the following values
  • NEXT - Evaluate the policy with the next higher numbered priority.
  • END - Stop evaluation.
  • USE_INVOCATION_RESULT - Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the evaluation stops. If the final goto is anything other than END, the current policy label performs a NEXT.
  • An expression that evaluates to a number. If you specify an expression, it’s evaluation result determines the next policy to evaluate, as follows
  • If the expression evaluates to a higher numbered priority, that policy is evaluated next.
  • If the expression evaluates to the priority of the current policy, the policy with the next higher priority number is evaluated next.
  • If the expression evaluates to a priority number that is numerically higher than the highest priority number, policy evaluation ends. An UNDEF event is triggered if
  • The expression is invalid.
  • The expression evaluates to a priority number that is numerically lower than the current policy’s priority.
  • The expression evaluates to a priority number that is between the current policy’s priority number (say, 30) and the highest priority number (say, 100), but does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number increments by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.
    		•
    policyname Read-write The name of the globally bound HTTP compression policy.
    type Read-write Bind point to which the policy is bound.

    Possible values = REQ_OVERRIDE, REQ_DEFAULT, RES_OVERRIDE, RES_DEFAULT, HTTPQUIC_REQ_OVERRIDE, HTTPQUIC_REQ_DEFAULT, HTTPQUIC_RES_OVERRIDE, HTTPQUIC_RES_DEFAULT, NONE
    labeltype Read-write Type of policy label invocation.

    Possible values = reqvserver, resvserver, policylabel
    labelname Read-write Name of the label to invoke if the current policy rule evaluates to TRUE.
    invoke Read-write Invoke policies bound to a virtual server or a policy label. After the invoked policies are evaluated, the flow returns to the policy with the next priority.
    numpol Read-only The number of policies bound to the bindpoint.
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • DELETE
    • GET
    • 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

    add

    URL: http:// <netscaler-ip-address /nitro/v1/config/cmpglobal_cmppolicy_binding HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {
"cmpglobal_cmppolicy_binding":{
<b>"policyname":<String_value>,
</b>"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"type":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"labelname":<String_value>
}}

<!--NeedCopy-->

    Response: HTTP Status Code on Success: 201 Created

    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

    delete

    URL: http:// <netscaler-ip-address> /nitro/v1/config/cmpglobal_cmppolicy_binding Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/cmpglobal_cmppolicy_binding? args= policyname:<String_value>, type: <String_value> ,priority: <Double_value>

    HTTP Method: DELETE

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    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

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/cmpglobal_cmppolicy_binding Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/cmpglobal_cmppolicy_binding? args=type: <String_value>

    Use this query-parameter to get cmpglobal_cmppolicy_binding resources based on additional properties.

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

    Use this query-parameter to get the filtered set of cmpglobal_cmppolicy_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/cmpglobal_cmppolicy_binding? pagesize=#no;pageno=#no

    Use this query-parameter to get the cmpglobal_cmppolicy_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: 

    {  "cmpglobal_cmppolicy_binding": [ {
"priority":<Double_value>,
"globalbindtype":<String_value>,
"gotopriorityexpression":<String_value>,
"policyname":<String_value>,
"type":<String_value>,
"labeltype":<String_value>,
"labelname":<String_value>,
"invoke":<Boolean_value>,
"numpol":<Double_value>
}]}

<!--NeedCopy-->

    count

    URL: http:// <netscaler-ip-address> /nitro/v1/config/cmpglobal_cmppolicy_binding? 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: 

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

<!--NeedCopy-->
    cmpglobal_cmppolicy_binding
    May 23, 2024
    Contributed by: 
    C
    May 23, 2024
    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.