Developer Documentation
ADM NITRO APIs

adc_application_summary

June 20, 2023
Contributed by: 
C

Configuration for application summarized information resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
issues_detected Read-write Array of all app issues affecting health score. Each array element tells issueId, penalty and time when it occured.

Maximum length = 2048
ssl_rating Read-write A+ / non-A+ / NA.

Maximum length = 50
appname Read-write AppName.

Maximum length = 255
response_time Read-write total time taken by the app to send response to client.
vslbhealth Read-write Vserver Health.
appcategory Read-write App Category.

Maximum length = 255
ip_address Read-write Field to store the ip address as it is along with any extension.

Maximum length = 512
clnt_connections Read-write Current Client Connections.
vservertype Read-write Vserver Tyoe.

Maximum length = 255
pkt_recvd_cur Read-write Total Pkts Received.
error_percentage Read-write Number of 5xx response recieved wrt total requests.
total_bytes Read-write Session total bytes.
srvr_connections Read-write Current Server Connections.
vservername Read-write Vserver Name.

Maximum length = 255
pkt_sent_cur Read-write Total Pkts Sent.
curr_state Read-write Current State.

Maximum length = 50
health_score Read-write App Health Score.
total_requests Read-write Total Requests.
throughput Read-write Throughput ..
application_class Read-only Application class.

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/adc_application_summary Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/adc_application_summary ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of adc_application_summary resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/adc_application_summary ?pagesize=#no;pageno=#no Use this query-parameter to get the adc_application_summary resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/adc_application_summary ?count=yes Use this query-parameter to get the count of adc_application_summary resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "adc_application_summary":[{
"issues_detected":<String_value>,
"ssl_rating":<String_value>,
"appname":<String_value>,
"response_time":<Double_value>,
"vslbhealth":<Integer_value>,
"appcategory":<String_value>,
"ip_address":<String_value>,
"clnt_connections":<Double_value>,
"vservertype":<String_value>,
"pkt_recvd_cur":<Double_value>,
"error_percentage":<Double_value>,
"total_bytes":<Double_value>,
"srvr_connections":<Double_value>,
"vservername":<String_value>,
"application_class":<String_value>,
"pkt_sent_cur":<Double_value>,
"curr_state":<String_value>,
"health_score":<Double_value>,
"total_requests":<Double_value>,
"throughput":<Double_value>}]}

<!--NeedCopy-->
adc_application_summary
June 20, 2023
Contributed by: 
C
June 20, 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.