Class: Ansible::Ruby::Modules::Ce_sflow

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb

Overview

Configure Sampled Flow (sFlow) to monitor traffic on an interface in real time, detect abnormal traffic, and locate the source of attack traffic, ensuring stable running of the network.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#agent_ip ⇒ Object?

Returns Specifies the IPv4/IPv6 address of an sFlow agent.

Returns:

  • (Object, nil) —

    Specifies the IPv4/IPv6 address of an sFlow agent.



12
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 12

attribute :agent_ip

#collector_datagram_size ⇒ Object?

Returns Specifies the maximum length of sFlow packets sent from an sFlow agent to an sFlow collector. The value is an integer, in bytes. It ranges from 1024 to 8100. The default value is 1400.

Returns:

  • (Object, nil) —

    Specifies the maximum length of sFlow packets sent from an sFlow agent to an sFlow collector. The value is an integer, in bytes. It ranges from 1024 to 8100. The default value is 1400.



28
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 28

attribute :collector_datagram_size

#collector_description ⇒ Object?

Returns Specifies the description of an sFlow collector. The value is a string of 1 to 255 case-sensitive characters without spaces.

Returns:

  • (Object, nil) —

    Specifies the description of an sFlow collector. The value is a string of 1 to 255 case-sensitive characters without spaces.



38
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 38

attribute :collector_description

#collector_id ⇒ 1, ...

Returns Specifies the ID of an sFlow collector. This ID is used when you specify the collector in subsequent sFlow configuration.

Returns:

  • (1, 2, nil) —

    Specifies the ID of an sFlow collector. This ID is used when you specify the collector in subsequent sFlow configuration.



18
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 18

attribute :collector_id

#collector_ip ⇒ Object?

Returns Specifies the IPv4/IPv6 address of the sFlow collector.

Returns:

  • (Object, nil) —

    Specifies the IPv4/IPv6 address of the sFlow collector.



22
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 22

attribute :collector_ip

#collector_ip_vpn ⇒ Object?

Returns Specifies the name of a VPN instance. The value is a string of 1 to 31 case-sensitive characters, spaces not supported. When double quotation marks are used around the string, spaces are allowed in the string. The value C(public) is reserved and cannot be used as the VPN instance name.

Returns:

  • (Object, nil) —

    Specifies the name of a VPN instance. The value is a string of 1 to 31 case-sensitive characters, spaces not supported. When double quotation marks are used around the string, spaces are allowed in the string. The value C(public) is reserved and cannot be used as the VPN instance name.



25
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 25

attribute :collector_ip_vpn

#collector_meth ⇒ :meth, ...

Returns Configures the device to send sFlow packets through service interfaces, enhancing the sFlow packet forwarding capability. The enhanced parameter is optional. No matter whether you configure the enhanced mode, the switch determines to send sFlow packets through service cards or management port based on the routing information on the collector. When the value is meth, the device forwards sFlow packets at the control plane. When the value is enhanced, the device forwards sFlow packets at the forwarding plane to enhance the sFlow packet forwarding capacity.

Returns:

  • (:meth, :enhanced, nil) —

    Configures the device to send sFlow packets through service interfaces, enhancing the sFlow packet forwarding capability. The enhanced parameter is optional. No matter whether you configure the enhanced mode, the switch determines to send sFlow packets through service cards or management port based on the routing information on the collector. When the value is meth, the device forwards sFlow packets at the control plane. When the value is enhanced, the device forwards sFlow packets at the forwarding plane to enhance the sFlow packet forwarding capacity.



34
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 34

attribute :collector_meth

#collector_udp_port ⇒ Object?

Returns Specifies the UDP destination port number of sFlow packets. The value is an integer that ranges from 1 to 65535. The default value is 6343.

Returns:

  • (Object, nil) —

    Specifies the UDP destination port number of sFlow packets. The value is an integer that ranges from 1 to 65535. The default value is 6343.



31
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 31

attribute :collector_udp_port

#counter_collector ⇒ Object?

Returns Indicates the ID list of the counter collector.

Returns:

  • (Object, nil) —

    Indicates the ID list of the counter collector.



57
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 57

attribute :counter_collector

#counter_interval ⇒ Object?

Returns Indicates the counter sampling interval. The value is an integer that ranges from 10 to 4294967295, in seconds. The default value is 20.

