Skip to content

ns_ssl_certkey

Configuration for SSL certificate on Citrix ADC resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
no_domain_check <Boolean> Read-write Specify this option to override the check for matching domain names during certificate update operation.
ns_ip_address <String> Read-write List of 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
ssl_key <String> Read-write Key.

Minimum length = 1

Maximum length = 128
id <String> Read-write Id is system generated key for all ssl cert-keys entries. For download operation "id" must be provided in the format ;ltadc_ip_address;gt_;ltcertkeypair_name;gt.tgz.
key_data <String> Read-write Key Data.

Maximum length = 16384
ssl_certificate <String> Read-write Certificate.

Minimum length = 1

Maximum length = 128
certificate_data <String> Read-write Certificate Data.

Maximum length = 16384
file_location_path <String> Read-write File Location on Client for download.

Minimum length = 1
cert_format <String> Read-write Certificate Format.

Maximum length = 64
certchainbinding <String[]> Read-write Certificate Chain binding..
save_config <Boolean> Read-write true, if save config is required.
ns_ip_address_arr <String[]> Read-write List of Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
password <String> Read-write The pass-phrase that was used to encrypt the private-key..

Maximum length = 128
source_certificate <String> Read-write CertKeyPair Name of the certificate that needs to installed in another instance.
file_name <String> Read-write File Name.

Minimum length = 1

Maximum length = 256
source_ipaddress <String> Read-write Citrix ADC IP of the certificate that needs to installed in another instance.
serial_number <String> Read-only Serial Number.
signature_algorithm <String> Read-only Signature Algorithm.
valid_from <String> Read-only Valid From.
status <String> Read-only Tells whether the certificate is still valid or not.
hostname <String> Read-only Host Name of the device.
issuer <String> Read-only Issuer.
public_key_size <Integer> Read-only Public Key Size.
device_name <String> Read-only Name of the device.
valid_to <String> Read-only Valid To.
subject <String> Read-only Subject.
version <Integer> Read-only Version.
public_key_algorithm <String> Read-only Public Key Algorithm.
days_to_expiry <Integer> Read-only Days before SSL certificate expires.
poll_time <Integer> Read-only Last Polling Time.
display_name <String> Read-only Display Name of the device.
no_of_bound_entities <Integer> Read-only no_of_bound_entities.
partition_name <String> Read-only Name of Admin Partition. Blank means Default Partition.
datacenter_id <String> Read-only Datacenter Id .
domain <String> Read-only Domain name for certificate issuer.
csr <String> Read-only Certificate Signing Request.

Operations

(click to see Properties )

  • INVENTORY
  • ADD
  • DELETE
  • GET (ALL)
  • GET
  • MODIFY
  • DOWNLOAD
  • GEN_CSR

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

inventory

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey?action=inventory;onerror=<String_value>

HTTPS Method: POST

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_ssl_certkey": {
      "certchainbinding":<String_value[]>,
      "no_domain_check":<Boolean_value>,
      "ns_ip_address":<String_value>,
      "certkeypair_name":<String_value>,
      "source_certificate":<String_value>,
      "password":<String_value>,
      "file_name":<String_value>,
      "ssl_key":<String_value>,
      "source_ipaddress":<String_value>,
      "id":<String_value>,
      "key_data":<String_value>,
      "save_config":<Boolean_value>,
      "ns_ip_address_arr":<String_value[]>,
      "certificate_data":<String_value>,
      "ssl_certificate":<String_value>,
      "file_location_path":<String_value>,
      "cert_format":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
      "serial_number":<String_value>,
      "signature_algorithm":<String_value>,
      "valid_from":<String_value>,
      "status":<String_value>,
      "hostname":<String_value>,
      "issuer":<String_value>,
      "no_domain_check":<Boolean_value>,
      "ns_ip_address":<String_value>,
      "certkeypair_name":<String_value>,
      "public_key_size":<Integer_value>,
      "device_name":<String_value>,
      "ssl_key":<String_value>,
      "id":<String_value>,
      "key_data":<String_value>,
      "valid_to":<String_value>,
      "subject":<String_value>,
      "version":<Integer_value>,
      "public_key_algorithm":<String_value>,
      "days_to_expiry":<Integer_value>,
      "poll_time":<Integer_value>,
      "key_name":<String_value>,
      "display_name":<String_value>,
      "no_of_bound_entities":<Integer_value>,
      "ssl_certificate":<String_value>,
      "certificate_data":<String_value>,
      "file_location_path":<String_value>,
      "partition_name":<String_value>,
      "cert_format":<String_value>,
      "certchainbinding":<String_value>,
      "save_config":<Boolean_value>,
      "datacenter_id":<String_value>,
      "ns_ip_address_arr":<String_value>,
      "password":<String_value>,
      "source_certificate":<String_value>,
      "domain":<String_value>,
      "file_name":<String_value>,
      "csr":<String_value>,
      "source_ipaddress":<String_value>}]}

