Class: MistApi::OrgSettingMistNacFingerprinting

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

Overview

Allows customer to enable client fingerprinting for policy enforcement

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(enabled = false, generate_coa = false, generate_wireless_coa = false, wireless_coa_type = SKIP) ⇒ OrgSettingMistNacFingerprinting

Returns a new instance of OrgSettingMistNacFingerprinting.



54
55
56
57
58
59
60
# File 'lib/mist_api/models/org_setting_mist_nac_fingerprinting.rb', line 54

def initialize(enabled = false, generate_coa = false,
               generate_wireless_coa = false, wireless_coa_type = SKIP)
  @enabled = enabled unless enabled == SKIP
  @generate_coa = generate_coa unless generate_coa == SKIP
  @generate_wireless_coa = generate_wireless_coa unless generate_wireless_coa == SKIP
  @wireless_coa_type = wireless_coa_type unless wireless_coa_type == SKIP
end

Instance Attribute Details

#enabledTrueClass | FalseClass

enable/disable writes to NAC DDB fingerprint table

Returns:

  • (TrueClass | FalseClass)


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

def enabled
  @enabled
end

#generate_coaTrueClass | FalseClass

enable/disable CoA triggers on fingerprint change for wired clients, always port-bounce

Returns:

  • (TrueClass | FalseClass)


19
20
21
# File 'lib/mist_api/models/org_setting_mist_nac_fingerprinting.rb', line 19

def generate_coa
  @generate_coa
end

#generate_wireless_coaTrueClass | FalseClass

enable/disable CoA triggers on fingerprint change for wireless clients

Returns:

  • (TrueClass | FalseClass)


23
24
25
# File 'lib/mist_api/models/org_setting_mist_nac_fingerprinting.rb', line 23

def generate_wireless_coa
  @generate_wireless_coa
end

#wireless_coa_typeOrgSettingMistNacFingerprintingWirelessCoaEnum

enum: ‘reauth`, `disconnect`



27
28
29
# File 'lib/mist_api/models/org_setting_mist_nac_fingerprinting.rb', line 27

def wireless_coa_type
  @wireless_coa_type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/mist_api/models/org_setting_mist_nac_fingerprinting.rb', line 63

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  enabled = hash['enabled'] ||= false
  generate_coa = hash['generate_coa'] ||= false
  generate_wireless_coa = hash['generate_wireless_coa'] ||= false
  wireless_coa_type =
    hash.key?('wireless_coa_type') ? hash['wireless_coa_type'] : SKIP

  # Create object from extracted values.
  OrgSettingMistNacFingerprinting.new(enabled,
                                      generate_coa,
                                      generate_wireless_coa,
                                      wireless_coa_type)
end

.namesObject

A mapping from model property names to API property names.



30
31
32
33
34
35
36
37
# File 'lib/mist_api/models/org_setting_mist_nac_fingerprinting.rb', line 30

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['enabled'] = 'enabled'
  @_hash['generate_coa'] = 'generate_coa'
  @_hash['generate_wireless_coa'] = 'generate_wireless_coa'
  @_hash['wireless_coa_type'] = 'wireless_coa_type'
  @_hash
end

.nullablesObject

An array for nullable fields



50
51
52
# File 'lib/mist_api/models/org_setting_mist_nac_fingerprinting.rb', line 50

def self.nullables
  []
end

.optionalsObject

An array for optional fields



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

def self.optionals
  %w[
    enabled
    generate_coa
    generate_wireless_coa
    wireless_coa_type
  ]
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



89
90
91
92
93
94
# File 'lib/mist_api/models/org_setting_mist_nac_fingerprinting.rb', line 89

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} enabled: #{@enabled.inspect}, generate_coa: #{@generate_coa.inspect},"\
  " generate_wireless_coa: #{@generate_wireless_coa.inspect}, wireless_coa_type:"\
  " #{@wireless_coa_type.inspect}>"
end

#to_sObject

Provides a human-readable string representation of the object.



81
82
83
84
85
86
# File 'lib/mist_api/models/org_setting_mist_nac_fingerprinting.rb', line 81

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} enabled: #{@enabled}, generate_coa: #{@generate_coa},"\
  " generate_wireless_coa: #{@generate_wireless_coa}, wireless_coa_type:"\
  " #{@wireless_coa_type}>"
end