Skip to content

sslvserver_sslpolicy_binding

Binding object showing the sslpolicy that can be bound to sslvserver.

Properties

(click to see Operations)

NameData TypePermissionsDescription
priority<Double>Read-writeThe priority of the policies bound to this SSL service.
Minimum value = 0
Maximum value = 65534
policyname<String>Read-writeThe name of the SSL policy binding.
labelname<String>Read-writeName of the label to invoke if the current policy rule evaluates to TRUE.
vservername<String>Read-writeName of the SSL virtual server.
Minimum length = 1
gotopriorityexpression<String>Read-writeExpression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
invoke<Boolean>Read-writeInvoke flag. This attribute is relevant only for ADVANCED policies.
type<String>Read-writeBind point to which to bind the policy. Possible Values: REQUEST, INTERCEPT_REQ and CLIENTHELLO_REQ. These bindpoints mean: 1. REQUEST: Policy evaluation will be done at appplication above SSL. This bindpoint is default and is used for actions based on clientauth and client cert. 2. INTERCEPT_REQ: Policy evaluation will be done during SSL handshake to decide whether to intercept or not. Actions allowed with this type are: INTERCEPT, BYPASS and RESET. 3. CLIENTHELLO_REQ: Policy evaluation will be done during handling of Client Hello Request. Action allowed with this type is: RESET, FORWARD and PICKCACERTGRP.
Default value: REQUEST
Possible values = INTERCEPT_REQ, REQUEST, CLIENTHELLO_REQ
labeltype<String>Read-writeType of policy label invocation.
Possible values = vserver, service, policylabel
polinherit<Double>Read-onlyWhether the bound policy is a inherited policy or not.
Minimum value = 0
Maximum value = 254
__count<Double>Read-onlycount 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/sslvserver_sslpolicy_binding

HTTP Method:PUT

Request Headers:

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

Request Payload:

{
"sslvserver_sslpolicy_binding":{
<b>"vservername":<String_value>,
</b>"policyname":<String_value>,
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"invoke":<Boolean_value>,
"labeltype":<String_value>,
"labelname":<String_value>,
"type":<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 Citrix ADC specific errors). The response payload provides details of the error

delete:

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

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/sslvserver_sslpolicy_binding/vservername_value<String>?args=policyname:<String_value>,priority:<Double_value>,type:<String_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/sslvserver_sslpolicy_binding/vservername_value<String>

Query-parameters:

filter

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

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

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

{ "sslvserver_sslpolicy_binding": [ {
"priority":<Double_value>,
"policyname":<String_value>,
"labelname":<String_value>,
"vservername":<String_value>,
"gotopriorityexpression":<String_value>,
"invoke":<Boolean_value>,
"type":<String_value>,
"labeltype":<String_value>,
"polinherit":<Double_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

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

{ "sslvserver_sslpolicy_binding": [ {
"priority":<Double_value>,
"policyname":<String_value>,
"labelname":<String_value>,
"vservername":<String_value>,
"gotopriorityexpression":<String_value>,
"invoke":<Boolean_value>,
"type":<String_value>,
"labeltype":<String_value>,
"polinherit":<Double_value>
}]}

count

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

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