Class: NSXDriver::NSXTdfw

Inherits:
DistributedFirewall show all
Defined in:
lib/nsxt_dfw.rb

Overview

Class Logical Switch

Instance Attribute Summary collapse

Attributes inherited from DistributedFirewall

#one_section_name

Instance Method Summary collapse

Methods inherited from DistributedFirewall

#clear_all_rules, #clear_rules, #create_rules, #extract_nic_data, new_child

Methods included from NSXRule

#extract_rule_data, #extract_vnet_data, #parse_ports, #rule_spec, #to_nets

Methods included from NSXDriver::NSXRule::NSXVRule

#nsxv_rule_spec

Methods included from NSXDriver::NSXRule::NSXTRule

#nsxt_rule_spec

Constructor Details

#initialize(nsx_client) ⇒ NSXTdfw

CONSTRUCTOR Creates OpenNebula section if not exists



26
27
28
29
30
31
32
33
 
# File 'lib/nsxt_dfw.rb', line 26

def initialize(nsx_client)
    super(nsx_client)
    # Construct base URLs
    @base_url = NSXConstants::NSXT_DFW_BASE
    @url_sections = @base_url + \
                    NSXConstants::NSXT_DFW_SECTIONS
    @one_section_id = init_section
end

Instance Attribute Details

#one_section_id ⇒ Object (readonly)

ATTRIBUTES



22
23
24
 
# File 'lib/nsxt_dfw.rb', line 22

def one_section_id
  @one_section_id
end

Instance Method Details

#create_rule(rule_spec, section_id = @one_section_id) ⇒ Object

Create new rule



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/nsxt_dfw.rb', line 160

def create_rule(rule_spec, section_id = @one_section_id)
    # Get revision from section
    section = section_by_id(section_id)
    unless section
        error_msg = "Section with id #{section_id} not found"
        error = NSXError::ObjectNotFound
                .new(error_msg)
        raise error
    end
    revision_id = section['_revision']
    rule_spec['_revision'] = revision_id
    rule_spec = rule_spec.to_json
    url = @url_sections + '/' + section_id + '/rules'
    @nsx_client.post(url, rule_spec)
end

#create_section(section_name) ⇒ Object

Create new section and return the section



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/nsxt_dfw.rb', line 82

def create_section(section_name)
    section_spec = %(
      {
          "display_name": "#{section_name}",
          "section_type": "LAYER3",
          "stateful": true
      }
    )
    section_id = @nsx_client.post(@url_sections, section_spec)
    result = section_by_id(section_id)
    raise 'Section was not created in DFW' unless result

    result
end

#delete_rule(rule_id, section_id = @one_section_id) ⇒ Object

Delete rule



188
189
190
191
192
 
# File 'lib/nsxt_dfw.rb', line 188

def delete_rule(rule_id, section_id = @one_section_id)
    url = @url_sections + '/' + section_id + '/rules/' + rule_id
    # Delete receive a 200 OK also if the rule doesn't exist
    @nsx_client.delete(url)
end

#delete_section(section_id = @one_section_id) ⇒ Object

Delete section Params:

  • section_id: [String] ID of the section or @one_section_id



100
101
102
103
 
# File 'lib/nsxt_dfw.rb', line 100

def delete_section(section_id = @one_section_id)
    url = @url_sections + '/' + section_id
    @nsx_client.delete(url)
end

#init_section ⇒ Object

Sections Creates OpenNebula section if not exists and returns its section_id. Returns its section_id if OpenNebula section already exists



39
40
41
42
43
 
# File 'lib/nsxt_dfw.rb', line 39

def init_section
    one_section = section_by_name(NSXConstants::ONE_SECTION_NAME)
    one_section ||= create_section(NSXConstants::ONE_SECTION_NAME)
    return one_section['id'] if one_section
end

#rule_by_id(rule_id) ⇒ Object

Get rule by id Return: rule | nil



117
118
119
120
121
122
123
124
125
 
# File 'lib/nsxt_dfw.rb', line 117

def rule_by_id(rule_id)
    url = @base_url + '/rules/' + rule_id
    valid_codes = [NSXConstants::CODE_CREATED,
                   NSXConstants::CODE_OK,
                   NSXConstants::CODE_BAD_REQUEST,
                   NSXConstants::CODE_NOT_FOUND]
    additional_headers = []
    @nsx_client.get(url, additional_headers, valid_codes)
end

#rules(section_id = @one_section_id) ⇒ Object

Rules Get all rules of a Section, OpenNebula section if it’s not defined Return:

  • Array 


109
110
111
112
 
# File 'lib/nsxt_dfw.rb', line 109

def rules(section_id = @one_section_id)
    url = @url_sections + '/' + section_id + '/rules'
    @nsx_client.get(url)
end

#rules_by_name(rule_name, section_id = @one_section_id) ⇒ Object

Get rules by name Return:

- Array with rules or an empty array



130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/nsxt_dfw.rb', line 130

def rules_by_name(rule_name, section_id = @one_section_id)
    rules = []
    return rules unless section_id

    all_rules = rules(section_id)
    return rules unless all_rules

    all_rules['results'].each do |rule|
        rules << rule if rule['display_name'] == rule_name
    end
    rules
end

#rules_by_regex(regex, section_id = @one_section_id) ⇒ Object

Get rule by regex Return:

- Array with rules or an empty array



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/nsxt_dfw.rb', line 146

def rules_by_regex(regex, section_id = @one_section_id)
    rules = []
    return rules unless section_id

    all_rules = rules(section_id)
    return rules unless all_rules

    all_rules['results'].each do |rule|
        rules << rule if rule['display_name'].match(regex)
    end
    rules
end

#section_by_id(section_id = @one_section_id) ⇒ Object

Get section by id Params:

  • section_id: [String] ID of the section or @one_section_id

Return

  • nil | section



60
61
62
63
 
# File 'lib/nsxt_dfw.rb', line 60

def section_by_id(section_id = @one_section_id)
    url = @url_sections + '/' + section_id
    @nsx_client.get(url)
end

#section_by_name(section_name) ⇒ Object

Get section by name Params:

  • section_name: Name of the section

Return

  • nil | section



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/nsxt_dfw.rb', line 70

def section_by_name(section_name)
    result = nil
    all_sections = sections
    return result unless all_sections

    all_sections.each do |section|
        result = section if section['display_name'] == section_name
    end
    result
end

#sections ⇒ Object

Get all sections Params:

  • None

Return

  • nil | sections



50
51
52
53
 
# File 'lib/nsxt_dfw.rb', line 50

def sections
    result = @nsx_client.get(@url_sections)
    result['results']
end

#update_rule(rule_id, rule_spec, section_id = @one_section_id) ⇒ Object

Update rule



177
178
179
180
181
182
183
184
185
 
# File 'lib/nsxt_dfw.rb', line 177

def update_rule(rule_id, rule_spec, section_id = @one_section_id)
    url = @url_sections + '/' + section_id + '/rules/' + rule_id
    rule = rule_by_id(rule_id)
    raise "Rule id #{rule_id} not found" unless rule

    rule_spec['_revision'] = rule['_revision']
    rule_spec = rule_spec.to_json
    @nsx_client.put(url, rule_spec)
end