add

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey?onerror=<String_value>

HTTPS Method: POST

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_ssl_certkey": {
<b>      "certkeypair_name":<String_value></b>,
<b>      "ns_ip_address_arr":<String_value[]></b>,
      "certchainbinding":<String_value[]>,
      "no_domain_check":<Boolean_value>,
      "ns_ip_address":<String_value>,
      "source_certificate":<String_value>,
      "password":<String_value>,
      "file_name":<String_value>,
      "ssl_key":<String_value>,
      "source_ipaddress":<String_value>,
      "id":<String_value>,
      "key_data":<String_value>,
      "save_config":<Boolean_value>,
      "certificate_data":<String_value>,
      "ssl_certificate":<String_value>,
      "file_location_path":<String_value>,
      "cert_format":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
      "serial_number":<String_value>,
      "signature_algorithm":<String_value>,
      "valid_from":<String_value>,
      "status":<String_value>,
      "hostname":<String_value>,
      "issuer":<String_value>,
      "no_domain_check":<Boolean_value>,
      "ns_ip_address":<String_value>,
      "certkeypair_name":<String_value>,
      "public_key_size":<Integer_value>,
      "device_name":<String_value>,
      "ssl_key":<String_value>,
      "id":<String_value>,
      "key_data":<String_value>,
      "valid_to":<String_value>,
      "subject":<String_value>,
      "version":<Integer_value>,
      "public_key_algorithm":<String_value>,
      "days_to_expiry":<Integer_value>,
      "poll_time":<Integer_value>,
      "key_name":<String_value>,
      "display_name":<String_value>,
      "no_of_bound_entities":<Integer_value>,
      "ssl_certificate":<String_value>,
      "certificate_data":<String_value>,
      "file_location_path":<String_value>,
      "partition_name":<String_value>,
      "cert_format":<String_value>,
      "certchainbinding":<String_value>,
      "save_config":<Boolean_value>,
      "datacenter_id":<String_value>,
      "ns_ip_address_arr":<String_value>,
      "password":<String_value>,
      "source_certificate":<String_value>,
      "domain":<String_value>,
      "file_name":<String_value>,
      "csr":<String_value>,
      "source_ipaddress":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey/id_value<String>

HTTPS Method: DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of ns_ssl_certkey resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey ?pagesize=#no;pageno=#no

Use this query-parameter to get the ns_ssl_certkey resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey ?count=yes

