Skip to content

cmppolicy_cmpglobal_binding

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

Properties

(click to see Operations)

NameData TypePermissionsDescription
boundto<String>Read-writeThe name of the entity to which the policy is bound.
name<String>Read-writeName of the HTTP compression policy for which to display details.
Minimum length = 1
priority<Double>Read-only.
labelname<String>Read-onlyName of the label to invoke if the current policy rule evaluates to TRUE.
gotopriorityexpression<String>Read-onlyExpression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
labeltype<String>Read-onlyType of policy label invocation.
Possible values = reqvserver, resvserver, policylabel
activepolicy<Double>Read-only.
__count<Double>Read-onlycount 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 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>.

get

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

Query-parameters:

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/cmppolicy_cmpglobal_binding/name_value<String>?filter=property-name1:property-value1,property-name2:property-value2

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

Use this query-parameter to get the cmppolicy_cmpglobal_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "cmppolicy_cmpglobal_binding": [ {
"boundto":<String_value>,
"name":<String_value>,
"priority":<Double_value>,
"labelname":<String_value>,
"gotopriorityexpression":<String_value>,
"labeltype":<String_value>,
"activepolicy":<Double_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

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

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "cmppolicy_cmpglobal_binding": [ {
"boundto":<String_value>,
"name":<String_value>,
"priority":<Double_value>,
"labelname":<String_value>,
"gotopriorityexpression":<String_value>,
"labeltype":<String_value>,
"activepolicy":<Double_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/cmppolicy_cmpglobal_binding/name_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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