Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

authenticationvserver

August 17, 2023
Contributed by: 
C

Statistics for authentication virtual server resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name of the authentication virtual server.

Minimum length = 1
clearstats Read-write Clear the statsistics / counters.

Possible values = basic, full
primaryipaddress Read-only The IP address on which the service is running.
primaryport Read-only The port on which the service is running.
type Read-only Protocol associated with the vserver
state Read-only Current 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)
totalrequests Read-only Total number of requests received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
requestsrate Read-only Rate (/s) counter for totalrequests
totalresponses Read-only Number of responses received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
responsesrate Read-only Rate (/s) counter for totalresponses
totalrequestbytes Read-only Total number of request bytes received on this service or virtual server.
requestbytesrate Read-only Rate (/s) counter for totalrequestbytes
totalresponsebytes Read-only Number of response bytes received by this service or virtual server.
responsebytesrate Read-only Rate (/s) counter for totalresponsebytes

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 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

get (all)

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

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/stat/authenticationvserver? args=name: <String_value> ,detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

Use this query-parameter to get authenticationvserver 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 Header:

Content-Type:application/json

Response Payload: 


{  "authenticationvserver": [ {
      "name":<String_value>,
      "totalrequests":<Double_value>,
      "responsebytesrate":<Double_value>,
      "requestbytesrate":<Double_value>,
      "type":<String_value>,
      "primaryipaddress":<String_value>,
      "responsesrate":<Double_value>,
      "totalrequestbytes":<Double_value>,
      "state":<String_value>,
      "totalresponses":<Double_value>,
      "totalresponsebytes":<Double_value>,
      "primaryport":<Integer_value>,
      "requestsrate":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/stat/authenticationvserver/ name_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 Header:

Content-Type:application/json

Response Payload: 


{  "authenticationvserver": [ {
      "name":<String_value>,
      "totalrequests":<Double_value>,
      "responsebytesrate":<Double_value>,
      "requestbytesrate":<Double_value>,
      "type":<String_value>,
      "primaryipaddress":<String_value>,
      "responsesrate":<Double_value>,
      "totalrequestbytes":<Double_value>,
      "state":<String_value>,
      "totalresponses":<Double_value>,
      "totalresponsebytes":<Double_value>,
      "primaryport":<Integer_value>,
      "requestsrate":<Double_value>
}]}

<!--NeedCopy-->
authenticationvserver
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.