Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

videooptimizationglobalpacing_videooptimizationpacingpolicy_binding

August 17, 2023
Contributed by: 
C

Binding object showing the videooptimizationpacingpolicy that can be bound to videooptimizationglobalpacing.

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
policyname Read-write Name of the videooptimization pacing policy.
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 policylabel.
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.
type Read-write Specifies the bind point whose policies you want to display.
Possible values = REQ_OVERRIDE, REQ_DEFAULT, RES_OVERRIDE, RES_DEFAULT
labeltype Read-write Type of invocation, Available settings function as follows: * vserver - Forward the request to the specified virtual server. * policylabel - Invoke the specified policy label.
Possible values = vserver, policylabel
numpol Read-only number of polices bound.
__count Read-only count parameter

Operations

(click to see Properties)

ADD: DELETE: 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>.

add

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

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{
"videooptimizationglobalpacing_videooptimizationpacingpolicy_binding":{
<b>"policyname":<String_value>,
</b><b>"priority":<Double_value>,
</b>"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/videooptimizationglobalpacing_videooptimizationpacingpolicy_binding

Query-parameters:

args

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

Query-parameters:

filter

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

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

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


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

<!--NeedCopy-->

get (all)

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

Query-parameters:

bulkbindings

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


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

<!--NeedCopy-->

count

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

Content-Type:application/json

Response Payload: 


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

<!--NeedCopy-->
videooptimizationglobalpacing_videooptimizationpacingpolicy_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.