Skip to content

sslvserver

Statistics for SSL virtual server resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
vservername<String>Read-writeName of the SSL virtual server for which to show detailed statistics.
Minimum length = 1
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
vslbhealth<Double>Read-onlyHealth of the vserver. This gives percentage of UP services bound to this vserver.
primaryipaddress<String>Read-onlyIP address of the vserver
primaryport<Integer>Read-onlyThe port on which the service is running.
type<String>Read-onlyProtocol associated with the vserver
state<String>Read-onlyCurrent state of the server. There are seven possible values: UP(7), DOWN(1), UNKNOWN(2), BUSY(3), OFS(Out of Service)(4), TROFS(Transition Out of Service)(5), TROFS_DOWN(Down When going Out of Service)(8)
actsvcs<Double>Read-onlynumber of ACTIVE services bound to a vserver
ssltotclientauthsuccess<Double>Read-onlyNumber of successful client authentication on this vserver
sslclientauthsuccessrate<Double>Read-onlyRate (/s) counter for ssltotclientauthsuccess
ssltotclientauthfailure<Double>Read-onlyNumber of failure client authentication on this vserver
sslclientauthfailurerate<Double>Read-onlyRate (/s) counter for ssltotclientauthfailure
sslctxtotencbytes<Double>Read-onlyNumber of encrypted bytes per SSL vserver
sslctxencbytesrate<Double>Read-onlyRate (/s) counter for sslctxtotencbytes
sslctxtotdecbytes<Double>Read-onlyNumber of decrypted bytes per SSL vserver
sslctxdecbytesrate<Double>Read-onlyRate (/s) counter for sslctxtotdecbytes
sslctxtothwencbytes<Double>Read-onlyNumber of hardware encrypted bytes per SSL vserver
sslctxhwencbytesrate<Double>Read-onlyRate (/s) counter for sslctxtothwencbytes
sslctxtothwdec_bytes<Double>Read-onlyNumber of hw decrypted bytes per SSL vserver
sslctxhwdec_bytesrate<Double>Read-onlyRate (/s) counter for sslctxtothwdec_bytes
sslctxtotsessionnew<Double>Read-onlyNumber of new sessions created
sslctxsessionnewrate<Double>Read-onlyRate (/s) counter for sslctxtotsessionnew
sslctxtotsessionhits<Double>Read-onlyNumber of session hits
sslctxsessionhitsrate<Double>Read-onlyRate (/s) counter for sslctxtotsessionhits

Operations

(click to see Properties)

GET (ALL)| 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/sslvserver

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/sslvserver?args=vservername:<String_value>,detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get sslvserver resources based on additional properties.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "sslvserver": [ {
"vservername":<String_value>,
"sslclientauthsuccessrate":<Double_value>,
"sslctxtothwdec_bytes":<Double_value>,
"sslctxtotencbytes":<Double_value>,
"sslctxtotsessionnew":<Double_value>,
"ssltotclientauthfailure":<Double_value>,
"sslctxdecbytesrate":<Double_value>,
"sslctxsessionnewrate":<Double_value>,
"sslclientauthfailurerate":<Double_value>,
"type":<String_value>,
"sslctxencbytesrate":<Double_value>,
"sslctxhwencbytesrate":<Double_value>,
"sslctxtotdecbytes":<Double_value>,
"primaryipaddress":<String_value>,
"sslctxtotsessionhits":<Double_value>,
"sslctxtothwencbytes":<Double_value>,
"sslctxsessionhitsrate":<Double_value>,
"state":<String_value>,
"vslbhealth":<Double_value>,
"actsvcs":<Double_value>,
"sslctxhwdec_bytesrate":<Double_value>,
"primaryport":<Integer_value>,
"ssltotclientauthsuccess":<Double_value>
}]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/sslvserver/vservername_value><String>

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "sslvserver": [ {
"vservername":<String_value>,
"sslclientauthsuccessrate":<Double_value>,
"sslctxtothwdec_bytes":<Double_value>,
"sslctxtotencbytes":<Double_value>,
"sslctxtotsessionnew":<Double_value>,
"ssltotclientauthfailure":<Double_value>,
"sslctxdecbytesrate":<Double_value>,
"sslctxsessionnewrate":<Double_value>,
"sslclientauthfailurerate":<Double_value>,
"type":<String_value>,
"sslctxencbytesrate":<Double_value>,
"sslctxhwencbytesrate":<Double_value>,
"sslctxtotdecbytes":<Double_value>,
"primaryipaddress":<String_value>,
"sslctxtotsessionhits":<Double_value>,
"sslctxtothwencbytes":<Double_value>,
"sslctxsessionhitsrate":<Double_value>,
"state":<String_value>,
"vslbhealth":<Double_value>,
"actsvcs":<Double_value>,
"sslctxhwdec_bytesrate":<Double_value>,
"primaryport":<Integer_value>,
"ssltotclientauthsuccess":<Double_value>
}]}