Citrix ADM NITRO API Reference

ns_sslprofile

Configuration for Citrix ADC SSL Profile resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
denysslreneg Read-write denysslreneg.
sessionticketkeyrefresh Read-write sessionticketkeyrefresh.
quantumsize Read-write quantumsize.
cipherurl Read-write cipherurl.
ns_ip_address Read-write Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
ssltriggertimeout Read-write ssltriggertimeout.
pushflag Read-write pushflag.
allowextendedmastersecret Read-write allowextendedmastersecret.
commonname Read-write commonname.
ssllogprofile Read-write ssllogprofile.
name Read-write Name.

Minimum length = 1

Maximum length = 100
dhcount Read-write dhcount.
tls13sessionticketsperauthcontext Read-write tls13sessionticketsperauthcontext.
pushenctriggertimeout Read-write pushenctriggertimeout.
dh Read-write dh.
hsts Read-write hsts.
serverauth Read-write serverauth.
tls13 Read-write tls13.
snienable Read-write snienable.
sslinterception Read-write sslinterception.
cipherredirect Read-write cipherredirect.
strictsigdigestcheck Read-write strictsigdigestcheck.
sslimaxsessperserver Read-write sslimaxsessperserver.
clientcert Read-write clientcert.
prevsessionkeylifetime Read-write prevsessionkeylifetime.
sessionticketlifetime Read-write sessionticketlifetime.
dhfile Read-write dhfile.
encrypttriggerpktcount Read-write encrypttriggerpktcount.
ssl2 Read-write ssl2.
sslredirect Read-write sslredirect.
insertionencoding Read-write insertionencoding.
ersa Read-write ersa.
strictcachecks Read-write strictcachecks.
sslireneg Read-write sslireneg.
redirectportrewrite Read-write redirectportrewrite.
sessreuse Read-write sessreuse.
ssl3 Read-write ssl3.
sessionticketkeydata Read-write sessionticketkeydata.
sessionticket Read-write sessionticket.
id Read-write Id is system generated key.
cleartextport Read-write cleartextport.
alpnprotocol Read-write alpnprotocol.
clientauthuseboundcachain Read-write clientauthuseboundcachain.
ocspstapling Read-write ocspstapling.
dhekeyexchangewithpsk Read-write dhekeyexchangewithpsk.
ersacount Read-write ersacount.
snihttphostmatch Read-write snihttphostmatch.
preload Read-write preload.
sesstimeout Read-write sesstimeout.
sendclosenotify Read-write sendclosenotify.
tls11 Read-write tls11.
skipclientcertpolicycheck Read-write skipclientcertpolicycheck.
dropreqwithnohostheader Read-write dropreqwithnohostheader.
maxage Read-write maxage.
sessionkeylifetime Read-write sessionkeylifetime.
tls12 Read-write tls12.
includesubdomains Read-write includesubdomains.
tls10 Read-write tls1.
dhkeyexpsizelimit Read-write dhkeyexpsizelimit.
ssliocspcheck Read-write ssliocspcheck.
pushenctrigger Read-write pushenctrigger.
clientauth Read-write clientauth.
zerorttearlydata Read-write zerorttearlydata.
poll_time Read-only Last Polling Time.
display_name Read-only Display Name.
partition_name Read-only Partition Name.

Operations

(click to see Properties )

  • GET

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

get

URL: https://<MGMT-IP>/nitro/v2/config/ns_sslprofile 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_sslprofile":[{
"denysslreneg":<String_value>,
"sessionticketkeyrefresh":<String_value>,
"quantumsize":<Integer_value>,
"cipherurl":<String_value>,
"ns_ip_address":<String_value>,
"ssltriggertimeout":<Integer_value>,
"pushflag":<Integer_value>,
"allowextendedmastersecret":<String_value>,
"commonname":<String_value>,
"ssllogprofile":<String_value>,
"name":<String_value>,
"dhcount":<Integer_value>,
"tls13sessionticketsperauthcontext":<Integer_value>,
"pushenctriggertimeout":<Integer_value>,
"dh":<Boolean_value>,
"hsts":<Boolean_value>,
"serverauth":<String_value>,
"tls13":<Boolean_value>,
"snienable":<String_value>,
"sslinterception":<String_value>,
"cipherredirect":<String_value>,
"strictsigdigestcheck":<Boolean_value>,
"sslimaxsessperserver":<Integer_value>,
"clientcert":<String_value>,
"prevsessionkeylifetime":<Integer_value>,
"sessionticketlifetime":<Integer_value>,
"dhfile":<String_value>,
"encrypttriggerpktcount":<Integer_value>,
"ssl2":<Boolean_value>,
"sslredirect":<String_value>,
"insertionencoding":<String_value>,
"ersa":<Boolean_value>,
"strictcachecks":<String_value>,
"sslireneg":<String_value>,
"redirectportrewrite":<String_value>,
"sessreuse":<String_value>,
"ssl3":<Boolean_value>,
"sessionticketkeydata":<String_value>,
"sessionticket":<String_value>,
"id":<String_value>,
"cleartextport":<String_value>,
"alpnprotocol":<String_value>,
"clientauthuseboundcachain":<String_value>,
"poll_time":<Integer_value>,
"ocspstapling":<String_value>,
"dhekeyexchangewithpsk":<String_value>,
"ersacount":<Integer_value>,
"snihttphostmatch":<String_value>,
"preload":<String_value>,
"sesstimeout":<Integer_value>,
"sendclosenotify":<String_value>,
"tls11":<Boolean_value>,
"skipclientcertpolicycheck":<String_value>,
"dropreqwithnohostheader":<String_value>,
"maxage":<Integer_value>,
"sessionkeylifetime":<Integer_value>,
"tls12":<Boolean_value>,
"includesubdomains":<Boolean_value>,
"tls10":<Boolean_value>,
"dhkeyexpsizelimit":<String_value>,
"ssliocspcheck":<String_value>,
"pushenctrigger":<String_value>,
"clientauth":<String_value>,
"display_name":<String_value>,
"zerorttearlydata":<String_value>,
"partition_name":<String_value>}]}

<!--NeedCopy-->
ns_sslprofile