Product Documentation

sslvserver

Sep 08, 2016

Statistics for SSL virtual server resource.

Properties (click to see Operations)

Name Data Type Permissions Description
vservername
<String>
Read-write
Name of the SSL virtual server for which to show detailed statistics.
Minimum length = 1
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
vslbhealth
<Double>
Read-only
Health of the vserver. This gives percentage of UP services bound to this vserver.
primaryipaddress
<String>
Read-only
IP address of the vserver
primaryport
<Integer>
Read-only
The port on which the service is running.
type
<String>
Read-only
Protocol associated with the vserver
state
<String>
Read-only
Current state of the server. Possible values are UP, DOWN, UNKNOWN, OFS(Out of Service), TROFS(Transition Out of Service), TROFS_DOWN(Down When going Out of Service)
actsvcs
<Double>
Read-only
number of ACTIVE services bound to a vserver
ssltotclientauthsuccess
<Double>
Read-only
Number of successful client authentication on this vserver
sslclientauthsuccessrate
<Double>
Read-only
Rate (/s) counter for ssltotclientauthsuccess
ssltotclientauthfailure
<Double>
Read-only
Number of failure client authentication on this vserver
sslclientauthfailurerate
<Double>
Read-only
Rate (/s) counter for ssltotclientauthfailure
sslctxtotencbytes
<Double>
Read-only
Number of encrypted bytes per SSL vserver
sslctxencbytesrate
<Double>
Read-only
Rate (/s) counter for sslctxtotencbytes
sslctxtotdecbytes
<Double>
Read-only
Number of decrypted bytes per SSL vserver
sslctxdecbytesrate
<Double>
Read-only
Rate (/s) counter for sslctxtotdecbytes
sslctxtothwencbytes
<Double>
Read-only
Number of hardware encrypted bytes per SSL vserver
sslctxhwencbytesrate
<Double>
Read-only
Rate (/s) counter for sslctxtothwencbytes
sslctxtothwdec_bytes
<Double>
Read-only
Number of hw decrypted bytes per SSL vserver
sslctxhwdec_bytesrate
<Double>
Read-only
Rate (/s) counter for sslctxtothwdec_bytes
sslctxtotsessionnew
<Double>
Read-only
Number of new sessions created
sslctxsessionnewrate
<Double>
Read-only
Rate (/s) counter for sslctxtotsessionnew
sslctxtotsessionhits
<Double>
Read-only
Number of session hits
sslctxsessionhitsrate
<Double>
Read-only
Rate (/s) counter for sslctxtotsessionhits

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/stat/sslvserver

Query-parameters:

args

http://<netscaler-ip-address>/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 NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

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

get

URL: http://<netscaler-ip-address>/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 NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

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