Class: MistApi::CaptureRadiotapwired

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

Overview

Initiate a Radiotap Packet Capture and Wired Packet Capture

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(ap_mac = SKIP, band = CaptureRadiotapwiredBandEnum::ENUM_24, client_mac = SKIP, duration = 600, format = CaptureRadiotapwiredFormatEnum::PCAP, max_pkt_len = 512, num_packets = 1024, radiotap_tcpdump_expression = SKIP, ssid = SKIP, tcpdump_expression = SKIP, wired_tcpdump_expression = SKIP, wireless_tcpdump_expression = SKIP, wlan_id = SKIP) ⇒ CaptureRadiotapwired

Returns a new instance of CaptureRadiotapwired.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 123

def initialize(ap_mac = SKIP, band = CaptureRadiotapwiredBandEnum::ENUM_24,
               client_mac = SKIP, duration = 600,
               format = CaptureRadiotapwiredFormatEnum::PCAP,
               max_pkt_len = 512, num_packets = 1024,
               radiotap_tcpdump_expression = SKIP, ssid = SKIP,
               tcpdump_expression = SKIP, wired_tcpdump_expression = SKIP,
               wireless_tcpdump_expression = SKIP, wlan_id = SKIP)
  @ap_mac = ap_mac unless ap_mac == SKIP
  @band = band unless band == SKIP
  @client_mac = client_mac unless client_mac == SKIP
  @duration = duration unless duration == SKIP
  @format = format unless format == SKIP
  @max_pkt_len = max_pkt_len unless max_pkt_len == SKIP
  @num_packets = num_packets unless num_packets == SKIP
  unless radiotap_tcpdump_expression == SKIP
    @radiotap_tcpdump_expression =
      radiotap_tcpdump_expression
  end
  @ssid = ssid unless ssid == SKIP
  @tcpdump_expression = tcpdump_expression unless tcpdump_expression == SKIP
  @type = 'radiotap,wired'
  @wired_tcpdump_expression = wired_tcpdump_expression unless wired_tcpdump_expression == SKIP
  unless wireless_tcpdump_expression == SKIP
    @wireless_tcpdump_expression =
      wireless_tcpdump_expression
  end
  @wlan_id = wlan_id unless wlan_id == SKIP
end

Instance Attribute Details

#ap_mac ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def ap_mac
  @ap_mac
end

#band ⇒ CaptureRadiotapwiredBandEnum

only used for radiotap. enum: ‘24`, `24,5,6`, `5`, `6`

Returns:



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

def band
  @band
end

#client_mac ⇒ String

only used for radiotap. enum: ‘24`, `24,5,6`, `5`, `6`

Returns:

  • (String) 


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

def client_mac
  @client_mac
end

#duration ⇒ Integer

Duration of the capture, in seconds

Returns:

  • (Integer) 


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

def duration
  @duration
end

#format ⇒ CaptureRadiotapwiredFormatEnum

enum: ‘pcap`, `stream`

Returns:



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

def format
  @format
end

#max_pkt_len ⇒ Integer

enum: ‘pcap`, `stream`

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 34

def max_pkt_len
  @max_pkt_len
end

#num_packets ⇒ Integer

number of packets to capture, 0 for unlimited, default is 1024, maximum is 10000

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 39

def num_packets
  @num_packets
end

#radiotap_tcpdump_expression ⇒ String

tcpdump expression for radiotap interface (802.11 + radio headers)

Returns:

  • (String) 


43
44
45
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 43

def radiotap_tcpdump_expression
  @radiotap_tcpdump_expression
end

#ssid ⇒ String

tcpdump expression for radiotap interface (802.11 + radio headers)

Returns:

  • (String) 


47
48
49
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 47

def ssid
  @ssid
end

#tcpdump_expression ⇒ String

tcpdump expression

Returns:

  • (String) 


51
52
53
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 51

def tcpdump_expression
  @tcpdump_expression
end

#type ⇒ String (readonly)

