ADM NITRO APIs

ns_sslcertkey_binding

Configuration for SSL certificate Vs entity bindings on Citrix ADC resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
ns_ip_address <String> Read-write Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
certkeypair_name <String> Read-write Cert Key Pair Name.

Minimum length = 1

Maximum length = 128
id <String> Read-write Id is system generated key for all ssl cert-keys entries. .
hostname <String> Read-only Host Name of the device.
poll_time <Integer> Read-only Last Polling Time.
display_name <String> Read-only Display Name of the device.
entity_name <String> Read-only Name of the SSL LB Vserver or Service or Service Group to which the certificate is bound.
partition_name <String> Read-only Name of Admin Partition. Blank means Default Partition.
entity_type <String> Read-only Entity type.Indicates sslvserver,service.

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>

    *Note: * Mandatory parameters are marked in red and placeholder content is marked in green

    The following parameters can be used in the nitro request : onerror <String_value>

    Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

    Default value: EXIT

    Possible values = EXIT, CONTINUE

    ns_sslcertkey_binding