ADC CLI Commands

appflow-action

The following operations can be performed on “appflow-action”:

unbind add unset rm show bind rename set

unbind appflow action

unbind an entity from AppFlow action

Synopsis

unbind appflow action -analyticsProfile

Arguments

name Name for the action. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my appflow action” or ‘my appflow action’).

analyticsProfile Name of analytics profile to be unbound to the appflow action.

Example

unbind appflow action -analyticsProfile

add appflow action

Creates an AppFlow action. The action can be associated with an AppFlow policy by using the add appflow policy command.

Synopsis

add appflow action -collectors ... [-clientSideMeasurements ( ENABLED | DISABLED )] [-pageTracking ( ENABLED | DISABLED )] [-webInsight ( ENABLED | DISABLED )] [-securityInsight ( ENABLED | DISABLED )] [-botInsight ( ENABLED | DISABLED )] [-CIInsight ( ENABLED | DISABLED )] [-videoAnalytics ( ENABLED | DISABLED )] [-distributionAlgorithm ( ENABLED | DISABLED )] [-TransactionLog ( ALL | ANOMALOUS )] [-comment ]

Arguments

name Name for the action. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my appflow action” or ‘my appflow action’).

collectors Name(s) of collector(s) to be associated with the AppFlow action.

clientSideMeasurements On enabling this option, the Citrix ADC will collect the time required to load and render the mainpage on the client.

Possible values: ENABLED, DISABLED Default value: DISABLED

pageTracking On enabling this option, the Citrix ADC will start tracking the page for waterfall chart by inserting a NS_ESNS cookie in the response.

Possible values: ENABLED, DISABLED Default value: DISABLED

webInsight On enabling this option, the Citrix ADC will send the webinsight records to the configured collectors.

Possible values: ENABLED, DISABLED Default value: ENABLED

securityInsight On enabling this option, the Citrix ADC will send the security insight records to the configured collectors.

Possible values: ENABLED, DISABLED Default value: DISABLED

botInsight On enabling this option, the Citrix ADC will send the bot insight records to the configured collectors.

Possible values: ENABLED, DISABLED Default value: DISABLED

CIInsight On enabling this option, the Citrix ADC will send the ContentInspection Insight records to the configured collectors.

Possible values: ENABLED, DISABLED Default value: DISABLED

videoAnalytics On enabling this option, the Citrix ADC will send the videoinsight records to the configured collectors.

Possible values: ENABLED, DISABLED Default value: DISABLED

distributionAlgorithm On enabling this option, the Citrix ADC will distribute records among the collectors. Else, all records will be sent to all the collectors.

Possible values: ENABLED, DISABLED Default value: DISABLED

TransactionLog Log ANOMALOUS or ALL transactions

Possible values: ALL, ANOMALOUS Default value: ALL

comment Any comments about this action. In the CLI, if including spaces between words, enclose the comment in quotation marks. (The quotation marks are not required in the configuration utility.)

Example

add appflow action appflow_action_1 -collectors col1 col2

unset appflow action

Use this command to remove appflow action settings.Refer to the set appflow action command for meanings of the arguments.

Synopsis

unset appflow action [-clientSideMeasurements] [-comment] [-pageTracking] [-webInsight] [-securityInsight] [-botInsight] [-CIInsight] [-videoAnalytics] [-distributionAlgorithm]

rm appflow action

Removes a configured AppFlow action. You cannot remove an action that is associated with an AppFlow policy.

Synopsis

rm appflow action

Arguments

name Name of the action to be removed.

Example

rm appflow action appflow_action_1

show appflow action

Displays information about AppFlow action(s), or about the specified AppFlow action.

Synopsis

show appflow action []

Arguments

name Name of the action about which to display information.

Output

stateflag hits The number of times the action has been taken.

collectors Name(s) of collector(s) to be associated with the AppFlow action.

clientSideMeasurements On enabling this option, the Citrix ADC will collect the time required to load and render the mainpage on the client.

