ADM NITRO APIs

ns_sslcertkey_binding

June 20, 2023

Contributed by:

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

Properties

(click to see Operations )

Name	Permissions	Description
ns_ip_address	Read-write	Citrix ADC IP Address. Minimum length = 1 Maximum length = 64
certkeypair_name	Read-write	Cert Key Pair Name. Minimum length = 1 Maximum length = 128
id	Read-write	Id is system generated key for all ssl cert-keys entries. .
hostname	Read-only	Host Name of the device.
poll_time	Read-only	Last Polling Time.
display_name	Read-only	Display Name of the device.
entity_name	Read-only	Name of the SSL LB Vserver or Service or Service Group to which the certificate is bound.
partition_name	Read-only	Name of Admin Partition. Blank means Default Partition.
entity_type	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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

ns_sslcertkey_binding

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

ns_sslcertkey_binding

Properties

Operations

In this article