Returns:

  • (Object, nil) —

    Indicates the counter sampling interval. The value is an integer that ranges from 10 to 4294967295, in seconds. The default value is 20.



60
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 60

attribute :counter_interval

#export_route ⇒ :enable, ...

Returns Configures the sFlow packets sent by the switch not to carry routing information.

Returns:

  • (:enable, :disable, nil) —

    Configures the sFlow packets sent by the switch not to carry routing information.



63
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 63

attribute :export_route

#forward_enp_slot ⇒ Object?

Returns Enable the Embedded Network Processor (ENP) chip function. The switch uses the ENP chip to perform sFlow sampling, and the maximum sFlow sampling interval is 65535. If you set the sampling interval to be larger than 65535, the switch automatically restores it to 65535. The value is an integer or ‘all’.

Returns:

  • (Object, nil) —

    Enable the Embedded Network Processor (ENP) chip function. The switch uses the ENP chip to perform sFlow sampling, and the maximum sFlow sampling interval is 65535. If you set the sampling interval to be larger than 65535, the switch automatically restores it to 65535. The value is an integer or ‘all’.



73
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 73

attribute :forward_enp_slot

#rate_limit ⇒ Object?

Returns Specifies the rate of sFlow packets sent from a card to the control plane. The value is an integer that ranges from 100 to 1500, in pps.

Returns:

  • (Object, nil) —

    Specifies the rate of sFlow packets sent from a card to the control plane. The value is an integer that ranges from 100 to 1500, in pps.



67
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 67

attribute :rate_limit

#rate_limit_slot ⇒ Object?

Returns Specifies the slot where the rate of output sFlow packets is limited. If this parameter is not specified, the rate of sFlow packets sent from all cards to the control plane is limited. The value is an integer or a string of characters.

Returns:

  • (Object, nil) —

    Specifies the slot where the rate of output sFlow packets is limited. If this parameter is not specified, the rate of sFlow packets sent from all cards to the control plane is limited. The value is an integer or a string of characters.



70
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 70

attribute :rate_limit_slot

#sample_collector ⇒ Object?

Returns Indicates the ID list of the collector.

Returns:

  • (Object, nil) —

    Indicates the ID list of the collector.



44
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 44

attribute :sample_collector

#sample_direction ⇒ :inbound, ...

Returns Enables flow sampling in the inbound or outbound direction.

Returns:

  • (:inbound, :outbound, :both, nil) —

    Enables flow sampling in the inbound or outbound direction.



53
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 53

attribute :sample_direction

#sample_length ⇒ Object?

Returns Specifies the maximum length of sampled packets. The value is an integer and ranges from 18 to 512, in bytes. The default value is 128.

Returns:

  • (Object, nil) —

    Specifies the maximum length of sampled packets. The value is an integer and ranges from 18 to 512, in bytes. The default value is 128.



50
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 50

attribute :sample_length

#sample_rate ⇒ Object?

Returns Specifies the flow sampling rate in the format 1/rate. The value is an integer and ranges from 1 to 4294967295. The default value is 8192.

Returns:

  • (Object, nil) —

    Specifies the flow sampling rate in the format 1/rate. The value is an integer and ranges from 1 to 4294967295. The default value is 8192.



47
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 47

attribute :sample_rate

#sflow_interface ⇒ Object?

Returns Full name of interface for Flow Sampling or Counter. It must be a physical interface, Eth-Trunk, or Layer 2 subinterface.

Returns:

  • (Object, nil) —

    Full name of interface for Flow Sampling or Counter. It must be a physical interface, Eth-Trunk, or Layer 2 subinterface.



41
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 41

attribute :sflow_interface

#source_ip ⇒ Object?

Returns Specifies the source IPv4/IPv6 address of sFlow packets.

Returns:

  • (Object, nil) —

    Specifies the source IPv4/IPv6 address of sFlow packets.



15
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 15

attribute :source_ip

#state ⇒ :present, ...

Returns Determines whether the config should be present or not on the device.

Returns:

  • (:present, :absent, nil) —

    Determines whether the config should be present or not on the device.



76
 
# File 'lib/ansible/ruby/modules/generated/network/cloudengine/ce_sflow.rb', line 76

attribute :state