sys sflow receiver

sys sflow receiver(1)	      BIG-IP TMSH Manual	 sys sflow receiver(1)



NAME
       receiver - Manages sFlow receivers configured on the BIG-IP system.

MODULE
       sys sflow

SYNTAX
       Configure the receiver component within the sys sflow module using the
       syntax shown in the following sections.

   CREATE/MODIFY
	create receiver [name]
	modify receiver [name]
	  options:
	   address [ip address]
	   app-service [[string] | none]
	   description [string]
	   max-datagram-size [integer]
	   port [ip port]
	   state [disabled | enabled]

   DISPLAY
	list receiver
	list receiver [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    one-line

   DELETE
	delete receiver [name]

DESCRIPTION
       You can use the receiver component to create, delete, list, or modify
       an sFlow receiver object on the BIG-IP system.

       Note: You can add an sFlow receiver to the BIG-IP system, only if you
       are assigned either the Resource Administrator or Administrator user
       role.

EXAMPLES
       create receiver my_receiver address 10.10.10.10

       Creates an sFlow receiver object named my_receiver with an IP address
       of 10.10.10.10, where the port, max-datagram-size, and state options
       are set to default values.

       create receiver my_receiver address 10.20.10.20 port 1234 state enabled

       Creates an sFlow receiver object named my_receiver with an IP address
       of 10.20.10.20, a port of 1234, and the max-datagram-size option set to
       default value. The state of the receiver is enabled.

       modify receiver my_receiver state enabled

       Changes the state of sFlow receiver object named my_receiver to
       enabled.

OPTIONS
       address
	    Specifies the IP address on which the sFlow receiver listens for
	    UDP datagrams. This option is required for the create command.

       app-service
	    Specifies the name of the application service to which the object
	    belongs. The default value is none. Note: If the strict-updates
	    option is enabled on the application service that owns the object,
	    you cannot modify or delete the object. Only the application
	    service can modify or delete the object.

       description
	    User defined description.

       glob Displays the items that match the glob expression. See help glob
	    for a description of glob expression syntax.

       max-datagram-size
	    Specifies the maximum size in bytes of the UDP datagram the sFlow
	    receiver accepts. The default value is 1400.

       name Specifies a unique name for the component. This option is required
	    for the commands create, delete, and modify.

       port Specifies the port on which the sFlow receiver listens for UDP
	    datagrams. The default value is the standard sFlow port, 6343.

       regex
	    Displays the items that match the regular expression. The regular
	    expression must be preceded by an at sign (@[regular expression])
	    to indicate that the identifier is a regular expression. See help
	    regex for a description of regular expression syntax.

       state
	    Specifies the state of the receiver. The sFlow samples will be
	    collected and sent to the receiver when enabled. The default value
	    is disabled.

SEE ALSO
       create, delete, glob, list, modify, regex, tmsh

COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or
       by any means, electronic or mechanical, including photocopying,
       recording, or information storage and retrieval systems, for any
       purpose other than the purchaser's personal use, without the express
       written permission of F5 Networks, Inc.

       F5 Networks and BIG-IP (c) Copyright 2008-2013. All rights reserved.



BIG-IP				  2014-03-18		 sys sflow receiver(1)