Skip to content

sslprofile

Configuration for SSL profile resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> Read-write Name for the SSL profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the profile is created.

Minimum length = 1

Maximum length = 127
sslprofiletype <String> Read-write Type of profile. Front end profiles apply to the entity that receives requests from a client. Backend profiles apply to the entity that sends client requests to a server.

Default value: FrontEnd

Possible values = BackEnd, FrontEnd
ssllogprofile <String> Read-write The name of the ssllogprofile.

Minimum length = 1

Maximum length = 127
dhcount <Double> Read-write Number of interactions, between the client and the Citrix ADC, after which the DH private-public pair is regenerated. A value of zero (0) specifies infinite use (no refresh).

This parameter is not applicable when configuring a backend profile. Allowed DH count values are 0 and >= 500.

Minimum value = 0

Maximum value = 65534
dh <String> Read-write State of Diffie-Hellman (DH) key exchange.

This parameter is not applicable when configuring a backend profile.

Default value: DISABLED

Possible values = ENABLED, DISABLED
dhfile <String> Read-write The file name and path for the DH parameter.

Minimum length = 1
ersa <String> Read-write State of Ephemeral RSA (eRSA) key exchange. Ephemeral RSA allows clients that support only export ciphers to communicate with the secure server even if the server certificate does not support export clients. The ephemeral RSA key is automatically generated when you bind an export cipher to an SSL or TCP-based SSL virtual server or service. When you remove the export cipher, the eRSA key is not deleted. It is reused at a later date when another export cipher is bound to an SSL or TCP-based SSL virtual server or service. The eRSA key is deleted when the appliance restarts.

This parameter is not applicable when configuring a backend profile.

Default value: ENABLED

Possible values = ENABLED, DISABLED
ersacount <Double> Read-write The refresh count for the re-generation of RSA public-key and private-key pair.

Minimum value = 0

Maximum value = 65534
sessreuse <String> Read-write State of session reuse. Establishing the initial handshake requires CPU-intensive public key encryption operations. With the ENABLED setting, session key exchange is avoided for session resumption requests received from the client.

Default value: ENABLED

Possible values = ENABLED, DISABLED
sesstimeout <Double> Read-write The Session timeout value in seconds.

Minimum value = 0

Maximum value = 4294967294
cipherredirect <String> Read-write State of Cipher Redirect. If this parameter is set to ENABLED, you can configure an SSL virtual server or service to display meaningful error messages if the SSL handshake fails because of a cipher mismatch between the virtual server or service and the client.

This parameter is not applicable when configuring a backend profile.

Default value: DISABLED

Possible values = ENABLED, DISABLED
cipherurl <String> Read-write The redirect URL to be used with the Cipher Redirect feature.
clientauth <String> Read-write State of client authentication. In service-based SSL offload, the service terminates the SSL handshake if the SSL client does not provide a valid certificate.

This parameter is not applicable when configuring a backend profile.

Default value: DISABLED

Possible values = ENABLED, DISABLED
clientcert <String> Read-write The rule for client certificate requirement in client authentication.

Possible values = Mandatory, Optional
dhkeyexpsizelimit <String> Read-write This option enables the use of NIST recommended (NIST Special Publication 800-56A) bit size for private-key size. For example, for DH params of size 2048bit, the private-key size recommended is 224bits. This is rounded-up to 256bits.

Default value: DISABLED

Possible values = ENABLED, DISABLED
sslredirect <String> Read-write State of HTTPS redirects for the SSL service.