enum: ‘radiotap,wired`

Returns:

  • (String) 


55
56
57
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 55

def type
  @type
end

#wired_tcpdump_expression ⇒ String

tcpdump expression

Returns:

  • (String) 


59
60
61
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 59

def wired_tcpdump_expression
  @wired_tcpdump_expression
end

#wireless_tcpdump_expression ⇒ String

tcpdump expression for radiotap interface (802.11)

Returns:

  • (String) 


63
64
65
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 63

def wireless_tcpdump_expression
  @wireless_tcpdump_expression
end

#wlan_id ⇒ String

WLAN id associated with the respective ssid.

Returns:

  • (String) 


67
68
69
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 67

def wlan_id
  @wlan_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 153

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  ap_mac = hash.key?('ap_mac') ? hash['ap_mac'] : SKIP
  band = hash['band'] ||= CaptureRadiotapwiredBandEnum::ENUM_24
  client_mac = hash.key?('client_mac') ? hash['client_mac'] : SKIP
  duration = hash['duration'] ||= 600
  format = hash['format'] ||= CaptureRadiotapwiredFormatEnum::PCAP
  max_pkt_len = hash['max_pkt_len'] ||= 512
  num_packets = hash['num_packets'] ||= 1024
  radiotap_tcpdump_expression =
    hash.key?('radiotap_tcpdump_expression') ? hash['radiotap_tcpdump_expression'] : SKIP
  ssid = hash.key?('ssid') ? hash['ssid'] : SKIP
  tcpdump_expression =
    hash.key?('tcpdump_expression') ? hash['tcpdump_expression'] : SKIP
  wired_tcpdump_expression =
    hash.key?('wired_tcpdump_expression') ? hash['wired_tcpdump_expression'] : SKIP
  wireless_tcpdump_expression =
    hash.key?('wireless_tcpdump_expression') ? hash['wireless_tcpdump_expression'] : SKIP
  wlan_id = hash.key?('wlan_id') ? hash['wlan_id'] : SKIP

  # Create object from extracted values.
  CaptureRadiotapwired.new(ap_mac,
                           band,
                           client_mac,
                           duration,
                           format,
                           max_pkt_len,
                           num_packets,
                           radiotap_tcpdump_expression,
                           ssid,
                           tcpdump_expression,
                           wired_tcpdump_expression,
                           wireless_tcpdump_expression,
                           wlan_id)
end

.names ⇒ Object

A mapping from model property names to API property names.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 70

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['ap_mac'] = 'ap_mac'
  @_hash['band'] = 'band'
  @_hash['client_mac'] = 'client_mac'
  @_hash['duration'] = 'duration'
  @_hash['format'] = 'format'
  @_hash['max_pkt_len'] = 'max_pkt_len'
  @_hash['num_packets'] = 'num_packets'
  @_hash['radiotap_tcpdump_expression'] = 'radiotap_tcpdump_expression'
  @_hash['ssid'] = 'ssid'
  @_hash['tcpdump_expression'] = 'tcpdump_expression'
  @_hash['type'] = 'type'
  @_hash['wired_tcpdump_expression'] = 'wired_tcpdump_expression'
  @_hash['wireless_tcpdump_expression'] = 'wireless_tcpdump_expression'
  @_hash['wlan_id'] = 'wlan_id'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 109

def self.nullables
  %w[
    ap_mac
    client_mac
    duration
    max_pkt_len
    num_packets
    ssid
    tcpdump_expression
    wired_tcpdump_expression
    wlan_id
  ]
end

.optionals ⇒ Object

An array for optional fields



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 90

def self.optionals
  %w[
    ap_mac
    band
    client_mac
    duration
    format
    max_pkt_len
    num_packets
    radiotap_tcpdump_expression
    ssid
    tcpdump_expression
    wired_tcpdump_expression
    wireless_tcpdump_expression
    wlan_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 203

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} ap_mac: #{@ap_mac.inspect}, band: #{@band.inspect}, client_mac:"\
  " #{@client_mac.inspect}, duration: #{@duration.inspect}, format: #{@format.inspect},"\
  " max_pkt_len: #{@max_pkt_len.inspect}, num_packets: #{@num_packets.inspect},"\
  " radiotap_tcpdump_expression: #{@radiotap_tcpdump_expression.inspect}, ssid:"\
  " #{@ssid.inspect}, tcpdump_expression: #{@tcpdump_expression.inspect}, type:"\
  " #{@type.inspect}, wired_tcpdump_expression: #{@wired_tcpdump_expression.inspect},"\
  " wireless_tcpdump_expression: #{@wireless_tcpdump_expression.inspect}, wlan_id:"\
  " #{@wlan_id.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



192
193
194
195
196
197
198
199
200
 
# File 'lib/mist_api/models/capture_radiotapwired.rb', line 192

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} ap_mac: #{@ap_mac}, band: #{@band}, client_mac: #{@client_mac}, duration:"\
  " #{@duration}, format: #{@format}, max_pkt_len: #{@max_pkt_len}, num_packets:"\
  " #{@num_packets}, radiotap_tcpdump_expression: #{@radiotap_tcpdump_expression}, ssid:"\
  " #{@ssid}, tcpdump_expression: #{@tcpdump_expression}, type: #{@type},"\
  " wired_tcpdump_expression: #{@wired_tcpdump_expression}, wireless_tcpdump_expression:"\
  " #{@wireless_tcpdump_expression}, wlan_id: #{@wlan_id}>"
end