| getappflowparamResult Structure Definition |
The getappflowparamResult structure defines the return type for getappflowparam API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
appflowparamList |
List of appflowparams |
| appflowparam Structure Definition |
The appflowparam structure defines the actual return type values for getappflowparam API. |
Syntax |
Members |
templaterefresh |
Refresh interval, in seconds, at which to export the template data. Because data transmission is in UDP, the templates must be resent at regular intervals. |
appnamerefresh |
Interval, in seconds, at which to send Appnames to the configured collectors. Appname refers to the name of an entity (virtual server, service, or service group) in the Citrix ADC. |
flowrecordinterval |
Interval, in seconds, at which to send flow records to the configured collectors. |
securityinsightrecordinterval |
Interval, in seconds, at which to send security insight flow records to the configured collectors. |
udppmtu |
MTU, in bytes, for IPFIX UDP packets. |
httpurl |
State of AppFlow HTTP URL logging. |
aaausername |
State of AppFlow AAA User logging. |
httpcookie |
State of AppFlow HTTP cookie logging. |
httpreferer |
State of AppFlow HTTP referer logging. |
httpmethod |
State of AppFlow HTTP method logging. |
httphost |
State of AppFlow HTTP host logging. |
httpuseragent |
State of AppFlow HTTP user-agent logging. |
clienttrafficonly |
Generate AppFlow records for only the traffic from the client. |
httpcontenttype |
State of AppFlow HTTP Content-Type header logging |
httpauthorization |
State of AppFlow HTTP Authorization header logging |
httpvia |
State of AppFlow HTTP Via header logging |
httpxforwardedfor |
State of AppFlow HTTP X-Forwarded-For header logging |
httplocation |
State of AppFlow HTTP Location header logging |
httpsetcookie |
State of AppFlow HTTP Setcookie header logging |
httpsetcookie2 |
State of AppFlow HTTP Setcookie2 header logging |
connectionchaining |
State of connection-chaining feature |
httpdomain |
State of AppFlow HTTP Domain name logging |
skipcacheredirectionhttptransaction |
Skip Cache http transaction. This HTTP transaction is specific to Cache Redirection module. In Case of Cache Miss there will be another HTTP transaction initiated by the cache server. |
identifiername |
State of AppFlow Stream Identifier Name logging |
identifiersessionname |
State of AppFlow Stream Identifier Session Name logging |
observationdomainid |
An observation domain groups a set of Citrix ADCs based on deployment: cluster, HA etc. A unique Observation Domain ID is required to be assigned to each such group. |
observationpointid |
An observation point ID is identifier for the NetScaler from which appflow records are being exported. By default, the NetScaler IP is the observation point ID. |
observationdomainname |
Name of the Observation Domain defined by the observation domain ID. |
builtin |
Flag to determine if the appflow param is built-in or not |
securityinsighttraffic |
State of Security Insight traffic exporting |
subscriberawareness |
Enable this option for logging end user MSISDN in L4/L7 appflow records |
subscriberidobfuscation |
Enable this option for obfuscating MSISDN in L4/L7 appflow records |
subscriberidobfuscationalgo |
Algorithm(MD5 or SHA256) to be used for obfuscating MSISDN |
gxsessionreporting |
Enable this option for Gx session reporting |
cacheinsight |
Flag to determine whether cache records need to be exported or not. If this flag is true and IC is enabled, cache records are exported instead of L7 HTTP records |
videoinsight |
Enable/disable the feature individually on appflow action. |
httpquerywithurl |
Include the HTTP query segment along with the URL that the Citrix ADC received from the client. |
tcpburstreporting |
TCP burst reporting enable/disable knob. |
tcpburstreportingthreshold |
TCP burst reporting threshold. |
urlcategory |
Include the URL category record. |
lsnlogging |
On enabling this option, the Citrix ADC will send the Large Scale Nat(LSN) records to the configured collectors. |
cqareporting |
TCP CQA reporting enable/disable knob. |
emailaddress |
Enable AppFlow user email-id logging. |
usagerecordinterval |
On enabling this option, the NGS will send bandwidth usage record to configured collectors. |
websaasappusagereporting |
On enabling this option, NGS will send data used by Web/saas app at the end of every HTTP transaction to configured collectors. |
metrics |
Enable Citrix ADC Stats to be sent to the Telemetry Agent NOTE: This attribute is deprecated. This attribute is deprecated and will be removed in the future; configure it on timeseries analytics profile(s) instead |
events |
Enable Events to be sent to the Telemetry Agent NOTE: This attribute is deprecated. This attribute is deprecated and will be removed in the future; configure it on timeseries analytics profile(s) instead |
auditlogs |
Enable Auditlogs to be sent to the Telemetry Agent NOTE: This attribute is deprecated. This attribute is deprecated and will be removed in the future; configure it on timeseries analytics profile(s) instead |
distributedtracing |
Enable generation of the distributed tracing templates in the Appflow records |
disttracingsamplingrate |
Sampling rate for Distributed Tracing |
tcpattackcounterinterval |
Interval, in seconds, at which to send tcp attack counters to the configured collectors. If 0 is configured, the record is not sent. |
logstreamovernsip |
To use the Citrix ADC IP to send Logstream records instead of the SNIP |
analyticsauthtoken |
Authentication token to be set by the agent. |
timeseriesovernsip |
To use the Citrix ADC IP to send Time series data such as metrics and events, instead of the SNIP |
_nextgenapiresource |
See Also |