Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

ipseccounters

August 17, 2023
Contributed by: 
C

Statistics for counters resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
clearstats Read-write Clear the statsistics / counters.

Possible values = basic, full
ipsectotrxbytes Read-only Bytes received during IPsec sessions.
ipsecrxbytesrate Read-only Rate (/s) counter for ipsectotrxbytes
ipsectottxbytes Read-only Bytes sent during IPsec sessions.
ipsectxbytesrate Read-only Rate (/s) counter for ipsectottxbytes
ipsectotrxpkts Read-only Packets received during IPsec sessions.
ipsecrxpktsrate Read-only Rate (/s) counter for ipsectotrxpkts
ipsectottxpkts Read-only Packets sent during IPsec sessions.
ipsectxpktsrate Read-only Rate (/s) counter for ipsectottxpkts

Operations

(click to see Properties )

  • GET (ALL)

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

Query-parameters:

args

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

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


{  "ipseccounters": [ {
      "ipsectottxbytes":<Double_value>,
      "ipsectotrxbytes":<Double_value>,
      "ipsectxpktsrate":<Double_value>,
      "ipsecrxbytesrate":<Double_value>,
      "ipsectxbytesrate":<Double_value>,
      "ipsecrxpktsrate":<Double_value>,
      "ipsectotrxpkts":<Double_value>,
      "ipsectottxpkts":<Double_value>
}]}

<!--NeedCopy-->
ipseccounters
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.