Citrix ADC 12.1 NITRO API Reference

cmpglobal_cmppolicy_binding

August 17, 2023

Contributed by:

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

Properties

(click to see Operations)

Name	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
policyname	Read-write	The name of the globally bound HTTP compression policy.
labelname	Read-write	Name of the label to invoke if the current policy rule evaluates to TRUE. Applicable only to advanced (default-syntax) policies.
state	Read-write	The current state of the policy binding. This attribute is relevant only for CLASSIC policies. Possible values = ENABLED, DISABLED
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.
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. Applicable only for default-syntax policies.
type	Read-write	Bind point to which the policy is bound. Possible values = REQ_OVERRIDE, REQ_DEFAULT, RES_OVERRIDE, RES_DEFAULT
labeltype	Read-write	Type of policy label invocation. This argument is relevant only for advanced (default-syntax) policies. Possible values = reqvserver, resvserver, policylabel
numpol	Read-only	The number of policies bound to the bindpoint.
policytype	Read-only	Policy type (Classic/Advanced) to be bound.Used for display. Possible values = Classic Policy, Advanced Policy
__count	Read-only	count parameter

Operations

(click to see Properties)

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 Citrix ADC appliance, the URL is as follows:

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

add

URL:http://<Citrix-ADC-IP-address(NSIP)/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>,
"state":<String_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 Citrix ADC specific errors). The response payload provides details of the error

delete

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/cmpglobal_cmppolicy_binding

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the error

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/cmpglobal_cmppolicy_binding

Query-parameters:

filter

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC. Filtering can be done on any of the properties of the resource.

pagination

http://<Citrix-ADC-IP-address(NSIP)>/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:

Content-Type:application/json

Response Payload:

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

<!--NeedCopy-->

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/cmpglobal_cmppolicy_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/cmpglobal_cmppolicy_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

Content-Type:application/json

Response Payload:

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

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/cmpglobal_cmppolicy_binding?count=yes

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

Content-Type:application/json

Response Payload:

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

cmpglobal_cmppolicy_binding

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

cmpglobal_cmppolicy_binding

Properties

Operations

add

delete

get

get (all)

count

In this article