Product Documentation

appflow collector

Sep 12, 2016

The following operations can be performed on "appflow collector":

add | set | unset | rm | rename | show

add appflow collector

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

Synopsys

add appflow collector <name> -IPAddress <ip_addr> [-port <port>] [-netProfile <string>]

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 NetScaler 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

UDP port on which the collector listens.

Default value: 4739

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 NetScaler IP (NSIP) address is used as the source IP address.

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 NetScaler appliance.

Synopsys

set appflow collector <name> [-IPAddress <ip_addr>] [-port <port>] [-netProfile <string>]

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 NetScaler 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

UDP port on which the collector listens.

Default value: 4739

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 NetScaler IP (NSIP) address is used as the source IP address.

Example

set appflow collector collector1 -IPAddress 192.168.1.40 -port 2055

unset appflow collector

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

Synopsys

unset appflow collector <name> [-IPAddress] [-port] [-netProfile]

rm appflow collector

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

Synopsys

rm appflow collector <name>

Arguments

name

Name of the collector to remove.

Example

rm appflow collector collector1

rename appflow collector

Renames an AppFlow collector.

Synopsys

rename appflow collector <name>@ <newName>@

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 NetScaler 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

show appflow collector

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

Synopsys

show appflow collector [<name>]

Arguments

name

Name of the collector about which to display information.

Outputs

IPAddress

IPv4 address of the collector.

port

UDP 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 NetScaler IP (NSIP) address is used as the source IP address.

devno

count

stateflag

Example

show appflow collector collector1