Use this query-parameter to get the count of ns_ssl_certkey resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
      "serial_number":<String_value>,
      "signature_algorithm":<String_value>,
      "valid_from":<String_value>,
      "status":<String_value>,
      "hostname":<String_value>,
      "issuer":<String_value>,
      "no_domain_check":<Boolean_value>,
      "ns_ip_address":<String_value>,
      "certkeypair_name":<String_value>,
      "public_key_size":<Integer_value>,
      "device_name":<String_value>,
      "ssl_key":<String_value>,
      "id":<String_value>,
      "key_data":<String_value>,
      "valid_to":<String_value>,
      "subject":<String_value>,
      "version":<Integer_value>,
      "public_key_algorithm":<String_value>,
      "days_to_expiry":<Integer_value>,
      "poll_time":<Integer_value>,
      "key_name":<String_value>,
      "display_name":<String_value>,
      "no_of_bound_entities":<Integer_value>,
      "ssl_certificate":<String_value>,
      "certificate_data":<String_value>,
      "file_location_path":<String_value>,
      "partition_name":<String_value>,
      "cert_format":<String_value>,
      "certchainbinding":<String_value>,
      "save_config":<Boolean_value>,
      "datacenter_id":<String_value>,
      "ns_ip_address_arr":<String_value>,
      "password":<String_value>,
      "source_certificate":<String_value>,
      "domain":<String_value>,
      "file_name":<String_value>,
      "csr":<String_value>,
      "source_ipaddress":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey/id_value<String>

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
      "serial_number":<String_value>,
      "signature_algorithm":<String_value>,
      "valid_from":<String_value>,
      "status":<String_value>,
      "hostname":<String_value>,
      "issuer":<String_value>,
      "no_domain_check":<Boolean_value>,
      "ns_ip_address":<String_value>,
      "certkeypair_name":<String_value>,
      "public_key_size":<Integer_value>,
      "device_name":<String_value>,
      "ssl_key":<String_value>,
      "id":<String_value>,
      "key_data":<String_value>,
      "valid_to":<String_value>,
      "subject":<String_value>,
      "version":<Integer_value>,
      "public_key_algorithm":<String_value>,
      "days_to_expiry":<Integer_value>,
      "poll_time":<Integer_value>,
      "key_name":<String_value>,
      "display_name":<String_value>,
      "no_of_bound_entities":<Integer_value>,
      "ssl_certificate":<String_value>,
      "certificate_data":<String_value>,
      "file_location_path":<String_value>,
      "partition_name":<String_value>,
      "cert_format":<String_value>,
      "certchainbinding":<String_value>,
      "save_config":<Boolean_value>,
      "datacenter_id":<String_value>,
      "ns_ip_address_arr":<String_value>,
      "password":<String_value>,
      "source_certificate":<String_value>,
      "domain":<String_value>,
      "file_name":<String_value>,
      "csr":<String_value>,
      "source_ipaddress":<String_value>}]}

modify

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey/id_value<String>

HTTPS Method: PUT

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_ssl_certkey":{
<b>      "id":<String_value></b>,
      "certchainbinding":<String_value[]>,
      "no_domain_check":<Boolean_value>,
      "ns_ip_address":<String_value>,
      "certkeypair_name":<String_value>,
      "source_certificate":<String_value>,
      "password":<String_value>,
      "file_name":<String_value>,
      "ssl_key":<String_value>,
      "source_ipaddress":<String_value>,
      "key_data":<String_value>,
      "save_config":<Boolean_value>,
      "ns_ip_address_arr":<String_value[]>,
      "certificate_data":<String_value>,
      "ssl_certificate":<String_value>,
      "file_location_path":<String_value>,
      "cert_format":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
      "serial_number":<String_value>,
      "signature_algorithm":<String_value>,
      "valid_from":<String_value>,
      "status":<String_value>,
      "hostname":<String_value>,
      "issuer":<String_value>,
      "no_domain_check":<Boolean_value>,
      "ns_ip_address":<String_value>,
      "certkeypair_name":<String_value>,
      "public_key_size":<Integer_value>,
      "device_name":<String_value>,
      "ssl_key":<String_value>,
      "id":<String_value>,
      "key_data":<String_value>,
      "valid_to":<String_value>,
      "subject":<String_value>,
      "version":<Integer_value>,
      "public_key_algorithm":<String_value>,
      "days_to_expiry":<Integer_value>,
      "poll_time":<Integer_value>,
      "key_name":<String_value>,
      "display_name":<String_value>,
      "no_of_bound_entities":<Integer_value>,
      "ssl_certificate":<String_value>,
      "certificate_data":<String_value>,
      "file_location_path":<String_value>,
      "partition_name":<String_value>,
      "cert_format":<String_value>,
      "certchainbinding":<String_value>,
      "save_config":<Boolean_value>,
      "datacenter_id":<String_value>,
      "ns_ip_address_arr":<String_value>,
      "password":<String_value>,
      "source_certificate":<String_value>,
      "domain":<String_value>,
      "file_name":<String_value>,
      "csr":<String_value>,
      "source_ipaddress":<String_value>}]}

gen_csr

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey/id_value<String>?action=gen_csr;onerror=<String_value>

HTTPS Method: POST

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_ssl_certkey": { }}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt}

download

URL: https://<MGMT-IP>/nitro/v2/download/;ltns_ip_address;gt_;ltcertkeypair_name;gt.tgz

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: Binary Stream

Was this article helpful?