Product Documentation

sslvserver_sslcertkey_binding

Sep 07, 2016

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

Properties (click to see Operations)

Name Data Type Permissions Description
ca
<Boolean>
Read-write
CA certificate.
crlcheck
<String>
Read-write
The state of the CRL check parameter. (Mandatory/Optional).
Possible values = Mandatory, Optional
vservername
<String>
Read-write
Name of the SSL virtual server.
Minimum length = 1
certkeyname
<String>
Read-write
The name of the certificate key pair binding.
skipcaname
<Boolean>
Read-write
The flag is used to indicate whether this particular CA certificate's CA_Name needs to be sent to the SSL client while requesting for client certificate in a SSL handshake.
snicert
<Boolean>
Read-write
The name of the CertKey. Use this option to bind Certkey(s) which will be used in SNI processing.
ocspcheck
<String>
Read-write
The state of the OCSP check parameter. (Mandatory/Optional).
Possible values = Mandatory, Optional
cleartextport
<Integer>
Read-only
Port on which clear-text data is sent by the appliance to the server. Do not specify this parameter for SSL offloading with end-to-end encryption.
Default value: 0
__count
<Double>
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 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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add:

URL: http://<netscaler-ip-address/nitro/v1/config/sslvserver_sslcertkey_binding

HTTP Method: PUT

Request Headers:

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

Request Payload:

{
"sslvserver_sslcertkey_binding":{
      "vservername":<String_value>,
      "certkeyname":<String_value>,
      "ca":<Boolean_value>,
      "crlcheck":<String_value>,
      "skipcaname":<Boolean_value>,
      "snicert":<Boolean_value>,
      "ocspcheck":<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/sslvserver_sslcertkey_binding/vservername_value<String>

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/sslvserver_sslcertkey_binding/vservername_value<String>

Query-parameters:

filter

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

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

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

Content-Type:application/json

Response Payload:

{ "sslvserver_sslcertkey_binding": [ {
      "ca":<Boolean_value>,
      "crlcheck":<String_value>,
      "vservername":<String_value>,
      "certkeyname":<String_value>,
      "skipcaname":<Boolean_value>,
      "snicert":<Boolean_value>,
      "ocspcheck":<String_value>,
      "cleartextport":<Integer_value>
}]}

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/sslvserver_sslcertkey_binding

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/sslvserver_sslcertkey_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 NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "sslvserver_sslcertkey_binding": [ {
      "ca":<Boolean_value>,
      "crlcheck":<String_value>,
      "vservername":<String_value>,
      "certkeyname":<String_value>,
      "skipcaname":<Boolean_value>,
      "snicert":<Boolean_value>,
      "ocspcheck":<String_value>,
      "cleartextport":<Integer_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/sslvserver_sslcertkey_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 NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

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