ADC CLI Commands

appflow-collector

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

rm add set show rename unset

rm appflow collector

Removes an AppFlow collector. You cannot remove a collector if it is associated with an AppFlow action.

Synopsis

rm appflow collector

Arguments

name Name of the collector to remove.

Example

rm appflow collector collector1

add appflow collector

Adds a new AppFlow collector. A collector receives the flow records generated by the Citrix ADC. You can add only four AppFlow collectors to the Citrix ADC.

Synopsis

add appflow collector -IPAddress [-port ] [-netProfile ] [-Transport ]

Arguments

name Name for the collector. 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. Only four collectors can be configured.

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 collector” or ‘my appflow collector’).

IPAddress IPv4 address of the collector.

port Port on which the collector listens.

netProfile Netprofile to associate with the collector. The IP address defined in the profile is used as the source IP address for AppFlow traffic for this collector. If you do not set this parameter, the Citrix ADC IP (NSIP) address is used as the source IP address.

Transport Type of collector: either logstream or ipfix or rest.

Possible values: ipfix, logstream, rest Default value: ipfix,

Example

add appflow collector collector1 -IPAddress 192.168.1.40 -port 2055

set appflow collector

Sets an AppFlow collector. A collector receives the flow records generated by the Citrix ADC.

Synopsis

set appflow collector [-IPAddress ] [-port ] [-netProfile ]

Arguments

name Name for the collector. 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. Only four collectors can be configured.

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 collector” or ‘my appflow collector’).

IPAddress IPv4 address of the collector.

port Port on which the collector listens.

netProfile Netprofile to associate with the collector. The IP address defined in the profile is used as the source IP address for AppFlow traffic for this collector. If you do not set this parameter, the Citrix ADC IP (NSIP) address is used as the source IP address.

Example

set appflow collector collector1 -IPAddress 192.168.1.40 -port 2055

show appflow collector

Displays information about all configured AppFlow collectors, or about the specified collector.

Synopsis

show appflow collector []

Arguments

name Name of the collector about which to display information.

Output

IPAddress IPv4 address of the collector.

port Port on which the collector listens.

netProfile Netprofile to associate with the collector. The IP address defined in the profile is used as the source IP address for AppFlow traffic for this collector. If you do not set this parameter, the Citrix ADC IP (NSIP) address is used as the source IP address.

Transport Type of collector: either logstream or ipfix or rest.

state Appflow collector state.

devno count stateflag

Example

show appflow collector collector1

rename appflow collector

Renames an AppFlow collector.

Synopsis

rename appflow collector @ @

Arguments

name Existing name of the collector.

newName New name for the collector. 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 coll” or ‘my appflow coll’).

Example

rename appflow collector old_name new_name

unset appflow collector

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

Synopsis

unset appflow collector [-IPAddress] [-port] [-netProfile]

appflow-collector