pageTracking On enabling this option, the Citrix ADC will start tracking the page for waterfall chart by inserting a NS_ESNS cookie in the response.

webInsight On enabling this option, the Citrix ADC will send the webinsight records to the configured collectors.

securityInsight On enabling this option, the Citrix ADC will send the security insight records to the configured collectors.

botInsight On enabling this option, the Citrix ADC will send the bot insight records to the configured collectors.

CIInsight On enabling this option, the Citrix ADC will send the ContentInspection Insight records to the configured collectors.

videoAnalytics On enabling this option, the Citrix ADC will send the videoinsight records to the configured collectors.

distributionAlgorithm On enabling this option, the Citrix ADC will distribute records among the collectors. Else, all records will be sent to all the collectors.

MetricsLog If only the stats records are to be exported, turn on this option.

TransactionLog Log ANOMALOUS or ALL transactions

referenceCount The number of references to the action.

description Description of the action

comment Comments associated with the AppFlow action.

analyticsProfile Analytics profile to be bound to the appflow action

devno count

Example

  1. show appflow action
  2. show appflow action appflow_action_1

bind appflow action

Bind an entity to AppFlow action

Synopsis

bind appflow action -analyticsProfile

Arguments

name Name for the action. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my appflow action” or ‘my appflow action’).

analyticsProfile Name of analytics profile to be bound to the appflow action.

Example

bind appflow action -analyticsProfile

rename appflow action

Renames an AppFlow action.

Synopsis

rename appflow action @ @

Arguments

name Existing name of the action.

newName New name for the AppFlow action. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my appflow action” or ‘my appflow action’).

Example

rename appflow action old_name new_name

set appflow action

Modifies the specified parameters of an AppFlow action.

Synopsis

set appflow action [-collectors ...] [-clientSideMeasurements ( ENABLED | DISABLED )] [-comment ] [-pageTracking ( ENABLED | DISABLED )] [-webInsight ( ENABLED | DISABLED )] [-securityInsight ( ENABLED | DISABLED )] [-botInsight ( ENABLED | DISABLED )] [-CIInsight ( ENABLED | DISABLED )] [-videoAnalytics ( ENABLED | DISABLED )] [-distributionAlgorithm ( ENABLED | DISABLED )]

Arguments

name Name of the action to be modified.

collectors Name(s) of collector(s) to be associated with the AppFlow action.

clientSideMeasurements On enabling this option, the Citrix ADC will collect the time required to load and render the mainpage on the client.

Possible values: ENABLED, DISABLED Default value: DISABLED

comment Any comments about this action. In the CLI, if including spaces between words, enclose the comment in quotation marks. (The quotation marks are not required in the configuration utility.)

pageTracking On enabling this option, the Citrix ADC will start tracking the page for waterfall chart by inserting a NS_ESNS cookie in the response.

Possible values: ENABLED, DISABLED Default value: DISABLED

webInsight On enabling this option, the Citrix ADC will send the webinsight records to the configured collectors.

Possible values: ENABLED, DISABLED Default value: ENABLED

securityInsight On enabling this option, the Citrix ADC will send the security insight records to the configured collectors.

Possible values: ENABLED, DISABLED Default value: DISABLED

botInsight On enabling this option, the Citrix ADC will send the bot insight records to the configured collectors.

Possible values: ENABLED, DISABLED Default value: DISABLED

CIInsight On enabling this option, the Citrix ADC will send the ContentInspection Insight records to the configured collectors.

Possible values: ENABLED, DISABLED Default value: DISABLED

videoAnalytics On enabling this option, the Citrix ADC will send the videoinsight records to the configured collectors.

Possible values: ENABLED, DISABLED Default value: DISABLED

distributionAlgorithm On enabling this option, the Citrix ADC will distribute records among the collectors. Else, all records will be sent to all the collectors.

Possible values: ENABLED, DISABLED Default value: DISABLED

Example

set appflow action appflow_action_1 -collectors col1 col2 col3

appflow-action