Citrix ADM NITRO API Reference

adc_update_appflow_info

Configuration for Execute the Appflow Info Query through Remote Proxy Handler resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
transactionlog <String> Read-write transactionlog.
priority <String> Read-write priority.
transport <String> Read-write Transport type..

Minimum length = 1

Maximum length = 20
policy_name <String> Read-write policy_name.

Minimum length = 1

Maximum length = 256
vsvr_name <String> Read-write Vserver name.

Minimum length = 1

Maximum length = 100
webinsight <String> Read-write webinsight.
videoanalytics <String> Read-write videoanalytics.
rule <String> Read-write Rule.
ns_ip_address <String> Read-write Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
agent_list <String> Read-write Agent List, on which traffic will flow.
appflowlog_effective <String> Read-write Appflowlog effective (validating AppFlow config) enabled or disabled.
securityinsight <String> Read-write securityinsight.
icalog <String> Read-write ICA log.
collector_ip <String> Read-write Collector IP Address.

Minimum length = 1

Maximum length = 64
export_option <String> Read-write Export Options: TCP, ICA.
appflow_policy_rule <String> Read-write Appflow policy rule.
es4nslog <String> Read-write ESNS enable.
collectors <String> Read-write collectors.
action <String> Read-write action.
type <String> Read-write type.
clientsidemeasurements <String> Read-write clientsidemeasurements.
metricslog <Boolean> Read-write metricslog.

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_update_appflow_info Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/adc_update_appflow_info ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of adc_update_appflow_info 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_update_appflow_info ?pagesize=#no;pageno=#no Use this query-parameter to get the adc_update_appflow_info resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/adc_update_appflow_info ?count=yes Use this query-parameter to get the count of adc_update_appflow_info 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_update_appflow_info":[{
"transactionlog":<String_value>,
"priority":<String_value>,
"transport":<String_value>,
"policy_name":<String_value>,
"vsvr_name":<String_value>,
"webinsight":<String_value>,
"videoanalytics":<String_value>,
"rule":<String_value>,
"ns_ip_address":<String_value>,
"agent_list":<String_value>,
"appflowlog_effective":<String_value>,
"securityinsight":<String_value>,
"icalog":<String_value>,
"collector_ip":<String_value>,
"export_option":<String_value>,
"appflow_policy_rule":<String_value>,
"es4nslog":<String_value>,
"collectors":<String_value>,
"action":<String_value>,
"type":<String_value>,
"clientsidemeasurements":<String_value>,
"metricslog":<Boolean_value>}]}

<!--NeedCopy-->
adc_update_appflow_info