Skip to content

ns_ssl_certkey

Configuration for SSL certificate on NetScaler resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
no_domain_check<Boolean>Read-writeSpecify this option to override the check for matching domain names during certificate update operation.
ns_ip_address<String>Read-writeList of NetScaler IP Address.
Minimum length = 1
Maximum length = 64
certkeypair_name<String>Read-writeCert Key Pair Name.
Minimum length = 1
Maximum length = 128
ssl_key<String>Read-writeKey.
Minimum length = 1
Maximum length = 128
id<String>Read-writeId is system generated key for all ssl cert-keys entries. For download operation "id" must be provided in the format ;ltns_ip_address>_;ltcertkeypair_name>.tgz.
key_data<String>Read-writeKey Data.
Maximum length = 16384
ssl_certificate<String>Read-writeCertificate.
Minimum length = 1
Maximum length = 128
certificate_data<String>Read-writeCertificate Data.
Maximum length = 16384
file_location_path<String>Read-writeFile Location on Client for download.
Minimum length = 1
cert_format<String>Read-writeCertificate Format.
Maximum length = 64
certchainbinding<String[]>Read-writeCertificate Chain binding..
save_config<Boolean>Read-writetrue, if save config is required.
source_certificate<String>Read-writeCertKeyPair Name of the certificate that needs to installed in another instance.
password<String>Read-writeThe pass-phrase that was used to encrypt the private-key..
Maximum length = 128
source_ipaddress<String>Read-writeNS IP of the certificate that needs to installed in another instance.
ns_ip_address_arr<String[]>Read-writeList of NetScaler IP Address.
Minimum length = 1
Maximum length = 64
serial_number<String>Read-onlySerial Number.
signature_algorithm<String>Read-onlySignature Algorithm.
valid_from<String>Read-onlyValid From.
status<String>Read-onlyTells whether the certificate is still valid or not.
hostname<String>Read-onlyHost Name of the device.
issuer<String>Read-onlyIssuer.
public_key_size<Integer>Read-onlyPublic Key Size.
device_name<String>Read-onlyName of the device.
valid_to<String>Read-onlyValid To.
subject<String>Read-onlySubject.
version<Integer>Read-onlyVersion.
public_key_algorithm<String>Read-onlyPublic Key Algorithm.
days_to_expiry<Integer>Read-onlyDays before SSL certificate expires.
poll_time<Integer>Read-onlyLast Polling Time.
display_name<String>Read-onlyDisplay Name of the device.
no_of_bound_entities<Integer>Read-onlyno_of_bound_entities.
partition_name<String>Read-onlyName of Admin Partition. Blank means Default Partition.
csr<String>Read-onlyCertificate Signing Request.

Operations

(click to see Properties)

INVENTORY| ADD| DELETE| GET (ALL)| GET| DOWNLOAD_CERTS (ALL)| MODIFY| 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>.

inventory

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

HTTP Method: null

Request Payload:

{ns_ssl_certkey: {
"certchainbinding":<String_value[]>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"password":<String_value>,
"source_certificate":<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 Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"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>,
"source_certificate":<String_value>,
"password":<String_value>,
"source_ipaddress":<String_value>,
"csr":<String_value>,
"ns_ip_address_arr":<String_value>}]}

add

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

HTTP Method: null

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>,
"password":<String_value>,
"source_certificate":<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 Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"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>,
"source_certificate":<String_value>,
"password":<String_value>,
"source_ipaddress":<String_value>,
"csr":<String_value>,
"ns_ip_address_arr":<String_value>}]}

delete

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

HTTP Method: null

Response Payload:

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

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"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>,
"source_certificate":<String_value>,
"password":<String_value>,
"source_ipaddress":<String_value>,
"csr":<String_value>,
"ns_ip_address_arr":<String_value>}]}

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"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>,
"source_certificate":<String_value>,
"password":<String_value>,
"source_ipaddress":<String_value>,
"csr":<String_value>,
"ns_ip_address_arr":<String_value>}]}

download_certs (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"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>,
"source_certificate":<String_value>,
"password":<String_value>,
"source_ipaddress":<String_value>,
"csr":<String_value>,
"ns_ip_address_arr":<String_value>}]}

modify

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

HTTP Method: null

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>,
"password":<String_value>,
"source_certificate":<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 Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>,
"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>,
"source_certificate":<String_value>,
"password":<String_value>,
"source_ipaddress":<String_value>,
"csr":<String_value>,
"ns_ip_address_arr":<String_value>}]}

gen_csr

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

HTTP Method: null

Request Payload:

{"ns_ssl_certkey": { }}

Response Payload:

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