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 <String> Read-write denysslreneg.
sessionticketkeyrefresh <String> Read-write sessionticketkeyrefresh.
quantumsize <Integer> Read-write quantumsize.
cipherurl <String> Read-write cipherurl.
ns_ip_address <String> Read-write Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
ssltriggertimeout <Integer> Read-write ssltriggertimeout.
pushflag <Integer> Read-write pushflag.
allowextendedmastersecret <String> Read-write allowextendedmastersecret.
commonname <String> Read-write commonname.
ssllogprofile <String> Read-write ssllogprofile.
name <String> Read-write Name.

Minimum length = 1

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