Class: MistApi::SwitchPortUsageStormControl

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/mist_api/models/switch_port_usage_storm_control.rb

Overview

Switch storm control. Only if ‘mode`!=`dynamic`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(disable_port = false, no_broadcast = false, no_multicast = false, no_registered_multicast = false, no_unknown_unicast = false, percentage = 80) ⇒ SwitchPortUsageStormControl

Returns a new instance of SwitchPortUsageStormControl.



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 66

def initialize(disable_port = false, no_broadcast = false,
               no_multicast = false, no_registered_multicast = false,
               no_unknown_unicast = false, percentage = 80)
  @disable_port = disable_port unless disable_port == SKIP
  @no_broadcast = no_broadcast unless no_broadcast == SKIP
  @no_multicast = no_multicast unless no_multicast == SKIP
  @no_registered_multicast = no_registered_multicast unless no_registered_multicast == SKIP
  @no_unknown_unicast = no_unknown_unicast unless no_unknown_unicast == SKIP
  @percentage = percentage unless percentage == SKIP
end

Instance Attribute Details

#disable_port ⇒ TrueClass | FalseClass

Whether to disable the port when storm control is triggered

Returns:

  • (TrueClass | FalseClass) 


14
15
16
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 14

def disable_port
  @disable_port
end

#no_broadcast ⇒ TrueClass | FalseClass

Whether to disable storm control on broadcast traffic

Returns:

  • (TrueClass | FalseClass) 


18
19
20
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 18

def no_broadcast
  @no_broadcast
end

#no_multicast ⇒ TrueClass | FalseClass

Whether to disable storm control on multicast traffic

Returns:

  • (TrueClass | FalseClass) 


22
23
24
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 22

def no_multicast
  @no_multicast
end

#no_registered_multicast ⇒ TrueClass | FalseClass

Whether to disable storm control on registered multicast traffic

Returns:

  • (TrueClass | FalseClass) 


26
27
28
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 26

def no_registered_multicast
  @no_registered_multicast
end

#no_unknown_unicast ⇒ TrueClass | FalseClass

Whether to disable storm control on unknown unicast traffic

Returns:

  • (TrueClass | FalseClass) 


30
31
32
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 30

def no_unknown_unicast
  @no_unknown_unicast
end

#percentage ⇒ Integer

Bandwidth-percentage, configures the storm control level as a percentage of the available bandwidth

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 35

def percentage
  @percentage
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 78

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  disable_port = hash['disable_port'] ||= false
  no_broadcast = hash['no_broadcast'] ||= false
  no_multicast = hash['no_multicast'] ||= false
  no_registered_multicast = hash['no_registered_multicast'] ||= false
  no_unknown_unicast = hash['no_unknown_unicast'] ||= false
  percentage = hash['percentage'] ||= 80

  # Create object from extracted values.
  SwitchPortUsageStormControl.new(disable_port,
                                  no_broadcast,
                                  no_multicast,
                                  no_registered_multicast,
                                  no_unknown_unicast,
                                  percentage)
end

.names ⇒ Object

A mapping from model property names to API property names.



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 38

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['disable_port'] = 'disable_port'
  @_hash['no_broadcast'] = 'no_broadcast'
  @_hash['no_multicast'] = 'no_multicast'
  @_hash['no_registered_multicast'] = 'no_registered_multicast'
  @_hash['no_unknown_unicast'] = 'no_unknown_unicast'
  @_hash['percentage'] = 'percentage'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



62
63
64
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 62

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 50

def self.optionals
  %w[
    disable_port
    no_broadcast
    no_multicast
    no_registered_multicast
    no_unknown_unicast
    percentage
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



100
101
102
103
104
105
106
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 100

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



117
118
119
120
121
122
123
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 117

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} disable_port: #{@disable_port.inspect}, no_broadcast:"\
  " #{@no_broadcast.inspect}, no_multicast: #{@no_multicast.inspect}, no_registered_multicast:"\
  " #{@no_registered_multicast.inspect}, no_unknown_unicast: #{@no_unknown_unicast.inspect},"\
  " percentage: #{@percentage.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



109
110
111
112
113
114
 
# File 'lib/mist_api/models/switch_port_usage_storm_control.rb', line 109

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} disable_port: #{@disable_port}, no_broadcast: #{@no_broadcast},"\
  " no_multicast: #{@no_multicast}, no_registered_multicast: #{@no_registered_multicast},"\
  " no_unknown_unicast: #{@no_unknown_unicast}, percentage: #{@percentage}>"
end