Skip to content

appflow

Statistics for appflow.

Properties

(click to see Operations)

NameData TypePermissionsDescription
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
appflowtotaltxoctets<Double>Read-onlyThe total number of AppFlow (IPFIX) octets that the Citrix ADC has transmitted.
appflowtxoctetsrate<Double>Read-onlyRate (/s) counter for appflowtotaltxoctets
appflowtotalflows<Double>Read-onlyThe total number of AppFlow (IPFIX) flows that the Citrix ADC has transmitted.
appflowflowsrate<Double>Read-onlyRate (/s) counter for appflowtotalflows
appflowtotaltxmessagess<Double>Read-onlyThe total number of AppFlow (IPFIX) messages that the Citrix ADC has transmitted.
appflowtxmessagessrate<Double>Read-onlyRate (/s) counter for appflowtotaltxmessagess
appflowtotalignoctets<Double>Read-onlyThe total number of octets that the Citrix ADC has ignored for AppFlow (IPFIX).
appflowignoctetsrate<Double>Read-onlyRate (/s) counter for appflowtotalignoctets
appflowtotalignpacketss<Double>Read-onlyThe total number of packets that the Citrix ADC has ignored for AppFlow (IPFIX).
appflowignpacketssrate<Double>Read-onlyRate (/s) counter for appflowtotalignpacketss
appflowtotalnotxoctets<Double>Read-onlyThe total number of AppFlow (IPFIX) octets that the Citrix ADC has not transmitted.
appflownotxoctetsrate<Double>Read-onlyRate (/s) counter for appflowtotalnotxoctets
appflowtotalnotxflows<Double>Read-onlyThe total number of AppFlow (IPFIX) flows that the Citrix ADC has not transmitted.
appflownotxflowsrate<Double>Read-onlyRate (/s) counter for appflowtotalnotxflows
appflowtotalnotxpackets<Double>Read-onlyThe total number of AppFlow (IPFIX) packets that the Citrix ADC has not transmitted.
appflownotxpacketsrate<Double>Read-onlyRate (/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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/appflow

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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