ADC NITRO APIs

appflow

May 23, 2024

Contributed by:

Statistics for appflow.

Properties

(click to see Operations )

Name	Permissions	Description
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
appflowtotaltxoctets	Read-only	The total number of AppFlow (IPFIX) octets that the Citrix ADC has transmitted.
appflowtxoctetsrate	Read-only	Rate (/s) counter for appflowtotaltxoctets
appflowtotalflows	Read-only	The total number of AppFlow (IPFIX) flows that the Citrix ADC has transmitted.
appflowflowsrate	Read-only	Rate (/s) counter for appflowtotalflows
appflowtotaltxmessagess	Read-only	The total number of AppFlow (IPFIX) messages that the Citrix ADC has transmitted.
appflowtxmessagessrate	Read-only	Rate (/s) counter for appflowtotaltxmessagess
appflowtotalignoctets	Read-only	The total number of octets that the Citrix ADC has ignored for AppFlow (IPFIX).
appflowignoctetsrate	Read-only	Rate (/s) counter for appflowtotalignoctets
appflowtotalignpacketss	Read-only	The total number of packets that the Citrix ADC has ignored for AppFlow (IPFIX).
appflowignpacketssrate	Read-only	Rate (/s) counter for appflowtotalignpacketss
appflowtotalnotxoctets	Read-only	The total number of AppFlow (IPFIX) octets that the Citrix ADC has not transmitted.
appflownotxoctetsrate	Read-only	Rate (/s) counter for appflowtotalnotxoctets
appflowtotalnotxflows	Read-only	The total number of AppFlow (IPFIX) flows that the Citrix ADC has not transmitted.
appflownotxflowsrate	Read-only	Rate (/s) counter for appflowtotalnotxflows
appflowtotalnotxpackets	Read-only	The total number of AppFlow (IPFIX) packets that the Citrix ADC has not transmitted.
appflownotxpacketsrate	Read-only	Rate (/s) counter for appflowtotalnotxpackets

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/appflow Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/stat/appflow? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

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

attrs http:// <netscaler-ip-address> /nitro/v1/stat/appflow? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

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:

{  "appflow": [ {
"appflowtxmessagessrate":<Double_value>,
"appflowtotalflows":<Double_value>,
"appflownotxflowsrate":<Double_value>,
"appflowtotalnotxoctets":<Double_value>,
"appflowtotaltxmessagess":<Double_value>,
"appflowignoctetsrate":<Double_value>,
"appflowtotalignoctets":<Double_value>,
"appflowtotaltxoctets":<Double_value>,
"appflowtotalnotxpackets":<Double_value>,
"appflowtxoctetsrate":<Double_value>,
"appflownotxpacketsrate":<Double_value>,
"appflowflowsrate":<Double_value>,
"appflownotxoctetsrate":<Double_value>,
"appflowignpacketssrate":<Double_value>,
"appflowtotalignpacketss":<Double_value>,
"appflowtotalnotxflows":<Double_value>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

appflow

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

appflow

Properties

Operations

get (all)

In this article