ADC NITRO APIs

cacheglobal_cachepolicy_binding

Binding object showing the cachepolicy that can be bound to cacheglobal.

Properties

(click to see Operations )

Name Data Type Permissions Description
priority Read-write Specifies the priority of the policy.
globalbindtype Read-write .

Default value: SYSTEM_GLOBAL

Possible values = SYSTEM_GLOBAL, VPN_GLOBAL, RNAT_GLOBAL, APPFW_GLOBAL
gotopriorityexpression Read-write Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
policy Read-write Name of the cache policy.
type Read-write The bind point to which policy is bound. When you specify the type, detailed information about that bind point appears.

Possible values = REQ_OVERRIDE, REQ_DEFAULT, RES_OVERRIDE, RES_DEFAULT, HTTPQUIC_REQ_OVERRIDE, HTTPQUIC_REQ_DEFAULT, HTTPQUIC_RES_OVERRIDE, HTTPQUIC_RES_DEFAULT
precededefrules Read-write Specify whether this policy should be evaluated.

Default value: NO

Possible values = YES, NO
labeltype Read-write Type of policy label to invoke.

Possible values = reqvserver, resvserver, policylabel
labelname Read-write Name of the label to invoke if the current policy rule evaluates to TRUE. (To invoke a label associated with a virtual server, specify the name of the virtual server.).
invoke Read-write Invoke policies bound to a virtual server or a user-defined policy label. After the invoked policies are evaluated, the flow returns to the policy with the next priority. Applicable only to default-syntax policies.
flowtype Read-only flowtype of the bound cache policy.
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/cacheglobal_cachepolicy_binding HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{ "cacheglobal_cachepolicy_binding":{ <b>"policy":<String_value>, </b><b>"priority":<Double_value>, </b>"precededefrules":<String_value>, "gotopriorityexpression":<String_value>, "type":<String_value>, "invoke":<Boolean_value>, "labeltype":<String_value>, "labelname":<String_value> }}

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/cacheglobal_cachepolicy_binding Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/cacheglobal_cachepolicy_binding? args= policy:<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/cacheglobal_cachepolicy_binding Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/cacheglobal_cachepolicy_binding? args=type: <String_value>

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

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

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

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

{ "cacheglobal_cachepolicy_binding": [ { "priority":<Double_value>, "globalbindtype":<String_value>, "gotopriorityexpression":<String_value>, "policy":<String_value>, "type":<String_value>, "precededefrules":<String_value>, "labeltype":<String_value>, "labelname":<String_value>, "invoke":<Boolean_value>, "flowtype":<Double_value>, "numpol":<Double_value> }]}

count

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

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