For an SSL session, if the client browser receives a redirect message, the browser tries to connect to the new location. However, the secure SSL session breaks if the object has moved from a secure site (https://) to an unsecure site (http://). Typically, a warning message appears on the screen, prompting the user to continue or disconnect.

If SSL Redirect is ENABLED, the redirect message is automatically converted from http:// to https:// and the SSL session does not break.

This parameter is not applicable when configuring a backend profile.

Default value: DISABLED

Possible values = ENABLED, DISABLED
redirectportrewrite <String> Read-write State of the port rewrite while performing HTTPS redirect. If this parameter is set to ENABLED, and the URL from the server does not contain the standard port, the port is rewritten to the standard.

Default value: DISABLED

Possible values = ENABLED, DISABLED
ssl3 <String> Read-write State of SSLv3 protocol support for the SSL profile.

Note: On platforms with SSL acceleration chips, if the SSL chip does not support SSLv3, this parameter cannot be set to ENABLED.

Default value: DISABLED

Possible values = ENABLED, DISABLED
tls1 <String> Read-write State of TLSv1.0 protocol support for the SSL profile.

Default value: ENABLED

Possible values = ENABLED, DISABLED
tls11 <String> Read-write State of TLSv1.1 protocol support for the SSL profile.

Default value: ENABLED

Possible values = ENABLED, DISABLED
tls12 <String> Read-write State of TLSv1.2 protocol support for the SSL profile.

Default value: ENABLED

Possible values = ENABLED, DISABLED
tls13 <String> Read-write State of TLSv1.3 protocol support for the SSL profile.

Default value: DISABLED

Possible values = ENABLED, DISABLED
snienable <String> Read-write State of the Server Name Indication (SNI) feature on the virtual server and service-based offload. SNI helps to enable SSL encryption on multiple domains on a single virtual server or service if the domains are controlled by the same organization and share the same second-level domain name. For example, *.sports.net can be used to secure domains such as login.sports.net and help.sports.net.

Default value: DISABLED

Possible values = ENABLED, DISABLED
ocspstapling <String> Read-write State of OCSP stapling support on the SSL virtual server. Supported only if the protocol used is higher than SSLv3. Possible values:

ENABLED: The appliance sends a request to the OCSP responder to check the status of the server certificate and caches the response for the specified time. If the response is valid at the time of SSL handshake with the client, the OCSP-based server certificate status is sent to the client during the handshake.

DISABLED: The appliance does not check the status of the server certificate. .

Default value: DISABLED

Possible values = ENABLED, DISABLED
serverauth <String> Read-write State of server authentication support for the SSL Backend profile.

Default value: DISABLED

Possible values = ENABLED, DISABLED
commonname <String> Read-write Name to be checked against the CommonName (CN) field in the server certificate bound to the SSL server.

Minimum length = 1
pushenctrigger <String> Read-write Trigger encryption on the basis of the PUSH flag value. Available settings function as follows:

* ALWAYS - Any PUSH packet triggers encryption.

* IGNORE - Ignore PUSH packet for triggering encryption.

* MERGE - For a consecutive sequence of PUSH packets, the last PUSH packet triggers encryption.

* TIMER - PUSH packet triggering encryption is delayed by the time defined in the set ssl parameter command or in the Change Advanced SSL Settings dialog box.

Possible values = Always, Merge, Ignore, Timer
sendclosenotify <String> Read-write Enable sending SSL Close-Notify at the end of a transaction.

Default value: YES

Possible values = YES, NO
cleartextport <Integer> Read-write Port on which clear-text data is sent by the appliance to the server. Do not specify this parameter for SSL offloading with end-to-end encryption.

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
insertionencoding <String> Read-write Encoding method used to insert the subject or issuer's name in HTTP requests to servers.

Default value: Unicode

Possible values = Unicode, UTF-8
denysslreneg <String> Read-write Deny renegotiation in specified circumstances. Available settings function as follows:

* NO - Allow SSL renegotiation.

* FRONTEND_CLIENT - Deny secure and nonsecure SSL renegotiation initiated by the client.

* FRONTEND_CLIENTSERVER - Deny secure and nonsecure SSL renegotiation initiated by the client or the Citrix ADC during policy-based client authentication.

* ALL - Deny all secure and nonsecure SSL renegotiation.

* NONSECURE - Deny nonsecure SSL renegotiation. Allows only clients that support RFC 5746.

Default value: ALL

Possible values = NO, FRONTEND_CLIENT, FRONTEND_CLIENTSERVER, ALL, NONSECURE
quantumsize <String> Read-write Amount of data to collect before the data is pushed to the crypto hardware for encryption. For large downloads, a larger quantum size better utilizes the crypto resources.

Default value: 8192

Possible values = 4096, 8192, 16384
strictcachecks <String> Read-write Enable strict CA certificate checks on the appliance.

Default value: NO

Possible values = YES, NO
encrypttriggerpktcount <Double> Read-write Maximum number of queued packets after which encryption is triggered. Use this setting for SSL transactions that send small packets from server to Citrix ADC.

Default value: 45

Minimum value = 10

Maximum value = 50
pushflag <Double> Read-write Insert PUSH flag into decrypted, encrypted, or all records. If the PUSH flag is set to a value other than 0, the buffered records are forwarded on the basis of the value of the PUSH flag. Available settings function as follows:

0 - Auto (PUSH flag is not set.)

1 - Insert PUSH flag into every decrypted record.

2 -Insert PUSH flag into every encrypted record.

3 - Insert PUSH flag into every decrypted and encrypted record.

Minimum value = 0

Maximum value = 3
dropreqwithnohostheader <String> Read-write Host header check for SNI enabled sessions. If this check is enabled and the HTTP request does not contain the host header for SNI enabled sessions(i.e vserver or profile bound to vserver has SNI enabled and 'Client Hello' arrived with SNI extension), the request is dropped.

Default value: NO

Possible values = YES, NO
snihttphostmatch <String> Read-write Controls how the HTTP 'Host' header value is validated. These checks are performed only if the session is SNI enabled (i.e when vserver or profile bound to vserver has SNI enabled and 'Client Hello' arrived with SNI extension) and HTTP request contains 'Host' header.

Available settings function as follows:

CERT - Connection is forwarded if the 'Host' value is covered

by the certificate used to establish this SSL session.

STRICT - Connection is forwarded only if value of 'Host' header

in HTTP is identical to the 'Server name' value passed

in 'Client Hello' of the SSL connection.

NO - No validation is performed on the HTTP 'Host'

header value.

Default value: CERT

Possible values = NO, CERT, STRICT
pushenctriggertimeout <Double> Read-write PUSH encryption trigger timeout value. The timeout value is applied only if you set the Push Encryption Trigger parameter to Timer in the SSL virtual server settings.

Default value: 1

Minimum value = 1

Maximum value = 200
ssltriggertimeout <Double> Read-write Time, in milliseconds, after which encryption is triggered for transactions that are not tracked on the Citrix ADC because their length is not known. There can be a delay of up to 10ms from the specified timeout value before the packet is pushed into the queue.

Default value: 100

Minimum value = 1

Maximum value = 200
clientauthuseboundcachain <String> Read-write Certficates bound on the VIP are used for validating the client cert. Certficates came along with client cert are not used for validating the client cert.

Default value: DISABLED

Possible values = ENABLED, DISABLED
sslinterception <String> Read-write Enable or disable transparent interception of SSL sessions.

Default value: DISABLED

Possible values = ENABLED, DISABLED
sslireneg <String> Read-write Enable or disable triggering the client renegotiation when renegotiation request is received from the origin server.

Default value: ENABLED

Possible values = ENABLED, DISABLED
ssliocspcheck <String> Read-write Enable or disable OCSP check for origin server certificate.

Default value: ENABLED

Possible values = ENABLED, DISABLED
sslimaxsessperserver <Double> Read-write Maximum ssl session to be cached per dynamic origin server. A unique ssl session is created for each SNI received from the client on ClientHello and the matching session is used for server session reuse.

Default value: 10

Minimum value = 1

Maximum value = 1000
sessionticket <String> Read-write This option enables the use of session tickets, as per the RFC 5077.

Default value: DISABLED

Possible values = ENABLED, DISABLED
sessionticketlifetime <Double> Read-write This option sets the life time of session tickets issued by NS in secs.

Default value: 300

Minimum value = 0

Maximum value = 172800
sessionticketkeyrefresh <String> Read-write This option enables the use of session tickets, as per the RFC 5077.

Default value: ENABLED

Possible values = ENABLED, DISABLED
sessionticketkeydata <String> Read-write Session ticket enc/dec key , admin can set it.
sessionkeylifetime <Double> Read-write This option sets the life time of symm key used to generate session tickets issued by NS in secs.

Default value: 3000

Minimum value = 600

Maximum value = 86400
prevsessionkeylifetime <Double> Read-write This option sets the life time of symm key used to generate session tickets issued by NS in secs.

Default value: 0

Minimum value = 0

Maximum value = 172800
hsts <String> Read-write State of HSTS protocol support for the SSL profile. Using HSTS, a server can enforce the use of an HTTPS connection for all communication with a client.

Default value: DISABLED

Possible values = ENABLED, DISABLED
maxage <Double> Read-write Set the maximum time, in seconds, in the strict transport security (STS) header during which the client must send only HTTPS requests to the server.

Default value: 0

Minimum value = 0

Maximum value = 4294967294
includesubdomains <String> Read-write Enable HSTS for subdomains. If set to Yes, a client must send only HTTPS requests for subdomains.

Default value: NO

Possible values = YES, NO
preload <String> Read-write Flag indicates the consent of the site owner to have their domain preloaded.

Default value: NO

Possible values = YES, NO
skipclientcertpolicycheck <String> Read-write This flag controls the processing of X509 certificate policies. If this option is Enabled, then the policy check in Client authentication will be skipped. This option can be used only when Client Authentication is Enabled and ClientCert is set to Mandatory.

Default value: DISABLED

Possible values = ENABLED, DISABLED
zerorttearlydata <String> Read-write State of TLS 1.3 0-RTT early data support for the SSL Virtual Server. This setting only has an effect if resumption is enabled, as early data cannot be sent along with an initial handshake.

Early application data has significantly different security properties - in particular there is no guarantee that the data cannot be replayed.

Default value: DISABLED

Possible values = ENABLED, DISABLED
tls13sessionticketsperauthcontext <Double> Read-write Number of tickets the SSL Virtual Server will issue anytime TLS 1.3 is negotiated, ticket-based resumption is enabled, and either (1) a handshake completes or (2) post-handhsake client auth completes.

This value can be increased to enable clients to open multiple parallel connections using a fresh ticket for each connection.

No tickets are sent if resumption is disabled.

Default value: 1

Minimum value = 1

Maximum value = 10
dhekeyexchangewithpsk <String> Read-write Whether or not the SSL Virtual Server will require a DHE key exchange to occur when a PSK is accepted during a TLS 1.3 resumption handshake.

A DHE key exchange ensures forward secrecy even in the event that ticket keys are compromised, at the expense of an additional round trip and resources required to carry out the DHE key exchange.

If disabled, a DHE key exchange will be performed when a PSK is accepted but only if requested by the client.

If enabled, the server will require a DHE key exchange when a PSK is accepted regardless of whether the client supports combined PSK-DHE key exchange. This setting only has an effect when resumption is enabled.

Default value: NO

Possible values = YES, NO
ciphername <String> Read-write The cipher group/alias/individual cipher configuration.
cipherpriority <Double> Read-write cipher priority.

Minimum value = 1
strictsigdigestcheck <String> Read-write Parameter indicating to check whether peer entity certificate during TLS1.2 handshake is signed with one of signature-hash combination supported by Citrix ADC.

Default value: DISABLED

Possible values = ENABLED, DISABLED
nonfipsciphers <String> Read-only State of usage of ciphers that are not FIPS approved. Valid only for an SSL service bound with a FIPS key and certificate.

Default value: DISABLED

Possible values = ENABLED, DISABLED
crlcheck <String> Read-only The state of the CRL check parameter. (Mandatory/Optional).

Possible values = Mandatory, Optional
ocspcheck <String> Read-only The state of the OCSP check parameter. (Mandatory/Optional).

Possible values = Mandatory, Optional
snicert <Boolean> Read-only The name of the CertKey. Use this option to bind Certkey(s) which will be used in SNI processing.
skipcaname <Boolean> Read-only The flag is used to indicate whether this

particular CA certificate's CA_Name needs to be sent to

the SSL client while requesting for client certificate

in a SSL handshake.
invoke <Boolean> Read-only Invoke flag. This attribute is relevant only for ADVANCED policies.
labeltype <String> Read-only Type of policy label invocation.

Possible values = vserver, service, policylabel
service <Double> Read-only Service.
builtin <String[]> Read-only Flag to determine whether ssl profile is built-in or not.

Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature <String> Read-only The feature to be checked while applying this config.
sslpfobjecttype <Double> Read-only Internal flag to indicate what type of object binds this profile: monitor or service.
ssliverifyservercertforreuse <String> Read-only Verify the origin server's certificate before reusing the front-end SSL session. Making it hidden since we always verify for now.

Default value: ENABLED

Possible values = ENABLED, DISABLED
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • GET (ALL)
  • GET
  • COUNT

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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslprofile

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"sslprofile":{
<b>      "name":<String_value>,
</b>      "sslprofiletype":<String_value>,
      "ssllogprofile":<String_value>,
      "dhcount":<Double_value>,
      "dh":<String_value>,
      "dhfile":<String_value>,
      "ersa":<String_value>,
      "ersacount":<Double_value>,
      "sessreuse":<String_value>,
      "sesstimeout":<Double_value>,
      "cipherredirect":<String_value>,
      "cipherurl":<String_value>,
      "clientauth":<String_value>,
      "clientcert":<String_value>,
      "dhkeyexpsizelimit":<String_value>,
      "sslredirect":<String_value>,
      "redirectportrewrite":<String_value>,
      "ssl3":<String_value>,
      "tls1":<String_value>,
      "tls11":<String_value>,
      "tls12":<String_value>,
      "tls13":<String_value>,
      "snienable":<String_value>,
      "ocspstapling":<String_value>,
      "serverauth":<String_value>,
      "commonname":<String_value>,
      "pushenctrigger":<String_value>,
      "sendclosenotify":<String_value>,
      "cleartextport":<Integer_value>,
      "insertionencoding":<String_value>,
      "denysslreneg":<String_value>,
      "quantumsize":<String_value>,
      "strictcachecks":<String_value>,
      "encrypttriggerpktcount":<Double_value>,
      "pushflag":<Double_value>,
      "dropreqwithnohostheader":<String_value>,
      "snihttphostmatch":<String_value>,
      "pushenctriggertimeout":<Double_value>,
      "ssltriggertimeout":<Double_value>,
      "clientauthuseboundcachain":<String_value>,
      "sslinterception":<String_value>,
      "sslireneg":<String_value>,
      "ssliocspcheck":<String_value>,
      "sslimaxsessperserver":<Double_value>,
      "sessionticket":<String_value>,
      "sessionticketlifetime":<Double_value>,
      "sessionticketkeyrefresh":<String_value>,
      "sessionticketkeydata":<String_value>,
      "sessionkeylifetime":<Double_value>,
      "prevsessionkeylifetime":<Double_value>,
      "hsts":<String_value>,
      "maxage":<Double_value>,
      "includesubdomains":<String_value>,
      "preload":<String_value>,
      "skipclientcertpolicycheck":<String_value>,
      "zerorttearlydata":<String_value>,
      "tls13sessionticketsperauthcontext":<Double_value>,
      "dhekeyexchangewithpsk":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslprofile/ name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslprofile

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"sslprofile":{
<b>      "name":<String_value>,
</b>      "ssllogprofile":<String_value>,
      "dh":<String_value>,
      "dhfile":<String_value>,
      "dhcount":<Double_value>,
      "dhkeyexpsizelimit":<String_value>,
      "ersa":<String_value>,
      "ersacount":<Double_value>,
      "sessreuse":<String_value>,
      "sesstimeout":<Double_value>,
      "cipherredirect":<String_value>,
      "cipherurl":<String_value>,
      "clientauth":<String_value>,
      "clientcert":<String_value>,
      "sslredirect":<String_value>,
      "redirectportrewrite":<String_value>,
      "ssl3":<String_value>,
      "tls1":<String_value>,
      "tls11":<String_value>,
      "tls12":<String_value>,
      "tls13":<String_value>,
      "snienable":<String_value>,
      "ocspstapling":<String_value>,
      "serverauth":<String_value>,
      "commonname":<String_value>,
      "pushenctrigger":<String_value>,
      "sendclosenotify":<String_value>,
      "cleartextport":<Integer_value>,
      "insertionencoding":<String_value>,
      "denysslreneg":<String_value>,
      "quantumsize":<String_value>,
      "strictcachecks":<String_value>,
      "encrypttriggerpktcount":<Double_value>,
      "pushflag":<Double_value>,
      "dropreqwithnohostheader":<String_value>,
      "snihttphostmatch":<String_value>,
      "pushenctriggertimeout":<Double_value>,
      "ssltriggertimeout":<Double_value>,
      "clientauthuseboundcachain":<String_value>,
      "sslinterception":<String_value>,
      "sslireneg":<String_value>,
      "ssliocspcheck":<String_value>,
      "sslimaxsessperserver":<Double_value>,
      "hsts":<String_value>,
      "maxage":<Double_value>,
      "includesubdomains":<String_value>,
      "preload":<String_value>,
      "sessionticket":<String_value>,
      "sessionticketlifetime":<Double_value>,
      "sessionticketkeyrefresh":<String_value>,
      "sessionticketkeydata":<String_value>,
      "sessionkeylifetime":<Double_value>,
      "prevsessionkeylifetime":<Double_value>,
      "ciphername":<String_value>,
      "cipherpriority":<Double_value>,
      "strictsigdigestcheck":<String_value>,
      "skipclientcertpolicycheck":<String_value>,
      "zerorttearlydata":<String_value>,
      "tls13sessionticketsperauthcontext":<Double_value>,
      "dhekeyexchangewithpsk":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslprofile? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"sslprofile":{
<b>      "name":<String_value>,
</b>      "ssllogprofile":true,
      "dh":true,
      "dhfile":true,
      "dhcount":true,
      "dhkeyexpsizelimit":true,
      "ersa":true,
      "ersacount":true,
      "sessreuse":true,
      "sesstimeout":true,
      "cipherredirect":true,
      "cipherurl":true,
      "clientauth":true,
      "clientcert":true,
      "sslredirect":true,
      "redirectportrewrite":true,
      "ssl3":true,
      "tls1":true,
      "tls11":true,
      "tls12":true,
      "tls13":true,
      "snienable":true,
      "ocspstapling":true,
      "serverauth":true,
      "commonname":true,
      "pushenctrigger":true,
      "sendclosenotify":true,
      "cleartextport":true,
      "insertionencoding":true,
      "denysslreneg":true,
      "quantumsize":true,
      "strictcachecks":true,
      "encrypttriggerpktcount":true,
      "pushflag":true,
      "dropreqwithnohostheader":true,
      "snihttphostmatch":true,
      "pushenctriggertimeout":true,
      "ssltriggertimeout":true,
      "clientauthuseboundcachain":true,
      "sslinterception":true,
      "sslireneg":true,
      "ssliocspcheck":true,
      "sslimaxsessperserver":true,
      "hsts":true,
      "maxage":true,
      "includesubdomains":true,
      "preload":true,
      "sessionticket":true,
      "sessionticketlifetime":true,
      "sessionticketkeyrefresh":true,
      "sessionticketkeydata":true,
      "sessionkeylifetime":true,
      "prevsessionkeylifetime":true,
      "ciphername":true,
      "cipherpriority":true,
      "strictsigdigestcheck":true,
      "skipclientcertpolicycheck":true,
      "zerorttearlydata":true,
      "tls13sessionticketsperauthcontext":true,
      "dhekeyexchangewithpsk":true
}}

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslprofile

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/sslprofile? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/sslprofile? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of sslprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/sslprofile? view=summary

Use this query-parameter to get the summary output of sslprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/sslprofile? pagesize=#no;pageno=#no

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "sslprofile": [ {
      "name":<String_value>,
      "dh":<String_value>,
      "dhfile":<String_value>,
      "dhcount":<Double_value>,
      "dhkeyexpsizelimit":<String_value>,
      "ersa":<String_value>,
      "ersacount":<Double_value>,
      "sessreuse":<String_value>,
      "sesstimeout":<Double_value>,
      "cipherredirect":<String_value>,
      "cipherurl":<String_value>,
      "clientauth":<String_value>,
      "clientcert":<String_value>,
      "sslredirect":<String_value>,
      "redirectportrewrite":<String_value>,
      "nonfipsciphers":<String_value>,
      "ssl3":<String_value>,
      "tls1":<String_value>,
      "tls11":<String_value>,
      "tls12":<String_value>,
      "tls13":<String_value>,
      "snienable":<String_value>,
      "ocspstapling":<String_value>,
      "serverauth":<String_value>,
      "commonname":<String_value>,
      "pushenctrigger":<String_value>,
      "sendclosenotify":<String_value>,
      "cleartextport":<Integer_value>,
      "insertionencoding":<String_value>,
      "denysslreneg":<String_value>,
      "quantumsize":<String_value>,
      "strictcachecks":<String_value>,
      "encrypttriggerpktcount":<Double_value>,
      "pushflag":<Double_value>,
      "dropreqwithnohostheader":<String_value>,
      "snihttphostmatch":<String_value>,
      "pushenctriggertimeout":<Double_value>,
      "ssltriggertimeout":<Double_value>,
      "cipherpriority":<Double_value>,
      "ciphername":<String_value>,
      "crlcheck":<String_value>,
      "ocspcheck":<String_value>,
      "snicert":<Boolean_value>,
      "skipcaname":<Boolean_value>,
      "invoke":<Boolean_value>,
      "labeltype":<String_value>,
      "sslprofiletype":<String_value>,
      "clientauthuseboundcachain":<String_value>,
      "ssllogprofile":<String_value>,
      "service":<Double_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>,
      "sslpfobjecttype":<Double_value>,
      "sslinterception":<String_value>,
      "ssliverifyservercertforreuse":<String_value>,
      "sslireneg":<String_value>,
      "ssliocspcheck":<String_value>,
      "sslimaxsessperserver":<Double_value>,
      "sessionticket":<String_value>,
      "sessionticketlifetime":<Double_value>,
      "sessionticketkeyrefresh":<String_value>,
      "sessionticketkeydata":<String_value>,
      "sessionkeylifetime":<Double_value>,
      "prevsessionkeylifetime":<Double_value>,
      "hsts":<String_value>,
      "maxage":<Double_value>,
      "includesubdomains":<String_value>,
      "preload":<String_value>,
      "strictsigdigestcheck":<String_value>,
      "skipclientcertpolicycheck":<String_value>,
      "zerorttearlydata":<String_value>,
      "tls13sessionticketsperauthcontext":<Double_value>,
      "dhekeyexchangewithpsk":<String_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslprofile/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/sslprofile/ name_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/sslprofile/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of sslprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "sslprofile": [ {
      "name":<String_value>,
      "dh":<String_value>,
      "dhfile":<String_value>,
      "dhcount":<Double_value>,
      "dhkeyexpsizelimit":<String_value>,
      "ersa":<String_value>,
      "ersacount":<Double_value>,
      "sessreuse":<String_value>,
      "sesstimeout":<Double_value>,
      "cipherredirect":<String_value>,
      "cipherurl":<String_value>,
      "clientauth":<String_value>,
      "clientcert":<String_value>,
      "sslredirect":<String_value>,
      "redirectportrewrite":<String_value>,
      "nonfipsciphers":<String_value>,
      "ssl3":<String_value>,
      "tls1":<String_value>,
      "tls11":<String_value>,
      "tls12":<String_value>,
      "tls13":<String_value>,
      "snienable":<String_value>,
      "ocspstapling":<String_value>,
      "serverauth":<String_value>,
      "commonname":<String_value>,
      "pushenctrigger":<String_value>,
      "sendclosenotify":<String_value>,
      "cleartextport":<Integer_value>,
      "insertionencoding":<String_value>,
      "denysslreneg":<String_value>,
      "quantumsize":<String_value>,
      "strictcachecks":<String_value>,
      "encrypttriggerpktcount":<Double_value>,
      "pushflag":<Double_value>,
      "dropreqwithnohostheader":<String_value>,
      "snihttphostmatch":<String_value>,
      "pushenctriggertimeout":<Double_value>,
      "ssltriggertimeout":<Double_value>,
      "cipherpriority":<Double_value>,
      "ciphername":<String_value>,
      "crlcheck":<String_value>,
      "ocspcheck":<String_value>,
      "snicert":<Boolean_value>,
      "skipcaname":<Boolean_value>,
      "invoke":<Boolean_value>,
      "labeltype":<String_value>,
      "sslprofiletype":<String_value>,
      "clientauthuseboundcachain":<String_value>,
      "ssllogprofile":<String_value>,
      "service":<Double_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>,
      "sslpfobjecttype":<Double_value>,
      "sslinterception":<String_value>,
      "ssliverifyservercertforreuse":<String_value>,
      "sslireneg":<String_value>,
      "ssliocspcheck":<String_value>,
      "sslimaxsessperserver":<Double_value>,
      "sessionticket":<String_value>,
      "sessionticketlifetime":<Double_value>,
      "sessionticketkeyrefresh":<String_value>,
      "sessionticketkeydata":<String_value>,
      "sessionkeylifetime":<Double_value>,
      "prevsessionkeylifetime":<Double_value>,
      "hsts":<String_value>,
      "maxage":<Double_value>,
      "includesubdomains":<String_value>,
      "preload":<String_value>,
      "strictsigdigestcheck":<String_value>,
      "skipclientcertpolicycheck":<String_value>,
      "zerorttearlydata":<String_value>,
      "tls13sessionticketsperauthcontext":<Double_value>,
      "dhekeyexchangewithpsk":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslprofile? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "sslprofile": [ { "__count": "#no"} ] }