palo_alto 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e727fd699e499c9c7cdf0f445f1f83dc6b39721595060eb40f8ca686742f76fe
-  data.tar.gz: 538f05942d1bebd82c67c79749cf4cca51c57d3f56d6acbe6c8765eccd0abaca
+  metadata.gz: f3f5565d4ace0fcd1e96290bcd2b5e2d1ffa726b53fd7fe691497f7a2c137d42
+  data.tar.gz: 9e8e63ab0508abf76cc5fdf13e6827067aa42100f6beb996ef16b1256dd96f5b
 SHA512:
-  metadata.gz: 6e02483ec9f3e9860d2a248b043e30f8da48a89c7385feee667fffdea51abfaced43db81a487ba2bdf79b0c396310baf65f0b30c2132a7e1486e9e5ba4fc09f8
-  data.tar.gz: 1be23db7b31ed050c9fea102f2ba3007b916572a0f1b6d9b25e94bc1ebb09b923a6f938bc31c9b165c057cc8af984aa245266de71afb5cb20ac2890b167443d2
+  metadata.gz: 59e3ee0f6f425554cf6dd10ac49310cdc4ebba3ec24ad9cf3914f7e5a6c465a386ccfe8cae77041691ddbc157c281c66aaee84b49f617057bcd750cd81e7c0e3
+  data.tar.gz: ad822a803c73d950cfdf0e428c41ee47b7fc3c3dd8b3fb631cecf2cf19c4b07e31d120fe0468cf25bed0ad250b859e7ee3d6ce7467a7c9adf7254a9697d7e1fa

data/lib/palo_alto/config.rb

@@ -268,7 +268,11 @@ module PaloAlto
 		end
 
 		def binary_operator(name, left, right)
-			"#{left}#{name}#{right}".gsub('./@', '@')
+			if %w(and or).include?(name)
+				"(#{left} #{name} #{right})".gsub('./@', '@')
+			else
+				"#{left}#{name}#{right}".gsub('./@', '@')
+			end
 		end
 
 		def root(current, element_names)

data/lib/palo_alto/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PaloAlto
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/lib/palo_alto.rb

@@ -197,7 +197,11 @@ module PaloAlto
         begin
           Helpers::Rest.execute(payload, headers: {'X-PAN-KEY': self.auth_key})
         rescue TemporaryException => e
-          unless retried
+          dont_continue_at = [
+            'Partial revert is not allowed. Full system commit must be completed.',
+            'Config for scope '
+          ]
+          unless retried || dont_continue_at.any? { |x| e.message.start_with?(x) }
             if XML.debug.include?(:warnings)
               warn "Got error #{e.inspect}; retrying"
             end
@@ -247,6 +251,69 @@ module PaloAlto
       false
     end
 
+    def primary_active?
+      cmd = {show: {'high-availability': 'state'}}
+      state = Op.new.execute(cmd)
+      state.at_xpath("response/result/local-info/state").text == "primary-active"
+    end
+
+    # area: config, commit
+    def show_locks(area:)
+      cmd = {show: "#{area}-locks"}
+      ret = Op.new.execute(cmd)
+      ret.xpath("response/result/#{area}-locks/entry").map do |lock|
+        comment = lock.at_xpath('comment').inner_text
+        location = lock.at_xpath('name').inner_text
+        {
+          name: lock.attribute('name').value,
+          location: location == 'shared' ? nil : location,
+          type: lock.at_xpath('type').inner_text,
+          comment: comment == '(null)' ? nil : comment
+        }
+      end
+    end
+
+    # will execute block if given and unlock afterwards. returns false if lock could not be aquired
+    def lock(area:, comment: nil, type: nil, location: nil)
+      if block_given?
+        if lock(area: area, comment: comment, type: type, location: location)
+          begin
+            return yield
+          ensure
+            unlock(area: area, type: type, location: location)
+          end
+        else
+          return false
+        end
+      end
+
+      begin
+        cmd = {request: {"#{area}-lock": {add: {comment: comment || '(null)' }}}}
+        Op.new.execute(cmd, get_extra_argument(type: type, location: location))
+        true
+      rescue PaloAlto::InternalErrorException
+        false
+      end
+    end
+
+    def unlock(area:, type: nil, location: nil)
+      begin
+        cmd = {request: {"#{area}-lock": 'remove'}}
+        Op.new.execute(cmd, get_extra_argument(type: type, location: location))
+      rescue PaloAlto::InternalErrorException
+        return false
+      end
+      true
+    end
+
+    def remove_all_locks
+      %w(config commit).each do |area|
+        show_locks(area: area).each {|lock|
+          unlock(area: area, type: lock[:type], location: lock[:location])
+        }
+      end
+    end
+
     def check_for_changes(usernames: [XML.username])
       result = Op.new.execute({show: {config: {list: {'change-summary': {partial: {admin: usernames}}}}}})
       result.xpath('response/result/summary/device-group/member').map(&:inner_text)
@@ -317,5 +384,17 @@ module PaloAlto
       xml_data = Helpers::Rest.execute(payload)
       self.auth_key = xml_data.xpath('//response/result/key')[0].content
     end
+
+    private
+
+    # used to limit an op command to a specifc dg/template
+    def get_extra_argument(type:, location:)
+      case type
+        when 'dg'  then {vsys: location}
+        when 'tpl' then raise
+        else {}
+      end
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: palo_alto
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Sebastian Roesner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri