| getsslactionResult Structure Definition |
The getsslactionResult structure defines the return type for getsslaction API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
sslactionList |
List of sslactions |
| sslaction Structure Definition |
The sslaction structure defines the actual return type values for getsslaction API. |
Syntax |
Members |
name |
Name of the SSL action for which to show detailed information. |
clientauth |
Perform client certificate authentication. |
clientcertverification |
Client certificate verification is mandatory or optional. |
clientcert |
Insert the entire client certificate into the HTTP header of the request being sent to the web server. The certificate is inserted in ASCII (PEM) format. |
certheader |
Name of the header into which to insert the client certificate. |
clientcertserialnumber |
Insert the entire client serial number into the HTTP header of the request being sent to the web server. |
certserialheader |
Name of the header into which to insert the client serial number. |
clientcertsubject |
Insert the client certificate subject, also known as the distinguished name (DN), into the HTTP header of the request being sent to the web server. |
certsubjectheader |
Name of the header into which to insert the client certificate subject. |
clientcerthash |
Insert the certificate's signature into the HTTP header of the request being sent to the web server. The signature is the value extracted directly from the X.509 certificate signature field. All X.509 certificates contain a signature field. |
certhashheader |
Name of the header into which to insert the client certificate signature (hash). |
clientcertfingerprint |
Insert the certificate's fingerprint into the HTTP header of the request being sent to the web server. The fingerprint is derived by computing the specified hash value (SHA256, for example) of the DER-encoding of the client certificate. |
certfingerprintheader |
Name of the header into which to insert the client certificate fingerprint. |
certfingerprintdigest |
Digest algorithm used to compute the fingerprint of the client certificate. |
clientcertissuer |
Insert the certificate issuer details into the HTTP header of the request being sent to the web server. |
certissuerheader |
Name of the header into which to insert the client certificate issuer details. |
sessionid |
Insert the SSL session ID into the HTTP header of the request being sent to the web server. Every SSL connection that the client and the Citrix ADC share has a unique ID that identifies the specific connection. |
sessionidheader |
Name of the header into which to insert the Session ID. |
cipher |
Insert the cipher suite that the client and the Citrix ADC negotiated for the SSL session into the HTTP header of the request being sent to the web server. The appliance inserts the cipher-suite name, SSL protocol, export or non-export string, and cipher strength bit, depending on the type of browser connecting to the SSL virtual server or service (for example, Cipher-Suite: RC4- MD5 SSLv3 Non-Export 128-bit). |
cipherheader |
Name of the header into which to insert the name of the cipher suite. |
owasupport |
If the appliance is in front of an Outlook Web Access (OWA) server, insert a special header field, FRONT-END-HTTPS: ON, into the HTTP requests going to the OWA server. This header communicates to the server that the transaction is HTTPS and not HTTP. |
forward |
This action takes an argument a vserver name, to this vserver one will be able to forward all the packets. |
cacertgrpname |
This action will allow to pick CA(s) from the specific CA group, to verify the client certificate. |
clientcertnotbefore |
Insert the date from which the certificate is valid into the HTTP header of the request being sent to the web server. Every certificate is configured with the date and time from which it is valid. |
certnotbeforeheader |
Name of the header into which to insert the date and time from which the certificate is valid. |
clientcertnotafter |
Insert the date of expiry of the certificate into the HTTP header of the request being sent to the web server. Every certificate is configured with the date and time at which the certificate expires. |
certnotafterheader |
Name of the header into which to insert the certificate's expiry date. |
ocspcertvalidation |
This option is used to check the revocation status of client/server certificate in SSL handshake using OCSP. |
ocspstapling |
This option is used to enable ocspStapling parameter for the SSL connection. |
ocspcache |
Enable cache of OCSP response. Caching of response received from the OCSP responder enables faster response to the client and reduces the load on the OCSP responder. |
hits |
The number of times the action has been taken. |
undefhits |
The number of times the action resulted in UNDEF. |
referencecount |
The number of references to the action. |
description |
Description of the action |
ssllogprofile |
The name of the ssllogprofile. |
builtin |
Flag to determine whether ssl action is built-in or not |
_nextgenapiresource |
See Also |